IClosedCaptionControllerEvent Class Reference

Closed Caption controller callback event. More...

#include <meeting_closedcaption_interface.h>

Public Member Functions
virtual	~IClosedCaptionControllerEvent ()
virtual void	onAssignedToSendCC (bool bAssigned)=0
	Callback event when the user is assigned to send Closed Caption messages.
virtual void	onClosedCaptionMsgReceived (const zchar_t *ccMsg, unsigned int sender_id, time_t time)=0
	Callback event when the user receives Closed Caption messages. 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.
virtual void	onLiveTranscriptionStatus (SDKLiveTranscriptionStatus status)=0
	live transcription status changed callback.
virtual void	onOriginalLanguageMsgReceived (ILiveTranscriptionMessageInfo *messageInfo)=0
	original language message received callback.
virtual void	onLiveTranscriptionMsgInfoReceived (ILiveTranscriptionMessageInfo *messageInfo)=0
	live transcription message received callback.
virtual void	onLiveTranscriptionMsgError (ILiveTranscriptionLanguage *spokenLanguage, ILiveTranscriptionLanguage *transcriptLanguage)=0
	The translation message error callback.
virtual void	onRequestForLiveTranscriptReceived (unsigned int requester_id, bool bAnonymous)=0
	only host can receive this callback.
virtual void	onRequestLiveTranscriptionStatusChange (bool bEnabled)=0
	request live transcription status changed callback.
virtual void	onCaptionStatusChanged (bool bEnabled)=0
	Sink the event of captions enabled status changed.
virtual void	onStartCaptionsRequestReceived (ICCRequestHandler *handler)=0
	Sink the event to start captions request.
virtual void	onStartCaptionsRequestApproved ()=0
	Sink the event to start captions request was approved.
virtual void	onManualCaptionStatusChanged (bool bEnabled)=0
	Sink the event of manual captions enablement status change.
virtual void	onSpokenLanguageChanged (ILiveTranscriptionLanguage *spokenLanguage)=0
	Callback when the spoken language is changed.

Detailed Description

Closed Caption controller callback event.

Definition at line 157 of file meeting_closedcaption_interface.h.

Constructor & Destructor Documentation

~IClosedCaptionControllerEvent()

virtual IClosedCaptionControllerEvent::~IClosedCaptionControllerEvent ( )

inlinevirtual

Definition at line 160 of file meeting_closedcaption_interface.h.

{}

Member Function Documentation

onAssignedToSendCC()

virtual void IClosedCaptionControllerEvent::onAssignedToSendCC ( bool bAssigned )

pure virtual

Callback event when the user is assigned to send Closed Caption messages.

onCaptionStatusChanged()

virtual void IClosedCaptionControllerEvent::onCaptionStatusChanged ( bool bEnabled )

pure virtual

Sink the event of captions enabled status changed.

Parameters

bEnabled

true indicates the host enables the captions, otherwise means the host disables the captions.

onClosedCaptionMsgReceived()

virtual void IClosedCaptionControllerEvent::onClosedCaptionMsgReceived ( const zchar_t * ccMsg, unsigned int sender_id, time_t time )

pure virtual

Callback event when the user receives Closed Caption messages. 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.

Parameters

ccMsg	an object pointer to the closed caption message content.
sender_id	the sender id of a closed caption message.
time	the time when a caption message was sent.

onLiveTranscriptionMsgError()

virtual void IClosedCaptionControllerEvent::onLiveTranscriptionMsgError ( ILiveTranscriptionLanguage * spokenLanguage, ILiveTranscriptionLanguage * transcriptLanguage )

pure virtual

The translation message error callback.

Parameters

speakingLanguage	an object of the spoken message language.
transcriptLanguageId	an object of the message language you want to translate.

onLiveTranscriptionMsgInfoReceived()

virtual void IClosedCaptionControllerEvent::onLiveTranscriptionMsgInfoReceived ( ILiveTranscriptionMessageInfo * messageInfo )

pure virtual

live transcription message received callback.

Parameters

messageInfo

The live transcription message.

onLiveTranscriptionStatus()

virtual void IClosedCaptionControllerEvent::onLiveTranscriptionStatus ( SDKLiveTranscriptionStatus status )

pure virtual

live transcription status changed callback.

Parameters

status

the live transcription status.

Note

This callback is triggered when the live transcription status changes. It can be triggered by calling StartLiveTranscription() or by calling SetTranslationLanguage() for the first time before calling StartLiveTranscription().

onManualCaptionStatusChanged()

virtual void IClosedCaptionControllerEvent::onManualCaptionStatusChanged ( bool bEnabled )

pure virtual

Sink the event of manual captions enablement status change.

Parameters

bEnabled

true indicates the host enables the manual captions. Otherwise the host disabled the manual captions.

onOriginalLanguageMsgReceived()

virtual void IClosedCaptionControllerEvent::onOriginalLanguageMsgReceived ( ILiveTranscriptionMessageInfo * messageInfo )

pure virtual

original language message received callback.

Parameters

messageInfo

The spoken language message.

onRequestForLiveTranscriptReceived()

virtual void IClosedCaptionControllerEvent::onRequestForLiveTranscriptReceived ( unsigned int requester_id, bool bAnonymous )

pure virtual

only host can receive this callback.

Parameters

requester_id	the request user id, if param bAnonymous is true, the requester_id is 0, no meanings.
bAnonymous	specify the request whether user anonymous request.

onRequestLiveTranscriptionStatusChange()

virtual void IClosedCaptionControllerEvent::onRequestLiveTranscriptionStatusChange ( bool bEnabled )

pure virtual

request live transcription status changed callback.

Parameters

bEnabled

Specify the request live transcription status is enable, true enable, false disabled.

onSpokenLanguageChanged()

virtual void IClosedCaptionControllerEvent::onSpokenLanguageChanged ( ILiveTranscriptionLanguage * spokenLanguage )

pure virtual

Callback when the spoken language is changed.

Parameters

spokenLanguage

A pointer to the current spoken language object.

onStartCaptionsRequestApproved()

virtual void IClosedCaptionControllerEvent::onStartCaptionsRequestApproved ( )

pure virtual

Sink the event to start captions request was approved.

onStartCaptionsRequestReceived()

virtual void IClosedCaptionControllerEvent::onStartCaptionsRequestReceived ( ICCRequestHandler * handler )

pure virtual

Sink the event to start captions request.

Parameters

handler

A pointer to the ICCRequestHandler.