Meeting Audio helper event callback. More...

#include <IMeetingAudioHelper.h>

Public Member Functions
virtual	~IMeetingAudioHelperSink ()

virtual void	OnUpdateMyAudioStatus (const AudioStatus &audioStatus)=0
	Zoom Room's audio status changed callback.

virtual void	OnMuteUserAudioNotification (int32_t userID, const AudioStatus &audioStatus)=0
	After mute user audio, user audio status changed callback.

virtual void	OnMuteOnEntryNotification (bool isMuteOnEntry)=0
	Mute on entry status notification.

virtual void	OnAskUnmuteAudioByHostNotification (bool show, AskUnmuteAudioByHostType type)=0
	Notification from host ask to unmute audio.

virtual void	OnAllowAttendeesUnmuteThemselvesNotification (bool canAttendeesUnmuteThemselves)=0
	Allow attendees unmute themselves notification.

virtual void	OnEnablePlayJoinOrLeaveChimeNotification (bool enable)=0
	Enable play join or leave chime status notification.

virtual void	OnUpdateAudioTroubleShootingStatus (const AudioTroubleShootingStatus &status)=0
	Audio troubleshooting status update notification.

virtual void	OnFEACApproveNotification (int32_t farEndUserID, const std::string &farEndUserName)=0
	FEAC approve your request notification.

virtual void	OnFEACDeclineNotification (int32_t farEndUserID, const std::string &farEndUserName)=0
	FEAC decline your request notification.

virtual void	OnFEACTakeOverNotification (int32_t farEndUserID, const std::string &farEndUserName, int32_t controllingUserID, const std::string &controllingUserName)=0
	FEAC take over notification.

virtual void	OnFEACMicListChangedNotification (int32_t farEndUserID, const std::vector< FarEndAudioDeviceInfo > &micList)=0
	FEAC microphone list changed notification.

virtual void	OnFEACSpeakerListChangedNotification (int32_t farEndUserID, const std::vector< FarEndAudioDeviceInfo > &speakerList)=0
	FEAC speaker list changed notification.

virtual void	OnFEACMuteStateChangedNotification (int32_t farEndUserID, bool muteState)=0
	FEAC mute state changed notification.

virtual void	OnFEACUnmuteDisabledByHostNotification (int32_t farEndUserID)=0
	FEAC unmute disabled by host notification. You will receive this notification when you unmute the controlled user and the unmute is disabled by host.

virtual void	OnFEACRequestNotification (int32_t requesterUserID, const std::string &requesterUserName)=0
	FEAC request your audio control notification.

virtual void	OnFEACGiveUpNotification (int32_t requesterUserID, const std::string &requesterUserName)=0
	FEAC give up your audio control notification.

virtual void	OnFEACApproveControlRequestNotification (int32_t requesterUserID)=0
	FEAC approve audio control request notification. You will receive this notification when other ZRC approve the requester audio control.

virtual void	OnFEACDeclineControlRequestNotification (int32_t requesterUserID)=0
	FEAC decline audio control request notification. You will receive this notification when other ZRC decline the requester audio control.

Detailed Description

Meeting Audio helper event callback.

Definition at line 59 of file IMeetingAudioHelper.h.

Constructor & Destructor Documentation

◆ ~IMeetingAudioHelperSink()

virtual IMeetingAudioHelperSink::~IMeetingAudioHelperSink ( )

inlinevirtual

Definition at line 62 of file IMeetingAudioHelper.h.

62{}

Member Function Documentation

◆ OnAllowAttendeesUnmuteThemselvesNotification()

virtual void IMeetingAudioHelperSink::OnAllowAttendeesUnmuteThemselvesNotification ( bool canAttendeesUnmuteThemselves )

pure virtual

Allow attendees unmute themselves notification.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

canAttendeesUnmuteThemselves TRUE indicates the user can unmute himself. Otherwise not.

