Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
ZoomSDKTalkbackController.h
Go to the documentation of this file.
1
5
6#import <Foundation/Foundation.h>
7#import <ZoomSDK/ZoomSDKErrors.h>
8
9NS_ASSUME_NONNULL_BEGIN
10
15@interface ZoomSDKTalkbackChannel : NSObject
16
20@property(nonatomic, copy, readonly) NSString *channelID;
21
25@property(nonatomic, retain, readonly, nullable) NSArray<NSNumber*> *userIDList;
26
27
28@end
29
34@protocol ZoomSDKTalkbackControllerDelegate <NSObject>
35
36@optional
37
44- (void)onCreateChannelResponse:(NSString *)channelID error:(ZoomSDKTalkbackError)error;
45
52- (void)onDestroyChannelResponse:(NSString *)channelID error:(ZoomSDKTalkbackError)error;
53
61- (void)onChannelUserJoinResponse:(NSString *)channelID userID:(unsigned int)userID error:(ZoomSDKTalkbackError)error;
62
70- (void)onChannelUserLeaveResponse:(NSString *)channelID userID:(unsigned int)userID error:(ZoomSDKTalkbackError)error;
71
77- (void)onJoinTalkbackChannel:(unsigned int)inviterID;
78
84- (void)onLeaveTalkbackChannel:(unsigned int)inviterID;
85
91- (void)onInviterAudioLevel:(unsigned int)inviterID audioLevel:(unsigned int)audioLevel;
92
93@end
94
99@interface ZoomSDKTalkbackController : NSObject
100
104@property(nonatomic,assign,nullable)id<ZoomSDKTalkbackControllerDelegate> delegate;
105
111
118- (ZoomSDKError)createChannel:(unsigned int)count;
119
125- (ZoomSDKTalkbackChannel* _Nullable)getChannelByID:(NSString *)channelID;
126
131- (NSArray<ZoomSDKTalkbackChannel*> * _Nullable)getChannelList;
132
139- (ZoomSDKError)destroyChannels:(NSArray<NSString*> *)channelIDs;
140
148- (ZoomSDKError)inviteUsersToChannel:(NSString*)channelID userIDList:(NSArray<NSNumber*> *)userIDs;
149
157- (ZoomSDKError)removeUsersFromChannel:(NSString*)channelID userIDList:(NSArray<NSNumber*> *)userIDs;
158
169- (ZoomSDKError)sendAudioDataToChannel:(NSString *)channelID audioData:(char *)audioData dataLength:(unsigned int)dataLength sampleRate:(unsigned int)sampleRate channel:(ZoomSDKAudioChannel)channel;
170
177- (ZoomSDKError)setChannelBackgroundVolume:(NSString *)channelID backgroundVolume:(float)backgroundVolume;
178
179@end
180
181NS_ASSUME_NONNULL_END
182
ZoomSDKAudioChannel
Enumeration of audio channel types.
ZoomSDKError
Enumeration of common errors of SDK.
ZoomSDKTalkbackError
Enumeration of talkback error codes.
Represents a talkback channel object.
NSString * channelID
Gets the channel's ID.
NSArray< NSNumber * > * userIDList
Gets the list of user IDs in the channel.
Provides interfaces to manage talkback session in Zoom meeting.
NSArray< ZoomSDKTalkbackChannel * > *_Nullable getChannelList()
Gets the list of all talkback channels.
BOOL isMeetingSupportTalkBack()
Determines whether the meeting supports talkback.
id< ZoomSDKTalkbackControllerDelegate > delegate
Gets or sets the delegate that receives talkback-related callback events.