Controller interface to manage closed captions and live transcription in meetings. More...

#include <ZoomSDKCloseCaptionController.h>

Inherits NSObject.

Instance Methods
(BOOL)	- isMeetingSupportCloseCaption
	Query if Close Caption is supported in the current meeting.

(BOOL)	- canAssignOthersToSendCC
	Query if it is able to assign others to send Close Caption.

(BOOL)	- canBeAssignedToSendCC:
	Query if the specified user can be assigned to send close caption.

(BOOL)	- canSendClosedCaption
	Query if the current user can send Close Caption.

(BOOL)	- isCanSaveClosedCaption
	Query if user can save Close Caption.

(BOOL)	- is3rdPartCCServerAvailable
	Query if the third party close caption server is available.

(ZoomSDKError)	- withdrawCCPrivilegeForUser:
	Withdraws CC privilege from another user (host only).

(ZoomSDKError)	- assignCCPrivilegeTo:
	Assigns CC privilege to another user (host only).

(ZoomSDKError)	- sendClosedCaptionMessage:
	Sends CC message.

(ZoomSDKError)	- saveCCHistory
	Saves CC.

(NSString *)	- getClosedCaptionHistorySavedPath
	Gets the path where the CC is saved.

(ZoomSDKError)	- getClosedCaptionUrlFor3rdParty:
	Gets the third party URL for inputting CC.

(BOOL)	- isLiveTranscriptLegalNoticeAvailable
	Determines whether the legal notice for Live transcript is available.

(NSString *)	- getLiveTranscriptLegalNoticesPrompt
	Gets the CC legal notices prompt.

(NSString *)	- getLiveTranscriptLegalNoticesExplained
	Gets the CC legal notices explained.

(BOOL)	- isLiveTranscriptionFeatureEnabled
	Determines whether the live transcription feature is enabled.

(BOOL)	- isMultiLanguageTranscriptionEnabled
	Determines whether the multi-language transcription feature is enabled.

(BOOL)	- isTextLiveTranslationEnabled
	Determines whether the translated captions feature is enabled.

(ZoomSDKLiveTranscriptionStaus)	- getLiveTranscriptionStatus
	Query the status of live transcription.

(ZoomSDKError)	- canStartLiveTranscription
	Query if it is able to start live transcription.

(ZoomSDKError)	- startLiveTranscription
	Starts live transcription.

(ZoomSDKError)	- stopLiveTranscription
	Stops live transcription.

(ZoomSDKError)	- enableRequestLiveTranscription:
	Enables or disable the ability for attendees to request live transcriptions.

(ZoomSDKError)	- isRequestToStartLiveTranscriptionEnabled
	Determines whether the request to start live transcription is enabled.

(ZoomSDKError)	- requestToStartLiveTranscription:
	Request the host to start ive transcription.

(ZoomSDKError)	- enableMeetingManualCaption:
	Enables or disable manual captions for the meeting.

(BOOL)	- isMeetingManualCaptionEnabled
	Determines whether manually added closed captions are enabled for the meeting.

(NSArray< ZoomSDKLiveTranscriptionLanguage * > *)	- getAvailableMeetingSpokenLanguages
	Gets the list of all available spoken languages in a meeting.

(ZoomSDKError)	- setMeetingSpokenLanguage:
	Sets the spoken language.

(ZoomSDKError)	- setMeetingSpokenLanguage:isForAll:
	Sets the spoken language.

(ZoomSDKLiveTranscriptionLanguage *)	- getMeetingSpokenLanguage
	Gets the current user's spoken language.

(NSArray< ZoomSDKLiveTranscriptionLanguage * > *)	- getAvailableTranslationLanguages
	Gets the list of all available translation languages in a meeting.

(ZoomSDKError)	- setTranslationLanguage:
	Sets the current user's translation language.

(ZoomSDKLiveTranscriptionLanguage *)	- getTranslationLanguage
	Gets the current user's translation language.

(ZoomSDKError)	- enableReceiveSpokenLanguageContent:
	Enables or disable to receive original and translated content.If enable this feature,you need start live transcription.

(BOOL)	- isReceiveSpokenLanguageContentEnabled
	Determines whether receive original and translated is available.

(BOOL)	- canDisableCaptions
	Query if the user can disable captions.

(ZoomSDKError)	- enableCaptions:
	Enables or disable captions.

(BOOL)	- isCaptionsEnabled
	Query if the captions enabled.

