Agora RTC Objective-C API Reference  Refactor
Properties
AgoraRtcVideoCanvas Class Reference

Inherits <NSObject>.

Properties

VIEW_CLASS *_Nullable view
 
AgoraVideoRenderMode renderMode
 
AgoraVideoMirrorMode mirrorMode
 
NSUInteger uid
 
NSString *_Nullable userId
 
AgoraVideoSourceType sourceType
 
int sourceId
 
CGRect cropArea
 
AgoraVideoViewSetupMode setupMode
 

Detailed Description

Properties of the video canvas object.

Property Documentation

◆ view

- (VIEW_CLASS* _Nullable) view
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.

◆ renderMode

- (AgoraVideoRenderMode) renderMode
readwritenonatomicassign

Render mode of the view; hidden, fit, or adaptive.

◆ mirrorMode

- (AgoraVideoMirrorMode) mirrorMode
readwritenonatomicassign

Mirror mode of the view; auto, enabled, or disabled.

◆ uid

- (NSUInteger) uid
readwritenonatomicassign

User ID of the view.

◆ userId

- (NSString* _Nullable) userId
readwritenonatomiccopy

the string user id of view

◆ sourceType

- (AgoraVideoSourceType) sourceType
readwritenonatomicassign

the sourceType of view

◆ sourceId

- (int) sourceId
readwritenonatomicassign

when sourceType == AgoraVideoSourceTypeMediaPlayer valid( sourceId == mediaPlayerId )

◆ cropArea

- (CGRect) cropArea
readwritenonatomicassign

crop area of video to show.

◆ setupMode

- (AgoraVideoViewSetupMode) setupMode
readwritenonatomicassign

setup Mode add or remove.