Agora RTC Objective-C API Reference
Refactor
|
Attributes of video canvas object.
|
inline |
|
inline |
|
inline |
|
inline |
uid_t uid |
The user id of local video.
uid_t subviewUid |
The uid of video stream composing the video stream from transcoder which will be drawn on this video canvas.
view_t view |
Video display window.
uint32_t backgroundColor |
A RGBA value indicates background color of the render view. Defaults to 0x00000000.
media::base::RENDER_MODE_TYPE renderMode |
The video render mode. See RENDER_MODE_TYPE. The default value is RENDER_MODE_HIDDEN.
VIDEO_MIRROR_MODE_TYPE mirrorMode |
The video mirror mode. See VIDEO_MIRROR_MODE_TYPE. The default value is VIDEO_MIRROR_MODE_AUTO.
VIDEO_VIEW_SETUP_MODE setupMode |
The mode of setting up video view. See VIDEO_VIEW_SETUP_MODE The default value is VIDEO_VIEW_SETUP_REPLACE.
VIDEO_SOURCE_TYPE sourceType |
The video source type. See VIDEO_SOURCE_TYPE. The default value is VIDEO_SOURCE_CAMERA_PRIMARY.
int 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 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.
bool enableAlphaMask |
Whether to apply alpha mask to the video frame if exsit: true: Apply alpha mask to video frame. false: (Default) Do not apply alpha mask to video frame.
media::base::VIDEO_MODULE_POSITION position |
The video frame position in pipeline. See VIDEO_MODULE_POSITION. The default value is POSITION_POST_CAPTURER.