LeaveChannelOptions

java.lang.Object

io.agora.rtc2.LeaveChannelOptions

public class LeaveChannelOptions extends Object

Field Summary

Fields

Modifier and Type

Field

Description

boolean

stopAllEffect

Whether to stop playing all audio effects when a user leaves the channel.

boolean

stopAudioMixing

Whether to stop playing and mixing the music file when a user leaves the channel.

boolean

stopMicrophoneRecording

Whether to stop microphone recording when a user leaves the channel.
Constructor Summary

Constructors

Constructor

Description

LeaveChannelOptions()
Method Summary

Modifier and Type

Method

Description

boolean

isStopAllEffect()

boolean

isStopAudioMixing()

boolean

isStopMicrophoneRecording()

String

toString()

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details
- stopAudioMixing
  
  public boolean 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
  
  public boolean 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
  
  public boolean stopMicrophoneRecording
  
  Whether to stop microphone recording when a user leaves the channel. - `true`: (Default) Stop microphone recording. - `false`: Do not stop microphone recording.
Constructor Details
- LeaveChannelOptions
  
  public LeaveChannelOptions()
Method Details
- isStopAudioMixing
  
  public boolean isStopAudioMixing()
- isStopAllEffect
  
  public boolean isStopAllEffect()
- isStopMicrophoneRecording
  
  public boolean isStopMicrophoneRecording()
- toString
  
  public String toString()
  
  Overrides:
  
  toString in class Object