◆ OnAskUnmuteAudioByHostNotification()

virtual void IMeetingAudioHelperSink::OnAskUnmuteAudioByHostNotification	(	bool	show,
		AskUnmuteAudioByHostType	type
	)

pure virtual

Notification from host ask to unmute audio.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

show	TURE indicates to show the request. Otherwise not.
type	Ask to unmute audio by host type, see AskUnmuteAudioByHostType enum.

◆ OnEnablePlayJoinOrLeaveChimeNotification()

virtual void IMeetingAudioHelperSink::OnEnablePlayJoinOrLeaveChimeNotification ( bool enable )

pure virtual

Enable play join or leave chime status notification.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

enable TRUE indicates to play chime when the user joins or leaves the meeting.

◆ OnFEACApproveControlRequestNotification()

virtual void IMeetingAudioHelperSink::OnFEACApproveControlRequestNotification ( int32_t requesterUserID )

pure virtual

FEAC approve audio control request notification. You will receive this notification when other ZRC approve the requester audio control.

Since: 6.5.0

Zoom Rooms minimum version: 6.5.0

Parameters

requesterUserID The requester user ID.

◆ OnFEACApproveNotification()

virtual void IMeetingAudioHelperSink::OnFEACApproveNotification	(	int32_t	farEndUserID,
		const std::string &	farEndUserName
	)

pure virtual

FEAC approve your request notification.

Since: 6.5.0

Zoom Rooms minimum version: 6.5.0

Parameters

farEndUserID	The controlled user ID.
farEndUserName	The controlled user name.

◆ OnFEACDeclineControlRequestNotification()

virtual void IMeetingAudioHelperSink::OnFEACDeclineControlRequestNotification ( int32_t requesterUserID )

pure virtual

FEAC decline audio control request notification. You will receive this notification when other ZRC decline the requester audio control.

Since: 6.5.0

Zoom Rooms minimum version: 6.5.0

Parameters

requesterUserID The requester user ID.

◆ OnFEACDeclineNotification()

virtual void IMeetingAudioHelperSink::OnFEACDeclineNotification	(	int32_t	farEndUserID,
		const std::string &	farEndUserName
	)

pure virtual

FEAC decline your request notification.

Since: 6.5.0

Zoom Rooms minimum version: 6.5.0

Parameters

farEndUserID	The controlled user ID.
farEndUserName	The controlled user name.

◆ OnFEACGiveUpNotification()

virtual void IMeetingAudioHelperSink::OnFEACGiveUpNotification	(	int32_t	requesterUserID,
		const std::string &	requesterUserName
	)

pure virtual

FEAC give up your audio control notification.

Since: 6.5.0

Zoom Rooms minimum version: 6.5.0

Parameters

requesterUserID	The requester user ID.
requesterUserName	The requester user name.

◆ OnFEACMicListChangedNotification()

virtual void IMeetingAudioHelperSink::OnFEACMicListChangedNotification	(	int32_t	farEndUserID,
		const std::vector< FarEndAudioDeviceInfo > &	micList
	)

pure virtual

FEAC microphone list changed notification.

Since: 6.5.0

Zoom Rooms minimum version: 6.5.0

Parameters

farEndUserID	The controlled user ID.
micList	All controlled user's microphones.

◆ OnFEACMuteStateChangedNotification()

virtual void IMeetingAudioHelperSink::OnFEACMuteStateChangedNotification	(	int32_t	farEndUserID,
		bool	muteState
	)

pure virtual

FEAC mute state changed notification.

Since: 6.5.0

Zoom Rooms minimum version: 6.5.0

Parameters

farEndUserID	The controlled user ID.
muteState	The controlled user's mute state.

◆ OnFEACRequestNotification()

virtual void IMeetingAudioHelperSink::OnFEACRequestNotification	(	int32_t	requesterUserID,
		const std::string &	requesterUserName
	)

pure virtual

FEAC request your audio control notification.

