Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
<ZoomSDKCloseCaptionControllerDelegate> Protocol Reference

Delegate protocol to receive closed caption and live transcription related events. More...

#include <ZoomSDKCloseCaptionController.h>

Inherits <NSObjectNSObject>.

Instance Methods

(void) - onGetCCPrivilege
 Callback of getting the privilege of close caption.
 
(void) - onLostCCPrivilege
 Callback of losing privilege of close caption.
 
(void) - onReceiveCCMessageWithString:senderID:
 Notify the current user that close caption is received.
 
(void) - onReceiveCCRealtimeMessage:
 Notify the current user of realtime message.
 
(void) - onLiveTranscriptionStatus:
 Notify the live transcription status changed.
 
(void) - onLiveTranscriptionMsgInfoReceived:
 Callback: Invoked when a live transcription message is received.
 
(void) - onOriginalLanguageMsgReceived:
 Callback: Original language message received callback.
 
(void) - onLiveTranscriptionMsgError:transcriptLanguage:
 The translation message error callback.
 
(void) - onRequestForLiveTranscriptReceived:anonymous:
 Notify the request for live transcript received.
 
(void) - onRequestLiveTranscriptionStatusChange:
 Notify the request for live transcript status changed.
 
(void) - onCaptionStatusChanged:
 Sink the event of captions enabled status changed.
 
(void) - onStartCaptionsRequestReceived:
 Sink the event to start captions request.
 
(void) - onStartCaptionsRequestApproved
 Sink the event to start captions request was approved.
 
(void) - onManualCaptionStatusChanged:
 Sink the event of manual captions enablement status change.
 
(void) - onSpokenLanguageChanged:
 Callback when the spoken language is changed.
 

Detailed Description

Delegate protocol to receive closed caption and live transcription related events.

Definition at line 118 of file ZoomSDKCloseCaptionController.h.

Method Documentation

◆ onCaptionStatusChanged:

- (void) onCaptionStatusChanged: (BOOL) enable
optionalrequired

Sink the event of captions enabled status changed.

Parameters
enableYES means the host enables the captions, otherwise means the host disables the captions.

◆ onGetCCPrivilege

- (void) onGetCCPrivilege
optional

Callback of getting the privilege of close caption.

◆ onLiveTranscriptionMsgError:transcriptLanguage:

- (void) onLiveTranscriptionMsgError: (ZoomSDKLiveTranscriptionLanguage *_Nullable) spokenLanguage
transcriptLanguage: (ZoomSDKLiveTranscriptionLanguage *_Nullable) transcriptLanguage 
optionalrequired

The translation message error callback.

Parameters
spokenLanguageAn object of the spoken message language.
transcriptLanguageAn object of the message language you want to translate.

◆ onLiveTranscriptionMsgInfoReceived:

- (void) onLiveTranscriptionMsgInfoReceived: (ZoomSDKLiveTranscriptionMessageInfo *_Nullable) messageInfo
optionalrequired

Callback: Invoked when a live transcription message is received.

Parameters
messageInfoThe live transcription message.

◆ onLiveTranscriptionStatus:

- (void) onLiveTranscriptionStatus: (ZoomSDKLiveTranscriptionStaus) status
optionalrequired

Notify the live transcription status changed.

Parameters
statusThe type of live transcription status.

◆ onLostCCPrivilege

- (void) onLostCCPrivilege
optionalrequired

Callback of losing privilege of close caption.

◆ onManualCaptionStatusChanged:

- (void) onManualCaptionStatusChanged: (BOOL) bEnabled
optionalrequired

Sink the event of manual captions enablement status change.

Parameters
bEnabledYES means the host enableds the manual captions. Otherwise, the host disabled the manual captions.

◆ onOriginalLanguageMsgReceived:

- (void) onOriginalLanguageMsgReceived: (ZoomSDKLiveTranscriptionMessageInfo *_Nullable) messageInfo
optionalrequired

Callback: Original language message received callback.

Parameters
messageInfomessageInfo The spoken language message.

◆ onReceiveCCMessageWithString:senderID:

- (void) onReceiveCCMessageWithString: (NSString *) inString
senderID: (unsigned int) senderID 
optionalrequired

Notify the current user that close caption is received.

Parameters
inStringThe content of the close caption message.
senderIDThe sender id of a closed caption message.
Note
If the meeting supports multi- language transcription and the host sets manual captions to true, attendees must set the translation language id to -1 to receive closed captioned messages.

◆ onReceiveCCRealtimeMessage:

- (void) onReceiveCCRealtimeMessage: (NSString *) realtimeMessage
optionalrequired

Notify the current user of realtime message.

Parameters
realtimeMessageThe message that is being input.

◆ onRequestForLiveTranscriptReceived:anonymous:

- (void) onRequestForLiveTranscriptReceived: (unsigned int) requesterID
anonymous: (BOOL) bAnonymous 
optionalrequired

Notify the request for live transcript received.

Parameters
requesterIDThe user id of requester.
bAnonymousRequest anonymously of not, if bAnonymous is YES, requesterID has no meanings.
Note
only host can retrieve this callback

◆ onRequestLiveTranscriptionStatusChange:

- (void) onRequestLiveTranscriptionStatusChange: (BOOL) bEnabled
optionalrequired

Notify the request for live transcript status changed.

Parameters
bEnabledYES means enabled, otherwise not.

◆ onSpokenLanguageChanged:

- (void) onSpokenLanguageChanged: (ZoomSDKLiveTranscriptionLanguage *_Nullable) spokenLanguage
optionalrequired

Callback when the spoken language is changed.

Parameters
spokenLanguageA pointer to the current spoken language object.

◆ onStartCaptionsRequestApproved

- (void) onStartCaptionsRequestApproved
optionalrequired

Sink the event to start captions request was approved.

◆ onStartCaptionsRequestReceived:

- (void) onStartCaptionsRequestReceived: (ZoomSDKCCRequestHandler *) handler
optionalrequired

Sink the event to start captions request.

Parameters
handlerThe helper to handle the start captions request.