Interface for managing interpretation in a Zoom meeting. More...

#include <ZoomSDKInterpretationController.h>

Inherits NSObject.

Instance Methods
(BOOL)	- isInterpretationEnabled
	Determines if the interpretation function is enabled.

(BOOL)	- isInterpretationStarted
	Determines if the interpretation function is started.

(BOOL)	- isInterpreter
	Determines if self is interpreter.

(ZoomSDKInterpretationLanguageInfo *_Nullable)	- getInterpretationLanguageByID:
	Gets interpretation language info by language ID.

(NSArray *_Nullable)	- getAllLanguageList
	Gets the full list of supported interpretation languages.

(NSArray *_Nullable)	- getAllInterpreterList
	Gets the list of all interpreters in the meeting.

(ZoomSDKError)	- addInterpreter:languageID1:languageID2:
	Adds an interpreter.

(ZoomSDKError)	- removeInterpreter:
	Removes an interpreter.

(ZoomSDKError)	- modifyInterpreter:languageID1:languageID2:
	Modify the supported languages of an interpreter.

(ZoomSDKError)	- startInterpretation
	Starts interppretation.

(ZoomSDKError)	- StopInterpretation
	Stops interppretation.

(NSArray *_Nullable)	- getAvailableLanguageList
	Gets the list of available interpretation languages.

(ZoomSDKError)	- joinLanguageChannel:
	Join an interpretation language channel.

(int)	- getJoinedLanguageID
	Gets the language ID currently joined.

(ZoomSDKError)	- turnOffMajorAudio
	Turn off the major meeting audio.

(ZoomSDKError)	- turnOnMajorAudio
	Turn on the major meeting audio.

(BOOL)	- isMajorAudioTurnOff
	Determines if major audio is turn off.

(ZoomSDKError)	- getInterpreterLans:languageID2:
	Gets interpreter support language.

(ZoomSDKError)	- setInterpreterActiveLan:
	Sets interpreter active language.

(int)	- getInterpreterActiveLanID
	Gets interpreter current active language ID.

(NSArray< ZoomSDKInterpretationLanguageInfo * > *_Nullable)	- getInterpreterAvailableLanguages
	Gets the list of available languages that interpreters can hear.

(ZoomSDKError)	- setInterpreterListenLan:
	Sets a language that I can hear as an interpreter.

(int)	- getInterpreterListenLanID
	Gets a language that I can hear as an interpreter.

Properties
id< ZoomSDKInterpretationControllerDelegate >	delegate
	Delegate for receiving interpretation-related events.

Detailed Description

Interface for managing interpretation in a Zoom meeting.

Definition at line 130 of file ZoomSDKInterpretationController.h.

Method Documentation

◆ addInterpreter:languageID1:languageID2:

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

Adds an interpreter.

Parameters

userID	User ID.
lanID1	First language ID.
lanID2	Second language ID.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

References delegate, getAllInterpreterList, getAllLanguageList, getAvailableLanguageList, getInterpreterActiveLanID, getInterpreterAvailableLanguages, getInterpreterListenLanID, getJoinedLanguageID, isInterpretationEnabled, isInterpretationStarted, isInterpreter, isMajorAudioTurnOff, startInterpretation, StopInterpretation, turnOffMajorAudio, and turnOnMajorAudio.

◆ getAllInterpreterList

- (NSArray *_Nullable) getAllInterpreterList

Gets the list of all interpreters in the meeting.

Returns: If the function succeeds, the return array contain interpreter object.(The language object is ZoomSDKInterpreter). Otherwise, this function fails and returns nil.

Referenced by addInterpreter:languageID1:languageID2:.

◆ getAllLanguageList

- (NSArray *_Nullable) getAllLanguageList

Gets the full list of supported interpretation languages.

Returns: If the function succeeds, the return array contain language object.(The language object is ZoomSDKInterpretationLanguageInfo). Otherwise, this function fails and returns nil.

Referenced by addInterpreter:languageID1:languageID2:.

◆ getAvailableLanguageList

- (NSArray *_Nullable) getAvailableLanguageList

Gets the list of available interpretation languages.

Returns: Array of ZoomSDKInterpretationLanguageInfo. Otherwise, this function fails and returns nil.

Referenced by addInterpreter:languageID1:languageID2:.

◆ getInterpretationLanguageByID:

- (ZoomSDKInterpretationLanguageInfo *_Nullable) getInterpretationLanguageByID: (int) languageID

Gets interpretation language info by language ID.

Parameters

languageID The ID of language.

Returns: If the function succeeds, it returns ZoomSDKInterpretationLanguageInfo object. Otherwise, this function fails and returns nil.

◆ getInterpreterActiveLanID

- (int) getInterpreterActiveLanID

Gets interpreter current active language ID.

Returns: Active language ID.

Referenced by addInterpreter:languageID1:languageID2:.

