ZoomSDKCloseCaptionController Class Reference

Inheritance diagram for ZoomSDKCloseCaptionController:

Instance Methods
(BOOL)	- isMeetingSupportCloseCaption
	Query if Close Caption is supported in the current meeting. More...
(BOOL)	- canAssignOthersToSendCC
	Query if it is able to assign others to send Close Caption. More...
(BOOL)	- canBeAssignedToSendCC:
	Query if the specified user can be assigned to send close caption. More...
(BOOL)	- canSendClosedCaption
	Query if the current user can send Close Caption. More...
(BOOL)	- isCanSaveClosedCaption
	Query if user can save Close Caption. More...
(BOOL)	- is3rdPartCCServerAvailable
	Query if the third party close caption server is available. More...
(ZoomSDKError)	- withdrawCCPriviledgeForUser:
	This method is used for host to withdraw CC privilege from another user. More...
(ZoomSDKError)	- assignCCPriviledgeTo:
	This method is used for host to assign CC privilege to another user. More...
(ZoomSDKError)	- sendClosedCaptionMessage:
	Send CC message. More...
(ZoomSDKError)	- saveCCHistory
	Save CC. More...
(NSString *)	- getClosedCaptionHistorySavedPath
	Get the path where the CC is saved. More...
(ZoomSDKError)	- getClosedCaptionUrlFor3rdParty:
	Get the third party URL which is used to input CC. More...

Protected Attributes
id< ZoomSDKCloseCaptionControllerDelegate >	_delegate

Properties
id< ZoomSDKCloseCaptionControllerDelegate >	delegate

Method Documentation

assignCCPriviledgeTo:

- (ZoomSDKError) assignCCPriviledgeTo:

(unsigned int)

userID

This method is used for host to assign CC privilege to another user.

Parameters

userId

The ID of user whom you want to assign CC privilege to.

Returns

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

canAssignOthersToSendCC

- (BOOL) canAssignOthersToSendCC

Query if it is able to assign others to send Close Caption.

Returns

YES means able, otherwise not.

canBeAssignedToSendCC:

- (BOOL) canBeAssignedToSendCC:

(unsigned int)

userID

Query if the specified user can be assigned to send close caption.

Parameters

userID

The ID of user who you want to assign to send close caption

Returns

YES means able, otherwise not.

canSendClosedCaption

- (BOOL) canSendClosedCaption

Query if the current user can send Close Caption.

Returns

YES means able, otherwise not.

getClosedCaptionHistorySavedPath

- (NSString*) getClosedCaptionHistorySavedPath

Get the path where the CC is saved.

Returns

If the function succeeds, it will return a NSString. Otherwise failed.

getClosedCaptionUrlFor3rdParty:

- (ZoomSDKError) getClosedCaptionUrlFor3rdParty:

(NSString **)

thirdPartyURL

Get the third party URL which is used to input CC.

Parameters

thirdPartyURL

The URL of the third party service.

Returns

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

is3rdPartCCServerAvailable

- (BOOL) is3rdPartCCServerAvailable

Query if the third party close caption server is available.

Returns

YES means available, otherwise not.

isCanSaveClosedCaption

- (BOOL) isCanSaveClosedCaption

Query if user can save Close Caption.

Returns

YES means able, otherwise not.

isMeetingSupportCloseCaption

- (BOOL) isMeetingSupportCloseCaption

Query if Close Caption is supported in the current meeting.

Returns

YES means supported, otherwise not.

saveCCHistory

- (ZoomSDKError) saveCCHistory

Save CC.

Returns

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

sendClosedCaptionMessage:

- (ZoomSDKError) sendClosedCaptionMessage:

(NSString *)

ccString

Send CC message.

Parameters

ccString

The content of CC.

Returns

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

withdrawCCPriviledgeForUser:

- (ZoomSDKError) withdrawCCPriviledgeForUser:

(unsigned int)

userID

This method is used for host to withdraw CC privilege from another user.

Parameters

userId

The ID of user that you want to withdraw CC privilege.

Returns

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

---

The documentation for this class was generated from the following file:

• ZoomSDKCloseCaptionController.h