IClosedCaptionHelperSink Class Reference

Closed Caption helper event callback. More...

#include <IClosedCaptionHelper.h>

Public Member Functions
virtual	~IClosedCaptionHelperSink ()
virtual void	OnUpdateClosedCaptionNotification (const ClosedCaptionInfo &closedCaptionInfo)=0
	Closed caption info changed callback.
virtual void	OnClosedCaptionResponse (int32_t result, ClosedCaptionFontSize fontSize)=0
	Closed caption control response callback.
virtual void	OnNewLTTLanguageNotification (const NewLTTCaptionInfo &newLttCaptionInfo)=0
	New LTT caption info changed callback.
virtual void	OnNewLTTCaptionNotification (NewLTTCaptionNotificationType type)=0
	New LTT caption notification.
virtual void	OnUpdateInterpretLanguageNotification (const InterpretLanguageInfoList &infoList)=0
	Interpret language info update notification.
virtual void	OnMessageAdd (const LTTCaptionMessage &message)=0
	LTT caption message add notification.
virtual void	OnMessageUpdate (const LTTCaptionMessage &message)=0
	LTT caption message update notification.
virtual void	OnMessageNotSupported (const LTTCaptionMessage &message)=0
	LTT caption message not supported notification.
virtual void	OnMessageLoad (const std::vector< LTTCaptionMessage > &messages, bool hasMoreHistory)=0
	LTT caption messages loaded notification.
virtual void	OnMessageInstanceOnlySpeakerTagUpdate (const LTTCaptionMessage &message)=0
	LTT caption message instance only smart speaker tag update notification.

Detailed Description

Closed Caption helper event callback.

Definition at line 147 of file IClosedCaptionHelper.h.

Constructor & Destructor Documentation

~IClosedCaptionHelperSink()

virtual IClosedCaptionHelperSink::~IClosedCaptionHelperSink ( )

inlinevirtual

Definition at line 150 of file IClosedCaptionHelper.h.

{}

Member Function Documentation

OnClosedCaptionResponse()

virtual void IClosedCaptionHelperSink::OnClosedCaptionResponse ( int32_t  result, ClosedCaptionFontSize  fontSize  )

pure virtual

Closed caption control response callback.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

Parameters

result	[0] success, otherwise error.
fontSize	Specify the font size which requested to control.

OnMessageAdd()

virtual void IClosedCaptionHelperSink::OnMessageAdd ( const LTTCaptionMessage &  message )

pure virtual

LTT caption message add notification.

Since

6.1.0

Zoom Rooms minimum version

6.1.0

Parameters

message

LTT caption message

OnMessageInstanceOnlySpeakerTagUpdate()

virtual void IClosedCaptionHelperSink::OnMessageInstanceOnlySpeakerTagUpdate ( const LTTCaptionMessage &  message )

pure virtual

LTT caption message instance only smart speaker tag update notification.

Since

6.3.5

Zoom Rooms minimum version

6.2.0

Parameters

message

LTT caption message.

OnMessageLoad()

virtual void IClosedCaptionHelperSink::OnMessageLoad ( const std::vector< LTTCaptionMessage > &  messages, bool  hasMoreHistory  )

pure virtual

LTT caption messages loaded notification.

Since

6.1.0

Zoom Rooms minimum version

6.1.0

Parameters

messages	The loaded LTT caption messages.
hasMoreHistory	TRUE indicates has more caption message history.

OnMessageNotSupported()

virtual void IClosedCaptionHelperSink::OnMessageNotSupported ( const LTTCaptionMessage &  message )

pure virtual

LTT caption message not supported notification.

Since

6.1.0

Zoom Rooms minimum version

6.1.0

Parameters

message

LTT caption message

OnMessageUpdate()

virtual void IClosedCaptionHelperSink::OnMessageUpdate ( const LTTCaptionMessage &  message )

pure virtual

LTT caption message update notification.

Since

6.1.0

Zoom Rooms minimum version

6.1.0

Parameters

message

LTT caption message

OnNewLTTCaptionNotification()

virtual void IClosedCaptionHelperSink::OnNewLTTCaptionNotification ( NewLTTCaptionNotificationType  type )

pure virtual

New LTT caption notification.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

Parameters

type	The notification type, see NewLTTCaptionNotificationType enum.

OnNewLTTLanguageNotification()

virtual void IClosedCaptionHelperSink::OnNewLTTLanguageNotification ( const NewLTTCaptionInfo &  newLttCaptionInfo )

pure virtual

New LTT caption info changed callback.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

Parameters

newLttCaptionInfo

Updated New LTT caption info.

OnUpdateClosedCaptionNotification()

virtual void IClosedCaptionHelperSink::OnUpdateClosedCaptionNotification ( const ClosedCaptionInfo &  closedCaptionInfo )

pure virtual

Closed caption info changed callback.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

Parameters

closedCaptionInfo

Updated closed caption info.

OnUpdateInterpretLanguageNotification()

virtual void IClosedCaptionHelperSink::OnUpdateInterpretLanguageNotification ( const InterpretLanguageInfoList &  infoList )

pure virtual

Interpret language info update notification.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

Parameters

infoList

Interpret language info