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).

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

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

virtual SDKError	AssignCCPrivilege (unsigned int userid, bool bAssigned)=0
	Assign a user to send CC.

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

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

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

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

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

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

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

virtual SDKError	EnableMeetingManualCaption (bool bEnable)=0
	Enable or disable manual captions for the meeting.

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

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

virtual SDKError	EnableReceiveSpokenLanguageContent (bool bEnable)=0
	Enable or disable to receive original and translated content.If enable this feature,you need start live transcription.

virtual bool	CanDisableCaptions ()=0
	Query if the user can disable captions.

virtual SDKError	EnableCaptions (bool bEnable)=0
	Enable or disable captions.

virtual bool	IsCaptionsEnabled ()=0
	Query if the captions enabled.

virtual bool	IsReceiveSpokenLanguageContentEnabled ()=0
	Determine whether receive original and translated is available.

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

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

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

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

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

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

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

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.

virtual SDKError	StopLiveTranscription ()=0
	Stop live transcription.

virtual SDKError	EnableRequestLiveTranscription (bool bEnable)=0
	Enable or disable the ability for attendees to request live transcriptions.

virtual bool	IsRequestToStartLiveTranscriptionEnabled ()=0
	Determine whether the request to start live transcription is enabled.If the return value is true, it is enabled, if false, disabled.

virtual SDKError	RequestToStartLiveTranscription (bool bRequestAnonymous)=0
	Request the host to start live transcription.

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

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

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

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

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

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

virtual bool	IsSupportRequestCaptions ()=0
	Determine whether users can request to start captions.

virtual bool	IsSupportTranslationWhenRequestToStartCaptions ()=0
	Determine whether support translation when users request to start captions.

virtual SDKError	RequestToStartCaptions (bool bEnableTranslation)=0
	the host to start captions. If the host approves your request, you receive the callback onStartCaptionsRequestApproved, and you should start captions of translation there.

virtual SDKError	SetMeetingSpokenLanguage (int languageID, bool bIsForAll)=0
	Set the current user's spoken language.

Detailed Description

Closed caption controller interface.

Definition at line 247 of file meeting_closedcaption_interface.h.

Member Function Documentation

◆ AssignCCPrivilege()

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

pure virtual

Assign a user to send CC.

Note: 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.

◆ CanDisableCaptions()

virtual bool IClosedCaptionController::CanDisableCaptions ( )

pure virtual

Query if the user can disable captions.

Returns: True means that the host can disable captions.

◆ 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.

◆ EnableCaptions()

virtual SDKError IClosedCaptionController::EnableCaptions ( bool bEnable )

pure virtual

Enable or disable captions.

Parameters

bEnable True means that captions are enabled; false means that captions are disabled.

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

◆ EnableMeetingManualCaption()

virtual SDKError IClosedCaptionController::EnableMeetingManualCaption ( bool bEnable )

pure virtual

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.

◆ EnableReceiveSpokenLanguageContent()

virtual SDKError IClosedCaptionController::EnableReceiveSpokenLanguageContent ( bool bEnable )

pure virtual

Enable or disable to receive original and translated content.If enable this feature,you need start live transcription.

Returns: If the function succeeds, the return value is SDKErr_Success. Otherwise the function fails and returns an error. 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.

Note: 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 nullptr.

◆ 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 nullptr.

◆ GetClosedCaptionHistorySavedPath()

virtual const zchar_t * IClosedCaptionController::GetClosedCaptionHistorySavedPath ( )

pure virtual

Get the path of saving CC.

◆ GetClosedCaptionUrlFor3rdParty()

virtual const zchar_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.

Returns: type: the current live transcription status type. For more details, see SDKLiveTranscriptionStatus.

◆ getLiveTranscriptLegalNoticesExplained()

virtual const zchar_t * IClosedCaptionController::getLiveTranscriptLegalNoticesExplained ( )

pure virtual

Get the CC legal notices explained.

◆ getLiveTranscriptLegalNoticesPrompt()

virtual const zchar_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.

◆ IsCaptionsEnabled()

virtual bool IClosedCaptionController::IsCaptionsEnabled ( )

pure virtual

Query if the captions enabled.

Returns: True means that captions are enabled.

◆ IsLiveTranscriptionFeatureEnabled()

virtual bool IClosedCaptionController::IsLiveTranscriptionFeatureEnabled ( )

pure virtual

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

Determine whether the multi-language transcription feature is enabled.

