alexaClientSDK::captions Namespace Reference

Namespaces
	test

Classes
struct	CaptionData
class	CaptionFrame
class	CaptionFrameParseListenerInterface
struct	CaptionLine
class	CaptionManager
class	CaptionManagerInterface
class	CaptionParserInterface
class	CaptionPresenterInterface
class	CaptionTimingAdapter
class	CaptionTimingAdapterInterface
class	DelayInterface
class	LibwebvttParserAdapter
struct	Style
class	SystemClockDelay
struct	TextStyle
class	TimingAdapterFactory

Typedefs
using	CaptionsComponent = acsdkManufactory::Component< std::shared_ptr< CaptionManagerInterface >, acsdkManufactory::Import< std::shared_ptr< acsdkShutdownManagerInterfaces::ShutdownNotifierInterface > >>

Enumerations
enum	CaptionFormat { CaptionFormat::WEBVTT, CaptionFormat::UNKNOWN }

Functions
CaptionsComponent	getComponent ()
CaptionFormat	avsStringToCaptionFormat (const std::string &text)
std::ostream &	operator<< (std::ostream &stream, const CaptionFormat &format)
std::ostream &	operator<< (std::ostream &stream, const CaptionFrame &frame)
std::ostream &	operator<< (std::ostream &stream, const CaptionLine &line)
std::ostream &	operator<< (std::ostream &stream, const Style &style)
std::ostream &	operator<< (std::ostream &stream, const TextStyle &textStyle)

Typedef Documentation

CaptionsComponent

using alexaClientSDK::captions::CaptionsComponent = typedef acsdkManufactory::Component< std::shared_ptr<CaptionManagerInterface>, acsdkManufactory::Import<std::shared_ptr<acsdkShutdownManagerInterfaces::ShutdownNotifierInterface> >>

Definition of a Manufactory component for Captions.

Enumeration Type Documentation

CaptionFormat

enum alexaClientSDK::captions::CaptionFormat

strong

An enumeration of caption formats supported by the SDK.

Enumerator
WEBVTT	WebVTT formatted plain text, see https://www.w3.org/TR/webvtt1/.
UNKNOWN	Unknown or unsupported format.

Function Documentation

avsStringToCaptionFormat()

CaptionFormat alexaClientSDK::captions::avsStringToCaptionFormat ( const std::string &  text )

inline

Convert an AVS-compliant string to a CaptionFormat.

Parameters

text	The AVS-compliant string to convert.

Returns

The converted CaptionFormat if a match is found, otherwise CaptionFormat::UNKNOWN.

getComponent()

CaptionsComponent alexaClientSDK::captions::getComponent

(

)

Creates an manufactory component that exports a shared pointer to an implementation of CaptionManagerInterface.

Returns

A component.

operator<<() [1/5]

std::ostream& alexaClientSDK::captions::operator<< ( std::ostream &  stream, const CaptionFormat &  format  )

inline

Write a CaptionFormat value to an ostream as a string.

Parameters

stream	The stream to write the value to.
format	The CaptionFormat value to write to the ostream as a string.

Returns

The ostream that was passed in and written to.

operator<<() [2/5]

std::ostream& alexaClientSDK::captions::operator<<	(	std::ostream &	stream,
		const Style &	style
	)

Write a Style value to an ostream as a string.

Parameters

stream	The stream to write the value to.
s	The Style value to write to the ostream as a string.

Returns

The ostream that was passed in and written to.

operator<<() [3/5]

std::ostream& alexaClientSDK::captions::operator<<	(	std::ostream &	stream,
		const CaptionLine &	line
	)

Write a CaptionLine value to an ostream as a string.

Parameters

stream	The stream to write the value to.
cl	The caption line value to write to the ostream as a string.

Returns

The ostream that was passed in and written to.

operator<<() [4/5]

std::ostream& alexaClientSDK::captions::operator<<	(	std::ostream &	stream,
		const TextStyle &	textStyle
	)

Write a TextStyle value to an ostream as a string.

Parameters

stream	The stream to write the value to.
s	The TextStyle value to write to the ostream as a string.

Returns

The ostream that was passed in and written to.

operator<<() [5/5]

std::ostream& alexaClientSDK::captions::operator<<	(	std::ostream &	stream,
		const CaptionFrame &	frame
	)

Write a CaptionFrame value to an ostream as a string.

Parameters

stream	The stream to write the value to.
frame	The CaptionFrame value to write to the ostream as a string.

Returns

The ostream that was passed in and written to.