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.

◆ 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.

References getAllInterpreterList.

Referenced by getAllInterpreterList.

◆ 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.

References getAllLanguageList.

Referenced by getAllLanguageList.

◆ getAvailableLanguageList

- (NSArray *_Nullable) getAvailableLanguageList

Gets the list of available interpretation languages.

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

References getAvailableLanguageList.

Referenced by getAvailableLanguageList.

◆ 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.

References getInterpreterActiveLanID.

Referenced by getInterpreterActiveLanID.

◆ 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.

References getInterpreterAvailableLanguages.

Referenced by getInterpreterAvailableLanguages.