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

Public Member Functions

 VideoCanvas ()
 
 VideoCanvas (view_t v, media::base::RENDER_MODE_TYPE m, VIDEO_MIRROR_MODE_TYPE mt, uid_t u)
 
 VideoCanvas (view_t v, media::base::RENDER_MODE_TYPE m, VIDEO_MIRROR_MODE_TYPE mt, user_id_t)
 

Public Attributes

view_t view
 
uid_t uid
 
media::base::RENDER_MODE_TYPE renderMode
 
VIDEO_MIRROR_MODE_TYPE mirrorMode
 
VIDEO_VIEW_SETUP_MODE setupMode
 
VIDEO_SOURCE_TYPE sourceType
 
int mediaPlayerId
 
Rectangle cropArea
 

Detailed Description

Attributes of video canvas object.

Constructor & Destructor Documentation

◆ VideoCanvas() [1/3]

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

◆ VideoCanvas() [2/3]

agora::rtc::VideoCanvas::VideoCanvas ( view_t  v,
media::base::RENDER_MODE_TYPE  m,
VIDEO_MIRROR_MODE_TYPE  mt,
uid_t  u 
)
inline

◆ VideoCanvas() [3/3]

agora::rtc::VideoCanvas::VideoCanvas ( view_t  v,
media::base::RENDER_MODE_TYPE  m,
VIDEO_MIRROR_MODE_TYPE  mt,
user_id_t   
)
inline

Member Data Documentation

◆ view

view_t agora::rtc::VideoCanvas::view

Video display window.

◆ uid

uid_t agora::rtc::VideoCanvas::uid

The user id of local video.

◆ renderMode

media::base::RENDER_MODE_TYPE agora::rtc::VideoCanvas::renderMode

The video render mode. See RENDER_MODE_TYPE. The default value is RENDER_MODE_HIDDEN.

◆ mirrorMode

VIDEO_MIRROR_MODE_TYPE agora::rtc::VideoCanvas::mirrorMode

The video mirror mode. See VIDEO_MIRROR_MODE_TYPE. The default value is VIDEO_MIRROR_MODE_AUTO.

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 remote user: The mirror mode is disabled by default.

◆ setupMode

VIDEO_VIEW_SETUP_MODE agora::rtc::VideoCanvas::setupMode

The mode of setting up video view. See VIDEO_VIEW_SETUP_MODE The default value is VIDEO_VIEW_SETUP_REPLACE.

◆ sourceType

VIDEO_SOURCE_TYPE agora::rtc::VideoCanvas::sourceType

The video source type. See VIDEO_SOURCE_TYPE. The default value is VIDEO_SOURCE_CAMERA_PRIMARY.

◆ mediaPlayerId

int agora::rtc::VideoCanvas::mediaPlayerId

The media player id of AgoraMediaPlayer. It should set this parameter when the sourceType is VIDEO_SOURCE_MEDIA_PLAYER to show the video that AgoraMediaPlayer is playing. You can get this value by calling the method getMediaPlayerId().

◆ cropArea

Rectangle agora::rtc::VideoCanvas::cropArea

If you want to display a certain part of a video frame, you can set this value to crop the video frame to show. The default value is empty(that is, if it has zero width or height), which means no cropping.