Closed Caption helper interface. More...

#include <IClosedCaptionHelper.h>

Public Member Functions
virtual	~IClosedCaptionHelper ()

virtual ZRCSDKError	RegisterSink (IClosedCaptionHelperSink *pSink)=0
	Register closed caption helper callback sink.

virtual ZRCSDKError	DeregisterSink (IClosedCaptionHelperSink *pSink)=0
	Deregister closed caption helper callback sink.

virtual ZRCSDKError	ControlClosedCaptionVisible (bool show, ClosedCaptionFontSize fontSize)=0
	Control closed caption visibility and font size.

virtual ZRCSDKError	AssignClosedCaption (int32_t userID, bool assign)=0
	Assign user to type closed caption.

virtual ZRCSDKError	ShowCaption (bool show)=0
	Control New LTT caption visibility.

virtual ZRCSDKError	SetNewLTTCaptionFontSize (ClosedCaptionFontSize fontSize)=0
	Control New LTT caption font size.

virtual ZRCSDKError	EnableNewLTTManualCaptioner (bool enable)=0
	Enable New LTT manual captioner.

virtual ZRCSDKError	SetNewLTTSpeakerLanguage (int32_t languageID)=0
	Set New LTT caption speaker language.

virtual ZRCSDKError	SetNewLTTTranslationLanguage (int32_t languageID)=0
	Set New LTT caption translation language.

virtual ZRCSDKError	ShowNewLTTOriginalAndTranslated (bool show)=0
	Show New LTT caption both original and translated caption.

virtual ZRCSDKError	SendEnableCaptionRequest ()=0
	Send enable caption request to host.

virtual ZRCSDKError	ApproveEnableCaptionRequest (bool approve)=0
	Approve enable caption request.

virtual ZRCSDKError	EnableCaption (bool enable)=0
	Enable caption.

virtual ZRCSDKError	GetRecommendSpeakerLanguageInfo (NewLTTCaptionLanguage &recommendLanguage)=0
	Query recommend speaker language for closed caption.

virtual ZRCSDKError	MuteOriginalAudio (bool mute)=0
	Mute original audio.

virtual ZRCSDKError	GetInterpretLanguageInfoList (InterpretLanguageInfoList &infoList)=0
	Query the list of supported interpretation languages.

virtual ZRCSDKError	SelectInterpretLanguage (const InterpretLanguageInfo &languageInfo)=0
	Select interpret language.

virtual ZRCSDKError	ShowTranscriptPanelOnZR (bool show)=0
	Show transcript panel on ZR display.

virtual ZRCSDKError	ShowTranscriptPanelOnZRC (bool show)=0
	Show transcript panel on controller.

virtual ZRCSDKError	LoadLTTCaptionMessage ()=0
	Load more LTT caption history messages step by 20.

virtual ZRCSDKError	IsAllowViewFullTranscript (bool &isAllow)=0
	Query if is allow view full transcript.

virtual ZRCSDKError	GetLTTCaptionMessageList (std::vector< LTTCaptionMessage > &messages)=0
	Get current loaded LTT caption message list.

virtual ZRCSDKError	HasMoreMessageHistoryOnZR (bool &hasMore)=0
	Query if has more history on ZR.

Detailed Description

Closed Caption helper interface.

Definition at line 257 of file IClosedCaptionHelper.h.

Constructor & Destructor Documentation

◆ ~IClosedCaptionHelper()

virtual IClosedCaptionHelper::~IClosedCaptionHelper ( )

inlinevirtual

Definition at line 260 of file IClosedCaptionHelper.h.

260{}

Member Function Documentation

◆ ApproveEnableCaptionRequest()

virtual ZRCSDKError IClosedCaptionHelper::ApproveEnableCaptionRequest ( bool approve )

pure virtual

Approve enable caption request.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

approve TRUE indicates approve the request. Otherwise not.

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

◆ AssignClosedCaption()

virtual ZRCSDKError IClosedCaptionHelper::AssignClosedCaption	(	int32_t	userID,
		bool	assign
	)

pure virtual

Assign user to type closed caption.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

userID	Specify the userID.
assign	TRUE indicates assign user to type CC. Otherwise not.

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

◆ ControlClosedCaptionVisible()

virtual ZRCSDKError IClosedCaptionHelper::ControlClosedCaptionVisible	(	bool	show,
		ClosedCaptionFontSize	fontSize
	)

pure virtual

Control closed caption visibility and font size.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

show	TRUE indicates show the closed caption. Otherwise not.
fontSize	Choose the closed caption font size, see ClosedCaptionFontSize enum

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

◆ DeregisterSink()

virtual ZRCSDKError IClosedCaptionHelper::DeregisterSink ( IClosedCaptionHelperSink * pSink )

pure virtual

Deregister closed caption helper callback sink.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

pSink A pointer to the IClosedCaptionHelperSink that receives the closed caption helper event callback.

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

◆ EnableCaption()

virtual ZRCSDKError IClosedCaptionHelper::EnableCaption ( bool enable )

pure virtual

Enable caption.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

enable TRUE indicates enable caption. Otherwise disable.

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

◆ EnableNewLTTManualCaptioner()

virtual ZRCSDKError IClosedCaptionHelper::EnableNewLTTManualCaptioner ( bool enable )

pure virtual

Enable New LTT manual captioner.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

enable TRUE indicates enable NEW LTT manual captioner. Otherwise not.

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

◆ GetInterpretLanguageInfoList()

virtual ZRCSDKError IClosedCaptionHelper::GetInterpretLanguageInfoList ( InterpretLanguageInfoList & infoList )

pure virtual

Query the list of supported interpretation languages.

Since: 6.6.0

Zoom Rooms minimum version: 6.0.0

