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. More...
virtual void	onClosedCaptionMsgReceived (const wchar_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. More...
virtual void	onLiveTranscriptionStatus (SDKLiveTranscriptionStatus status)=0
	live transcription status changed callback. More...
virtual void	onLiveTranscriptionMsgReceived (const wchar_t *ltMsg, unsigned int speaker_id, SDKLiveTranscriptionOperationType type)=0
	live transcription message received callback. More...
virtual void	onLiveTranscriptionMsgError (ILiveTranscriptionLanguage *spokenLanguage, ILiveTranscriptionLanguage *transcriptLanguage)=0
	The translation message error callback. More...
virtual void	onRequestForLiveTranscriptReceived (unsigned int requester_id, bool bAnonymous)=0
	only host can receive this callback. More...
virtual void	onRequestLiveTranscriptionStatusChange (bool bEnabled)=0
	request live transcription status changed callback. More...

Detailed Description

Closed Caption controller callback event.

Definition at line 47 of file meeting_closedcaption_interface.h.

Constructor & Destructor Documentation

~IClosedCaptionControllerEvent()

virtual IClosedCaptionControllerEvent::~IClosedCaptionControllerEvent ( )

inlinevirtual

Definition at line 50 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.

onClosedCaptionMsgReceived()

virtual void IClosedCaptionControllerEvent::onClosedCaptionMsgReceived ( const wchar_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.

onLiveTranscriptionMsgReceived()

virtual void IClosedCaptionControllerEvent::onLiveTranscriptionMsgReceived ( const wchar_t *  ltMsg, unsigned int  speaker_id, SDKLiveTranscriptionOperationType  type  )

pure virtual

live transcription message received callback.

Parameters

ltMsg	an object pointer to the live transcription message content.
ltSpearkId	the speaker id of the live transcription message.
type	the live transcription operation type. For more details, see SDKLiveTranscriptionOperationType.

onLiveTranscriptionStatus()

virtual void IClosedCaptionControllerEvent::onLiveTranscriptionStatus ( SDKLiveTranscriptionStatus  status )

pure virtual

live transcription status changed callback.

Parameters

status

the live transcription status. For more details, see SDKLiveTranscriptionStatus.

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.