us.zoom.sdk.InMeetingInterpretationController Interface Reference

Public Member Functions
void	setEvent (IMeetingInterpretationControllerEvent event)
boolean	isInterpretationEnabled ()
	Query if web enabled this feature option.
boolean	isInterpretationStarted ()
	Query if host has started the interpretation.
boolean	isInterpreter ()
	Query if I am an interpreter or not.
IInterpretationLanguage	getInterpretationLanguageByID (int lanID)
	Get interpretation language by ID.
List< IInterpretationLanguage >	getAllLanguageList ()
	Get all interpretation language list.
List< IInterpreter >	getInterpreterList ()
	Get interpreters list.
boolean	addInterpreter (long userID, int lanID1, int lanID2)
	Add a interpreter.
boolean	removeInterpreter (long userID)
	Remove a interpreter by user id.
boolean	modifyInterpreter (long userID, int lanID1, int lanID2)
	Update interpreter language information.
MobileRTCSDKError	startInterpretation ()
	Start interpretation.
MobileRTCSDKError	stopInterpretation ()
	Stop interpretation.
List< IInterpretationLanguage >	getAvailableLanguageList ()
	Get available language channel list.
MobileRTCSDKError	joinLanguageChannel (int lanID)
	Join a language channel.
int	getJoinedLanguageID ()
	Get my joined language channel.
MobileRTCSDKError	turnOffMajorAudio ()
	Turn off major audio channel while listen other language channel.
MobileRTCSDKError	turnOnMajorAudio ()
	Turn on major audio channel while listen other language channel.
boolean	isMajorAudioTurnOff ()
	Query the major audio channel enable status.
List< Integer >	getInterpreterLans ()
	Get my language if I am an interpreter.
MobileRTCSDKError	setInterpreterActiveLan (int activeLanID)
	Set my active language if i am an interpreter.
int	getInterpreterActiveLan ()
	Get my active language if i am an interpreter.
List< IInterpretationLanguage >	getInterpreterAvailableLanguages ()
	Get the list of available languages that interpreters can hear.
MobileRTCSDKError	setInterpreterListenLan (int languageID)
	Set a language that I can hear as an interpreter.
int	getInterpreterListenLan ()
	Get a language that I can hear as an interpreter.

Detailed Description

Definition at line 5 of file InMeetingInterpretationController.java.

Member Function Documentation

addInterpreter()

boolean us.zoom.sdk.InMeetingInterpretationController.addInterpreter	(	long	userID,
		int	lanID1,
		int	lanID2 )

Add a interpreter.

Parameters

userID	the interpreter user id.
lanID1	first language id.
lanID2	second language id.

Returns

true: add success.

getAllLanguageList()

List< IInterpretationLanguage > us.zoom.sdk.InMeetingInterpretationController.getAllLanguageList

(

)

Get all interpretation language list.

Returns

language list

getAvailableLanguageList()

List< IInterpretationLanguage > us.zoom.sdk.InMeetingInterpretationController.getAvailableLanguageList

(

)

Get available language channel list.

Returns

all available language channel list

getInterpretationLanguageByID()

IInterpretationLanguage us.zoom.sdk.InMeetingInterpretationController.getInterpretationLanguageByID

(

int

lanID

)

Get interpretation language by ID.

Parameters

lanID

language id

Returns

IInterpretationLanguage

getInterpreterActiveLan()

int us.zoom.sdk.InMeetingInterpretationController.getInterpreterActiveLan

(

)

Get my active language if i am an interpreter.

Returns

activity language id IInterpretationLanguage#getLanguageID()

getInterpreterAvailableLanguages()

List< IInterpretationLanguage > us.zoom.sdk.InMeetingInterpretationController.getInterpreterAvailableLanguages

(

)

Get the list of available languages that interpreters can hear.

Returns

If the function succeeds, the return value is IInterpretationLanguage list, Otherwise, the return value is NULL.

