Meeting SDK for iOS API Reference
Loading...
Searching...
No Matches
MobileRTCMeetingService+Interpretation.h
Go to the documentation of this file.
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;
54- (BOOL)isAvailable;
55
56@end
57
61@interface MobileRTCMeetingService (Interpretation)
62
63//Common (for all)
64
70
76
81- (BOOL)isInterpreter;
82
88- (MobileRTCInterpretationLanguage * _Nullable)getInterpretationLanguageByID:(NSInteger)lanID;
89
90//Admin (only for host)
91
97
102- (NSArray <MobileRTCMeetingInterpreter *> * _Nullable)getInterpreterList;
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
133- (BOOL)startInterpretation;
134
139- (BOOL)stopInterpretation;
140
141//Listener (for non interpreter)
142
148
154- (BOOL)joinLanguageChannel:(NSInteger)lanID;
155
160- (NSInteger)getJoinedLanguageID;
161
166- (BOOL)turnOffMajorAudio;
167
172- (BOOL)turnOnMajorAudio;
173
178- (BOOL)isMajorAudioTurnOff;
179
180//interpreter (only for interpreter)
181
186- (NSArray <MobileRTCInterpretationLanguage *> * _Nullable)getInterpreterLans;
187
193- (BOOL)setInterpreterActiveLan:(NSInteger)activeLanID;
194
199- (NSInteger)getInterpreterActiveLan;
200
206
212- (BOOL)setInterpreterListenLan:(NSInteger)lanID;
213
218- (NSInteger)getInterpreterListenLan;
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
283- (BOOL)isSignInterpretationEnabled;
284
289- (MobileRTCSignInterpretationStatus)getSignInterpretationStatus;
290
295- (BOOL)isSignInterpreter;
296
302- (MobileRTCSignInterpreterLanguage *_Nullable)getSignInterpretationLanguageInfoByID:(NSString *_Nullable)signLanguageID;
303
308- (NSArray<MobileRTCSignInterpreterLanguage *> *_Nullable)getAvailableSignLanguageInfoList;
309
315- (NSArray<MobileRTCSignInterpreterLanguage *> *_Nullable)getAllSupportedSignLanguageInfoList;
316
321- (NSArray<MobileRTCSignInterpreter *> *_Nullable)getSignInterpreterList;
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
354- (BOOL)canStartSignInterpretation;
355
361- (MobileRTCSDKError)startSignInterpretation;
362
368- (MobileRTCSDKError)stopSignInterpretation;
369
376- (MobileRTCSDKError)requestSignLanuageInterpreterToTalk:(NSUInteger)userID allowToTalk:(BOOL)allowToTalk;
377
383- (BOOL)isAllowSignLanuageInterpreterToTalk:(NSUInteger)userID;
384
389- (NSString *_Nullable)getSignInterpreterAssignedLanID;
390
396- (MobileRTCSDKError)joinSignLanguageChannel:(NSString *_Nullable)signLanID;
397
403- (MobileRTCSDKError)leaveSignLanguageChannel;
404@end
405
MobileRTCSDKError
Enumeration of SDK error.
MobileRTCSignInterpretationStatus
Enumeration of the status of sign language interpretation.
BOOL isInterpreter()
Determine if myself is interpreter.
BOOL isInterpretationStarted()
Determine if interpretation has been started by host.
NSArray< MobileRTCInterpretationLanguage * > *_Nullable getInterpreterAvailableLanguages()
Get the list of available languages that interpreters can hear.
BOOL turnOffMajorAudio()
Turn off the major audio, if you are in some interpreter language channel.
BOOL isInterpretationEnabled()
Determine if interpretation feature is enabled in the meeting.
BOOL stopInterpretation()
Stop interpretation.
NSArray< MobileRTCInterpretationLanguage * > *_Nullable getAvailableLanguageList()
Get the available interpretation language list.
BOOL startInterpretation()
Start interpretation.
BOOL isMajorAudioTurnOff()
Determine if the major audio is off.
NSArray< MobileRTCMeetingInterpreter * > *_Nullable getInterpreterList()
Get the interpreters list.
NSInteger getInterpreterActiveLan()
Get the active language ID, if myself is a interpreter.
BOOL turnOnMajorAudio()
Turn on the major audio, if you are in some interpreter language channel.
NSArray< MobileRTCInterpretationLanguage * > *_Nullable getAllLanguageList()
Get the all interpretation language list.
NSInteger getJoinedLanguageID()
Get the language ID which myself is in.
NSArray< MobileRTCInterpretationLanguage * > *_Nullable getInterpreterLans()
Get languages if myself is a interpreter.
NSInteger getInterpreterListenLan()
Get a language that I can hear as an interpreter.
The information of interpretation language.
NSInteger getLanguageID()
Get the language ID.
NSString *_Nullable getLanguageName()
Get the language name.
NSString *_Nullable getLanguageAbbreviations()
Get the language alias (abbreviation).
NSInteger getLanguageID2()
Get the interpreter's second supported language ID.
NSInteger getLanguageID1()
Get the interpreter's first supported language ID.
BOOL isAvailable()
Determine is currently available in the meeting.
NSInteger getUserID()
Get the interpreter's user ID.
Represent interpretation language information.