Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RtcSurfaceViewProps

Properties of the SurfaceView.

Hierarchy

  • RtcSurfaceViewProps

Index

Properties

Optional channelId

channelId: undefined | string

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:

  • 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 joinChannel method in the RtcEngine class.
  • If the user joins the channel using the joinChannel method in the RtcChannel class, set this parameter as the channelId of the RtcChannel object.

Optional mirrorMode

mirrorMode: VideoMirrorMode

The video mirror mode.

Optional renderMode

renderMode: VideoRenderMode

The rendering mode of the video view.

Optional zOrderMediaOverlay

zOrderMediaOverlay: undefined | false | true

Controls whether the SurfaceView's surface is placed on top of another regular surface view in the window (but still behind the window itself).

Optional zOrderOnTop

zOrderOnTop: undefined | false | true

Controls whether the SurfaceView's surface is placed on top of its window.

Generated using TypeDoc