Agora C++ API Reference for All Platforms
|
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) | |
Attributes of video canvas object.
|
inline |
|
inline |
|
inline |
view_t agora::rtc::VideoCanvas::view |
Video display window.
uid_t agora::rtc::VideoCanvas::uid |
The user id of local video.
media::base::RENDER_MODE_TYPE agora::rtc::VideoCanvas::renderMode |
The video render mode. See RENDER_MODE_TYPE. The default value is RENDER_MODE_HIDDEN.
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.
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.
VIDEO_SOURCE_TYPE agora::rtc::VideoCanvas::sourceType |
The video source type. See VIDEO_SOURCE_TYPE. The default value is VIDEO_SOURCE_CAMERA_PRIMARY.
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().
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.