Agora C++ API Reference for All Platforms

Public Member Functions | Public Attributes | List of all members
agora::rtc::LeaveChannelOptions Struct Reference

## Public Member Functions
| LeaveChannelOptions ()

## Public Attributes
bool | stopAudioMixing
bool | stopAllEffect
bool | unloadAllEffect
bool | stopMicrophoneRecording

## Detailed Description

The options for leaving a channel.

## Constructor & Destructor Documentation

## ◆ LeaveChannelOptions()

agora::rtc::LeaveChannelOptions::LeaveChannelOptions | ( |  | ) |
| inline

## Member Data Documentation

## ◆ stopAudioMixing

bool agora::rtc::LeaveChannelOptions::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

bool agora::rtc::LeaveChannelOptions::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.

## ◆ unloadAllEffect

bool agora::rtc::LeaveChannelOptions::unloadAllEffect

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

- `true`: Unload all audio effects.
- `false`: (Default) Do not unload any audio effect.

## ◆ stopMicrophoneRecording

bool agora::rtc::LeaveChannelOptions::stopMicrophoneRecording

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

- `true`: (Default) Stop microphone recording.
- `false`: Do not stop microphone recording.