ChannelMediaOptions class
The channel media options.
- Annotations
-
- @JsonSerializable(explicitToJson: true)
Constructors
- ChannelMediaOptions({bool? autoSubscribeAudio, bool? autoSubscribeVideo, bool? publishLocalAudio, bool? publishLocalVideo})
- Constructs the ChannelMediaOptions.
Properties
- autoSubscribeAudio ↔ bool?
-
Whether to automatically subscribe to all remote audio streams when the user joins a 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.
getter/setter pair
- autoSubscribeVideo ↔ bool?
-
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.
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
- publishLocalAudio ↔ bool?
-
whether to publish the local audio stream when the user joins a channel.
true: (Default) Publish the local audio.
false: Do not publish the local audio. 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.
getter/setter pair
- publishLocalVideo ↔ bool?
-
whether to publish the local video stream when the user joins a channel.
true: (Default) Publish the local video.
false: Do not publish the local video. 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 audio stream in the channel.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited