iOS API
Instance Methods | List of all members
MobileRTCMeetingService(Interpretation) Category Reference

Instance Methods

(BOOL) - isInterpretationEnabled
 Determine if interpretation feature is enabled in the meeting.
 
(BOOL) - isInterpretationStarted
 Determine if interpretation has been started by host.
 
(BOOL) - isInterpreter
 Determine if myself is interpreter.
 
(MobileRTCInterpretationLanguage *_Nullable) - getInterpretationLanguageByID:
 Get the interpretation language object of specified language ID. More...
 
(NSArray< MobileRTCInterpretationLanguage * > *_Nullable) - getAllLanguageList
 Get the all interpretation language list. More...
 
(NSArray< MobileRTCMeetingInterpreter * > *_Nullable) - getInterpreterList
 Get the interpreters list. More...
 
(BOOL) - addInterpreter:lan1:andLan2:
 Add someone as a interpreter. More...
 
(BOOL) - removeInterpreter:
 Remove some interpreter. More...
 
(BOOL) - modifyInterpreter:lan1:andLan2:
 modify the language of some interpreter. More...
 
(BOOL) - startInterpretation
 Start interpretation. More...
 
(BOOL) - stopInterpretation
 Stop interpretation. More...
 
(NSArray< MobileRTCInterpretationLanguage * > *_Nullable) - getAvailableLanguageList
 Get the available interpretation language list. More...
 
(BOOL) - joinLanguageChannel:
 Join some language channel. More...
 
(NSInteger) - getJoinedLanguageID
 Get the language ID which myself is in. More...
 
(BOOL) - turnOffMajorAudio
 Turn off the major audio, if you are in some interpreter language channel. More...
 
(BOOL) - turnOnMajorAudio
 Turn on the major audio, if you are in some interpreter language channel. More...
 
(BOOL) - isMajorAudioTurnOff
 Determine if the major audio is off. More...
 
(NSArray< MobileRTCInterpretationLanguage * > *_Nullable) - getInterpreterLans
 Get languages if myself is a interpreter. More...
 
(BOOL) - setInterpreterActiveLan:
 Set a language channel which myself will be in, if myself is a interpreter. More...
 
(NSInteger) - getInterpreterActiveLan
 Get the active language ID, if myself is a interpreter. More...
 

Method Documentation

◆ addInterpreter:lan1:andLan2:()

- (BOOL) addInterpreter: (NSUInteger)  userID
lan1: (NSInteger)  lanID1
andLan2: (NSInteger)  lanID2 

Add someone as a interpreter.

Parameters
userIDSpecify the user.
lanID1Specify the language1.
lanID2Specify the language2.
Returns
The result of the function.

Extends class MobileRTCMeetingService.

◆ getAllLanguageList()

- (NSArray <MobileRTCInterpretationLanguage *> * _Nullable) getAllLanguageList

Get the all interpretation language list.

Returns
If the function succeeds, the return value is a pointer to the NSArray <MobileRTCInterpretationLanguage *>, Otherwise failed, the return value is nil.

Extends class MobileRTCMeetingService.

◆ getAvailableLanguageList()

- (NSArray <MobileRTCInterpretationLanguage *> * _Nullable) getAvailableLanguageList

Get the available interpretation language list.

Returns
If the function succeeds, the return value is a pointer to the NSArray <MobileRTCInterpretationLanguage *>, Otherwise failed, the return value is nil.

Extends class MobileRTCMeetingService.

◆ getInterpretationLanguageByID:()

- (MobileRTCInterpretationLanguage * _Nullable) getInterpretationLanguageByID: (NSInteger)  lanID

Get the interpretation language object of specified language ID.

Parameters
lanIDSpecify the language ID for which you want to get the information.
Returns
If the function succeeds, the return value is a pointer to the MobileRTCInterpretationLanguage, Otherwise failed, the return value is nil.

Extends class MobileRTCMeetingService.

◆ getInterpreterActiveLan()

- (NSInteger) getInterpreterActiveLan

Get the active language ID, if myself is a interpreter.

Returns
The Active LanguageID..

Extends class MobileRTCMeetingService.

◆ getInterpreterLans()

- (NSArray <MobileRTCInterpretationLanguage *> * _Nullable) getInterpreterLans

Get languages if myself is a interpreter.

Returns
If the function succeeds, the return value is a pointer to the NSArray NSArray <MobileRTCInterpretationLanguage *>, Otherwise failed, the return value is nil.

Extends class MobileRTCMeetingService.

◆ getInterpreterList()

- (NSArray <MobileRTCMeetingInterpreter *> * _Nullable) getInterpreterList

Get the interpreters list.

Returns
If the function succeeds, the return value is a pointer to the NSArray <MobileRTCMeetingInterpreter *>, Otherwise failed, the return value is nil.

Extends class MobileRTCMeetingService.

◆ getJoinedLanguageID()

- (NSInteger) getJoinedLanguageID

Get the language ID which myself is in.

Returns
The LanguageID.

Extends class MobileRTCMeetingService.

◆ isMajorAudioTurnOff()

- (BOOL) isMajorAudioTurnOff

Determine if the major audio is off.

Returns
The result of the function.

Extends class MobileRTCMeetingService.

◆ joinLanguageChannel:()

- (BOOL) joinLanguageChannel: (NSInteger)  lanID

Join some language channel.

Parameters
lanIDSpecify the language channel.
Returns
The result of the function.

Extends class MobileRTCMeetingService.

◆ modifyInterpreter:lan1:andLan2:()

- (BOOL) modifyInterpreter: (NSUInteger)  userID
lan1: (NSInteger)  lanID1
andLan2: (NSInteger)  lanID2 

modify the language of some interpreter.

Parameters
userIDSpecify the interpreter.
lanID1Specify the new language1.
lanID2Specify the new language2.
Returns
The result of the function.

Extends class MobileRTCMeetingService.

◆ removeInterpreter:()

- (BOOL) removeInterpreter: (NSUInteger)  userID

Remove some interpreter.

Parameters
userIDSpecify the interpreter.
Returns
The result of the function.

Extends class MobileRTCMeetingService.

◆ setInterpreterActiveLan:()

- (BOOL) setInterpreterActiveLan: (NSInteger)  activeLanID

Set a language channel which myself will be in, if myself is a interpreter.

Parameters
activeLanIDSpecify the active language.
Returns
The result of the function.

Extends class MobileRTCMeetingService.

◆ startInterpretation()

- (BOOL) startInterpretation

Start interpretation.

Returns
The result of the function.

Extends class MobileRTCMeetingService.

◆ stopInterpretation()

- (BOOL) stopInterpretation

Stop interpretation.

Returns
The result of the function.

Extends class MobileRTCMeetingService.

◆ turnOffMajorAudio()

- (BOOL) turnOffMajorAudio

Turn off the major audio, if you are in some interpreter language channel.

Returns
The result of the function.

Extends class MobileRTCMeetingService.

◆ turnOnMajorAudio()

- (BOOL) turnOnMajorAudio

Turn on the major audio, if you are in some interpreter language channel.

Returns
The result of the function.

Extends class MobileRTCMeetingService.


The documentation for this category was generated from the following file: