Closed caption controller interface. More...

#include <meeting_closedcaption_interface.h>

Public Member Functions
virtual SDKError	SetEvent (IClosedCaptionControllerEvent *pEvent)=0
	Set the controller event of closed caption(CC). More...

virtual bool	IsMeetingSupportCC ()=0
	Determine if the current meeting supports the CC feature. More...

virtual bool	CanAssignOthersToSendCC ()=0
	Query if it is able to assign others to send CC. More...

virtual SDKError	AssignCCPriviledge (unsigned int userid, bool bAssigned)=0

virtual bool	CanBeAssignedToSendCC (unsigned int userid)=0
	Determine if the user can be assigned as a CC sender. More...

virtual bool	CanSendClosedCaption ()=0
	Query if the user can send CC. More...

virtual SDKError	SendClosedCaption (const wchar_t *ccMsg)=0
	Send the CC message. More...

virtual bool	IsSaveCCEnabled ()=0
	Determine if it is enabled to save CC. More...

virtual SDKError	SaveCCHistory ()=0
	History of saving CC. More...

virtual const wchar_t *	GetClosedCaptionHistorySavedPath ()=0
	Get the path of saving CC. More...

virtual const wchar_t *	GetClosedCaptionUrlFor3rdParty ()=0
	Get the CC URL used by the third party service. More...

virtual SDKError	EnableMeetingManualCaption (bool bEnable)=0

virtual bool	IsMeetingManualCaptionEnabled ()=0
	Determine whether manually added closed captions is enabled for the meeting. More...

virtual bool	IsLiveTranscriptLegalNoticeAvailable ()=0
	Determine whether the legal notice for Live transcript is available. More...

virtual const wchar_t *	getLiveTranscriptLegalNoticesPrompt ()=0
	Get the CC legal notices prompt. More...

virtual const wchar_t *	getLiveTranscriptLegalNoticesExplained ()=0
	Get the CC legal notices explained. More...

virtual bool	IsLiveTranscriptionFeatureEnabled ()=0
	brief Determine whether the live transcription feature is enabled. More...

virtual bool	IsMultiLanguageTranscriptionEnabled ()=0
	brief Determine whether the multi-language transcription feature is enabled. More...

virtual bool	IsTextLiveTranslationEnabled ()=0
	brief Determine whether the translated captions feature is enabled. More...

virtual SDKLiveTranscriptionStatus	GetLiveTranscriptionStatus ()=0
	Get the current live transcription status. More...

virtual bool	CanStartLiveTranscription ()=0
	Query if the user can start live transcription. More...

virtual SDKError	StartLiveTranscription ()=0
	Start live transcription. \If the meeting allows multi-language transcription,all users can start live transcription.Otherwise only the host can start it. More...

virtual SDKError	StopLiveTranscription ()=0
	Stop live transcription. \If the meeting allows multi-language transcription,all user can stop live transcription.Otherwise only the host can stop it. More...

virtual SDKError	EnableRequestLiveTranscription (bool bEnable)=0
	Enable or disable the ability for attendees to request live transcriptions. \If the meeting allows multi-language transcription,the return value is SDKERR_WRONG_USAGE. More...

virtual bool	IsRequestToStartLiveTranscriptionEnalbed ()=0
	Determine whether the request to start live transcription is enabled.If the return value is true, it is enabled, if false, disabled. \If the meeting allows multi-language transcription, the return value is false. More...

virtual SDKError	RequestToStartLiveTranscription (bool bRequestAnonymous)=0
	Request the host to start live transcription. \If the meeting allows multi-language transcription,the return value is SDKERR_WRONG_USAGE. More...

virtual IList< ILiveTranscriptionLanguage * > *	GetAvailableMeetingSpokenLanguages ()=0
	Get the list of all available speaking languages in meeting. More...

virtual SDKError	SetMeetingSpokenLanguage (int languageID)=0
	Set the spoken language of the current user. More...

virtual ILiveTranscriptionLanguage *	GetMeetingSpokenLanguage ()=0
	Get the spoken language of the current user. More...

virtual IList< ILiveTranscriptionLanguage * > *	GetAvailableTranslationLanguages ()=0
	Get the list of all available translation languages in a meeting. More...

virtual SDKError	SetTranslationLanguage (int languageID)=0
	Set the translation language of the current user. More...

virtual ILiveTranscriptionLanguage *	GetTranslationLanguage ()=0
	Get the translation language of the current user. More...

