IMeetingAudioController Class Reference

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.
virtual SDKError	JoinVoip ()=0
	Join VoIP meeting.
virtual SDKError	LeaveVoip ()=0
	Leave VoIP meeting.
virtual SDKError	MuteAudio (unsigned int userid, bool allowUnmuteBySelf=true)=0
	Mute the assigned user.
virtual SDKError	UnMuteAudio (unsigned int userid)=0
	Unmute the assigned user.
virtual bool	CanUnMuteBySelf ()=0
	Check if the user can unmute himself.
virtual bool	CanEnableMuteOnEntry ()=0
	Check if the host or cohost can enable mute on entry.
virtual SDKError	EnableMuteOnEntry (bool bEnable, bool allowUnmuteBySelf)=0
	Mute or umute the user after joining the meeting.
virtual bool	IsMuteOnEntryEnabled ()=0
	Determine 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
	Stop the incoming audio.
virtual bool	IsIncomingAudioStopped ()=0
	Determine if the incoming audio is stopped.
virtual bool	Is3rdPartyTelephonyAudioOn ()=0
	Determine if the meeting has third party telephony audio enabled.
virtual SDKError	EnablePlayMeetingAudio (bool bEnable)=0
virtual bool	IsPlayMeetingAudioEnabled ()=0
	Determine if play meeting audio is enabled or not.

Detailed Description

Meeting audio controller interface.

Definition at line 103 of file meeting_audio_interface.h.

Member Function Documentation

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.

Remarks

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.

Remarks

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.

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

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.

Remarks

Valid for both ZOOM style and user custom interface mode.

EnablePlayMeetingAudio()

virtual SDKError IMeetingAudioController::EnablePlayMeetingAudio ( bool bEnable )

pure virtual

brief 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.

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

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.

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

pEvent

An 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.

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.

Remarks

Valid for both ZOOM style and user custom interface mode.