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:
	This method is used for host to withdraw CC privilege from another user.

(ZoomSDKError)	- assignCCPrivilegeTo:
	This method is used for host to assign CC privilege to another user.

(ZoomSDKError)	- sendClosedCaptionMessage:
	Send CC message.

(ZoomSDKError)	- saveCCHistory
	Save CC.

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

(ZoomSDKError)	- getClosedCaptionUrlFor3rdParty:
	Get the third party URL which is used to input CC.

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

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

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

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

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

(BOOL)	- isTextLiveTranslationEnabled
	Determine 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
	Start live transcription.

(ZoomSDKError)	- stopLiveTranscription
	Stop live transcription.

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

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

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

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

(BOOL)	- isMeetingManualCaptionEnabled
	Determine whether manually added closed captions is enabled for the meeting.

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

(ZoomSDKError)	- setMeetingSpokenLanguage:
	Set the spoken language.

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

(ZoomSDKLiveTranscriptionLanguage *)	- getMeetingSpokenLanguage
	Get the spoken language of the current user.

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

(ZoomSDKError)	- setTranslationLanguage:
	Set the translation language of the current user.

(ZoomSDKLiveTranscriptionLanguage *)	- getTranslationLanguage
	Get the translation language of the current user.

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

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

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

(ZoomSDKError)	- enableCaptions:
	Enable or disable captions.

(BOOL)	- isCaptionsEnabled
	Query if the captions enabled.

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

(BOOL)	- isSupportTranslationWhenRequestToStartCaptions
	Determine 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

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.

◆ canDisableCaptions

- (BOOL) canDisableCaptions

Query if the user can disable captions.

Returns: YES means that the host can disable captions.

◆ canSendClosedCaption

- (BOOL) canSendClosedCaption

Query if the current user can send Close Caption.

Returns: YES means able, otherwise not.

◆ canStartLiveTranscription

- (ZoomSDKError) canStartLiveTranscription

Query if it is able to start live transcription.

Returns: ZoomSDKError_Success means able, otherwise not.

◆ enableCaptions:

- (ZoomSDKError) enableCaptions: (BOOL) enable

Enable or disable captions.

Parameters

enable YES means that captions are enabled; NO means that captions are disabled.

Returns: If the function succeeds, the return value is ZoomSDKError_Success. Otherwise the function returns an error.

◆ enableMeetingManualCaption:

- (ZoomSDKError) enableMeetingManualCaption: (BOOL) bEnable

Enable or disable manual captions for the meeting.

Parameters

bEnable YES means enable, otherwise not.

Returns: If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ enableReceiveSpokenLanguageContent:

- (ZoomSDKError) enableReceiveSpokenLanguageContent: (BOOL) enable

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

Returns: If the function succeeds, the return value is ZoomSDKError_Success. Otherwise not.

◆ enableRequestLiveTranscription:

- (ZoomSDKError) enableRequestLiveTranscription: (BOOL) bEnable

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

Parameters

bEnable YES means enable, otherwise not.

Returns: If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

Note: If the meeting allows multi- language transcription, the return value is ZoomSDKError_WrongUsage.

◆ getAvailableMeetingSpokenLanguages

- (NSArray< ZoomSDKLiveTranscriptionLanguage * > *) getAvailableMeetingSpokenLanguages

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

Returns: If the function succeeds, it will return an array contains the available spoken languages in a meeting, otherwise nil.

◆ getAvailableTranslationLanguages

- (NSArray< ZoomSDKLiveTranscriptionLanguage * > *) getAvailableTranslationLanguages

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

Returns: If the function succeeds, it will return an array contains all available translation languages in a meeting, otherwise nil.

◆ 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 *_Nullable *_Nonnull) 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.

◆ getLiveTranscriptionStatus

- (ZoomSDKLiveTranscriptionStaus) getLiveTranscriptionStatus

Query the status of live transcription.

Returns: If the function succeeds, it will return the status of live transcription with type ZoomSDKLiveTranscriptionStaus.

◆ getLiveTranscriptLegalNoticesExplained

- (NSString *) getLiveTranscriptLegalNoticesExplained

Get the CC legal notices explained.

Returns: If the function succeeds, it will return the CC legal notices explained, otherwise nil.

◆ getLiveTranscriptLegalNoticesPrompt

