AgoraRtcVideoCanvas Class Reference

Inherits from NSObject
Declared in AgoraObjects.h

Overview

视频画布对象的属性

  view

视频显示视窗

@property (strong, nonatomic) VIEW_CLASS *view

Discussion

VIEW_CLASS 为统称，具体为：

  • iOS: UIView
  • MacOS: NSView

Declared In

AgoraObjects.h

  renderMode

视图渲染模式，详见 AgoraVideoRenderMode

@property (assign, nonatomic) AgoraVideoRenderMode renderMode

Declared In

AgoraObjects.h

  channelId

能标识频道的频道名，长度在 64 字节以内的字符。以下为支持的字符集范围（共 89 个字符）：

@property (copy, nonatomic) NSString *channelId

Discussion

  • 26 个小写英文字母 a~z；
  • 26 个大写英文字母 A~Z；
  • 10 个数字 0~9；
  • 空格；
  • “!” 、 “#” 、 “$” 、 “%” 、 “&” 、 “(” 、 “)” 、 “+” 、 “-” 、 “:” 、 “;” 、 “<” 、 “=” 、 “.” 、 “>” 、 “?” 、 “@” 、 “[” 、 “]” 、 “^” 、 “_” 、 “{” 、 “}” 、 “|” 、 “~” 、 “,"。

Note

  • 该参数默认值为空字符 “"。如果用户是通过 AgoraRtcEngineKit 类的 joinChannelByToken 方法加入频道的，则将参数设为默认值，表示该用户在频道内的渲染视图。
  • 如果用户是通过 AgoraRtcChannel 类的 joinChannelByToken 方法加入频道的，则将该参数设为该 AgoraRtcChannel 类对应的 channelId，表示该用户在该 channelId 对应频道内的渲染视图。

Declared In

AgoraObjects.h

  uid

用户 ID，指定需要显示视窗的 uid

@property (assign, nonatomic) NSUInteger uid

Declared In

AgoraObjects.h

  mirrorMode

视图镜像模式，详见 AgoraVideoMirrorMode

@property (assign, nonatomic) AgoraVideoMirrorMode mirrorMode

Discussion

Note

  • 本地视图镜像模式：如果你使用前置摄像头，默认启动本地视图镜像模式；如果你使用后置摄像头，默认关闭本地视图镜像模式。
  • 远端用户视图镜像模式：默认关闭远端用户的镜像模式。

Declared In

AgoraObjects.h