Meeting Audio helper interface. More...

#include <IMeetingAudioHelper.h>

Public Member Functions
virtual	~IMeetingAudioHelper ()

virtual ZRCSDKError	RegisterSink (IMeetingAudioHelperSink *pSink)=0
	Register meeting audio helper callback sink.

virtual ZRCSDKError	DeregisterSink (IMeetingAudioHelperSink *pSink)=0
	Deregister meeting audio helper callback sink.

virtual ZRCSDKError	UpdateMyAudioStatus (bool mute)=0
	Mute or unmute self audio.

virtual ZRCSDKError	MuteUserAudio (int32_t userID, bool mute)=0
	Mute or unmute the assigned user audio.

virtual ZRCSDKError	MuteAllAudios (bool mute)=0
	Mute or unmute all meeting users' audio.

virtual ZRCSDKError	MuteOnEntry (bool mute)=0
	Mute or unmute the user after joining the meeting.

virtual ZRCSDKError	AnswerUnmuteAudioByHostRequest (bool accepted)=0
	Answer incoming unmute audio request.

virtual ZRCSDKError	AllowAttendeesUnmuteThemselves (bool allow)=0
	Allow attendee unmute themselves.

virtual ZRCSDKError	EnablePlayJoinOrLeaveChime (bool enable)=0
	Enable play chime when join or leave meeting.

virtual ZRCSDKError	IsMeetingAudioTroubleShootingAvailable (bool &isAvailable)=0
	Query if meeting audio troubleshooting available.

virtual ZRCSDKError	EnableMeetingAudioTroubleShooting (bool enable)=0
	Enable meeting audio troubleshooting.

virtual ZRCSDKError	RequestFarEndAudioControl (int32_t farEndUserID)=0
	Request far end audio control.

virtual ZRCSDKError	GiveUpFarEndAudioControl (int32_t farEndUserID)=0
	Give up far end audio control.

virtual ZRCSDKError	BeginControlFarEndAudio (int32_t farEndUserID)=0
	Begin control far end audio. Only when you begin control the controlled user's audio can you receive relevant control information. Otherwise not.

virtual ZRCSDKError	EndControlFarEndAudio (int32_t farEndUserID)=0
	End control far end audio. You will not receive relevant control information after end control the controlled user's audio.

virtual ZRCSDKError	SelectFarEndAudioMicrophone (int32_t farEndUserID, const std::string &deviceID)=0
	Select the controlled user's microphone.

virtual ZRCSDKError	SelectFarEndAudioSpeaker (int32_t farEndUserID, const std::string &deviceID)=0
	Select the controlled user's speaker.

virtual ZRCSDKError	AdjustFarEndAudioSelectedMicrophoneVolume (int32_t farEndUserID, int32_t volume)=0
	Adjust the controlled user's microphone volume.

virtual ZRCSDKError	AdjustFarEndAudioSelectedSpeakerVolume (int32_t farEndUserID, int32_t volume)=0
	Adjust the controlled user's speaker volume.

virtual ZRCSDKError	MuteFarEndAudioMicrophone (int32_t farEndUserID, bool mute)=0
	Mute the controlled user's microphone.

virtual ZRCSDKError	ApproveFarEndAudioControlRequest (int32_t requesterUserID)=0
	Approve far end audio control request.

virtual ZRCSDKError	DeclineFarEndAudioControlRequest (int32_t requesterUserID)=0
	Decline far end audio control request.

virtual ZRCSDKError	GetFarEndAudioControllingUserDeviceInfo (FarEndAudioControllingUserDeviceInfo &deviceInfo, int32_t userID)=0
	Get the controlling user's device info by user ID.

virtual ZRCSDKError	GetAllFarEndAudioControllingUserDeviceInfo (std::vector< FarEndAudioControllingUserDeviceInfo > &deviceInfoList)=0
	Get all controlling user's device infos.

Detailed Description

Meeting Audio helper interface.

Definition at line 256 of file IMeetingAudioHelper.h.

Constructor & Destructor Documentation

◆ ~IMeetingAudioHelper()

virtual IMeetingAudioHelper::~IMeetingAudioHelper ( )

inlinevirtual

Definition at line 259 of file IMeetingAudioHelper.h.

259{}

Member Function Documentation

◆ AdjustFarEndAudioSelectedMicrophoneVolume()

virtual ZRCSDKError IMeetingAudioHelper::AdjustFarEndAudioSelectedMicrophoneVolume	(	int32_t	farEndUserID,
		int32_t	volume
	)

pure virtual

Adjust the controlled user's microphone volume.

Since: 6.5.0

Zoom Rooms minimum version: 6.5.0

Parameters

