Talkback controller interface. More...

#include <meeting_talkback_ctrl_interface.h>

Public Member Functions
virtual	~IMeetingTalkbackController ()
virtual SDKError	SetEvent (IMeetingTalkbackCtrlEvent *pEvent)=0
	Configure the meeting talkback controller callback event handler.
virtual SDKError	CreateChannel (unsigned int count)=0
	Create talkback channels.
virtual IMeetingTalkbackChannel *	GetChannelByID (const zchar_t *channelID)=0
	Get a talkback channel by channel ID.
virtual IList< IMeetingTalkbackChannel * > *	GetChannelList ()=0
	Get the list of all talkback channels.
virtual SDKError	BeginBatchDestroyChannels ()=0
	Begin batch destroy channels operation.
virtual SDKError	AddChannelToDestroy (const zchar_t *pChanID)=0
	Add a channel to the batch destroy list.
virtual SDKError	RemoveChannelFromDestroy (const zchar_t *pChanID)=0
	Remove a channel from the batch destroy list.
virtual SDKError	ExecuteBatchDestroyChannels ()=0
	Execute batch destroy operation to destroy all channels in the list.
virtual SDKError	BeginBatchInviteUsers (const zchar_t *channelID)=0
	Begin batch invite users operation to a channel.
virtual SDKError	AddUserToInvite (unsigned int userID)=0
	Add a user to the batch invite list.
virtual SDKError	RemoveUserFromInvite (unsigned int userID)=0
	Remove a user from the batch invite list.
virtual SDKError	ExecuteBatchInviteUsers ()=0
	Execute batch invite operation to invite all users in the list to the channel.
virtual SDKError	BeginBatchRemoveUsers (const zchar_t *channelID)=0
	Begin batch remove users operation from a channel.
virtual SDKError	AddUserToRemove (unsigned int userID)=0
	Add a user to the batch remove list.
virtual SDKError	RemoveUserFromRemoveList (unsigned int userID)=0
	Remove a user from the batch remove list.
virtual SDKError	ExecuteBatchRemoveUsers ()=0
	Execute batch remove operation to remove all users in the list from the channel.
virtual SDKError	SendAudioDataToChannel (const zchar_t channelID, const char pAudioData, unsigned int dataLength, unsigned int sampleRate, ZoomSDKAudioChannel channel)=0
	Send audio data to a talkback channel.
virtual SDKError	SetChannelBackgroundVolume (const zchar_t *channelID, float backgroundVolume)=0
	Set the background volume - the main meeting audio volume - that people in the talkback channel can hear.
virtual bool	IsMeetingSupportTalkBack ()=0
	Check if the meeting supports talkback.

Detailed Description

Talkback controller interface.

Definition at line 125 of file meeting_talkback_ctrl_interface.h.

Constructor & Destructor Documentation

◆ ~IMeetingTalkbackController()

virtual IMeetingTalkbackController::~IMeetingTalkbackController ( )

inlinevirtual

Definition at line 128 of file meeting_talkback_ctrl_interface.h.

128{}

Member Function Documentation

◆ AddChannelToDestroy()

virtual SDKError IMeetingTalkbackController::AddChannelToDestroy ( const zchar_t * pChanID )

pure virtual

Add a channel to the batch destroy list.

Parameters

pChanID Specify the channel ID to add to the batch destroy list.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise the function fails.

Note: Call this function after BeginBatchDestroyChannels() and before ExecuteBatchDestroyChannels().

◆ AddUserToInvite()

virtual SDKError IMeetingTalkbackController::AddUserToInvite ( unsigned int userID )

pure virtual

Add a user to the batch invite list.

Parameters

userID Specify the user ID to add to the batch invite list.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise the function fails.

Note: Call this function after BeginBatchInviteUsers() and before ExecuteBatchInviteUsers().; A channel can have at most 10 users.

◆ AddUserToRemove()

virtual SDKError IMeetingTalkbackController::AddUserToRemove ( unsigned int userID )

