FVideoFrame

Configurations of the video frame.

USTRUCT(BlueprintType)
struct FVideoFrame {

	GENERATED_BODY()
	UPROPERTY(VisibleAnywhere, BlueprintReadWrite, Category = "Agora|VideoFrame")
	EVIDEO_PIXEL_FORMAT type;
	UPROPERTY(VisibleAnywhere, BlueprintReadWrite, Category = "Agora|VideoFrame")
	int width;
	UPROPERTY(VisibleAnywhere, BlueprintReadWrite, Category = "Agora|VideoFrame")
	int height;
	UPROPERTY(VisibleAnywhere, BlueprintReadWrite, Category = "Agora|VideoFrame")
	int yStride;
	UPROPERTY(VisibleAnywhere, BlueprintReadWrite, Category = "Agora|VideoFrame")
	int uStride;
	UPROPERTY(VisibleAnywhere, BlueprintReadWrite, Category = "Agora|VideoFrame")
	int vStride;
	UPROPERTY(VisibleAnywhere, BlueprintReadWrite, Category = "Agora|VideoFrame")
	int rotation;
	UPROPERTY(VisibleAnywhere, BlueprintReadWrite, Category = "Agora|VideoFrame")
	TArray<int64> yBuffer;
	UPROPERTY(VisibleAnywhere, BlueprintReadWrite, Category = "Agora|VideoFrame")
	TArray<int64> uBuffer;
	UPROPERTY(VisibleAnywhere, BlueprintReadWrite, Category = "Agora|VideoFrame")
	TArray<int64> vBuffer;
	UPROPERTY(VisibleAnywhere, BlueprintReadWrite, Category = "Agora|VideoFrame")
	int64 renderTimeMs;
	UPROPERTY(VisibleAnywhere, BlueprintReadWrite, Category = "Agora|VideoFrame")
	int avsync_type;
	UPROPERTY(VisibleAnywhere, BlueprintReadWrite, Category = "Agora|VideoFrame")
	TArray<int64> metadata_buffer;
	UPROPERTY(VisibleAnywhere, BlueprintReadWrite, Category = "Agora|VideoFrame")
	int metadata_size;
	UPROPERTY(VisibleAnywhere, BlueprintReadWrite, Category = "Agora|VideoFrame")
	int64 sharedContext;
	UPROPERTY(VisibleAnywhere, BlueprintReadWrite, Category = "Agora|VideoFrame")
	int textureId;
	UPROPERTY(VisibleAnywhere, BlueprintReadWrite, Category = "Agora|VideoFrame")
	TArray<float> matrix;
	UPROPERTY(VisibleAnywhere, BlueprintReadWrite, Category = "Agora|VideoFrame")
	TArray<int64> alphaBuffer;
	UPROPERTY(VisibleAnywhere, BlueprintReadWrite, Category = "Agora|VideoFrame")
	TArray<float> pixelBuffer;
};

Note that the buffer provides a pointer to a pointer. This interface cannot modify the pointer of the buffer, but it can modify the content of the buffer.

Attributes

type
The pixel format. See EVIDEO_PIXEL_FORMAT.
width
The width of the video, in pixels.
height
The height of the video, in pixels.
yStride
For YUV data, the line span of the Y buffer; for RGBA data, the total data length.
Attention: When dealing with video data, it is necessary to process the offset between each line of pixel data based on this parameter, otherwise it may result in image distortion.
uStride
For YUV data, the line span of the U buffer; for RGBA data, the value is 0.
Attention: When dealing with video data, it is necessary to process the offset between each line of pixel data based on this parameter, otherwise it may result in image distortion.
vStride
For YUV data, the line span of the V buffer; for RGBA data, the value is 0.
Attention: When dealing with video data, it is necessary to process the offset between each line of pixel data based on this parameter, otherwise it may result in image distortion.
yBuffer
For YUV data, the pointer to the Y buffer; for RGBA data, the data buffer.
uBuffer
For YUV data, the pointer to the U buffer; for RGBA data, the value is 0.
vBuffer
For YUV data, the pointer to the V buffer; for RGBA data, the value is 0.
rotation
The clockwise rotation of the video frame before rendering. Supported values include 0, 90, 180, and 270 degrees.
renderTimeMs
The Unix timestamp (ms) when the video frame is rendered. This timestamp can be used to guide the rendering of the video frame. This parameter is required.
avsync_type
Reserved for future use.
metadata_buffer
This parameter only applies to video data in Texture format. The MetaData buffer. The default value is NULL.
metadata_size
This parameter only applies to video data in Texture format. The MetaData size. The default value is 0.
sharedContext
This parameter only applies to video data in Texture format. EGL Context.
textureId
This parameter only applies to video data in Texture format. Texture ID.
matrix
This parameter only applies to video data in Texture format. Incoming 4 × 4 transformational matrix. The typical value is a unit matrix.
metaInfo

The meta information in the video frame. To use this parameter, please technical support.