Meeting SDK for Windows API Reference
Loading...
Searching...
No Matches
meeting_talkback_ctrl_interface.h
Go to the documentation of this file.
1
5#ifndef _MEETING_TALKBACK_CTRL_INTERFACE_H_
6#define _MEETING_TALKBACK_CTRL_INTERFACE_H_
7#include "zoom_sdk_def.h"
8
10
16{
17public:
19
24 virtual const zchar_t* GetChannelID() = 0;
25
31};
32
38{
39public:
41
64
71 virtual void onCreateChannelResponse(const zchar_t* channelID, TalkbackError error) = 0;
72
79 virtual void onDestroyChannelResponse(const zchar_t* channelID, TalkbackError error) = 0;
80
88 virtual void onChannelUserJoinResponse(const zchar_t* channelID, unsigned int userID, TalkbackError error) = 0;
89
97 virtual void onChannelUserLeaveResponse(const zchar_t* channelID, unsigned int userID, TalkbackError error) = 0;
98
104 virtual void onJoinTalkbackChannel(unsigned int inviterID) = 0;
105
111 virtual void onLeaveTalkbackChannel(unsigned int inviterID) = 0;
112
118 virtual void onInviterAudioLevel(unsigned int inviterID, unsigned int audioLevel) = 0;
119};
120
126{
127public:
129
137
144 virtual SDKError CreateChannel(unsigned int count) = 0;
145
151 virtual IMeetingTalkbackChannel* GetChannelByID(const zchar_t* channelID) = 0;
152
158
160
166
173 virtual SDKError AddChannelToDestroy(const zchar_t* pChanID) = 0;
174
181 virtual SDKError RemoveChannelFromDestroy(const zchar_t* pChanID) = 0;
182
190
192
198 virtual SDKError BeginBatchInviteUsers(const zchar_t* channelID) = 0;
199
207 virtual SDKError AddUserToInvite(unsigned int userID) = 0;
208
215 virtual SDKError RemoveUserFromInvite(unsigned int userID) = 0;
216
224
226
232 virtual SDKError BeginBatchRemoveUsers(const zchar_t* channelID) = 0;
233
240 virtual SDKError AddUserToRemove(unsigned int userID) = 0;
241
248 virtual SDKError RemoveUserFromRemoveList(unsigned int userID) = 0;
249
257
268 virtual SDKError SendAudioDataToChannel(const zchar_t* channelID, const char* pAudioData, unsigned int dataLength, unsigned int sampleRate, ZoomSDKAudioChannel channel) = 0;
269
276 virtual SDKError SetChannelBackgroundVolume(const zchar_t* channelID, float backgroundVolume) = 0;
277
282 virtual bool IsMeetingSupportTalkBack() = 0;
283};
284
286#endif
287
Talkback channel information interface.
virtual IList< unsigned int > * GetUserIDList()=0
Get the list of user IDs in the channel.
virtual const zchar_t * GetChannelID()=0
Get the channel ID.
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 SetEvent(IMeetingTalkbackCtrlEvent *pEvent)=0
Configure the meeting talkback controller callback event handler.
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 h...
virtual SDKError AddUserToRemove(unsigned int userID)=0
Add a user to the batch remove list.
virtual IMeetingTalkbackChannel * GetChannelByID(const zchar_t *channelID)=0
Get a talkback channel by channel ID.
virtual SDKError BeginBatchDestroyChannels()=0
Begin batch destroy channels operation.
virtual SDKError CreateChannel(unsigned int count)=0
Create talkback channels.
virtual SDKError RemoveChannelFromDestroy(const zchar_t *pChanID)=0
Remove a channel from the batch destroy list.
virtual SDKError ExecuteBatchInviteUsers()=0
Execute batch invite operation to invite all users in the list to the channel.
virtual SDKError ExecuteBatchDestroyChannels()=0
Execute batch destroy operation to destroy all channels in the list.
virtual SDKError ExecuteBatchRemoveUsers()=0
Execute batch remove operation to remove all users in the list from the channel.
virtual SDKError BeginBatchRemoveUsers(const zchar_t *channelID)=0
Begin batch remove users operation from a channel.
virtual IList< IMeetingTalkbackChannel * > * GetChannelList()=0
Get the list of all talkback channels.
virtual SDKError AddChannelToDestroy(const zchar_t *pChanID)=0
Add a channel to the batch destroy list.
virtual SDKError BeginBatchInviteUsers(const zchar_t *channelID)=0
Begin batch invite users operation to a channel.
virtual SDKError RemoveUserFromInvite(unsigned int userID)=0
Remove a user from the batch invite list.
virtual bool IsMeetingSupportTalkBack()=0
Check if the meeting supports talkback.
virtual SDKError AddUserToInvite(unsigned int userID)=0
Add a user to the batch invite list.
virtual SDKError RemoveUserFromRemoveList(unsigned int userID)=0
Remove a user from the batch remove list.
Talkback controller callback event.
virtual void onChannelUserLeaveResponse(const zchar_t *channelID, unsigned int userID, TalkbackError error)=0
Callback event for user left channel response.
virtual void onCreateChannelResponse(const zchar_t *channelID, TalkbackError error)=0
Callback event for create channel response.
virtual void onInviterAudioLevel(unsigned int inviterID, unsigned int audioLevel)=0
Callback event for inviter audio level in talkback channel.
virtual void onLeaveTalkbackChannel(unsigned int inviterID)=0
Callback event for already left talkback channel.
virtual void onChannelUserJoinResponse(const zchar_t *channelID, unsigned int userID, TalkbackError error)=0
Callback event for user joined channel response.
virtual void onDestroyChannelResponse(const zchar_t *channelID, TalkbackError error)=0
Callback event for destroy channel response.
virtual void onJoinTalkbackChannel(unsigned int inviterID)=0
Callback event for already joined talkback channel.
ZOOM windows SDK Common Definition File.
#define END_ZOOM_SDK_NAMESPACE
ZoomSDKAudioChannel
Enumeration of the audio modes.
#define BEGIN_ZOOM_SDK_NAMESPACE
char zchar_t
SDKError
Enumeration of common errors of SDK.