Video SDK v3.7.1 API Reference for Unity
Public Types | Public Attributes | List of all members
agora_gaming_rtc.ExternalVideoFrame Struct Reference

Public Types

enum class  VIDEO_BUFFER_TYPE { VIDEO_BUFFER_RAW_DATA = 1 }
 
enum class  VIDEO_PIXEL_FORMAT {
  VIDEO_PIXEL_UNKNOWN = 0 , VIDEO_PIXEL_I420 = 1 , VIDEO_PIXEL_BGRA = 2 , VIDEO_PIXEL_NV21 = 3 ,
  VIDEO_PIXEL_RGBA = 4 , VIDEO_PIXEL_IMC2 = 5 , VIDEO_PIXEL_ARGB = 7 , VIDEO_PIXEL_NV12 = 8 ,
  VIDEO_PIXEL_I422 = 16 , VIDEO_TEXTURE_2D = 17 , VIDEO_TEXTURE_OES = 18
}
 

Public Attributes

VIDEO_BUFFER_TYPE type
 
VIDEO_PIXEL_FORMAT format
 
byte[] buffer
 
int stride
 
int height
 
int cropLeft
 
int cropTop
 
int cropRight
 
int cropBottom
 
int rotation
 
long timestamp
 

Detailed Description

The external video frame.

Member Enumeration Documentation

◆ VIDEO_BUFFER_TYPE

The video buffer type.

Enumerator
VIDEO_BUFFER_RAW_DATA 

1: The video buffer in the format of raw data.

◆ VIDEO_PIXEL_FORMAT

The video pixel format.

Note
The SDK does not support the alpha channel, and discards any alpha value passed to the SDK.
Enumerator
VIDEO_PIXEL_UNKNOWN 

0: The video pixel format is unknown.

VIDEO_PIXEL_I420 

1: The video pixel format is I420.

VIDEO_PIXEL_BGRA 

2: The video pixel format is BGRA.

VIDEO_PIXEL_NV21 

3: The video pixel format is NV21.

VIDEO_PIXEL_RGBA 

4: The video pixel format is RGBA.

VIDEO_PIXEL_IMC2 

5: The video pixel format is IMC2.

VIDEO_PIXEL_ARGB 

7: The video pixel format is ARGB.

VIDEO_PIXEL_NV12 

8: The video pixel format is NV12.

VIDEO_PIXEL_I422 

16: The video pixel format is I422.

VIDEO_TEXTURE_2D 

17: The video pixel format is GL_TEXTURE_2D.

VIDEO_TEXTURE_OES 

18: The video pixel format is GL_TEXTURE_OES.

Member Data Documentation

◆ type

VIDEO_BUFFER_TYPE agora_gaming_rtc.ExternalVideoFrame.type

The buffer type. See VIDEO_BUFFER_TYPE.

◆ format

VIDEO_PIXEL_FORMAT agora_gaming_rtc.ExternalVideoFrame.format

The pixel format. See VIDEO_PIXEL_FORMAT.

◆ buffer

byte [] agora_gaming_rtc.ExternalVideoFrame.buffer

The video buffer.

◆ bufferPtr

IntPtr agora_gaming_rtc.ExternalVideoFrame.bufferPtr

◆ stride

int agora_gaming_rtc.ExternalVideoFrame.stride

Line spacing of the incoming video frame, which must be in pixels instead of bytes. For textures, it is the width of the texture.

◆ height

int agora_gaming_rtc.ExternalVideoFrame.height

Height of the incoming video frame.

◆ cropLeft

int agora_gaming_rtc.ExternalVideoFrame.cropLeft

[Raw data related parameter] The number of pixels trimmed from the left. The default value is 0.

◆ cropTop

int agora_gaming_rtc.ExternalVideoFrame.cropTop

[Raw data related parameter] The number of pixels trimmed from the top. The default value is 0.

◆ cropRight

int agora_gaming_rtc.ExternalVideoFrame.cropRight

[Raw data related parameter] The number of pixels trimmed from the right. The default value is 0.

◆ cropBottom

int agora_gaming_rtc.ExternalVideoFrame.cropBottom

[Raw data related parameter] The number of pixels trimmed from the bottom. The default value is 0.

◆ rotation

int agora_gaming_rtc.ExternalVideoFrame.rotation

[Raw data related parameter] The clockwise rotation of the video frame. You can set the rotation angle as 0, 90, 180, or 270. The default value is 0.

◆ timestamp

long agora_gaming_rtc.ExternalVideoFrame.timestamp

Timestamp of the incoming video frame (ms). An incorrect timestamp results in frame loss or unsynchronized audio and video.


The documentation for this struct was generated from the following file: