Agora C++ API Reference for All Platforms
Public Member Functions | Public Attributes | List of all members
agora::rtc::TranscodingVideoStream Struct Reference

Public Member Functions

 TranscodingVideoStream ()
 

Public Attributes

VIDEO_SOURCE_TYPE sourceType
 
uid_t remoteUserUid
 
const char * imageUrl
 
int x
 
int y
 
int width
 
int height
 
int zOrder
 
double alpha
 
bool mirror
 

Detailed Description

The definition of the LocalTranscodingVideoStream struct.

Constructor & Destructor Documentation

◆ TranscodingVideoStream()

agora::rtc::TranscodingVideoStream::TranscodingVideoStream ( )
inline

Member Data Documentation

◆ sourceType

VIDEO_SOURCE_TYPE agora::rtc::TranscodingVideoStream::sourceType

Source type of video stream.

◆ remoteUserUid

uid_t agora::rtc::TranscodingVideoStream::remoteUserUid

Remote user uid if sourceType is VIDEO_SOURCE_REMOTE.

◆ imageUrl

const char* agora::rtc::TranscodingVideoStream::imageUrl

RTC image if sourceType is VIDEO_SOURCE_RTC_IMAGE.

◆ x

int agora::rtc::TranscodingVideoStream::x

The horizontal position of the top left corner of the video frame.

◆ y

int agora::rtc::TranscodingVideoStream::y

The vertical position of the top left corner of the video frame.

◆ width

int agora::rtc::TranscodingVideoStream::width

The width of the video frame.

◆ height

int agora::rtc::TranscodingVideoStream::height

The height of the video frame.

◆ zOrder

int agora::rtc::TranscodingVideoStream::zOrder

The layer of the video frame that ranges from 1 to 100:

  • 1: (Default) The lowest layer.
  • 100: The highest layer.

◆ alpha

double agora::rtc::TranscodingVideoStream::alpha

The transparency of the video frame.

◆ mirror

bool agora::rtc::TranscodingVideoStream::mirror

mirror of the source video frame (only valid for camera streams)