MobileRTCMeetingService+Interpretation.h

Go to the documentation of this file.

//
//  MobileRTCMeetingService+Interpretation.h
//  MobileRTC
//
//  Created by Zoom Communications on 2020/10/15.
//  Copyright © Zoom Communications, Inc. All rights reserved.
//
 
 
#import <MobileRTC/MobileRTC.h>
 
@interface MobileRTCInterpretationLanguage : NSObject
- (NSInteger)getLanguageID;
- (NSString * _Nullable)getLanguageAbbreviations;
- (NSString * _Nullable)getLanguageName;
@end
 
@interface MobileRTCMeetingInterpreter : NSObject
- (NSInteger)getUserID;
- (NSInteger)getLanguageID1;
- (NSInteger)getLanguageID2;
- (BOOL)isAvailable;
 
@end
 
@interface MobileRTCMeetingService (Interpretation)
 
//Common (for all)
 
- (BOOL)isInterpretationEnabled;
 
- (BOOL)isInterpretationStarted;
 
- (BOOL)isInterpreter;
 
- (MobileRTCInterpretationLanguage * _Nullable)getInterpretationLanguageByID:(NSInteger)lanID;
 
//Admin (only for host)
 
- (NSArray <MobileRTCInterpretationLanguage *> * _Nullable)getAllLanguageList;
 
- (NSArray <MobileRTCMeetingInterpreter *> * _Nullable)getInterpreterList;
 
- (BOOL)addInterpreter:(NSUInteger)userID lan1:(NSInteger)lanID1 andLan2:(NSInteger)lanID2;
 
- (BOOL)removeInterpreter:(NSUInteger)userID;
 
- (BOOL)modifyInterpreter:(NSUInteger)userID lan1:(NSInteger)lanID1 andLan2:(NSInteger)lanID2;
 
- (BOOL)startInterpretation;
 
- (BOOL)stopInterpretation;
 
//Listener (for non interpreter)
 
- (NSArray <MobileRTCInterpretationLanguage *> * _Nullable)getAvailableLanguageList;
 
- (BOOL)joinLanguageChannel:(NSInteger)lanID;
 
- (NSInteger)getJoinedLanguageID;
 
- (BOOL)turnOffMajorAudio;
 
- (BOOL)turnOnMajorAudio;
 
- (BOOL)isMajorAudioTurnOff;
 
//interpreter (only for interpreter)
 
- (NSArray <MobileRTCInterpretationLanguage *> * _Nullable)getInterpreterLans;
 
- (BOOL)setInterpreterActiveLan:(NSInteger)activeLanID;
 
- (NSInteger)getInterpreterActiveLan;
 
- (NSArray <MobileRTCInterpretationLanguage *> * _Nullable)getInterpreterAvailableLanguages;
 
- (BOOL)setInterpreterListenLan:(NSInteger)lanID;
 
- (NSInteger)getInterpreterListenLan;
 
@end
 
#pragma mark  MobileRTCSignInterpreter
 
@interface  MobileRTCSignInterpreterLanguage : NSObject
 
@property (copy, nonatomic, nullable) NSString *  languageName;
@property (copy, nonatomic, nullable) NSString *  languageID;
 
@end
 
@interface  MobileRTCSignInterpreter : NSObject
@property (assign, nonatomic)           NSUInteger userID;
@property (assign, nonatomic)           BOOL available;
@property (copy, nonatomic, nullable)    NSString *  userName;
@property (copy, nonatomic, nullable)    NSString *  email;
@property (copy, nonatomic, nullable)    NSString *  languageName;
@property (copy, nonatomic, nullable)    NSString *  languageID;
 
@end
 
 
@interface MobileRTCMeetingService (SignInterpreter)
 
- (BOOL)isSignInterpretationEnabled;
 
- (MobileRTCSignInterpretationStatus)getSignInterpretationStatus;
 
- (BOOL)isSignInterpreter;
 
- (MobileRTCSignInterpreterLanguage *_Nullable)getSignInterpretationLanguageInfoByID:(NSString *_Nullable)signLanguageID;
 
- (NSArray<MobileRTCSignInterpreterLanguage *> *_Nullable)getAvailableSignLanguageInfoList;
 
- (NSArray<MobileRTCSignInterpreterLanguage *> *_Nullable)getAllSupportedSignLanguageInfoList;
 
- (NSArray<MobileRTCSignInterpreter *> *_Nullable)getSignInterpreterList;
 
- (MobileRTCSDKError)addSignInterpreter:(NSUInteger)userID signLanId:(NSString *_Nullable)signLanID;
 
- (MobileRTCSDKError)removeSignInterpreter:(NSUInteger)userID;
 
- (MobileRTCSDKError)modifySignInterpreter:(NSUInteger)userID signLanId:(NSString *_Nullable)signLanID;
 
- (BOOL)canStartSignInterpretation;
 
- (MobileRTCSDKError)startSignInterpretation;
 
- (MobileRTCSDKError)stopSignInterpretation;
 
- (MobileRTCSDKError)requestSignLanuageInterpreterToTalk:(NSUInteger)userID allowToTalk:(BOOL)allowToTalk;
 
- (BOOL)isAllowSignLanuageInterpreterToTalk:(NSUInteger)userID;
 
- (NSString *_Nullable)getSignInterpreterAssignedLanID;
 
- (MobileRTCSDKError)joinSignLanguageChannel:(NSString *_Nullable)signLanID;
 
- (MobileRTCSDKError)leaveSignLanguageChannel;
@end