Detailed Description

Closed caption controller interface.

Definition at line 82 of file meeting_closedcaption_interface.h.

Member Function Documentation

◆ AssignCCPriviledge()

virtual SDKError IClosedCaptionController::AssignCCPriviledge	(	unsigned int	userid,
		bool	bAssigned
	)

pure virtual

Assign a user to send CC. Zero(0) means to assign the current user himself.

◆ CanAssignOthersToSendCC()

virtual bool IClosedCaptionController::CanAssignOthersToSendCC ( )

pure virtual

Query if it is able to assign others to send CC.

◆ CanBeAssignedToSendCC()

virtual bool IClosedCaptionController::CanBeAssignedToSendCC ( unsigned int userid )

pure virtual

Determine if the user can be assigned as a CC sender.

◆ CanSendClosedCaption()

virtual bool IClosedCaptionController::CanSendClosedCaption ( )

pure virtual

Query if the user can send CC.

◆ CanStartLiveTranscription()

virtual bool IClosedCaptionController::CanStartLiveTranscription ( )

pure virtual

Query if the user can start live transcription.

◆ EnableMeetingManualCaption()

virtual SDKError IClosedCaptionController::EnableMeetingManualCaption ( bool bEnable )

pure virtual

brief Enable or disable manual captions for the meeting.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ EnableRequestLiveTranscription()

virtual SDKError IClosedCaptionController::EnableRequestLiveTranscription ( bool bEnable )

pure virtual

Enable or disable the ability for attendees to request live transcriptions. \If the meeting allows multi-language transcription,the return value is SDKERR_WRONG_USAGE.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ GetAvailableMeetingSpokenLanguages()

virtual IList< ILiveTranscriptionLanguage * > * IClosedCaptionController::GetAvailableMeetingSpokenLanguages ( )

pure virtual

Get the list of all available speaking languages in meeting.

Returns: If the function succeeds, the return value is the list of the available spoken languages in a meeting. Otherwise failed, the return value is NULL.

◆ GetAvailableTranslationLanguages()

virtual IList< ILiveTranscriptionLanguage * > * IClosedCaptionController::GetAvailableTranslationLanguages ( )

pure virtual

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

Returns: If the function succeeds, the return value is the list of all available translation languages in a meeting. Otherwise failed, the return value is NULL.

◆ GetClosedCaptionHistorySavedPath()

virtual const wchar_t * IClosedCaptionController::GetClosedCaptionHistorySavedPath ( )

pure virtual

Get the path of saving CC.

◆ GetClosedCaptionUrlFor3rdParty()

virtual const wchar_t * IClosedCaptionController::GetClosedCaptionUrlFor3rdParty ( )

pure virtual

Get the CC URL used by the third party service.

◆ GetLiveTranscriptionStatus()

virtual SDKLiveTranscriptionStatus IClosedCaptionController::GetLiveTranscriptionStatus ( )

pure virtual

Get the current live transcription status.

◆ getLiveTranscriptLegalNoticesExplained()

virtual const wchar_t * IClosedCaptionController::getLiveTranscriptLegalNoticesExplained ( )

pure virtual

Get the CC legal notices explained.

◆ getLiveTranscriptLegalNoticesPrompt()

virtual const wchar_t * IClosedCaptionController::getLiveTranscriptLegalNoticesPrompt ( )

pure virtual

Get the CC legal notices prompt.

◆ GetMeetingSpokenLanguage()

virtual ILiveTranscriptionLanguage * IClosedCaptionController::GetMeetingSpokenLanguage ( )

pure virtual

Get the spoken language of the current user.

◆ GetTranslationLanguage()

virtual ILiveTranscriptionLanguage * IClosedCaptionController::GetTranslationLanguage ( )

pure virtual

Get the translation language of the current user.

◆ IsLiveTranscriptionFeatureEnabled()

virtual bool IClosedCaptionController::IsLiveTranscriptionFeatureEnabled ( )

pure virtual

brief Determine whether the live transcription feature is enabled.

◆ IsLiveTranscriptLegalNoticeAvailable()

virtual bool IClosedCaptionController::IsLiveTranscriptLegalNoticeAvailable ( )

pure virtual

Determine whether the legal notice for Live transcript is available.

Returns: True indicates the legal notice for Live transcript is available. Otherwise False.

◆ IsMeetingManualCaptionEnabled()

virtual bool IClosedCaptionController::IsMeetingManualCaptionEnabled ( )

