Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ChannelMediaOptions

The channel media options.

Hierarchy

  • ChannelMediaOptions

Index

Constructors

Properties

Constructors

constructor

  • new ChannelMediaOptions(params?: undefined | { autoSubscribeAudio?: undefined | false | true; autoSubscribeVideo?: undefined | false | true; publishLocalAudio?: undefined | false | true; publishLocalVideo?: undefined | false | true }): ChannelMediaOptions

  • Parameters

    • Optional params: undefined | { autoSubscribeAudio?: undefined | false | true; autoSubscribeVideo?: undefined | false | true; publishLocalAudio?: undefined | false | true; publishLocalVideo?: undefined | false | true }

    Returns ChannelMediaOptions

Properties

Optional autoSubscribeAudio

autoSubscribeAudio: undefined | false | true

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.

Optional autoSubscribeVideo

autoSubscribeVideo: undefined | false | true

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 audio streams in the channel.

Optional publishLocalAudio

publishLocalAudio: undefined | false | true

Determines whether to publish the local audio stream when the user joins a channel:

  • true: (Default) Publish.
  • false: Do not publish.

This member serves a similar function to the muteLocalAudioStream method. After the user joins the channel, you can call the muteLocalAudioStream method to set whether to publish the local audio stream in the channel.

since

v3.4.5

Optional publishLocalVideo

publishLocalVideo: undefined | false | true

Determines whether to publish the local video stream when the user joins a channel:

  • true: (Default) Publish.
  • false: Do not publish.

This member serves a similar function to the muteLocalVideoStream method. After the user joins the channel, you can call the muteLocalVideoStream method to set whether to publish the local video stream in the channel.

since

v3.4.5

Generated using TypeDoc