◆ getInterpreterAvailableLanguages

- (NSArray< ZoomSDKInterpretationLanguageInfo * > *_Nullable) getInterpreterAvailableLanguages

Gets the list of available languages that interpreters can hear.

Returns: If the function succeeds, the retuan value is an array of ZoomSDKInterpretationLanguageInfo. Otherwise, this function fails and returns nil.

Referenced by addInterpreter:languageID1:languageID2:.

◆ getInterpreterLans:languageID2:

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

Gets interpreter support language.

Parameters

lanID1	The id is interpreter first language.
lanID2	The id is interpreter second language.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ getInterpreterListenLanID

- (int) getInterpreterListenLanID

Gets a language that I can hear as an interpreter.

Returns: Language ID.

Referenced by addInterpreter:languageID1:languageID2:.

◆ getJoinedLanguageID

- (int) getJoinedLanguageID

Gets the language ID currently joined.

Returns: Language ID.

Referenced by addInterpreter:languageID1:languageID2:.

◆ isInterpretationEnabled

- (BOOL) isInterpretationEnabled

Determines if the interpretation function is enabled.

Returns: YES if interpretation function is enable. Otherwise, NO.

Referenced by addInterpreter:languageID1:languageID2:.

◆ isInterpretationStarted

- (BOOL) isInterpretationStarted

Determines if the interpretation function is started.

Returns: YES if interpretation is started. Otherwise, NO.

Referenced by addInterpreter:languageID1:languageID2:.

◆ isInterpreter

- (BOOL) isInterpreter

Determines if self is interpreter.

Returns: YES if self is interpreter. Otherwise, NO.

Referenced by addInterpreter:languageID1:languageID2:.

◆ isMajorAudioTurnOff

- (BOOL) isMajorAudioTurnOff

Determines if major audio is turn off.

Returns: YES if major audio is turn off. Otherwise, NO.

Referenced by addInterpreter:languageID1:languageID2:.

◆ joinLanguageChannel:

- (ZoomSDKError) joinLanguageChannel: (int) languageID

Join an interpretation language channel.

Parameters

languageID Language ID. -1 means join the major audio.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ modifyInterpreter:languageID1:languageID2:

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

Modify the supported languages of an interpreter.

Parameters

userID	User ID.
lanID1	First language ID.
lanID2	Second language ID.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ removeInterpreter:

- (ZoomSDKError) removeInterpreter: (unsigned int) userID

Removes an interpreter.

Parameters

userID User ID.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ setInterpreterActiveLan:

- (ZoomSDKError) setInterpreterActiveLan: (int) activeLanID

Sets interpreter active language.

Parameters

activeLanID Active language ID.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ setInterpreterListenLan:

- (ZoomSDKError) setInterpreterListenLan: (int) languageID

Sets a language that I can hear as an interpreter.

Parameters

languageID Specify the selected language that I can hear as an interpreter.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ startInterpretation

- (ZoomSDKError) startInterpretation

Starts interppretation.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

Referenced by addInterpreter:languageID1:languageID2:.

◆ StopInterpretation

- (ZoomSDKError) StopInterpretation

Stops interppretation.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

Referenced by addInterpreter:languageID1:languageID2:.

◆ turnOffMajorAudio

- (ZoomSDKError) turnOffMajorAudio

Turn off the major meeting audio.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

Referenced by addInterpreter:languageID1:languageID2:.

◆ turnOnMajorAudio

- (ZoomSDKError) turnOnMajorAudio

Turn on the major meeting audio.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

Referenced by addInterpreter:languageID1:languageID2:.

Property Documentation

◆ delegate

- (id<ZoomSDKInterpretationControllerDelegate>) delegate

readwritenonatomicassign

Delegate for receiving interpretation-related events.

Definition at line 134 of file ZoomSDKInterpretationController.h.

Referenced by addInterpreter:languageID1:languageID2:.

Instance Methods

Properties

Detailed Description

Method Documentation

◆ addInterpreter:languageID1:languageID2:

◆ getAllInterpreterList

◆ getAllLanguageList

◆ getAvailableLanguageList

◆ getInterpretationLanguageByID:

◆ getInterpreterActiveLanID

◆ getInterpreterAvailableLanguages

◆ getInterpreterLans:languageID2:

◆ getInterpreterListenLanID

◆ getJoinedLanguageID

◆ isInterpretationEnabled

◆ isInterpretationStarted

◆ isInterpreter

◆ isMajorAudioTurnOff

◆ joinLanguageChannel:

◆ modifyInterpreter:languageID1:languageID2:

◆ removeInterpreter:

◆ setInterpreterActiveLan:

◆ setInterpreterListenLan:

◆ startInterpretation

◆ StopInterpretation

◆ turnOffMajorAudio

◆ turnOnMajorAudio

Property Documentation

◆ delegate