Agora RTC Objective-C API Reference
Refactor
|
Inherits <NSObject>.
Properties | |
NSUInteger | uid |
NSUInteger | subviewUid |
VIEW_CLASS *_Nullable | view |
AgoraVideoRenderMode | renderMode |
AgoraVideoMirrorMode | mirrorMode |
AgoraVideoViewSetupMode | setupMode |
AgoraVideoSourceType | sourceType |
int | mediaPlayerId |
CGRect | cropArea |
UInt32 | backgroundColor |
BOOL | enableAlphaMask |
AgoraVideoModulePosition | position |
Properties of the video canvas object.
|
readwritenonatomicassign |
The user id of local video.
|
readwritenonatomicassign |
The uid of video stream composing the video stream from transcoder which will be drawn on this video canvas.
|
readwritenonatomicstrong |
The video display view. The SDK does not maintain the lifecycle of the view.
The view can be safely released after calling [leaveChannel]([AgoraRtcEngineKit leaveChannel:]) with a returned value. The SDK keeps a cache of the view value, so calling [setupLocalVideo]([AgoraRtcEngineKit setupLocalVideo:]) to set the view value to nil can clear the cache before switching or releasing the view.
|
readwritenonatomicassign |
The video render mode. See AgoraVideoRenderMode. The default value is AgoraVideoRenderModeHidden.
|
readwritenonatomicassign |
The video mirror mode. See AgoraVideoMirrorMode. The default value is AgoraVideoMirrorModeAuto.
|
readwritenonatomicassign |
The mode of setting up video view. See AgoraVideoViewSetupMode. The default value is AgoraVideoViewSetupReplace.
|
readwritenonatomicassign |
The video source type. See AgoraVideoSourceType The default value is AgoraVideoSourceTypeCamera.
|
readwritenonatomicassign |
The media player id of AgoraMediaPlayer. It should set this parameter when the sourceType is AgoraVideoSourceTypeMediaPlayer to show the video that AgoraMediaPlayer is playing. You can get this value by calling the method getMediaPlayerId().
|
readwritenonatomicassign |
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.
|
readwritenonatomicassign |
A RGBA value indicates background color of the render view. Defaults to 0x00000000.
|
readwritenonatomicassign |
Whether to apply alpha mask to the video frame if exsit: YES: Apply alpha mask to video frame. NO: (Default) Do not apply alpha mask to video frame.
|
readwritenonatomicassign |
The video frame position in pipeline. See AgoraVideoModulePosition. The default value is AgoraVideoModulePositionPostCapture.