FLeaveChannelOptions
The options for leaving a channel.
USTRUCT(BlueprintType) struct FLeaveChannelOptions { GENERATED_BODY() public: UPROPERTY(VisibleAnywhere, BlueprintReadWrite, Category = "Agora|LeaveChannelOptions") bool stopAudioMixing = true; UPROPERTY(VisibleAnywhere, BlueprintReadWrite, Category = "Agora|LeaveChannelOptions") bool stopAllEffect = true; UPROPERTY(VisibleAnywhere, BlueprintReadWrite, Category = "Agora|LeaveChannelOptions") bool stopMicrophoneRecording = true; FLeaveChannelOptions() {} FLeaveChannelOptions(const agora::rtc::LeaveChannelOptions& AgoraData) { this->stopAudioMixing = AgoraData.stopAudioMixing; this->stopAllEffect = AgoraData.stopAllEffect; this->stopMicrophoneRecording = AgoraData.stopMicrophoneRecording; } agora::rtc::LeaveChannelOptions CreateAgoraData() const { agora::rtc::LeaveChannelOptions AgoraData; AgoraData.stopAudioMixing = this->stopAudioMixing; AgoraData.stopAllEffect = this->stopAllEffect; AgoraData.stopMicrophoneRecording = this->stopMicrophoneRecording; return AgoraData; } void FreeAgoraData(agora::rtc::LeaveChannelOptions& AgoraData) const { } };
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.