Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
ZoomSDKSignInterpretationController.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
18@property (copy,nonatomic,readonly,nullable) NSString *signLanguageID;
22@property (copy,nonatomic,readonly,nullable) NSString *signLanguageName;
23@end
24
29@interface ZoomSDKSignInterpreter : NSObject
33@property (assign,nonatomic,readonly) unsigned int userID;
37@property (copy,nonatomic,readonly,nullable) NSString *signLanguageID;
42@property (assign,nonatomic,readonly) BOOL isAvailable;
43@end
44
45
50@protocol ZoomSDKSignInterpretationControllerDelegate <NSObject>
51@optional
52
57- (void)onSignInterpretationStatusChanged:(ZoomSDKSignInterpretationStatus)status;
58
64
69
75
80- (void)onAvailableSignLanguageListUpdated:(NSArray<ZoomSDKSignInterpretationLanguageInfo *> *_Nullable)availableSignLanguageList;
81
86
92- (void)onTalkPrivilegeChanged:(BOOL)hasPrivilege;
93@end
94
103@property(nonatomic,assign,nullable)id<ZoomSDKSignInterpretationControllerDelegate> delegate;
104
110
116
122
128- (ZoomSDKSignInterpretationLanguageInfo *)getSignInterpretationLanguageInfoByID:(NSString *)signLanguageID;
129
135
142
148
155- (ZoomSDKError)addSignInterpreter:(unsigned int)userID signLanguageId:(NSString *)signLanguageId;
156
162- (ZoomSDKError)removeSignInterpreter:(unsigned int)userID;
163
170- (ZoomSDKError)modifySignInterpreter:(unsigned int)userID signLanguageId:(NSString *)signLanguageId;
171
176
182
188
195- (ZoomSDKError)requestSignLanguageInterpreterToTalk:(unsigned int)userID allowToTalk:(BOOL)allowToTalk;
196
202- (BOOL)canSignLanguageInterpreterTalk:(unsigned int)userID;
203
208- (NSString *_Nullable)getSignInterpreterAssignedLanID;
209
215- (ZoomSDKError)joinSignLanguageChannel:(NSString *)signLanguageId;
216
222@end
223
224NS_ASSUME_NONNULL_END
ZoomSDKError
Enumeration of common errors of SDK.
ZoomSDKSignInterpretationStatus
Enumeration of the status of sign language interpretation.
Manage sign interpretation status, interpreters, and available languages in a Zoom meeting.
ZoomSDKError startSignInterpretation()
Starts sign interpretation.
BOOL canStartSignInterpretation()
Determines if I can start the sign interpretation in the meeting.
ZoomSDKError stopSignInterpretation()
Stops sign interppretation.
BOOL isSignInterpreter()
Determines if myself is interpreter.
ZoomSDKError leaveSignLanguageChannel()
Off sign language if myself is not a sign interpreter.Only for non-interpreter. Available only for cu...
NSArray< ZoomSDKSignInterpretationLanguageInfo * > * getAvailableSignLanguageInfoList()
Gets the available sign interpretation language list.
BOOL isSignInterpretationEnabled()
Determines if the sign interpretation function is enabled.
ZoomSDKSignInterpretationStatus getSignInterpretationStatus()
Gets the sign interpretation status of current meeting.
NSString *_Nullable getSignInterpreterAssignedLanID()
Gets sign language ID if myself is a sign interpreter. Only for interpreter.
NSArray< ZoomSDKSignInterpretationLanguageInfo * > *_Nullable getAllSupportedSignLanguageInfoList()
Gets all supported sign interpretation language list.
NSArray< ZoomSDKSignInterpreter * > *_Nullable getSignInterpreterList()
Gets the sign interpreters list.
id< ZoomSDKSignInterpretationControllerDelegate > delegate
Delegate for receiving sign interpretation events.
Information of a supported sign interpretation language.
NSString * signLanguageID
Gets the sign language ID.
NSString * signLanguageName
Gets the sign language name.
Represent a sign language interpreter user and their assigned language.
unsigned int userID
Gets the user ID of the sign interpreter.
BOOL isAvailable
Determines if the interpreter is currently available in the meeting.
NSString * signLanguageID
Gets the language ID supported by the sign interpreter.
void onSignInterpreterListChanged()
Sign interpreter list changed callback. When an interpreter leaves the meeting, preset interpreter jo...
void onRequestSignInterpreterToTalk()
Callback event of the requirement to unmute the audio.
void onSignInterpreterRoleChanged()
Interpreters role changed callback. when myself role changed(participant <-> interpreter),...
void onSignInterpreterLanguageChanged()
Sign interpreter languages changed callback. when a sign interpreter's languages changed.