<ZoomSDKCloseCaptionControllerDelegate> Protocol Reference

#import <ZoomSDKCloseCaptionController.h>

Inherits <NSObjectNSObject>.

Instance Methods
(void)	- onGetCCPrvilege
	Callback of getting the privilege of close caption.
(void)	- onLostCCPrvilege
	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)	- onLiveTranscriptionMsgReceived:type:speakerID:
	Notify the live transcription message received.
(void)	- onLiveTranscriptionMsgError:transcriptLanguage:
	The translation message error callback.
(void)	- onRequestForLiveTranscriptReceived:anonymous:
	Notify the request for live transcript received.
(void)	- onRequestLiveTransciptionStatusChange:
	Notify the request for live transcript status changed.
(void)	- onCaptionStatusChanged:
	Sink the event of captions enabled status changed.

Detailed Description

Definition at line 13 of file ZoomSDKCloseCaptionController.h.

Method Documentation

onCaptionStatusChanged:

- (void) onCaptionStatusChanged:

(BOOL)

enable

Sink the event of captions enabled status changed.

Parameters

enable

YES means the host enables the captions, otherwise means the host disables the captions.

onGetCCPrvilege

- (void) onGetCCPrvilege

Callback of getting the privilege of close caption.

onLiveTranscriptionMsgError:transcriptLanguage:

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

The translation message error callback.

Parameters

spokenLanguage	An object of the spoken message language.
transcriptLanguage	An object of the message language you want to translate.

onLiveTranscriptionMsgReceived:type:speakerID:

- (void) onLiveTranscriptionMsgReceived:		(NSString *)	msgContent
type:		(ZoomSDKLiveTranscriptionOperationType)	type
speakerID:		(unsigned int)	speakerID

Notify the live transcription message received.

Parameters

msgContent	The content of message.
type	The type of live transcription operation.
speakerID	The id of live transcription spaker.

onLiveTranscriptionStatus:

- (void) onLiveTranscriptionStatus:

(ZoomSDKLiveTranscriptionStaus)

status

Notify the live transcription status changed.

Parameters

status

The type of live transcription status.

onLostCCPrvilege

- (void) onLostCCPrvilege

Callback of losing privilege of close caption.

onReceiveCCMessageWithString:senderID:

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

Notify the current user that close caption is received.

Parameters

inString	The content of the close caption message.
senderID	The 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

Notify the current user of realtime message.

Parameters

realtimeMessage

The message that is being input.

onRequestForLiveTranscriptReceived:anonymous:

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

Notify the request for live transcript received.

Parameters

requesterID	The user id of requester.
bAnonymous	Request anonymously of not, if bAnonymous is YES, requesterID has no meanings.

Note

only host can retrieve this callback

onRequestLiveTransciptionStatusChange:

- (void) onRequestLiveTransciptionStatusChange:

(BOOL)

bEnabled

Notify the request for live transcript status changed.

Parameters

bEnabled

YES means enabled, otherwise not.