◆ IsReceiveSpokenLanguageContentEnabled()

virtual bool IClosedCaptionController::IsReceiveSpokenLanguageContentEnabled ( )

pure virtual

Determine whether receive original and translated is available.

Returns: True indicates receive original and translated is available. Otherwise False.

◆ IsRequestToStartLiveTranscriptionEnabled()

virtual bool IClosedCaptionController::IsRequestToStartLiveTranscriptionEnabled ( )

pure virtual

Determine whether the request to start live transcription is enabled.If the return value is true, it is enabled, if false, disabled.

Note: 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.

◆ IsSupportRequestCaptions()

virtual bool IClosedCaptionController::IsSupportRequestCaptions ( )

pure virtual

Determine whether users can request to start captions.

Returns: True indicates users can request to start captions. Otherwise False.

◆ IsSupportTranslationWhenRequestToStartCaptions()

virtual bool IClosedCaptionController::IsSupportTranslationWhenRequestToStartCaptions ( )

pure virtual

Determine whether support translation when users request to start captions.

Returns: True indicates translation is available when users request to start captions. Otherwise False.

◆ IsTextLiveTranslationEnabled()

virtual bool IClosedCaptionController::IsTextLiveTranslationEnabled ( )

pure virtual

Determine whether the translated captions feature is enabled.

◆ RequestToStartCaptions()

virtual SDKError IClosedCaptionController::RequestToStartCaptions ( bool bEnableTranslation )

pure virtual

the host to start captions. If the host approves your request, you receive the callback onStartCaptionsRequestApproved, and you should start captions of translation there.

Parameters

bEnableTranslation True indicates to enable translation at the same time.

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

◆ RequestToStartLiveTranscription()

virtual SDKError IClosedCaptionController::RequestToStartLiveTranscription ( bool bRequestAnonymous )

pure virtual

Request the host to start live transcription.

Note: 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 zchar_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() [1/2]

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.

Deprecated: This interface is marked as deprecated, and is replaced by SetMeetingSpokenLanguage(int languageID, bool bIsForAll).

◆ SetMeetingSpokenLanguage() [2/2]

virtual SDKError IClosedCaptionController::SetMeetingSpokenLanguage	(	int	languageID,
		bool	bIsForAll )

pure virtual

Set the current user's spoken language.

Parameters

languageID	The spoken language ID.
bIsForAll	True means set spoken language for all users. False means set the language for myself.

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.

Note: 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.

Note: 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

◆ AssignCCPrivilege()

◆ CanAssignOthersToSendCC()

◆ CanBeAssignedToSendCC()

◆ CanDisableCaptions()

◆ CanSendClosedCaption()

◆ CanStartLiveTranscription()

◆ EnableCaptions()

◆ EnableMeetingManualCaption()

◆ EnableReceiveSpokenLanguageContent()

◆ EnableRequestLiveTranscription()

◆ GetAvailableMeetingSpokenLanguages()

◆ GetAvailableTranslationLanguages()

◆ GetClosedCaptionHistorySavedPath()

◆ GetClosedCaptionUrlFor3rdParty()

◆ GetLiveTranscriptionStatus()

◆ getLiveTranscriptLegalNoticesExplained()

◆ getLiveTranscriptLegalNoticesPrompt()

◆ GetMeetingSpokenLanguage()

◆ GetTranslationLanguage()

◆ IsCaptionsEnabled()

◆ IsLiveTranscriptionFeatureEnabled()

◆ IsLiveTranscriptLegalNoticeAvailable()

◆ IsMeetingManualCaptionEnabled()

◆ IsMeetingSupportCC()

◆ IsMultiLanguageTranscriptionEnabled()

◆ IsReceiveSpokenLanguageContentEnabled()

◆ IsRequestToStartLiveTranscriptionEnabled()

◆ IsSaveCCEnabled()

◆ IsSupportRequestCaptions()

◆ IsSupportTranslationWhenRequestToStartCaptions()

◆ IsTextLiveTranslationEnabled()

◆ RequestToStartCaptions()

◆ RequestToStartLiveTranscription()

◆ SaveCCHistory()

◆ SendClosedCaption()

◆ SetEvent()

◆ SetMeetingSpokenLanguage() [1/2]

◆ SetMeetingSpokenLanguage() [2/2]

◆ SetTranslationLanguage()

◆ StartLiveTranscription()

◆ StopLiveTranscription()