(BOOL)	- isSupportRequestCaptions
	Determines whether users can request to start captions.

(BOOL)	- isSupportTranslationWhenRequestToStartCaptions
	Determines whether support translation when users request to start captions.

(ZoomSDKError)	- requestToStartCaptions:
	Request the host to start captions. If the host approves your request, you receive the callback ZoomSDKCloseCaptionControllerDelegate::onStartCaptionsRequestApproved, and you should start captions or translation there.

Protected Attributes
id< ZoomSDKCloseCaptionControllerDelegate >	_delegate

Properties
id< ZoomSDKCloseCaptionControllerDelegate >	delegate
	The delegate to receive closed caption events.

Detailed Description

Controller interface to manage closed captions and live transcription in meetings.

Definition at line 219 of file ZoomSDKCloseCaptionController.h.

Method Documentation

◆ assignCCPrivilegeTo:

- (ZoomSDKError) assignCCPrivilegeTo: (unsigned int) userID

Assigns CC privilege to another user (host only).

Parameters

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

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

◆ canAssignOthersToSendCC

- (BOOL) canAssignOthersToSendCC

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

Returns: YES if able. Otherwise, NO.

◆ 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 if able. Otherwise, NO.

◆ canDisableCaptions

- (BOOL) canDisableCaptions

Query if the user can disable captions.

Returns: YES if the host can disable captions. Otherwise, NO.

◆ canSendClosedCaption

- (BOOL) canSendClosedCaption

Query if the current user can send Close Caption.

Returns: YES if able. Otherwise, NO.

◆ canStartLiveTranscription

- (ZoomSDKError) canStartLiveTranscription

Query if it is able to start live transcription.

Returns: ZoomSDKError_Success means able. Otherwise, this function returns an error.

◆ enableCaptions:

- (ZoomSDKError) enableCaptions: (BOOL) enable

Enables or disable captions.

Parameters

enable YES if captions are enabled, NO if captions are disabled.

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

◆ enableMeetingManualCaption:

- (ZoomSDKError) enableMeetingManualCaption: (BOOL) bEnable

Enables or disable manual captions for the meeting.

Parameters

bEnable YES to enable, NO otherwise.

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

◆ enableReceiveSpokenLanguageContent:

- (ZoomSDKError) enableReceiveSpokenLanguageContent: (BOOL) enable

Enables or disable to receive original and translated content.If enable this feature,you need start live transcription.

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

◆ enableRequestLiveTranscription:

- (ZoomSDKError) enableRequestLiveTranscription: (BOOL) bEnable

Enables or disable the ability for attendees to request live transcriptions.

Parameters

bEnable YES to enable, NO otherwise.

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

Note: If the meeting allows multi- language transcription, it returns ZoomSDKError_WrongUsage.

◆ getAvailableMeetingSpokenLanguages

- (NSArray< ZoomSDKLiveTranscriptionLanguage * > *) getAvailableMeetingSpokenLanguages

Gets the list of all available spoken languages in a meeting.

Returns: If the function succeeds, it returns an array contains the available spoken languages in a meeting. Otherwise, this function fails and returns nil.

◆ getAvailableTranslationLanguages

- (NSArray< ZoomSDKLiveTranscriptionLanguage * > *) getAvailableTranslationLanguages

Gets the list of all available translation languages in a meeting.

Returns: If the function succeeds, it returns an array contains all available translation languages in a meeting. Otherwise, this function fails and returns nil.

◆ getClosedCaptionHistorySavedPath

- (NSString *) getClosedCaptionHistorySavedPath

Gets the path where the CC is saved.

Returns: If the function succeeds, it returns a NSString. Otherwise, this function fails and returns nil.

◆ getClosedCaptionUrlFor3rdParty:

- (ZoomSDKError) getClosedCaptionUrlFor3rdParty: (NSString *_Nullable *_Nonnull) thirdPartyURL

Gets the third party URL for inputting CC.

Parameters

thirdPartyURL The third party service's URL.

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

◆ getLiveTranscriptionStatus

- (ZoomSDKLiveTranscriptionStaus) getLiveTranscriptionStatus

Query the status of live transcription.

Returns: The status of live transcription with type ZoomSDKLiveTranscriptionStaus.

◆ getLiveTranscriptLegalNoticesExplained

- (NSString *) getLiveTranscriptLegalNoticesExplained

Gets the CC legal notices explained.

Returns: If the function succeeds, it returns the CC legal notices explained. Otherwise, this function fails and returns nil.

