Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ChannelMediaOptions

The channel media options.

Hierarchy

  • ChannelMediaOptions

Index

Constructors

Properties

Constructors

constructor

  • new ChannelMediaOptions(autoSubscribeAudio?: boolean, autoSubscribeVideo?: boolean): ChannelMediaOptions

  • Parameters

    • Default value autoSubscribeAudio: boolean = true
    • Default value autoSubscribeVideo: boolean = true

    Returns ChannelMediaOptions

Properties

autoSubscribeAudio

autoSubscribeAudio: boolean

Determines whether to subscribe to audio streams when the user joins the channel:

  • true: (Default) Subscribe.
  • false: Do not subscribe.

This member serves a similar function to the muteAllRemoteAudioStreams method. After joining the channel, you can call the muteAllRemoteAudioStreams method to set whether to subscribe to audio streams in the channel.

autoSubscribeVideo

autoSubscribeVideo: boolean

Determines whether to subscribe to video streams when the user joins the channel:

  • true: (Default) Subscribe.
  • false: Do not subscribe.

This member serves a similar function to the muteAllRemoteVideoStreams method. After joining the channel, you can call the muteAllRemoteVideoStreams method to set whether to subscribe to video streams in the channel.

Generated using TypeDoc