pure virtual

Add a user to the batch remove list.

Parameters

userID Specify the user ID to add to the batch remove list.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise the function fails.

Note: Call this function after BeginBatchRemoveUsers() and before ExecuteBatchRemoveUsers().

◆ BeginBatchDestroyChannels()

virtual SDKError IMeetingTalkbackController::BeginBatchDestroyChannels ( )

pure virtual

Begin batch destroy channels operation.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise the function fails.

Note: Call this function before adding channels to the batch destroy list. After adding all channels, call ExecuteBatchDestroyChannels() to destroy them.

◆ BeginBatchInviteUsers()

virtual SDKError IMeetingTalkbackController::BeginBatchInviteUsers ( const zchar_t * channelID )

pure virtual

Begin batch invite users operation to a channel.

Parameters

channelID Specify the channel ID to invite users to.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise the function fails.

Note: Call this function before adding users to the batch invite list. After adding all users, call ExecuteBatchInviteUsers() to invite them.

◆ BeginBatchRemoveUsers()

virtual SDKError IMeetingTalkbackController::BeginBatchRemoveUsers ( const zchar_t * channelID )

pure virtual

Begin batch remove users operation from a channel.

Parameters

channelID Specify the channel ID to remove users from.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise the function fails.

Note: Call this function before adding users to the batch remove list. After adding all users, call ExecuteBatchRemoveUsers() to remove them.

◆ CreateChannel()

virtual SDKError IMeetingTalkbackController::CreateChannel ( unsigned int count )

pure virtual

Create talkback channels.

Parameters

count Specify the number of channels to create. Supports a maximum of 16 channels.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise the function fails.

Note: CreateChannel is asynchronous. To determine whether the channel is successfully created, check the onCreateChannelResponse event callback.

◆ ExecuteBatchDestroyChannels()

virtual SDKError IMeetingTalkbackController::ExecuteBatchDestroyChannels ( )

pure virtual

Execute batch destroy operation to destroy all channels in the list.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise the function fails.

Note: This function destroys all channels that were added to the batch destroy list using AddChannelToDestroy(). Call BeginBatchDestroyChannels() before adding channels.; Batch destroy channels is asynchronous. To determine whether the channels are successfully destroyed, check the onDestroyChannelResponse event callback.

◆ ExecuteBatchInviteUsers()

virtual SDKError IMeetingTalkbackController::ExecuteBatchInviteUsers ( )

pure virtual

Execute batch invite operation to invite all users in the list to the channel.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise the function fails.

Note: This function invites all users that were added to the batch invite list using AddUserToInvite(). Call BeginBatchInviteUsers() before adding users.; Batch invite users is asynchronous. To determine whether the users are successfully invited, check the onChannelUserJoinResponse event callback.

◆ ExecuteBatchRemoveUsers()

virtual SDKError IMeetingTalkbackController::ExecuteBatchRemoveUsers ( )

pure virtual

Execute batch remove operation to remove all users in the list from the channel.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise the function fails.

Note: This function removes all users that were added to the batch remove list using AddUserToRemove(). Call BeginBatchRemoveUsers() before adding users.; Batch remove users from channel is asynchronous. To determine whether the users are successfully removed, check the onChannelUserLeaveResponse event callback.

◆ GetChannelByID()

virtual IMeetingTalkbackChannel * IMeetingTalkbackController::GetChannelByID ( const zchar_t * channelID )

pure virtual

Get a talkback channel by channel ID.

Parameters

channelID Specify the channel ID to query.

Returns: If the function succeeds, the return value is a pointer to the IMeetingTalkbackChannel. Otherwise, the return value is nullptr.

◆ GetChannelList()

virtual IList< IMeetingTalkbackChannel * > * IMeetingTalkbackController::GetChannelList ( )

pure virtual

Get the list of all talkback channels.

Returns: If the function succeeds, the return value is a pointer to the IList<IMeetingTalkbackChannel*>. Otherwise, the return value is nullptr.

