Meeting SDK for iOS API Reference
Loading...
Searching...
No Matches
MobileRTCMeetingService+Interpretation.h
Go to the documentation of this file.
1
5
6#import <MobileRTC/MobileRTC.h>
7
17- (NSInteger)getLanguageID;
22- (NSString * _Nullable)getLanguageAbbreviations;
27- (NSString * _Nullable)getLanguageName;
28@end
29
34@interface MobileRTCMeetingInterpreter : NSObject
39- (NSInteger)getUserID;
44- (NSInteger)getLanguageID1;
49- (NSInteger)getLanguageID2;
55
56@end
57
61@interface MobileRTCMeetingService (Interpretation)
62
63//Common (for all)
64
70
76
82
88- (MobileRTCInterpretationLanguage * _Nullable)getInterpretationLanguageByID:(NSInteger)lanID;
89
90//Admin (only for host)
91
97
103
111- (BOOL)addInterpreter:(NSUInteger)userID lan1:(NSInteger)lanID1 andLan2:(NSInteger)lanID2;
112
118- (BOOL)removeInterpreter:(NSUInteger)userID;
119
127- (BOOL)modifyInterpreter:(NSUInteger)userID lan1:(NSInteger)lanID1 andLan2:(NSInteger)lanID2;
128
134
140
141//Listener (for non interpreter)
142
148
154- (BOOL)joinLanguageChannel:(NSInteger)lanID;
155
161
167
173
179
180//interpreter (only for interpreter)
181
187
193- (BOOL)setInterpreterActiveLan:(NSInteger)activeLanID;
194
200
206
212- (BOOL)setInterpreterListenLan:(NSInteger)lanID;
213
219
220@end
221
222#pragma mark MobileRTCSignInterpreter
223
229
233@property (copy, nonatomic, nullable) NSString * languageName;
237@property (copy, nonatomic, nullable) NSString * languageID;
238
239@end
240
245@interface MobileRTCSignInterpreter : NSObject
249@property (assign, nonatomic) NSUInteger userID;
253@property (assign, nonatomic) BOOL available;
257@property (copy, nonatomic, nullable) NSString * userName;
261@property (copy, nonatomic, nullable) NSString * email;
265@property (copy, nonatomic, nullable) NSString * languageName;
269@property (copy, nonatomic, nullable) NSString * languageID;
270
271@end
272
273
277@interface MobileRTCMeetingService (SignInterpreter)
278
284
290
296
302- (MobileRTCSignInterpreterLanguage *_Nullable)getSignInterpretationLanguageInfoByID:(NSString *_Nullable)signLanguageID;
303
309
316
322
330- (MobileRTCSDKError)addSignInterpreter:(NSUInteger)userID signLanId:(NSString *_Nullable)signLanID;
331
338- (MobileRTCSDKError)removeSignInterpreter:(NSUInteger)userID;
339
347- (MobileRTCSDKError)modifySignInterpreter:(NSUInteger)userID signLanId:(NSString *_Nullable)signLanID;
348
355
362
369
376- (MobileRTCSDKError)requestSignLanuageInterpreterToTalk:(NSUInteger)userID allowToTalk:(BOOL)allowToTalk;
377
383- (BOOL)isAllowSignLanuageInterpreterToTalk:(NSUInteger)userID;
384
389- (NSString *_Nullable)getSignInterpreterAssignedLanID;
390
397- (MobileRTCSDKError)joinSignLanguageChannel:(NSString *_Nullable)signLanID;
398
405@end
406
MobileRTCSDKError
Enumeration of the SDK error.
MobileRTCSignInterpretationStatus
Enumeration of the status of the sign language interpretation.
BOOL isInterpreter()
Determines if myself is an interpreter.
BOOL isInterpretationStarted()
Determines if interpretation has been started by the host.
NSArray< MobileRTCInterpretationLanguage * > *_Nullable getInterpreterAvailableLanguages()
Gets the list of available languages that interpreters can hear.
BOOL turnOffMajorAudio()
Turns off the major audio if you are in some interpreter language channel.
BOOL isInterpretationEnabled()
Determines if the interpretation feature is enabled in the meeting.
BOOL stopInterpretation()
Stops interpretation.
NSArray< MobileRTCInterpretationLanguage * > *_Nullable getAvailableLanguageList()
Gets the available interpretation language list.
BOOL startInterpretation()
Starts interpretation.
BOOL isMajorAudioTurnOff()
Determines if the major audio is off.
NSArray< MobileRTCMeetingInterpreter * > *_Nullable getInterpreterList()
Gets the interpreters list.
NSInteger getInterpreterActiveLan()
Gets the active language ID, if myself is an interpreter.
BOOL turnOnMajorAudio()
Turns on the major audio if you are in some interpreter language channel.
NSArray< MobileRTCInterpretationLanguage * > *_Nullable getAllLanguageList()
Gets all interpretation language list.
NSInteger getJoinedLanguageID()
Gets the language ID which myself is in.
NSArray< MobileRTCInterpretationLanguage * > *_Nullable getInterpreterLans()
Gets languages if myself is an interpreter.
NSInteger getInterpreterListenLan()
Gets a language that I can hear as an interpreter.
BOOL isSignInterpretationEnabled()
Determines if the sign interpretation function is enabled.
MobileRTCSDKError startSignInterpretation()
Starts sign interpretation.
MobileRTCSDKError leaveSignLanguageChannel()
Leaves the current sign language channel if myself is not a sign interpreter. Only for non-interprete...
NSString *_Nullable getSignInterpreterAssignedLanID()
Gets sign language ID if myself is a sign interpreter. Only for interpreter.
MobileRTCSignInterpretationStatus getSignInterpretationStatus()
Gets the sign interpretation status of the current meeting.
NSArray< MobileRTCSignInterpreter * > *_Nullable getSignInterpreterList()
Gets the sign interpreters list.
BOOL canStartSignInterpretation()
Determines if I can start the sign interpretation in the meeting.
BOOL isSignInterpreter()
Determines if self is a sign interpreter.
NSArray< MobileRTCSignInterpreterLanguage * > *_Nullable getAvailableSignLanguageInfoList()
Gets the available sign interpretation language list.
MobileRTCSDKError stopSignInterpretation()
Stops sign interpretation.
NSArray< MobileRTCSignInterpreterLanguage * > *_Nullable getAllSupportedSignLanguageInfoList()
Gets all supported sign interpretation language list. Only for host.
The information of interpretation language.
NSInteger getLanguageID()
Gets the language ID.
NSString *_Nullable getLanguageName()
Gets the language name.
NSString *_Nullable getLanguageAbbreviations()
Gets the language alias (abbreviation).
NSInteger getLanguageID2()
Gets the interpreter's second supported language ID.
NSInteger getLanguageID1()
Gets the interpreter's first supported language ID.
BOOL isAvailable()
Determines if currently available in the meeting.
NSInteger getUserID()
Gets the interpreter's user ID.
NSString * languageID
The language ID of the sign interpreter support.
BOOL available
YES if the sign interpreter is available. Otherwise, NO.
NSString * languageName
The sign language name.
Represent interpretation language information.