ZoomSDKSignInterpretationController Class Reference

Manage sign interpretation status, interpreters, and available languages in a Zoom meeting. More...

#include <ZoomSDKSignInterpretationController.h>

Inherits NSObject.

Instance Methods
(BOOL)	- isSignInterpretationEnabled
	Determines if the sign interpretation function is enabled.
(ZoomSDKSignInterpretationStatus)	- getSignInterpretationStatus
	Gets the sign interpretation status of current meeting.
(BOOL)	- isSignInterpreter
	Determines if myself is interpreter.
(ZoomSDKSignInterpretationLanguageInfo *)	- getSignInterpretationLanguageInfoByID:
	Gets the sign language object of the specified sign language ID.
(NSArray< ZoomSDKSignInterpretationLanguageInfo * > *)	- getAvailableSignLanguageInfoList
	Gets the available sign interpretation language list.
(NSArray< ZoomSDKSignInterpretationLanguageInfo * > *_Nullable)	- getAllSupportedSignLanguageInfoList
	Gets all supported sign interpretation language list.
(NSArray< ZoomSDKSignInterpreter * > *_Nullable)	- getSignInterpreterList
	Gets the sign interpreters list.
(ZoomSDKError)	- addSignInterpreter:signLanguageId:
	Adds someone as a sign interpreter.
(ZoomSDKError)	- removeSignInterpreter:
	Removes someone from the list of sign interpreters.
(ZoomSDKError)	- modifySignInterpreter:signLanguageId:
	Modify the language of some sign interpreter.
(BOOL)	- canStartSignInterpretation
	Determines if I can start the sign interpretation in the meeting.
(ZoomSDKError)	- startSignInterpretation
	Starts sign interpretation.
(ZoomSDKError)	- stopSignInterpretation
	Stops sign interppretation.
(ZoomSDKError)	- requestSignLanguageInterpreterToTalk:allowToTalk:
	Host allow or disallow sign language interpreter to talk.
(BOOL)	- canSignLanguageInterpreterTalk:
	Determines if the sign language interpreter be allowed to talk.
(NSString *_Nullable)	- getSignInterpreterAssignedLanID
	Gets sign language ID if myself is a sign interpreter. Only for interpreter.
(ZoomSDKError)	- joinSignLanguageChannel:
	Join a sign language channel if myself is not a sign interpreter.
(ZoomSDKError)	- leaveSignLanguageChannel
	Off sign language if myself is not a sign interpreter.Only for non-interpreter. Available only for customized ui.

Properties
id< ZoomSDKSignInterpretationControllerDelegate >	delegate
	Delegate for receiving sign interpretation events.

Detailed Description

Manage sign interpretation status, interpreters, and available languages in a Zoom meeting.

Definition at line 99 of file ZoomSDKSignInterpretationController.h.

Method Documentation

addSignInterpreter:signLanguageId:

- (ZoomSDKError) addSignInterpreter:		(unsigned int)	userID
signLanguageId:		(NSString *)	signLanguageId

Adds someone as a sign interpreter.

Parameters

userID	The user’s ID.
signLanguageId	The sign language ID.

Returns

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

canSignLanguageInterpreterTalk:

- (BOOL) canSignLanguageInterpreterTalk:

(unsigned int)

userID

Determines if the sign language interpreter be allowed to talk.

Parameters

userID

The user's unique identity.

Returns

YES if allow to talk. Otherwise, NO.

canStartSignInterpretation

- (BOOL) canStartSignInterpretation

Determines if I can start the sign interpretation in the meeting.

getAllSupportedSignLanguageInfoList

- (NSArray< ZoomSDKSignInterpretationLanguageInfo * > *_Nullable) getAllSupportedSignLanguageInfoList

Gets all supported sign interpretation language list.

Returns

If the function succeeds, the return array contain support language object. Otherwise, this function fails and returns nil.

Note

Only available for host.

getAvailableSignLanguageInfoList

- (NSArray< ZoomSDKSignInterpretationLanguageInfo * > *) getAvailableSignLanguageInfoList

Gets the available sign interpretation language list.

Returns

If the function succeeds, the return array contain available language object. Otherwise, this function fails and returns nil.

getSignInterpretationLanguageInfoByID:

- (ZoomSDKSignInterpretationLanguageInfo *) getSignInterpretationLanguageInfoByID:

(NSString *)

signLanguageID

Gets the sign language object of the specified sign language ID.

Parameters

signLanguageID

Specify the sign language ID for which you want to get the information.

Returns

If the function succeeds, it returns ZoomSDKSignInterpretationLanguageInfo object. Otherwise, this function fails and returns nil.

getSignInterpretationStatus

- (ZoomSDKSignInterpretationStatus) getSignInterpretationStatus

Gets the sign interpretation status of current meeting.

Returns

The current meeting's sign interpretation status.

getSignInterpreterAssignedLanID

- (NSString *_Nullable) getSignInterpreterAssignedLanID

Gets sign language ID if myself is a sign interpreter. Only for interpreter.

Returns

If the function succeeds, it returns the current assigned sign language ID. Otherwise, this function fails and returns nil.

getSignInterpreterList

- (NSArray< ZoomSDKSignInterpreter * > *_Nullable) getSignInterpreterList

Gets the sign interpreters list.

Returns

If the function succeeds, the return array contain sign interpreter object. Otherwise, this function fails and returns nil.

isSignInterpretationEnabled

- (BOOL) isSignInterpretationEnabled

Determines if the sign interpretation function is enabled.

Returns

YES if sign interpretation function is enabled. Otherwise, NO.

isSignInterpreter

- (BOOL) isSignInterpreter

Determines if myself is interpreter.

Returns

YES if self is sign language interpreter. Otherwise, NO.

joinSignLanguageChannel:

- (ZoomSDKError) joinSignLanguageChannel:

(NSString *)

signLanguageId

Join a sign language channel if myself is not a sign interpreter.

Parameters

signLanguageId

Specify the sign language channel ID.

Returns

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

leaveSignLanguageChannel

- (ZoomSDKError) leaveSignLanguageChannel

Off sign language if myself is not a sign interpreter.Only for non-interpreter. Available only for customized ui.

Returns

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

modifySignInterpreter:signLanguageId:

- (ZoomSDKError) modifySignInterpreter:		(unsigned int)	userID
signLanguageId:		(NSString *)	signLanguageId

Modify the language of some sign interpreter.

Parameters

userID	The user's unique identity.
signLanguageId	The ID of sign language.

Returns

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

removeSignInterpreter:

- (ZoomSDKError) removeSignInterpreter:

(unsigned int)

userID

Removes someone from the list of sign interpreters.

Parameters

userID

Specify the user.

Returns

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

requestSignLanguageInterpreterToTalk:allowToTalk:

- (ZoomSDKError) requestSignLanguageInterpreterToTalk:		(unsigned int)	userID
allowToTalk:		(BOOL)	allowToTalk

Host allow or disallow sign language interpreter to talk.

Parameters

userID	The interpreter's user ID.
allowToTalk	YES indicates allow to talk, NO otherwise.

Returns

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

startSignInterpretation

- (ZoomSDKError) startSignInterpretation

Starts sign interpretation.

Returns

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

stopSignInterpretation

- (ZoomSDKError) stopSignInterpretation

Stops sign interppretation.

Returns

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

Property Documentation

delegate

- (id<ZoomSDKSignInterpretationControllerDelegate>) delegate

readwritenonatomicassign

Delegate for receiving sign interpretation events.

Definition at line 103 of file ZoomSDKSignInterpretationController.h.