getInterpreterLans()

List< Integer > us.zoom.sdk.InMeetingInterpretationController.getInterpreterLans

(

)

Get my language if I am an interpreter.

Returns

interpreter first and language Id. the return list is null or size 2

getInterpreterList()

List< IInterpreter > us.zoom.sdk.InMeetingInterpretationController.getInterpreterList

(

)

Get interpreters list.

Returns

interpreters list

getInterpreterListenLan()

int us.zoom.sdk.InMeetingInterpretationController.getInterpreterListenLan

(

)

Get a language that I can hear as an interpreter.

Returns

Specify the selected language that I can hear as an interpreter. Otherwise failed, the return value is -1.

getJoinedLanguageID()

int us.zoom.sdk.InMeetingInterpretationController.getJoinedLanguageID

(

)

Get my joined language channel.

Returns

IInterpretationLanguage#getLanguageID()

isInterpretationEnabled()

boolean us.zoom.sdk.InMeetingInterpretationController.isInterpretationEnabled

(

)

Query if web enabled this feature option.

Returns

true: enable

isInterpretationStarted()

boolean us.zoom.sdk.InMeetingInterpretationController.isInterpretationStarted

(

)

Query if host has started the interpretation.

Returns

true: enable

isInterpreter()

boolean us.zoom.sdk.InMeetingInterpretationController.isInterpreter

(

)

Query if I am an interpreter or not.

Returns

true: enable

isMajorAudioTurnOff()

boolean us.zoom.sdk.InMeetingInterpretationController.isMajorAudioTurnOff

(

)

Query the major audio channel enable status.

Returns

true: major audio is turn off

joinLanguageChannel()

MobileRTCSDKError us.zoom.sdk.InMeetingInterpretationController.joinLanguageChannel

(

int

lanID

)

Join a language channel.

Parameters

lanID

-1 join to main channel(Original Audio)

Returns

If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

modifyInterpreter()

boolean us.zoom.sdk.InMeetingInterpretationController.modifyInterpreter	(	long	userID,
		int	lanID1,
		int	lanID2 )

Update interpreter language information.

Parameters

userID	the interpreter user id.
lanID1	first language id.
lanID2	second language id.

Returns

true: modify success.

removeInterpreter()

boolean us.zoom.sdk.InMeetingInterpretationController.removeInterpreter

(

long

userID

)

Remove a interpreter by user id.

Parameters

userID

the interpreter user id.

Returns

true: remove success.

setEvent()

void us.zoom.sdk.InMeetingInterpretationController.setEvent

(

IMeetingInterpretationControllerEvent

event

)

setInterpreterActiveLan()

MobileRTCSDKError us.zoom.sdk.InMeetingInterpretationController.setInterpreterActiveLan

(

int

activeLanID

)

Set my active language if i am an interpreter.

Parameters

activeLanID

language id.

Returns

If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

setInterpreterListenLan()

MobileRTCSDKError us.zoom.sdk.InMeetingInterpretationController.setInterpreterListenLan

(

int

languageID

)

Set 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 will return SDKERR_SUCCESS. Otherwise failed.

startInterpretation()

MobileRTCSDKError us.zoom.sdk.InMeetingInterpretationController.startInterpretation

(

)

Start interpretation.

Returns

If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

stopInterpretation()

MobileRTCSDKError us.zoom.sdk.InMeetingInterpretationController.stopInterpretation

(

)

Stop interpretation.

Returns

If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

turnOffMajorAudio()

MobileRTCSDKError us.zoom.sdk.InMeetingInterpretationController.turnOffMajorAudio

(

)

Turn off major audio channel while listen other language channel.

Returns

If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

turnOnMajorAudio()

MobileRTCSDKError us.zoom.sdk.InMeetingInterpretationController.turnOnMajorAudio

(

)

Turn on major audio channel while listen other language channel.

Returns

If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.