ZoomSDKTalkbackController Class Reference

Provides interfaces to manage talkback session in Zoom meeting. More...

#include <ZoomSDKTalkbackController.h>

Inherits NSObject.

Instance Methods
(BOOL)	- isMeetingSupportTalkBack
	Determines whether the meeting supports talkback.
(ZoomSDKError)	- createChannel:
	Creates talkback channels.
(ZoomSDKTalkbackChannel *_Nullable)	- getChannelByID:
	Gets a talkback channel by channel ID.
(NSArray< ZoomSDKTalkbackChannel * > *_Nullable)	- getChannelList
	Gets the list of all talkback channels.
(ZoomSDKError)	- destroyChannels:
	Destroys talkback channels in batches.
(ZoomSDKError)	- inviteUsersToChannel:userIDList:
	Invites users to a talkback channel in batches.
(ZoomSDKError)	- removeUsersFromChannel:userIDList:
	Removes users from a talkback channel in batches.
(ZoomSDKError)	- sendAudioDataToChannel:audioData:dataLength:sampleRate:channel:
	Sends audio data to a talkback channel.
(ZoomSDKError)	- setChannelBackgroundVolume:backgroundVolume:
	Sets the background volume, the main meeting audio that people in the talkback channel can hear.

Properties
id< ZoomSDKTalkbackControllerDelegate >	delegate
	Gets or sets the delegate that receives talkback-related callback events.

Detailed Description

Provides interfaces to manage talkback session in Zoom meeting.

Definition at line 99 of file ZoomSDKTalkbackController.h.

Method Documentation

createChannel:

- (ZoomSDKError) createChannel:

(unsigned int)

count

Creates talkback channels.

Parameters

count

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

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

Note

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

destroyChannels:

- (ZoomSDKError) destroyChannels:

(NSArray< NSString * > *)

channelIDs

Destroys talkback channels in batches.

Parameters

channelIDs

The array of channel IDs to destroy.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

Note

This operation is asynchronous. Check onDestroyChannelResponse:error: to verify the result.

getChannelByID:

- (ZoomSDKTalkbackChannel *_Nullable) getChannelByID:

(NSString *)

channelID

Gets a talkback channel by channel ID.

Parameters

channelID

Specify the channel ID to query.

Returns

If the function succeeds, it returns a ZoomSDKTalkbackChannel object. Otherwise, this function fails and returns nil.

getChannelList

- (NSArray< ZoomSDKTalkbackChannel * > *_Nullable) getChannelList

Gets the list of all talkback channels.

Returns

If the function succeeds, it returns an NSArray of talkback channel objects. Otherwise, this function fails and returns nil.

References getChannelList.

Referenced by getChannelList.

inviteUsersToChannel:userIDList:

- (ZoomSDKError) inviteUsersToChannel:		(NSString *)	channelID
userIDList:		(NSArray< NSNumber * > *)	userIDs

Invites users to a talkback channel in batches.

Parameters

channelID	The channel's ID to invite users to.
userIDList	The array of user IDs to invite.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

Note

This operation is asynchronous. Check onChannelUserJoinResponse:userID:error: to verify the result. A channel can have at most 10 users.

isMeetingSupportTalkBack

- (BOOL) isMeetingSupportTalkBack

Determines whether the meeting supports talkback.

Returns

YES if the meeting supports talkback. Otherwise, NO.

References isMeetingSupportTalkBack.

Referenced by isMeetingSupportTalkBack.

removeUsersFromChannel:userIDList:

- (ZoomSDKError) removeUsersFromChannel:		(NSString *)	channelID
userIDList:		(NSArray< NSNumber * > *)	userIDs

Removes users from a talkback channel in batches.

Parameters

channelID	The channel's ID to remove users from.
userIDList	The array of user IDs to remove.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

Note

This operation is asynchronous. Check onChannelUserLeaveResponse:userID:error: to verify the result.

sendAudioDataToChannel:audioData:dataLength:sampleRate:channel:

- (ZoomSDKError) sendAudioDataToChannel:		(NSString *)	channelID
audioData:		(char *)	audioData
dataLength:		(unsigned int)	dataLength
sampleRate:		(unsigned int)	sampleRate
channel:		(ZoomSDKAudioChannel)	channel

Sends audio data to a talkback channel.

Parameters

channelID	Specify the channel ID.
audioData	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, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

Note

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

setChannelBackgroundVolume:backgroundVolume:

- (ZoomSDKError) setChannelBackgroundVolume:		(NSString *)	channelID
backgroundVolume:		(float)	backgroundVolume

Sets the background volume, the main meeting audio that people in the talkback channel can hear.

Parameters

channelID	Specify the channel ID. If you want people in the channel to hear the channel audio more clearly, decrease the backgroundVolume.
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, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

Property Documentation

delegate

- (id<ZoomSDKTalkbackControllerDelegate>) delegate

readwritenonatomicassign

Gets or sets the delegate that receives talkback-related callback events.

Definition at line 104 of file ZoomSDKTalkbackController.h.