◆ IsMeetingSupportTalkBack()

virtual bool IMeetingTalkbackController::IsMeetingSupportTalkBack ( )

pure virtual

Check if the meeting supports talkback.

Returns: true if the meeting supports talkback, false otherwise.

◆ RemoveChannelFromDestroy()

virtual SDKError IMeetingTalkbackController::RemoveChannelFromDestroy ( const zchar_t * pChanID )

pure virtual

Remove a channel from the batch destroy list.

Parameters

pChanID Specify the channel ID to remove from the batch destroy list.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise the function fails.

Note: Call this function after BeginBatchDestroyChannels() and before ExecuteBatchDestroyChannels().

◆ RemoveUserFromInvite()

virtual SDKError IMeetingTalkbackController::RemoveUserFromInvite ( unsigned int userID )

pure virtual

Remove a user from the batch invite list.

Parameters

userID Specify the user ID to remove from the batch invite list.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise the function fails.

Note: This function should be called after BeginBatchInviteUsers() and before ExecuteBatchInviteUsers().

◆ RemoveUserFromRemoveList()

virtual SDKError IMeetingTalkbackController::RemoveUserFromRemoveList ( unsigned int userID )

pure virtual

Remove a user from the batch remove list.

Parameters

userID Specify the user ID to remove from the batch remove list.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise the function fails.

Note: Call this function after BeginBatchRemoveUsers() and before ExecuteBatchRemoveUsers().

◆ SendAudioDataToChannel()

virtual SDKError IMeetingTalkbackController::SendAudioDataToChannel	(	const zchar_t *	channelID,
		const char *	pAudioData,
		unsigned int	dataLength,
		unsigned int	sampleRate,
		ZoomSDKAudioChannel	channel )

pure virtual

Send audio data to a talkback channel.

Parameters

channelID	Specify the channel ID.
pAudioData	Specify the audio data buffer.
dataLength	Specify the length of audio data in bytes. dataLength must be a multiple of 2.
sampleRate	Specify the sample rate of the audio data like 32000 or 48000.
channel	Specify the audio channel type either mono or stereo.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise the function fails.

Note: The audio data format should be PCM, 16-bit, mono or stereo. Sample rate 32kHz or 48kHz is recommended.

◆ SetChannelBackgroundVolume()

virtual SDKError IMeetingTalkbackController::SetChannelBackgroundVolume	(	const zchar_t *	channelID,
		float	backgroundVolume )

pure virtual

Set the background volume - the main meeting audio volume - that people in the talkback channel can hear.

Parameters

channelID	Specify the channel ID.
backgroundVolume	Specify the background volume from 0.0 to 2.0. If you want people in the channel to hear the channel audio more clearly, decrease the backgroundVolume.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise the function fails.

◆ SetEvent()

virtual SDKError IMeetingTalkbackController::SetEvent ( IMeetingTalkbackCtrlEvent * pEvent )

pure virtual

Configure the meeting talkback controller callback event handler.

Parameters

pEvent An object pointer to the IMeetingTalkbackCtrlEvent that receives the meeting talkback callback event.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise the function fails.

Note: The SDK use 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.

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~IMeetingTalkbackController()

Member Function Documentation

◆ AddChannelToDestroy()

◆ AddUserToInvite()

◆ AddUserToRemove()

◆ BeginBatchDestroyChannels()

◆ BeginBatchInviteUsers()

◆ BeginBatchRemoveUsers()

◆ CreateChannel()

◆ ExecuteBatchDestroyChannels()

◆ ExecuteBatchInviteUsers()

◆ ExecuteBatchRemoveUsers()

◆ GetChannelByID()

◆ GetChannelList()

◆ IsMeetingSupportTalkBack()

◆ RemoveChannelFromDestroy()

◆ RemoveUserFromInvite()

◆ RemoveUserFromRemoveList()

◆ SendAudioDataToChannel()

◆ SetChannelBackgroundVolume()

◆ SetEvent()