agora::media::base::ExternalVideoFrame Struct Reference

#include <AgoraMediaBase.h>

Public Types
enum	VIDEO_BUFFER_TYPE { VIDEO_BUFFER_RAW_DATA = 1 , VIDEO_BUFFER_ARRAY = 2 , VIDEO_BUFFER_TEXTURE = 3 }

Public Member Functions
	ExternalVideoFrame ()

Public Attributes
VIDEO_BUFFER_TYPE	type
VIDEO_PIXEL_FORMAT	format
void *	buffer
int	stride
int	height
int	cropLeft
int	cropTop
int	cropRight
int	cropBottom
int	rotation
long long	timestamp
uint8_t *	alphaBuffer

Detailed Description

The definition of the ExternalVideoFrame struct.

Member Enumeration Documentation

VIDEO_BUFFER_TYPE

enum agora::media::base::ExternalVideoFrame::VIDEO_BUFFER_TYPE

Video buffer types.

Enumerator
VIDEO_BUFFER_RAW_DATA	1: Raw data.
VIDEO_BUFFER_ARRAY	2: The same as VIDEO_BUFFER_RAW_DATA.
VIDEO_BUFFER_TEXTURE	3: The video buffer in the format of texture.

Constructor & Destructor Documentation

ExternalVideoFrame()

agora::media::base::ExternalVideoFrame::ExternalVideoFrame ( )

inline

Member Data Documentation

alphaBuffer

uint8_t* agora::media::base::ExternalVideoFrame::alphaBuffer

Indicates the output data of the portrait segmentation algorithm, which is consistent with the size of the video frame. The value range of each pixel is [0,255], where 0 represents the background, and 255 represents the foreground (portrait).

In a custom video renderer scenario, you can use this parameter to render the video background into various effects, such as transparent, solid color, picture, or video.

Note

Contact suppo.nosp@m.rt@a.nosp@m.gora..nosp@m.io to activate this parameter.

buffer

void* agora::media::base::ExternalVideoFrame::buffer

The video buffer.

cropBottom

int agora::media::base::ExternalVideoFrame::cropBottom

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

cropLeft

int agora::media::base::ExternalVideoFrame::cropLeft

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

cropRight

int agora::media::base::ExternalVideoFrame::cropRight

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

cropTop

int agora::media::base::ExternalVideoFrame::cropTop

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

format

VIDEO_PIXEL_FORMAT agora::media::base::ExternalVideoFrame::format

The pixel format: VIDEO_PIXEL_FORMAT

height

int agora::media::base::ExternalVideoFrame::height

The height of the incoming video frame.

rotation

int agora::media::base::ExternalVideoFrame::rotation

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

stride

int agora::media::base::ExternalVideoFrame::stride

The line spacing of the incoming video frame (px). For texture, it is the width of the texture.

timestamp

long long agora::media::base::ExternalVideoFrame::timestamp

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

type

VIDEO_BUFFER_TYPE agora::media::base::ExternalVideoFrame::type

The buffer type: VIDEO_BUFFER_TYPE.

---

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

• AgoraMediaBase.h