pure virtual

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

◆ IsMeetingSupportCC()

virtual bool IClosedCaptionController::IsMeetingSupportCC ( )

pure virtual

Determine if the current meeting supports the CC feature.

◆ IsMultiLanguageTranscriptionEnabled()

virtual bool IClosedCaptionController::IsMultiLanguageTranscriptionEnabled ( )

pure virtual

brief Determine whether the multi-language transcription feature is enabled.

◆ IsRequestToStartLiveTranscriptionEnalbed()

virtual bool IClosedCaptionController::IsRequestToStartLiveTranscriptionEnalbed ( )

pure virtual

Determine whether the request to start live transcription is enabled.If the return value is true, it is enabled, if false, disabled. \If the meeting allows multi-language transcription, the return value is false.

◆ IsSaveCCEnabled()

virtual bool IClosedCaptionController::IsSaveCCEnabled ( )

pure virtual

Determine if it is enabled to save CC.

◆ IsTextLiveTranslationEnabled()

virtual bool IClosedCaptionController::IsTextLiveTranslationEnabled ( )

pure virtual

brief Determine whether the translated captions feature is enabled.

◆ RequestToStartLiveTranscription()

virtual SDKError IClosedCaptionController::RequestToStartLiveTranscription ( bool bRequestAnonymous )

pure virtual

Request the host to start live transcription. \If the meeting allows multi-language transcription,the return value is SDKERR_WRONG_USAGE.

Parameters

bRequestAnonymous True indicates the user anonymous request.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ SaveCCHistory()

virtual SDKError IClosedCaptionController::SaveCCHistory ( )

pure virtual

History of saving CC.

◆ SendClosedCaption()

virtual SDKError IClosedCaptionController::SendClosedCaption ( const wchar_t * ccMsg )

pure virtual

Send the CC message.

◆ SetEvent()

virtual SDKError IClosedCaptionController::SetEvent ( IClosedCaptionControllerEvent * pEvent )

pure virtual

Set the controller event of closed caption(CC).

◆ SetMeetingSpokenLanguage()

virtual SDKError IClosedCaptionController::SetMeetingSpokenLanguage ( int languageID )

pure virtual

Set the spoken language of the current user.

Parameters

languageID The spoken language id.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ SetTranslationLanguage()

virtual SDKError IClosedCaptionController::SetTranslationLanguage ( int languageID )

pure virtual

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 receive closed captions if the host sets manual captions to true for the meeting.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ StartLiveTranscription()

virtual SDKError IClosedCaptionController::StartLiveTranscription ( )

pure virtual

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

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ StopLiveTranscription()

virtual SDKError IClosedCaptionController::StopLiveTranscription ( )

pure virtual

Stop live transcription. \If the meeting allows multi-language transcription,all user can stop live transcription.Otherwise only the host can stop it.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

Public Member Functions

Detailed Description

Member Function Documentation

◆ AssignCCPriviledge()

◆ CanAssignOthersToSendCC()

◆ CanBeAssignedToSendCC()

◆ CanSendClosedCaption()

◆ CanStartLiveTranscription()

◆ EnableMeetingManualCaption()

◆ EnableRequestLiveTranscription()

◆ GetAvailableMeetingSpokenLanguages()

◆ GetAvailableTranslationLanguages()

◆ GetClosedCaptionHistorySavedPath()

◆ GetClosedCaptionUrlFor3rdParty()

◆ GetLiveTranscriptionStatus()

◆ getLiveTranscriptLegalNoticesExplained()

◆ getLiveTranscriptLegalNoticesPrompt()

◆ GetMeetingSpokenLanguage()

◆ GetTranslationLanguage()

◆ IsLiveTranscriptionFeatureEnabled()

◆ IsLiveTranscriptLegalNoticeAvailable()

◆ IsMeetingManualCaptionEnabled()

◆ IsMeetingSupportCC()

◆ IsMultiLanguageTranscriptionEnabled()

◆ IsRequestToStartLiveTranscriptionEnalbed()

◆ IsSaveCCEnabled()

◆ IsTextLiveTranslationEnabled()

◆ RequestToStartLiveTranscription()

◆ SaveCCHistory()

◆ SendClosedCaption()

◆ SetEvent()

◆ SetMeetingSpokenLanguage()

◆ SetTranslationLanguage()

◆ StartLiveTranscription()

◆ StopLiveTranscription()