LeaveChannelOptions

The options for leaving a channel.

class LeaveChannelOptions {
  const LeaveChannelOptions(
      {this.stopAudioMixing, this.stopAllEffect, this.stopMicrophoneRecording});

  @JsonKey(name: 'stopAudioMixing')
  final bool? stopAudioMixing;
  @JsonKey(name: 'stopAllEffect')
  final bool? stopAllEffect;
  @JsonKey(name: 'stopMicrophoneRecording')
  final bool? stopMicrophoneRecording;
  factory LeaveChannelOptions.fromJson(Map<String, dynamic> json) =>
      _$LeaveChannelOptionsFromJson(json);
  Map<String, dynamic> toJson() => _$LeaveChannelOptionsToJson(this);
}

Attributes

stopAudioMixing
Whether to stop playing and mixing the music file when a user leaves the channel.
  • true: (Default) Stop playing and mixing the music file.
  • false: Do not stop playing and mixing the music file.
stopAllEffect
Whether to stop playing all audio effects when a user leaves the channel.
  • true: (Default) Stop playing all audio effects.
  • false: Do not stop playing any audio effect.
stopMicrophoneRecording
Whether to stop microphone recording when a user leaves the channel.
  • true: (Default) Stop microphone recording.
  • false: Do not stop microphone recording.