Meeting audio controller interface.
More...
#include <meeting_audio_interface.h>
Meeting audio controller interface.
Definition at line 146 of file meeting_audio_interface.h.
◆ CanEnableMuteOnEntry()
virtual bool IMeetingAudioController::CanEnableMuteOnEntry |
( |
| ) |
|
|
pure virtual |
Check if the host or cohost can enable mute on entry.
- Returns
- TRUE indicates that the host or cohost can enable mute on entry. Otherwise not.
- Note
- Valid for both ZOOM style and user custom interface mode.
◆ 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.
- Note
- Valid for both ZOOM style and user custom interface mode.
◆ 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 fails. To get extended error information, see SDKError enum.
- Note
- Valid for both ZOOM style and user custom interface mode.
◆ 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.
- Note
- Valid for both ZOOM style and user custom interface mode.
◆ EnablePlayMeetingAudio()
virtual SDKError IMeetingAudioController::EnablePlayMeetingAudio |
( |
bool | bEnable | ) |
|
|
pure virtual |
Enable or disable SDK to play meeting audio.
- Parameters
-
bEnable | True means that SDK will play meeting audio. False means that SDK will not play meeting audio. |
- Returns
- If the function succeeds, the return value is SDKErr_Success. Otherwise fails. To get extended error information, see SDKError enum.
- Note
- SDK will not support sharing computer sound when disabling playing meeting audio.
◆ Is3rdPartyTelephonyAudioOn()
virtual bool IMeetingAudioController::Is3rdPartyTelephonyAudioOn |
( |
| ) |
|
|
pure virtual |
Determine if the meeting has third party telephony audio enabled.
- Returns
- TRUE means enabled, otherwise it is not enabled.
◆ IsIncomingAudioStopped()
virtual bool IMeetingAudioController::IsIncomingAudioStopped |
( |
| ) |
|
|
pure virtual |
Determine if the incoming audio is stopped.
- Returns
- TRUE indicates that the incoming audio is stopped.
◆ IsMuteOnEntryEnabled()
virtual bool IMeetingAudioController::IsMuteOnEntryEnabled |
( |
| ) |
|
|
pure virtual |
Determine if mute on entry is enabled.
- Returns
- TRUE indicates that mute on entry is enabled.
◆ IsPlayMeetingAudioEnabled()
virtual bool IMeetingAudioController::IsPlayMeetingAudioEnabled |
( |
| ) |
|
|
pure virtual |
Determine if play meeting audio is enabled or not.
- Returns
- TRUE means enabled, otherwise it is not enabled.
◆ 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.
- Note
- Valid for both ZOOM style and user custom interface mode.
◆ 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.
- Note
- Valid for both ZOOM style and user custom interface mode.
◆ 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.
- Note
- Valid for both ZOOM style and user custom interface mode.
◆ 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.
- Note
- The SDK use pEvent to transmit the callback event to the user's application. If the function is not called or failed, the user's application is unabled to retrieve the callback event.
◆ 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.
- Note
- Valid for both ZOOM style and user custom interface mode.