Meeting audio controller interface. More...

#include <meeting_audio_interface.h>

Public Member Functions
virtual SDKError	SetEvent (IMeetingAudioCtrlEvent *pEvent)=0
	Configures the meeting audio controller callback event handler.

virtual SDKError	JoinVoip ()=0
	Joins VoIP meeting.

virtual SDKError	LeaveVoip ()=0
	Leaves VoIP meeting.

virtual SDKError	MuteAudio (unsigned int userid, bool allowUnmuteBySelf=true)=0
	Mutes the assigned user.

virtual SDKError	UnMuteAudio (unsigned int userid)=0
	Unmutes the assigned user.

virtual bool	CanUnMuteBySelf ()=0
	Determines whether the user can unmute himself.

virtual bool	CanEnableMuteOnEntry ()=0
	Determines whether the host or cohost can enable mute on entry.

virtual SDKError	EnableMuteOnEntry (bool bEnable, bool allowUnmuteBySelf)=0
	Mutes or unmutes the user after joining the meeting.

virtual bool	IsMuteOnEntryEnabled ()=0
	Determines if mute on entry is enabled.

virtual SDKError	EnablePlayChimeWhenEnterOrExit (bool bEnable)=0
	User joins or leaves the meeting in silence or no.

virtual SDKError	StopIncomingAudio (bool bStop)=0
	Stops the incoming audio.

virtual bool	IsIncomingAudioStopped ()=0
	Determines if the incoming audio is stopped.

virtual bool	Is3rdPartyTelephonyAudioOn ()=0
	Determines if the meeting has third party telephony audio enabled.

virtual SDKError	EnablePlayMeetingAudio (bool bEnable)=0
	Enables or disables SDK to play meeting audio.

virtual bool	IsPlayMeetingAudioEnabled ()=0
	Determines if play meeting audio is enabled or not.

Detailed Description

Meeting audio controller interface.

Definition at line 149 of file meeting_audio_interface.h.

Member Function Documentation

◆ CanEnableMuteOnEntry()

virtual bool IMeetingAudioController::CanEnableMuteOnEntry ( )

pure virtual

Determines whether the host or cohost can enable mute on entry.

Returns: true if the host or cohost can enable mute on entry. Otherwise, false.

Note: Valid for both ZOOM style and user custom interface mode.

◆ CanUnMuteBySelf()

virtual bool IMeetingAudioController::CanUnMuteBySelf ( )

pure virtual

Determines whether the user can unmute himself.

Returns: true if the user can unmute himself. Otherwise, false.

Note: Valid for both ZOOM style and user custom interface mode.

◆ EnableMuteOnEntry()

virtual SDKError IMeetingAudioController::EnableMuteOnEntry	(	bool	bEnable,
		bool	allowUnmuteBySelf )

pure virtual

Mutes or unmutes the user after joining the meeting.

Parameters

bEnable	true indicates to mute the user after joining the meeting.
allowUnmuteBySelf	true indicates to allow the user to unmute by self.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

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, this function returns an error.

Note: Valid for both ZOOM style and user custom interface mode.

◆ EnablePlayMeetingAudio()

virtual SDKError IMeetingAudioController::EnablePlayMeetingAudio ( bool bEnable )

pure virtual

Enables or disables SDK to play meeting audio.

Parameters

bEnable true to enable SDK to play meeting audio, false to disable.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

Note: SDK will not support sharing computer sound when disabling playing meeting audio.

◆ Is3rdPartyTelephonyAudioOn()

virtual bool IMeetingAudioController::Is3rdPartyTelephonyAudioOn ( )

pure virtual

Determines if the meeting has third party telephony audio enabled.

Returns: true if enabled. Otherwise, false.

◆ IsIncomingAudioStopped()

virtual bool IMeetingAudioController::IsIncomingAudioStopped ( )

pure virtual

Determines if the incoming audio is stopped.

Returns: true indicates that the incoming audio is stopped.

◆ IsMuteOnEntryEnabled()

virtual bool IMeetingAudioController::IsMuteOnEntryEnabled ( )

pure virtual

Determines if mute on entry is enabled.

Returns: true indicates that mute on entry is enabled.

◆ IsPlayMeetingAudioEnabled()

virtual bool IMeetingAudioController::IsPlayMeetingAudioEnabled ( )

pure virtual

Determines if play meeting audio is enabled or not.

Returns: true if enabled. Otherwise, false.

◆ JoinVoip()

virtual SDKError IMeetingAudioController::JoinVoip ( )

pure virtual

Joins VoIP meeting.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

Note: Valid for both ZOOM style and user custom interface mode.

◆ LeaveVoip()

virtual SDKError IMeetingAudioController::LeaveVoip ( )

pure virtual

Leaves VoIP meeting.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

Note: Valid for both ZOOM style and user custom interface mode.

◆ MuteAudio()

virtual SDKError IMeetingAudioController::MuteAudio	(	unsigned int	userid,
		bool	allowUnmuteBySelf = true )

pure virtual

Mutes the assigned user.

Parameters

userid	The user ID to mute. ZERO(0) indicates to mute all the participants.
allowUnmuteBySelf	true if the user may unmute himself when everyone is muted, false otherwise.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

Note: Valid for both ZOOM style and user custom interface mode.

◆ SetEvent()

virtual SDKError IMeetingAudioController::SetEvent ( IMeetingAudioCtrlEvent * pEvent )

pure virtual

Configures the meeting audio controller callback event handler.

Parameters

pEvent An object pointer to the IMeetingAudioCtrlEvent that receives the meeting audio callback event.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

Note: The SDK uses pEvent to transmit the callback event to the user's application. If the function is not called or fails, the user's application is unable to retrieve the callback event.

◆ StopIncomingAudio()

virtual SDKError IMeetingAudioController::StopIncomingAudio ( bool bStop )

pure virtual

Stops the incoming audio.

Parameters

bStop true indicates to stop the incoming audio. false not.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ UnMuteAudio()

virtual SDKError IMeetingAudioController::UnMuteAudio ( unsigned int userid )

pure virtual

Unmutes the assigned user.

Parameters

userid The user ID to unmute.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

Note: Valid for both ZOOM style and user custom interface mode.

Public Member Functions

Detailed Description

Member Function Documentation

◆ CanEnableMuteOnEntry()

◆ CanUnMuteBySelf()

◆ EnableMuteOnEntry()

◆ EnablePlayChimeWhenEnterOrExit()

◆ EnablePlayMeetingAudio()

◆ Is3rdPartyTelephonyAudioOn()

◆ IsIncomingAudioStopped()

◆ IsMuteOnEntryEnabled()

◆ IsPlayMeetingAudioEnabled()

◆ JoinVoip()

◆ LeaveVoip()

◆ MuteAudio()

◆ SetEvent()

◆ StopIncomingAudio()

◆ UnMuteAudio()