Mac SDK
Instance Methods | Properties | List of all members
ZoomSDKInterpretationController Class Reference
Inheritance diagram for ZoomSDKInterpretationController:

Instance Methods

(BOOL) - isInterpretationEnabled
 Determine if the interpretation function is enabled. More...
 
(BOOL) - isInterpretationStarted
 Determine if the interpretation function is started. More...
 
(BOOL) - isInterpreter
 Determine if self is interpreter. More...
 
(ZoomSDKInterpretationLanguageInfo *) - getInterpretationLanguageByID:
 Get interpretation language. More...
 
(NSArray *) - getAllLanguageList
 Get all language list of interpretation support. More...
 
(NSArray *) - getAllInterpreterList
 Get all interpreter list. More...
 
(ZoomSDKError) - addInterpreter:languageID1:languageID2:
 Add interpreter. More...
 
(ZoomSDKError) - removeInterpreter:
 Remove interpreter. More...
 
(ZoomSDKError) - modifyInterpreter:languageID1:languageID2:
 Modify interpreter suport language. More...
 
(ZoomSDKError) - startInterpretation
 Start interppretation. More...
 
(ZoomSDKError) - StopInterpretation
 Stop interppretation. More...
 
(NSArray *) - getAvailableLanguageList
 Get available language list. More...
 
(ZoomSDKError) - joinLanguageChannel:
 Join language channel by language id. More...
 
(int) - getJoinedLanguageID
 Get the language id of user joined. More...
 
(ZoomSDKError) - turnOffMajorAudio
 Turn off the major meeting audio. More...
 
(ZoomSDKError) - turnOnMajorAudio
 Turn on the major meeting audio. More...
 
(BOOL) - isMajorAudioTurnOff
 Determine if major audio is turn off. More...
 
(ZoomSDKError) - getInterpreterLans:languageID2:
 Get interpreter support language. More...
 
(ZoomSDKError) - setInterpreterActiveLan:
 Set interpreter active language. More...
 
(int) - getInterpreterActiveLanID
 Get interpreter current active language id. More...
 

Properties

id< ZoomSDKInterpretationControllerDelegatedelegate
 

Method Documentation

◆ addInterpreter:languageID1:languageID2:

- (ZoomSDKError) addInterpreter: (unsigned int)  userID
languageID1: (int)  lanID1
languageID2: (int)  lanID2 

Add interpreter.

Parameters
userIDThe unique identity of the user.
lanID1The id of language.
lanID2The id of language.
Returns
If the function succeeds, it will return ZoomSDKError_succuss, otherwise not.

◆ getAllInterpreterList

- (NSArray*) getAllInterpreterList

Get all interpreter list.

Returns
If the function succeeds, the return array contain interpreter object.(The language object is ZoomSDKInterpreter)

◆ getAllLanguageList

- (NSArray*) getAllLanguageList

Get all language list of interpretation support.

Returns
If the function succeeds, the return array contain language object.(The language object is ZoomSDKInterpretationLanguageInfo)

◆ getAvailableLanguageList

- (NSArray*) getAvailableLanguageList

Get available language list.

Returns
The array contain available language object (The language object is ZoomSDKInterpretationLanguageInfo).

◆ getInterpretationLanguageByID:

- (ZoomSDKInterpretationLanguageInfo*) getInterpretationLanguageByID: (int)  languageID

Get interpretation language.

Parameters
languageIDThe id of language.
Returns
If the function succeeds, the return value is ZoomSDKInterpretationLanguageInfo object.

◆ getInterpreterActiveLanID

- (int) getInterpreterActiveLanID

Get interpreter current active language id.

Returns
If the function succeeds, it will return language id.

◆ getInterpreterLans:languageID2:

- (ZoomSDKError) getInterpreterLans: (int *)  lanID1
languageID2: (int *)  lanID2 

Get interpreter support language.

Parameters
lanID1The id is interpreter first language.
lanID2The id is interpreter second language.
Returns
If the function succeeds, it will return ZoomSDKError_succuss, otherwise not.

◆ getJoinedLanguageID

- (int) getJoinedLanguageID

Get the language id of user joined.

Returns
If the function succeeds, it will return language id.

◆ isInterpretationEnabled

- (BOOL) isInterpretationEnabled

Determine if the interpretation function is enabled.

Returns
YES means interpretation function is enable,otherwise not.

◆ isInterpretationStarted

- (BOOL) isInterpretationStarted

Determine if the interpretation function is started.

Returns
YES means interpretation is started,otherwise not.

◆ isInterpreter

- (BOOL) isInterpreter

Determine if self is interpreter.

Returns
YES means self is interpreter,otherwise not.

◆ isMajorAudioTurnOff

- (BOOL) isMajorAudioTurnOff

Determine if major audio is turn off.

Returns
YES means major audio is turn off,otherwise not.

◆ joinLanguageChannel:

- (ZoomSDKError) joinLanguageChannel: (int)  languageID

Join language channel by language id.

Parameters
languageIDThe language id.
Returns
If the function succeeds, it will return ZoomSDKError_succuss, otherwise not.
Note
LanguageID is -1 means join major meeting.

◆ modifyInterpreter:languageID1:languageID2:

- (ZoomSDKError) modifyInterpreter: (unsigned int)  userID
languageID1: (int)  lanID1
languageID2: (int)  lanID2 

Modify interpreter suport language.

Parameters
userIDThe unique identity of the user.
lanID1The id of language.
lanID2The id of language.
Returns
If the function succeeds, it will return ZoomSDKError_succuss, otherwise not.

◆ removeInterpreter:

- (ZoomSDKError) removeInterpreter: (unsigned int)  userID

Remove interpreter.

Parameters
userIDThe unique identity of the user.
Returns
If the function succeeds, it will return ZoomSDKError_succuss, otherwise not.

◆ setInterpreterActiveLan:

- (ZoomSDKError) setInterpreterActiveLan: (int)  activeLanID

Set interpreter active language.

Parameters
activeLanIDThe id of language id.
Returns
If the function succeeds, it will return ZoomSDKError_succuss, otherwise not.

◆ startInterpretation

- (ZoomSDKError) startInterpretation

Start interppretation.

Returns
If the function succeeds, it will return ZoomSDKError_succuss, otherwise not.

◆ StopInterpretation

- (ZoomSDKError) StopInterpretation

Stop interppretation.

Returns
If the function succeeds, it will return ZoomSDKError_succuss, otherwise not.

◆ turnOffMajorAudio

- (ZoomSDKError) turnOffMajorAudio

Turn off the major meeting audio.

Returns
If the function succeeds, it will return ZoomSDKError_succuss, otherwise not.

◆ turnOnMajorAudio

- (ZoomSDKError) turnOnMajorAudio

Turn on the major meeting audio.

Returns
If the function succeeds, it will return ZoomSDKError_succuss, otherwise not.

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