ZOOM Windows SDK  4.4.55968.0904
Public Member Functions | List of all members
IMeetingAudioController Class Referenceabstract

Meeting audio controller interface. More...

#include <meeting_audio_interface.h>

Public Member Functions

virtual SDKError SetEvent (IMeetingAudioCtrlEvent *pEvent)=0
 Configure the meeting audio controller callback event handler. More...
 
virtual SDKError JoinVoip ()=0
 Join VoIP meeting. More...
 
virtual SDKError LeaveVoip ()=0
 Leave VoIP meeting. More...
 
virtual SDKError MuteAudio (unsigned int userid, bool allowUnmuteBySelf=true)=0
 Mute the assigned user. More...
 
virtual SDKError UnMuteAudio (unsigned int userid)=0
 Unmute the assigned user. More...
 
virtual bool CanUnMuteBySelf ()=0
 Check if the user can unmute himself. More...
 
virtual SDKError EnableMuteOnEntry (bool bEnable)=0
 Mute or umute the user after joining the meeting. More...
 
virtual SDKError EnablePlayChimeWhenEnterOrExit (bool bEnable)=0
 User joins or leaves the meeting in silence or no. More...
 

Detailed Description

Meeting audio controller interface.

Member Function Documentation

◆ 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.
Remarks
Valid for both ZOOM style and user custom interface mode.

◆ EnableMuteOnEntry()

virtual SDKError IMeetingAudioController::EnableMuteOnEntry ( bool  bEnable)
pure virtual

Mute or umute the user after joining the meeting.

Parameters
bEnableTRUE 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.
Remarks
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
bEnableTRUE 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.
Remarks
Valid for both ZOOM style and user custom interface mode.

◆ 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.
Remarks
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.
Remarks
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
useridSpecify the user ID to mute. ZERO(0) indicates to mute all the participants.
allowUnmuteBySelfThe 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.
Remarks
Valid for both ZOOM style and user custom interface mode.

◆ SetEvent()

virtual SDKError IMeetingAudioController::SetEvent ( IMeetingAudioCtrlEvent pEvent)
pure virtual

Configure the meeting audio controller callback event handler.

Parameters
pEventAn object pointer to the IMeetingAudioCtrlEvent that receives the meeting audio callback event. For more details, see IMeetingAudioCtrlEvent.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.
Remarks
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.

◆ UnMuteAudio()

virtual SDKError IMeetingAudioController::UnMuteAudio ( unsigned int  userid)
pure virtual

Unmute the assigned user.

Parameters
useridSpecify the user ID to unmute. ZERO(0) indicates to unmute all the participants.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.
Remarks
Valid for both ZOOM style and user custom interface mode.

The documentation for this class was generated from the following file: