Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
<ZoomSDKTalkbackControllerDelegate> Protocol Reference

Callback events for the talkback controller. More...

#include <ZoomSDKTalkbackController.h>

Inherits <NSObjectNSObject>.

Instance Methods

(void) - onCreateChannelResponse:error:
 Callback event when the create channel response is received.
(void) - onDestroyChannelResponse:error:
 Callback event when the destroy channel response is received.
(void) - onChannelUserJoinResponse:userID:error:
 Callback event when the user joined channel response is received.
(void) - onChannelUserLeaveResponse:userID:error:
 Callback event when the user left channel response is received.
(void) - onJoinTalkbackChannel:
 Callback event when the current user has joined the talkback channel.
(void) - onLeaveTalkbackChannel:
 Callback event when the current user has left the talkback channel.
(void) - onInviterAudioLevel:audioLevel:
 Callback event for inviter audio level in talkback channel.

Detailed Description

Callback events for the talkback controller.

Definition at line 34 of file ZoomSDKTalkbackController.h.

Method Documentation

◆ onChannelUserJoinResponse:userID:error:

- (void) onChannelUserJoinResponse: (NSString *) channelID
userID: (unsigned int) userID
error: (ZoomSDKTalkbackError) error 
optionalrequired

Callback event when the user joined channel response is received.

Parameters
channelIDSpecify the channel ID.
userIDSpecify the user ID who joined the channel.
errorSpecify the error code.
Note
Determine whether the user is successfully invited. inviteUsersToChannel:userIDList: is asynchronous, so check this callback to verify the invitation result.

◆ onChannelUserLeaveResponse:userID:error:

- (void) onChannelUserLeaveResponse: (NSString *) channelID
userID: (unsigned int) userID
error: (ZoomSDKTalkbackError) error 
optionalrequired

Callback event when the user left channel response is received.

Parameters
channelIDSpecify the channel ID.
userIDSpecify the user ID who left the channel.
errorSpecify the error code.
Note
Determine whether the user is successfully removed. removeUsersFromChannel:userIDList: is asynchronous, so check this callback to verify the removal result.

◆ onCreateChannelResponse:error:

- (void) onCreateChannelResponse: (NSString *) channelID
error: (ZoomSDKTalkbackError) error 
optional

Callback event when the create channel response is received.

Parameters
channelIDSpecify the channel ID.
errorSpecify the error code.
Note
Determine whether the channel is successfully created. createChannel: is asynchronous, so check this callback to verify the creation result.

◆ onDestroyChannelResponse:error:

- (void) onDestroyChannelResponse: (NSString *) channelID
error: (ZoomSDKTalkbackError) error 
optionalrequired

Callback event when the destroy channel response is received.

Parameters
channelIDSpecify the channel ID.
errorSpecify the error code.
Note
Determine whether the channel is successfully destroyed. destroyChannels: is asynchronous, so check this callback to verify the destruction result.

◆ onInviterAudioLevel:audioLevel:

- (void) onInviterAudioLevel: (unsigned int) inviterID
audioLevel: (unsigned int) audioLevel 
optionalrequired

Callback event for inviter audio level in talkback channel.

Parameters
inviterIDSpecify the inviter user ID.
audioLevelInviter audio volume, range 0-15.

◆ onJoinTalkbackChannel:

- (void) onJoinTalkbackChannel: (unsigned int) inviterID
optionalrequired

Callback event when the current user has joined the talkback channel.

Parameters
inviterIDSpecify the user ID that was invited to join the channel.
Note
This event notifies you that you have already entered the talkback channel, and the inviter ID is inviterID.

◆ onLeaveTalkbackChannel:

- (void) onLeaveTalkbackChannel: (unsigned int) inviterID
optionalrequired

Callback event when the current user has left the talkback channel.

Parameters
inviterIDSpecify the user ID that left the channel.
Note
This event notifies you that you have left the talkback channel.