farEndUserID	The user ID whose audio you controlled.
volume	The microphone volume. The range is [0, 255].

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ AdjustFarEndAudioSelectedSpeakerVolume()

virtual ZRCSDKError IMeetingAudioHelper::AdjustFarEndAudioSelectedSpeakerVolume	(	int32_t	farEndUserID,
		int32_t	volume
	)

pure virtual

Adjust the controlled user's speaker volume.

Since: 6.5.0

Zoom Rooms minimum version: 6.5.0

Parameters

farEndUserID	The user ID whose audio you controlled.
volume	The speaker volume. The range is [0, 255].

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ AllowAttendeesUnmuteThemselves()

virtual ZRCSDKError IMeetingAudioHelper::AllowAttendeesUnmuteThemselves ( bool allow )

pure virtual

Allow attendee unmute themselves.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

allow TRUE indicates allow user to unmute themselves. Otherwise not.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ AnswerUnmuteAudioByHostRequest()

virtual ZRCSDKError IMeetingAudioHelper::AnswerUnmuteAudioByHostRequest ( bool accepted )

pure virtual

Answer incoming unmute audio request.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

accepted TURE indicates accept unmute request. Otherwise not.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ ApproveFarEndAudioControlRequest()

virtual ZRCSDKError IMeetingAudioHelper::ApproveFarEndAudioControlRequest ( int32_t requesterUserID )

pure virtual

Approve far end audio control request.

Since: 6.5.0

Zoom Rooms minimum version: 6.5.0

Parameters

requesterUserID The requester user ID.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ BeginControlFarEndAudio()

virtual ZRCSDKError IMeetingAudioHelper::BeginControlFarEndAudio ( int32_t farEndUserID )

pure virtual

Begin control far end audio. Only when you begin control the controlled user's audio can you receive relevant control information. Otherwise not.

Since: 6.5.0

Zoom Rooms minimum version: 6.5.0

Parameters

farEndUserID The user ID whose audio control you want to begin control.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ DeclineFarEndAudioControlRequest()

virtual ZRCSDKError IMeetingAudioHelper::DeclineFarEndAudioControlRequest ( int32_t requesterUserID )

pure virtual

Decline far end audio control request.

Since: 6.5.0

Zoom Rooms minimum version: 6.5.0

Parameters

requesterUserID The requester user ID.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ DeregisterSink()

virtual ZRCSDKError IMeetingAudioHelper::DeregisterSink ( IMeetingAudioHelperSink * pSink )

pure virtual

Deregister meeting audio helper callback sink.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

pSink A pointer to the IMeetingAudioHelperSink that receives the meeting audio helper event callback.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ EnableMeetingAudioTroubleShooting()

virtual ZRCSDKError IMeetingAudioHelper::EnableMeetingAudioTroubleShooting ( bool enable )

pure virtual

Enable meeting audio troubleshooting.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

enable TRUE indicates to enable meeting audio troubleshooting. Otherwise not.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ EnablePlayJoinOrLeaveChime()

virtual ZRCSDKError IMeetingAudioHelper::EnablePlayJoinOrLeaveChime ( bool enable )

pure virtual

Enable play chime when join or leave meeting.

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.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ EndControlFarEndAudio()

virtual ZRCSDKError IMeetingAudioHelper::EndControlFarEndAudio ( int32_t farEndUserID )

pure virtual

End control far end audio. You will not receive relevant control information after end control the controlled user's audio.

Since: 6.5.0

Zoom Rooms minimum version: 6.5.0

Parameters

farEndUserID The user ID whose audio control you want to end control.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ GetAllFarEndAudioControllingUserDeviceInfo()

virtual ZRCSDKError IMeetingAudioHelper::GetAllFarEndAudioControllingUserDeviceInfo ( std::vector< FarEndAudioControllingUserDeviceInfo > & deviceInfoList )

pure virtual

Get all controlling user's device infos.

Since: 6.5.0

Zoom Rooms minimum version: 6.5.0

Parameters

[out] deviceInfoList The all controlling device infos.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ GetFarEndAudioControllingUserDeviceInfo()

virtual ZRCSDKError IMeetingAudioHelper::GetFarEndAudioControllingUserDeviceInfo	(	FarEndAudioControllingUserDeviceInfo &	deviceInfo,
		int32_t	userID
	)

pure virtual

Get the controlling user's device info by user ID.

Since: 6.5.0

Zoom Rooms minimum version: 6.5.0

Parameters

[out]	deviceInfo	The controlling device info.
	userID	The controlled user ID.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ GiveUpFarEndAudioControl()

virtual ZRCSDKError IMeetingAudioHelper::GiveUpFarEndAudioControl ( int32_t farEndUserID )

pure virtual

Give up far end audio control.

Since: 6.5.0

Zoom Rooms minimum version: 6.5.0

