macOS SDK API Reference
Loading...
Searching...
No Matches
Instance Methods | Properties
ZoomSDKSignInterpretationController Class Reference

#import <ZoomSDKSignInterpretationController.h>

Inherits NSObject.

Instance Methods

(BOOL) - isSignInterpretationEnabled
 Determine if the sign interpretation function is enabled.
 
(ZoomSDKSignInterpretationStatus) - getSignInterpretationStatus
 Get the sign interpretation status of current meeting.
 
(BOOL) - isSignInterpreter
 Determine if myself is interpreter.
 
(ZoomSDKSignInterpretationLanguageInfo *) - getSignInterpretationLanguageInfoByID:
 Get the sign language object of the specified sign language ID.
 
(NSArray< ZoomSDKSignInterpretationLanguageInfo * > *) - getAvailableSignLanguageInfoList
 Get the available sign interpretation language list.
 
(NSArray< ZoomSDKSignInterpretationLanguageInfo * > *) - getAllSupportedSignLanguageInfoList
 Get all supported sign interpretation language list.only for host.
 
(NSArray< ZoomSDKSignInterpreter * > *) - getSignInterpreterList
 Get the sign interpreters list.
 
(ZoomSDKError) - addSignInterpreter:signLanguageId:
 Add someone as a sign interpreter.
 
(ZoomSDKError) - removeSignInterpreter:
 Remove someone from the list of sign interpreters.
 
(ZoomSDKError) - modifySignInterpreter:signLanguageId:
 Modify the language of some sign interpreter.
 
(BOOL) - canStartSignInterpretation
 Determine if I can start the sign interpretation in the meeting.
 
(ZoomSDKError) - startSignInterpretation
 Start sign interpretation.
 
(ZoomSDKError) - stopSignInterpretation
 Stop sign interppretation.
 
(ZoomSDKError) - requestSignLanuageInterpreterToTalk:allowToTalk:
 Host allow sign language interpreter to talk.
 
(BOOL) - canSignLanguageInterpreterTalk:
 Determine if the sign language interpreter be allowed to talk.
 
(NSString *) - getSignInterpreterAssignedLanID
 Get 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
 

Detailed Description

Definition at line 85 of file ZoomSDKSignInterpretationController.h.

Method Documentation

◆ addSignInterpreter:signLanguageId:

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

Add someone as a sign interpreter.

Parameters
userIDThe user’s ID.
signLanguageIdThe sign language ID.
Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.To get extended error information, see ZoomSDKError.

◆ canSignLanguageInterpreterTalk:

- (BOOL) canSignLanguageInterpreterTalk: (unsigned int)  userID

Determine if the sign language interpreter be allowed to talk.

Parameters
userIDThe unique identity of the user.
Returns
YES indicates to allow to talk, otherwise not.

◆ canStartSignInterpretation

- (BOOL) canStartSignInterpretation

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

◆ getAllSupportedSignLanguageInfoList

- (NSArray< ZoomSDKSignInterpretationLanguageInfo * > *) getAllSupportedSignLanguageInfoList

Get all supported sign interpretation language list.only for host.

Returns
If the function succeeds, the return array contain support language object.

◆ getAvailableSignLanguageInfoList

- (NSArray< ZoomSDKSignInterpretationLanguageInfo * > *) getAvailableSignLanguageInfoList

Get the available sign interpretation language list.

Returns
If the function succeeds, the return array contain available language object.

◆ getSignInterpretationLanguageInfoByID:

- (ZoomSDKSignInterpretationLanguageInfo *) getSignInterpretationLanguageInfoByID: (NSString *)  signLanguageID

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

Parameters
signLanguageIDSpecify the sign language ID for which you want to get the information.
Returns
If the function succeeds, the return value is ZoomSDKSignInterpretationLanguageInfo object.

◆ getSignInterpretationStatus

- (ZoomSDKSignInterpretationStatus) getSignInterpretationStatus

Get the sign interpretation status of current meeting.

Returns
If the function succeeds, the return value is the current meeting’s sign interpretation status.For more details, see ZoomSDKSignInterpretationStatus.

◆ getSignInterpreterAssignedLanID

- (NSString *) getSignInterpreterAssignedLanID

Get sign language id if myself is a sign interpreter.Only for interpreter.

Returns
If the function succeeds, the return value is the current assigned sign language id, otherwise not.

◆ getSignInterpreterList

- (NSArray< ZoomSDKSignInterpreter * > *) getSignInterpreterList

Get the sign interpreters list.

Returns
If the function succeeds, the return array contain sign interpreter object.

◆ isSignInterpretationEnabled

- (BOOL) isSignInterpretationEnabled

Determine if the sign interpretation function is enabled.

Returns
YES means sign interpretation function is enabled, otherwise it returns NO.

◆ isSignInterpreter

- (BOOL) isSignInterpreter

Determine if myself is interpreter.

Returns
YES means self is sign language interpreter, otherwise not.

◆ joinSignLanguageChannel:

- (ZoomSDKError) joinSignLanguageChannel: (NSString *)  signLanguageId

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

Parameters
signLanguageIdSpecify the sign language channel ID.
Returns
If the function succeeds, it will return ZoomSDKError_succuss, otherwise not.

◆ 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 will return ZoomSDKError_succuss, otherwise not.

◆ modifySignInterpreter:signLanguageId:

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

Modify the language of some sign interpreter.

Parameters
userIDThe unique identity of the user.
signLanguageIdThe id of sign language.
Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.To get extended error information, see ZoomSDKError.

◆ removeSignInterpreter:

- (ZoomSDKError) removeSignInterpreter: (unsigned int)  userID

Remove someone from the list of sign interpreters.

Parameters
userIDSpecify the user.
Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.To get extended error information, see ZoomSDKError.

◆ requestSignLanuageInterpreterToTalk:allowToTalk:

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

Host allow sign language interpreter to talk.

Parameters
userIDThe user’s ID.
allowToTalkYES indicates allow to talk, otherwise false.
Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.To get extended error information, see ZoomSDKError.

◆ startSignInterpretation

- (ZoomSDKError) startSignInterpretation

Start sign interpretation.

Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.To get extended error information, see ZoomSDKError.

◆ stopSignInterpretation

- (ZoomSDKError) stopSignInterpretation

Stop sign interppretation.

Returns
If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.To get extended error information, see ZoomSDKError.

Property Documentation

◆ delegate

- (id<ZoomSDKSignInterpretationControllerDelegate>) delegate
readwritenonatomicassign

Definition at line 86 of file ZoomSDKSignInterpretationController.h.