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

Inherits <NSObject>.

Properties

VIEW_CLASS *_Nullable view
 
AgoraVideoRenderMode renderMode
 
NSUInteger uid
 

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.

◆ uid

- (NSUInteger) uid
readwritenonatomicassign

User ID of the view.

◆ userId

- (NSString* _Nullable) userId
readwritenonatomiccopy

◆ isSecondaryCameraView

- (BOOL) isSecondaryCameraView
readwritenonatomicassign