Parameters

farEndUserID The user ID whose audio control you want to give up.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ IsMeetingAudioTroubleShootingAvailable()

virtual ZRCSDKError IMeetingAudioHelper::IsMeetingAudioTroubleShootingAvailable ( bool & isAvailable )

pure virtual

Query if meeting audio troubleshooting available.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

[out] isAvailable TRUE indicates meeting audio troubleshooting is available. Otherwise not.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ MuteAllAudios()

virtual ZRCSDKError IMeetingAudioHelper::MuteAllAudios ( bool mute )

pure virtual

Mute or unmute all meeting users' audio.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

mute	TRUE indicates mute all users' audio. Otherwise not.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ MuteFarEndAudioMicrophone()

virtual ZRCSDKError IMeetingAudioHelper::MuteFarEndAudioMicrophone	(	int32_t	farEndUserID,
		bool	mute
	)

pure virtual

Mute the controlled user's microphone.

Since: 6.5.0

Zoom Rooms minimum version: 6.5.0

Parameters

farEndUserID	The user ID whose audio you controlled.
mute	True indicates mute the controlled user's audio. Otherwise not.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ MuteOnEntry()

virtual ZRCSDKError IMeetingAudioHelper::MuteOnEntry ( bool mute )

pure virtual

Mute or unmute the user after joining the meeting.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

mute	TRUE indicates user will be muted on entry.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ MuteUserAudio()

virtual ZRCSDKError IMeetingAudioHelper::MuteUserAudio	(	int32_t	userID,
		bool	mute
	)

pure virtual

Mute or unmute the assigned user audio.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

userID	Specify the user ID to unmute.
mute	TRUE indicates to mute user audio. Otherwise not.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ RegisterSink()

virtual ZRCSDKError IMeetingAudioHelper::RegisterSink ( IMeetingAudioHelperSink * pSink )

pure virtual

Register meeting audio helper callback sink.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

pSink A pointer to the IMeetingAudioHelperSink that receives the meeting audio helper event callback.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ RequestFarEndAudioControl()

virtual ZRCSDKError IMeetingAudioHelper::RequestFarEndAudioControl ( int32_t farEndUserID )

pure virtual

Request far end audio control.

Since: 6.5.0

Zoom Rooms minimum version: 6.5.0

Parameters

farEndUserID The user ID whose audio control you want to control.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ SelectFarEndAudioMicrophone()

virtual ZRCSDKError IMeetingAudioHelper::SelectFarEndAudioMicrophone	(	int32_t	farEndUserID,
		const std::string &	deviceID
	)

pure virtual

Select the controlled user's microphone.

Since: 6.5.0

Zoom Rooms minimum version: 6.5.0

Parameters

farEndUserID	The user ID whose audio you controlled.
deviceID	The microphone ID.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ SelectFarEndAudioSpeaker()

virtual ZRCSDKError IMeetingAudioHelper::SelectFarEndAudioSpeaker	(	int32_t	farEndUserID,
		const std::string &	deviceID
	)

pure virtual

Select the controlled user's speaker.

Since: 6.5.0

Zoom Rooms minimum version: 6.5.0

Parameters

farEndUserID	The user ID whose audio you controlled.
deviceID	The speaker ID.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ UpdateMyAudioStatus()

virtual ZRCSDKError IMeetingAudioHelper::UpdateMyAudioStatus ( bool mute )

pure virtual

Mute or unmute self audio.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

mute	TRUE indicates mute self audio. Otherwise not.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~IMeetingAudioHelper()

Member Function Documentation

◆ AdjustFarEndAudioSelectedMicrophoneVolume()

◆ AdjustFarEndAudioSelectedSpeakerVolume()

◆ AllowAttendeesUnmuteThemselves()

◆ AnswerUnmuteAudioByHostRequest()

◆ ApproveFarEndAudioControlRequest()

◆ BeginControlFarEndAudio()

◆ DeclineFarEndAudioControlRequest()

◆ DeregisterSink()

◆ EnableMeetingAudioTroubleShooting()

◆ EnablePlayJoinOrLeaveChime()

◆ EndControlFarEndAudio()

◆ GetAllFarEndAudioControllingUserDeviceInfo()

◆ GetFarEndAudioControllingUserDeviceInfo()

◆ GiveUpFarEndAudioControl()

◆ IsMeetingAudioTroubleShootingAvailable()

◆ MuteAllAudios()

◆ MuteFarEndAudioMicrophone()

◆ MuteOnEntry()

◆ MuteUserAudio()

◆ RegisterSink()

◆ RequestFarEndAudioControl()

◆ SelectFarEndAudioMicrophone()

◆ SelectFarEndAudioSpeaker()

◆ UpdateMyAudioStatus()