Since: 6.5.0

Zoom Rooms minimum version: 6.5.0

Parameters

requesterUserID	The requester user ID.
requesterUserName	The requester user name.

◆ OnFEACSpeakerListChangedNotification()

virtual void IMeetingAudioHelperSink::OnFEACSpeakerListChangedNotification	(	int32_t	farEndUserID,
		const std::vector< FarEndAudioDeviceInfo > &	speakerList
	)

pure virtual

FEAC speaker list changed notification.

Since: 6.5.0

Zoom Rooms minimum version: 6.5.0

Parameters

farEndUserID	The controlled user ID.
speakerList	All controlled user's speakers.

◆ OnFEACTakeOverNotification()

virtual void IMeetingAudioHelperSink::OnFEACTakeOverNotification	(	int32_t	farEndUserID,
		const std::string &	farEndUserName,
		int32_t	controllingUserID,
		const std::string &	controllingUserName
	)

pure virtual

FEAC take over notification.

Since: 6.5.0

Zoom Rooms minimum version: 6.5.0

Parameters

farEndUserID	The user ID who is taken over.
farEndUserName	The user name who is taken over.
controllingUserID	The user ID who took over.
controllingUserName	The user name who took over.

◆ OnFEACUnmuteDisabledByHostNotification()

virtual void IMeetingAudioHelperSink::OnFEACUnmuteDisabledByHostNotification ( int32_t farEndUserID )

pure virtual

FEAC unmute disabled by host notification. You will receive this notification when you unmute the controlled user and the unmute is disabled by host.

Since: 6.5.0

Zoom Rooms minimum version: 6.5.0

Parameters

farEndUserID The controlled user ID.

◆ OnMuteOnEntryNotification()

virtual void IMeetingAudioHelperSink::OnMuteOnEntryNotification ( bool isMuteOnEntry )

pure virtual

Mute on entry status notification.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

isMuteOnEntry TRUE indicates to mute the user after joining the meeting.

◆ OnMuteUserAudioNotification()

virtual void IMeetingAudioHelperSink::OnMuteUserAudioNotification	(	int32_t	userID,
		const AudioStatus &	audioStatus
	)

pure virtual

After mute user audio, user audio status changed callback.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

userID	The assigned user ID
audioStatus	The user's audio status

◆ OnUpdateAudioTroubleShootingStatus()

virtual void IMeetingAudioHelperSink::OnUpdateAudioTroubleShootingStatus ( const AudioTroubleShootingStatus & status )

pure virtual

Audio troubleshooting status update notification.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

status The audio troubleshooting status. If never receiving this notification, it indicates the feature not available currently.

◆ OnUpdateMyAudioStatus()

virtual void IMeetingAudioHelperSink::OnUpdateMyAudioStatus ( const AudioStatus & audioStatus )

pure virtual

Zoom Room's audio status changed callback.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

audioStatus Updated audio status.

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~IMeetingAudioHelperSink()

Member Function Documentation

◆ OnAllowAttendeesUnmuteThemselvesNotification()

◆ OnAskUnmuteAudioByHostNotification()

◆ OnEnablePlayJoinOrLeaveChimeNotification()

◆ OnFEACApproveControlRequestNotification()

◆ OnFEACApproveNotification()

◆ OnFEACDeclineControlRequestNotification()

◆ OnFEACDeclineNotification()

◆ OnFEACGiveUpNotification()

◆ OnFEACMicListChangedNotification()

◆ OnFEACMuteStateChangedNotification()

◆ OnFEACRequestNotification()

◆ OnFEACSpeakerListChangedNotification()

◆ OnFEACTakeOverNotification()

◆ OnFEACUnmuteDisabledByHostNotification()

◆ OnMuteOnEntryNotification()

◆ OnMuteUserAudioNotification()

◆ OnUpdateAudioTroubleShootingStatus()

◆ OnUpdateMyAudioStatus()