Parameters

[out] infoList Supported interpretation languages.

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

◆ GetLTTCaptionMessageList()

virtual ZRCSDKError IClosedCaptionHelper::GetLTTCaptionMessageList ( std::vector< LTTCaptionMessage > & messages )

pure virtual

Get current loaded LTT caption message list.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

[out] messages Specify the interpret language.

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

◆ GetRecommendSpeakerLanguageInfo()

virtual ZRCSDKError IClosedCaptionHelper::GetRecommendSpeakerLanguageInfo ( NewLTTCaptionLanguage & recommendLanguage )

pure virtual

Query recommend speaker language for closed caption.

Since: 6.6.0

Zoom Rooms minimum version: 6.6.0

This method should be called after receiving an OnNewLTTCaptionNotification with type 'NewLTTCaptionNotificationTypeSpeakerLanguageMismatch'.

Parameters

[out] recommendLanguage The recommended language information for the current speaker.

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

◆ HasMoreMessageHistoryOnZR()

virtual ZRCSDKError IClosedCaptionHelper::HasMoreMessageHistoryOnZR ( bool & hasMore )

pure virtual

Query if has more history on ZR.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

[out] hasMore TRUE indicates has more history on ZR.

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

◆ IsAllowViewFullTranscript()

virtual ZRCSDKError IClosedCaptionHelper::IsAllowViewFullTranscript ( bool & isAllow )

pure virtual

Query if is allow view full transcript.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

[out] isAllow Specify the interpret language.

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

◆ LoadLTTCaptionMessage()

virtual ZRCSDKError IClosedCaptionHelper::LoadLTTCaptionMessage ( )

pure virtual

Load more LTT caption history messages step by 20.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

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

◆ MuteOriginalAudio()

virtual ZRCSDKError IClosedCaptionHelper::MuteOriginalAudio ( bool mute )

pure virtual

Mute original audio.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

mute	TRUE indicates mute the original audio. Otherwise not.

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

◆ RegisterSink()

virtual ZRCSDKError IClosedCaptionHelper::RegisterSink ( IClosedCaptionHelperSink * pSink )

pure virtual

Register closed caption helper callback sink.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

pSink A pointer to the IClosedCaptionHelperSink that receives the closed caption helper event callback.

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

◆ SelectInterpretLanguage()

virtual ZRCSDKError IClosedCaptionHelper::SelectInterpretLanguage ( const InterpretLanguageInfo & languageInfo )

pure virtual

Select interpret language.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

languageInfo Specify the interpret language.

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

◆ SendEnableCaptionRequest()

virtual ZRCSDKError IClosedCaptionHelper::SendEnableCaptionRequest ( )

pure virtual

Send enable caption request to host.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

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

◆ SetNewLTTCaptionFontSize()

virtual ZRCSDKError IClosedCaptionHelper::SetNewLTTCaptionFontSize ( ClosedCaptionFontSize fontSize )

pure virtual

Control New LTT caption font size.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

fontSize Choose the caption font size, see ClosedCaptionFontSize enum

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

◆ SetNewLTTSpeakerLanguage()

virtual ZRCSDKError IClosedCaptionHelper::SetNewLTTSpeakerLanguage ( int32_t languageID )

pure virtual

Set New LTT caption speaker language.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

languageID Speaker language ID

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

◆ SetNewLTTTranslationLanguage()

virtual ZRCSDKError IClosedCaptionHelper::SetNewLTTTranslationLanguage ( int32_t languageID )

pure virtual

Set New LTT caption translation language.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

languageID Translation language ID

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

◆ ShowCaption()

virtual ZRCSDKError IClosedCaptionHelper::ShowCaption ( bool show )

pure virtual

Control New LTT caption visibility.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

show	TRUE indicates show the caption. Otherwise not.

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

◆ ShowNewLTTOriginalAndTranslated()

virtual ZRCSDKError IClosedCaptionHelper::ShowNewLTTOriginalAndTranslated ( bool show )

pure virtual

Show New LTT caption both original and translated caption.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

show	TRUE indicates show both, FALSE indicates show translated caption only.

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

◆ ShowTranscriptPanelOnZR()

virtual ZRCSDKError IClosedCaptionHelper::ShowTranscriptPanelOnZR ( bool show )

pure virtual

Show transcript panel on ZR display.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

show	TRUE indicates to receive message update. Otherwise not.

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

◆ ShowTranscriptPanelOnZRC()

virtual ZRCSDKError IClosedCaptionHelper::ShowTranscriptPanelOnZRC ( bool show )

pure virtual

Show transcript panel on controller.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

show	TRUE indicates to receive message update. Otherwise not.

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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~IClosedCaptionHelper()

Member Function Documentation

◆ ApproveEnableCaptionRequest()

◆ AssignClosedCaption()

◆ ControlClosedCaptionVisible()

◆ DeregisterSink()

◆ EnableCaption()

◆ EnableNewLTTManualCaptioner()

◆ GetInterpretLanguageInfoList()

◆ GetLTTCaptionMessageList()

◆ GetRecommendSpeakerLanguageInfo()

◆ HasMoreMessageHistoryOnZR()

◆ IsAllowViewFullTranscript()

◆ LoadLTTCaptionMessage()

◆ MuteOriginalAudio()

◆ RegisterSink()

◆ SelectInterpretLanguage()

◆ SendEnableCaptionRequest()

◆ SetNewLTTCaptionFontSize()

◆ SetNewLTTSpeakerLanguage()

◆ SetNewLTTTranslationLanguage()

◆ ShowCaption()

◆ ShowNewLTTOriginalAndTranslated()

◆ ShowTranscriptPanelOnZR()

◆ ShowTranscriptPanelOnZRC()