Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
ZoomSDKInterpretationController.h
Go to the documentation of this file.
1
10#import <Foundation/Foundation.h>
11#import "ZoomSDKErrors.h"
12
13NS_ASSUME_NONNULL_BEGIN
19
24- (int)getLanguageID;
25
30- (NSString*_Nullable)getLanguageAbbreviations;
31
36- (NSString*_Nullable)getLanguageName;
37@end
38
43@interface ZoomSDKInterpreter : NSObject
44
49- (unsigned int)getUserID;
50
55- (int)getLanguageID1;
56
61- (int)getLanguageID2;
62
67- (BOOL)isAvailable;
68@end
69
74@protocol ZoomSDKInterpretationControllerDelegate <NSObject>
75
79- (void)onInterpretationStart;
80
84- (void)onInterpretationStop;
85
91- (void)onInterpreterRoleChanged:(unsigned int)userID isInterpreter:(BOOL)interpreter;
92
98- (void)onInterpreterActiveLanguageChanged:(unsigned int)userID activeLanguageID:(int)languageID;
99
105- (void)onInterpreterLanguageChanged:(int)lanID1 theLanguageID2:(int)lanID2;
106
111- (void)onAvailableLanguageListUpdated:(NSArray*_Nullable)availableLanguageArr;
112
116- (void)onInterpreterListChanged;
117
122- (void)onInterpreterLanguagesUpdated:(NSArray<ZoomSDKInterpretationLanguageInfo *>*_Nullable)availableLanguages;
123@end
124
125
134@property(nonatomic,assign,nullable)id<ZoomSDKInterpretationControllerDelegate> delegate;
135
141
147
152- (BOOL)isInterpreter;
153
159- (ZoomSDKInterpretationLanguageInfo*_Nullable)getInterpretationLanguageByID:(int)languageID;
160
165- (NSArray*_Nullable)getAllLanguageList;
166
171- (NSArray*_Nullable)getAllInterpreterList;
172
180- (ZoomSDKError)addInterpreter:(unsigned int)userID languageID1:(int)lanID1 languageID2:(int)lanID2;
181
187- (ZoomSDKError)removeInterpreter:(unsigned int)userID;
188
196- (ZoomSDKError)modifyInterpreter:(unsigned int)userID languageID1:(int)lanID1 languageID2:(int)lanID2;
197
203
209
214- (NSArray*_Nullable)getAvailableLanguageList;
215
221- (ZoomSDKError)joinLanguageChannel:(int)languageID;
222
228
234
240
245- (BOOL)isMajorAudioTurnOff;
246
253- (ZoomSDKError)getInterpreterLans:(int*)lanID1 languageID2:(int*)lanID2;
254
260- (ZoomSDKError)setInterpreterActiveLan:(int)activeLanID;
261
267
272- (NSArray <ZoomSDKInterpretationLanguageInfo *>*_Nullable)getInterpreterAvailableLanguages;
273
279- (ZoomSDKError)setInterpreterListenLan:(int)languageID;
280
286@end
287
288NS_ASSUME_NONNULL_END
Definitions of error codes, enumerations, and constants used throughout the Zoom SDK.
ZoomSDKError
Enumeration of common errors of SDK.
Interface for managing interpretation in a Zoom meeting.
BOOL isMajorAudioTurnOff()
Determines if major audio is turn off.
ZoomSDKError startInterpretation()
Starts interppretation.
NSArray *_Nullable getAllInterpreterList()
Gets the list of all interpreters in the meeting.
id< ZoomSDKInterpretationControllerDelegate > delegate
Delegate for receiving interpretation-related events.
NSArray *_Nullable getAvailableLanguageList()
Gets the list of available interpretation languages.
int getJoinedLanguageID()
Gets the language ID currently joined.
ZoomSDKError turnOffMajorAudio()
Turn off the major meeting audio.
BOOL isInterpretationEnabled()
Determines if the interpretation function is enabled.
NSArray< ZoomSDKInterpretationLanguageInfo * > *_Nullable getInterpreterAvailableLanguages()
Gets the list of available languages that interpreters can hear.
BOOL isInterpreter()
Determines if self is interpreter.
int getInterpreterActiveLanID()
Gets interpreter current active language ID.
int getInterpreterListenLanID()
Gets a language that I can hear as an interpreter.
BOOL isInterpretationStarted()
Determines if the interpretation function is started.
NSArray *_Nullable getAllLanguageList()
Gets the full list of supported interpretation languages.
ZoomSDKError StopInterpretation()
Stops interppretation.
ZoomSDKError turnOnMajorAudio()
Turn on the major meeting audio.
Represent interpretation language information.
NSString *_Nullable getLanguageAbbreviations()
Gets the language alias (abbreviation).
NSString *_Nullable getLanguageName()
Gets the language name.
int getLanguageID()
Gets the language ID.
Represent an interpreter user and their supported languages.
unsigned int getUserID()
Gets the interpreter's user ID.
int getLanguageID2()
Gets the interpreter's second supported language ID.
int getLanguageID1()
Gets the interpreter's first supported language ID.
BOOL isAvailable()
Determines is currently available in the meeting.