◆ getLiveTranscriptLegalNoticesPrompt

- (NSString *) getLiveTranscriptLegalNoticesPrompt

Gets the CC legal notices prompt.

Returns: If the function succeeds, it returns the CC legal notices prompt. Otherwise, this function fails and returns nil.

◆ getMeetingSpokenLanguage

- (ZoomSDKLiveTranscriptionLanguage *) getMeetingSpokenLanguage

Gets the current user's spoken language.

Returns: If the function succeeds, it will an object of ZoomSDKLiveTranscriptionLanguage. Otherwise, this function fails and returns nil.

◆ getTranslationLanguage

- (ZoomSDKLiveTranscriptionLanguage *) getTranslationLanguage

Gets the current user's translation language.

Returns: If the function succeeds, it will an object of ZoomSDKLiveTranscriptionLanguage. Otherwise, this function fails and returns nil.

◆ is3rdPartCCServerAvailable

- (BOOL) is3rdPartCCServerAvailable

Query if the third party close caption server is available.

Returns: YES if available. Otherwise, NO.

◆ isCanSaveClosedCaption

- (BOOL) isCanSaveClosedCaption

Query if user can save Close Caption.

Returns: YES if able. Otherwise, NO.

◆ isCaptionsEnabled

- (BOOL) isCaptionsEnabled

Query if the captions enabled.

Returns: YES if captions are enabled. Otherwise, NO.

◆ isLiveTranscriptionFeatureEnabled

- (BOOL) isLiveTranscriptionFeatureEnabled

Determines whether the live transcription feature is enabled.

Returns: YES if enabled. Otherwise, NO.

◆ isLiveTranscriptLegalNoticeAvailable

- (BOOL) isLiveTranscriptLegalNoticeAvailable

Determines whether the legal notice for Live transcript is available.

Returns: YES if the legal notice for Live transcript is available. Otherwise, NO.

◆ isMeetingManualCaptionEnabled

- (BOOL) isMeetingManualCaptionEnabled

Determines whether manually added closed captions are enabled for the meeting.

Returns: YES if enabled. Otherwise, NO.

◆ isMeetingSupportCloseCaption

- (BOOL) isMeetingSupportCloseCaption

Query if Close Caption is supported in the current meeting.

Returns: YES if supported. Otherwise, NO.

◆ isMultiLanguageTranscriptionEnabled

- (BOOL) isMultiLanguageTranscriptionEnabled

Determines whether the multi-language transcription feature is enabled.

Returns: YES if enabled. Otherwise, NO.

◆ isReceiveSpokenLanguageContentEnabled

- (BOOL) isReceiveSpokenLanguageContentEnabled

Determines whether receive original and translated is available.

Returns: YES if receive original and translated is available. Otherwise, NO.

◆ isRequestToStartLiveTranscriptionEnabled

- (ZoomSDKError) isRequestToStartLiveTranscriptionEnabled

Determines whether the request to start live transcription is enabled.

Returns: ZoomSDKError_Success means enabled. Otherwise, this function returns an error.

Note: If the meeting allows multi-language transcription, it returns ZoomSDKError_WrongUsage.

◆ isSupportRequestCaptions

- (BOOL) isSupportRequestCaptions

Determines whether users can request to start captions.

Returns: YES if users can request to start captions. Otherwise, NO.

◆ isSupportTranslationWhenRequestToStartCaptions

- (BOOL) isSupportTranslationWhenRequestToStartCaptions

Determines whether support translation when users request to start captions.

Returns: YES if translation is available when users request to start captions. Otherwise, NO.

◆ isTextLiveTranslationEnabled

- (BOOL) isTextLiveTranslationEnabled

Determines whether the translated captions feature is enabled.

Returns: YES if enabled. Otherwise, NO.

◆ requestToStartCaptions:

- (ZoomSDKError) requestToStartCaptions: (BOOL) enableTranslation

Request the host to start captions. If the host approves your request, you receive the callback ZoomSDKCloseCaptionControllerDelegate::onStartCaptionsRequestApproved, and you should start captions or translation there.

Parameters

enableTranslation YES indicates to enable translation at the same time, NO to disable.

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

◆ requestToStartLiveTranscription:

- (ZoomSDKError) requestToStartLiveTranscription: (BOOL) bAnonymous

Request the host to start ive transcription.

Parameters

bAnonymous YES indicates the user anonymous request, NO otherwise.

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

