AgoraRtcVideoCanvas Class Reference

Inherits from NSObject
Declared in AgoraObjects.h

Overview

Properties of the video canvas object.

  view

The video display view.

@property (strong, nonatomic) VIEW_CLASS *view

Discussion

VIEW_CLASS is a general name for this property. See the following definitions for iOS and macOS:

  • iOS: UIView
  • MacOS: NSView

Declared In

AgoraObjects.h

  renderMode

The rendering mode of the video view. See AgoraVideoRenderMode.

@property (assign, nonatomic) AgoraVideoRenderMode renderMode

Declared In

AgoraObjects.h

  channelId

The unique channel name for the AgoraRTC session in the string format. The string length must be less than 64 bytes. Supported character scopes are:

@property (copy, nonatomic) NSString *channelId

Discussion

  • All lowercase English letters: a to z.
  • All uppercase English letters: A to Z.
  • All numeric characters: 0 to 9.
  • The space character.
  • Punctuation characters and other symbols, including: “!”, “#”, “$”, “%”, “&”, “(”, “)”, “+”, “-”, “:”, “;”, “<”, “=”, “.”, “>”, “?”, “@”, “[”, “]”, “^”, “_”, “{”, “}”, “|”, “~”, “,”.

**Note**

  • The default value is the empty string “”. Use the default value if the user joins the channel using the joinChannelByToken method in the AgoraRtcEngineKit class. The AgoraRtcVideoCanvas struct defines the video canvas of the user in the channel.
  • If the user joins the channel using the joinChannelByToken method in the AgoraRtcChannel class, set this parameter as the channelID of the AgoraRtcChannel object. The AgoraRtcVideoCanvas struct defines the video canvas of the user in the channel with the specified channel ID.

Declared In

AgoraObjects.h

  uid

User ID of the view.

@property (assign, nonatomic) NSUInteger uid

Declared In

AgoraObjects.h

  mirrorMode

The mirror mode of the video view. See AgoraVideoMirrorMode.

@property (assign, nonatomic) AgoraVideoMirrorMode mirrorMode

Discussion

Note

  • For the mirror mode of the local video view: If you use a front camera, the SDK enables the mirror mode by default; if you use a rear camera, the SDK disables the mirror mode by default.
  • For the mirror mode of the remote video view: The SDK disables the mirror mode by default.

Declared In

AgoraObjects.h