agora::rtc::VideoCanvas Struct Reference

#include <IAgoraRtcEngine.h>

Public Member Functions
	VideoCanvas ()
	VideoCanvas (view_t v, int m, uid_t u)
	VideoCanvas (view_t v, int m, const char *ch, uid_t u)
	VideoCanvas (view_t v, int rm, uid_t u, VIDEO_MIRROR_MODE_TYPE mm)
	VideoCanvas (view_t v, int rm, const char *ch, uid_t u, VIDEO_MIRROR_MODE_TYPE mm)

Public Attributes
view_t	view
int	renderMode
char	channelId [MAX_CHANNEL_ID_LENGTH]
uid_t	uid
void *	priv
VIDEO_MIRROR_MODE_TYPE	mirrorMode

Detailed Description

Video display settings of the VideoCanvas class.

Constructor & Destructor Documentation

VideoCanvas() [1/5]

agora::rtc::VideoCanvas::VideoCanvas ( )

inline

VideoCanvas() [2/5]

agora::rtc::VideoCanvas::VideoCanvas ( view_t  v, int  m, uid_t  u  )

inline

VideoCanvas() [3/5]

agora::rtc::VideoCanvas::VideoCanvas ( view_t  v, int  m, const char *  ch, uid_t  u  )

inline

VideoCanvas() [4/5]

agora::rtc::VideoCanvas::VideoCanvas ( view_t  v, int  rm, uid_t  u, VIDEO_MIRROR_MODE_TYPE  mm  )

inline

VideoCanvas() [5/5]

agora::rtc::VideoCanvas::VideoCanvas ( view_t  v, int  rm, const char *  ch, uid_t  u, VIDEO_MIRROR_MODE_TYPE  mm  )

inline

Member Data Documentation

view

view_t agora::rtc::VideoCanvas::view

Video display window (view).

renderMode

int agora::rtc::VideoCanvas::renderMode

The rendering mode of the video view. See RENDER_MODE_TYPE

channelId

char agora::rtc::VideoCanvas::channelId[MAX_CHANNEL_ID_LENGTH]

The unique channel name for the AgoraRTC session in the string format. The string length must be less than 64 bytes. Supported character scopes are:

• All lowercase English letters: a to z.
• All uppercase English letters: A to Z.
• All numeric characters: 0 to 9.
• The space character.
• Punctuation characters and other symbols, including: "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "|", "~", ",".

Note

• The default value is the empty string "". Use the default value if the user joins the channel using the joinChannel method in the IRtcEngine class. The VideoCanvas struct defines the video canvas of the user in the channel.
• If the user joins the channel using the joinChannel method in the IChannel class, set this parameter as the channelId of the IChannel object. The VideoCanvas struct defines the video canvas of the user in the channel with the specified channel ID.

uid

uid_t agora::rtc::VideoCanvas::uid

The user ID.

priv

void* agora::rtc::VideoCanvas::priv

mirrorMode

VIDEO_MIRROR_MODE_TYPE agora::rtc::VideoCanvas::mirrorMode

The mirror mode of the video view. See VIDEO_MIRROR_MODE_TYPE

Note

• For the mirror mode of the local video view: If you use a front camera, the SDK enables the mirror mode by default; if you use a rear camera, the SDK disables the mirror mode by default.
• For the mirror mode of the remote video view: The SDK disables the mirror mode by default.