Meeting audio controller interface.
More...
#include <meeting_audio_interface.h>
Meeting audio controller interface.
Definition at line 94 of file meeting_audio_interface.h.
◆ CanUnMuteBySelf()
virtual bool IMeetingAudioController::CanUnMuteBySelf |
( |
| ) |
|
|
pure virtual |
Check if the user can unmute himself.
- Returns
- TRUE indicates that the user can unmute himself. Otherwise not.
◆ EnableMuteOnEntry()
virtual SDKError IMeetingAudioController::EnableMuteOnEntry |
( |
bool | bEnable, |
|
|
bool | allowUnmuteBySelf ) |
|
pure virtual |
Mute or umute the user after joining the meeting.
- Parameters
-
bEnable | TRUE indicates to mute the user after joining the meeting. |
- Returns
- If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.
◆ EnablePlayChimeWhenEnterOrExit()
virtual SDKError IMeetingAudioController::EnablePlayChimeWhenEnterOrExit |
( |
bool | bEnable | ) |
|
|
pure virtual |
User joins or leaves the meeting in silence or no.
- Parameters
-
bEnable | TRUE indicates to play chime when the user joins or leaves the meeting. |
- Returns
- If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.
◆ IsIncomingAudioStopped()
virtual bool IMeetingAudioController::IsIncomingAudioStopped |
( |
| ) |
|
|
pure virtual |
Determine if the incoming audio is stopped.
- Returns
- TRUE indicates that the incoming audio is stopped.
◆ JoinVoip()
virtual SDKError IMeetingAudioController::JoinVoip |
( |
| ) |
|
|
pure virtual |
Join VoIP meeting.
- Returns
- If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.
◆ LeaveVoip()
virtual SDKError IMeetingAudioController::LeaveVoip |
( |
| ) |
|
|
pure virtual |
Leave VoIP meeting.
- Returns
- If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.
◆ MuteAudio()
virtual SDKError IMeetingAudioController::MuteAudio |
( |
unsigned int | userid, |
|
|
bool | allowUnmuteBySelf = true ) |
|
pure virtual |
Mute the assigned user.
- Parameters
-
userid | Specify the user ID to mute. ZERO(0) indicates to mute all the participants. |
allowUnmuteBySelf | The user may unmute himself when everyone is muted. |
- Returns
- If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.
◆ SetEvent()
Configure the meeting audio controller callback event handler.
- Parameters
-
- Returns
- If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.
◆ StopIncomingAudio()
virtual SDKError IMeetingAudioController::StopIncomingAudio |
( |
bool | bStop | ) |
|
|
pure virtual |
Stop the incoming audio.
- Returns
- If the function succeeds, the return value is SDKErr_Success. Otherwise the function fails and returns an error. To get extended error information, see SDKError enum.
◆ UnMuteAudio()
virtual SDKError IMeetingAudioController::UnMuteAudio |
( |
unsigned int | userid | ) |
|
|
pure virtual |
Unmute the assigned user.
- Parameters
-
userid | Specify the user ID to unmute. |
- Returns
- If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.