Note: If the meeting allows multi-language transcription, it returns ZoomSDKError_WrongUsage.

◆ saveCCHistory

- (ZoomSDKError) saveCCHistory

Saves CC.

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

◆ sendClosedCaptionMessage:

- (ZoomSDKError) sendClosedCaptionMessage: (NSString *) ccString

Sends CC message.

Parameters

ccString The content of CC.

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

◆ setMeetingSpokenLanguage:

- (ZoomSDKError) setMeetingSpokenLanguage: (int) languageID

Sets the spoken language.

Parameters

languageID The spoken language ID.

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

Deprecated: Use ZoomSDKCloseCaptionController::setMeetingSpokenLanguage:isForAll: instead.

◆ setMeetingSpokenLanguage:isForAll:

- (ZoomSDKError) setMeetingSpokenLanguage:		(int)	languageID
isForAll:		(BOOL)	isForAll

Sets the spoken language.

Parameters

languageID	The spoken language ID.
isForAll	YES to set spoken language for all users, NO to set the language only for myself.

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

◆ setTranslationLanguage:

- (ZoomSDKError) setTranslationLanguage: (int) languageID

Sets the current user's translation language.

Parameters

languageID The translation language ID. If the language ID is set to -1, live translation will be disabled. You can reveive closed captions if the host sets manual captions to YES for the meeting, NO otherwise.

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

◆ startLiveTranscription

- (ZoomSDKError) startLiveTranscription

Starts live transcription.

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

Note: If the meeting allows multi- language transcription, all users can start live transcription. Otherwise, only the host can start it.

◆ stopLiveTranscription

- (ZoomSDKError) stopLiveTranscription

Stops live transcription.

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

Note: If the meeting allows multi- language transcription, all users can stop live transcription. Otherwise only the host can stop it.

◆ withdrawCCPrivilegeForUser:

- (ZoomSDKError) withdrawCCPrivilegeForUser: (unsigned int) userID

Withdraws CC privilege from another user (host only).

Parameters

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

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

Field Documentation

◆ _delegate

- (id<ZoomSDKCloseCaptionControllerDelegate>) _delegate

protected

Definition at line 221 of file ZoomSDKCloseCaptionController.h.

Property Documentation

◆ delegate

- (id<ZoomSDKCloseCaptionControllerDelegate>) delegate

readwritenonatomicassign

The delegate to receive closed caption events.

Definition at line 227 of file ZoomSDKCloseCaptionController.h.

Instance Methods

Protected Attributes

Properties

Detailed Description

Method Documentation

◆ assignCCPrivilegeTo:

◆ canAssignOthersToSendCC

◆ canBeAssignedToSendCC:

◆ canDisableCaptions

◆ canSendClosedCaption

◆ canStartLiveTranscription

◆ enableCaptions:

◆ enableMeetingManualCaption:

◆ enableReceiveSpokenLanguageContent:

◆ enableRequestLiveTranscription:

◆ getAvailableMeetingSpokenLanguages

◆ getAvailableTranslationLanguages

◆ getClosedCaptionHistorySavedPath

◆ getClosedCaptionUrlFor3rdParty:

◆ getLiveTranscriptionStatus

◆ getLiveTranscriptLegalNoticesExplained

◆ getLiveTranscriptLegalNoticesPrompt

◆ getMeetingSpokenLanguage

◆ getTranslationLanguage

◆ is3rdPartCCServerAvailable

◆ isCanSaveClosedCaption

◆ isCaptionsEnabled

◆ isLiveTranscriptionFeatureEnabled

◆ isLiveTranscriptLegalNoticeAvailable

◆ isMeetingManualCaptionEnabled

◆ isMeetingSupportCloseCaption

◆ isMultiLanguageTranscriptionEnabled

◆ isReceiveSpokenLanguageContentEnabled

◆ isRequestToStartLiveTranscriptionEnabled

◆ isSupportRequestCaptions

◆ isSupportTranslationWhenRequestToStartCaptions

◆ isTextLiveTranslationEnabled

◆ requestToStartCaptions:

◆ requestToStartLiveTranscription:

◆ saveCCHistory

◆ sendClosedCaptionMessage:

◆ setMeetingSpokenLanguage:

◆ setMeetingSpokenLanguage:isForAll:

◆ setTranslationLanguage:

◆ startLiveTranscription

◆ stopLiveTranscription

◆ withdrawCCPrivilegeForUser:

Field Documentation

◆ _delegate

Property Documentation

◆ delegate