- (NSString *) getLiveTranscriptLegalNoticesPrompt

Get the CC legal notices prompt.

Returns: If the function succeeds, it will return the CC legal notices prompt, otherwise nil.

◆ getMeetingSpokenLanguage

- (ZoomSDKLiveTranscriptionLanguage *) getMeetingSpokenLanguage

Get the spoken language of the current user.

Returns: If the function succeeds, it will an object of ZoomSDKLiveTranscriptionLanguage, otherwise nil.

◆ getTranslationLanguage

- (ZoomSDKLiveTranscriptionLanguage *) getTranslationLanguage

Get the translation language of the current user.

Returns: If the function succeeds, it will an object of ZoomSDKLiveTranscriptionLanguage, otherwise nil.

◆ 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.

◆ isCaptionsEnabled

- (BOOL) isCaptionsEnabled

Query if the captions enabled.

Returns: YES means that captions are enabled.

◆ isLiveTranscriptionFeatureEnabled

- (BOOL) isLiveTranscriptionFeatureEnabled

Determine whether the live transcription feature is enabled.

Returns: YES means enabled, otherwise not.

◆ isLiveTranscriptLegalNoticeAvailable

- (BOOL) isLiveTranscriptLegalNoticeAvailable

Determine whether the legal notice for Live transcript is available.

Returns: YES indicates the legal notice for Live transcript is available., otherwise not.

◆ isMeetingManualCaptionEnabled

- (BOOL) isMeetingManualCaptionEnabled

Determine whether manually added closed captions is enabled for the meeting.

Returns: YES means enabled, otherwise not.

◆ isMeetingSupportCloseCaption

- (BOOL) isMeetingSupportCloseCaption

Query if Close Caption is supported in the current meeting.

Returns: YES means supported, otherwise not.

◆ isMultiLanguageTranscriptionEnabled

- (BOOL) isMultiLanguageTranscriptionEnabled

Determine whether the multi-language transcription feature is enabled.

Returns: YES means enabled, otherwise not.

◆ isReceiveSpokenLanguageContentEnabled

- (BOOL) isReceiveSpokenLanguageContentEnabled

Determine whether receive original and translated is available.

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

◆ isRequestToStartLiveTranscriptionEnabled

- (ZoomSDKError) isRequestToStartLiveTranscriptionEnabled

Determine whether the request to start live transcription is enabled.

Returns: ZoomSDKError_Success means enabled, otherwise not.

Note: If the meeting allows multi-language transcription, the return value is ZoomSDKError_WrongUsage.

◆ isSupportRequestCaptions

- (BOOL) isSupportRequestCaptions

Determine whether users can request to start captions.

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

◆ isSupportTranslationWhenRequestToStartCaptions

- (BOOL) isSupportTranslationWhenRequestToStartCaptions

Determine whether support translation when users request to start captions.

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

◆ isTextLiveTranslationEnabled

- (BOOL) isTextLiveTranslationEnabled

Determine whether the translated captions feature is enabled.

Returns: YES means enabled, otherwise not.

◆ 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.

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

◆ requestToStartLiveTranscription:

- (ZoomSDKError) requestToStartLiveTranscription: (BOOL) bAnonymous

Request the host to start ive transcription.

Parameters

bAnonymous YES indicates the user anonymous request.

Returns: If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

Note: If the meeting allows multi-language transcription, the return value is ZoomSDKError_WrongUsage.

◆ 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.

◆ setMeetingSpokenLanguage:

- (ZoomSDKError) setMeetingSpokenLanguage: (int) languageID

Set the spoken language.

Parameters

languageID The spoken language ID.

Returns: If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

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

◆ setMeetingSpokenLanguage:isForAll:

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

Set the spoken language.

Parameters

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

Returns: If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ setTranslationLanguage:

- (ZoomSDKError) setTranslationLanguage: (int) languageID

Set the translation language of the current user.

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.

Returns: If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

◆ startLiveTranscription

- (ZoomSDKError) startLiveTranscription

Start live transcription.

Returns: If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

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

◆ stopLiveTranscription

- (ZoomSDKError) stopLiveTranscription

Stop live transcription.

Returns: If the function succeeds, it will return ZoomSDKError_Success, otherwise not.

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

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.

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