aace::alexa Namespace Reference

Classes
class	AlexaClient
class	AlexaClientEngineInterface
class	AlexaSpeaker
class	AlexaSpeakerEngineInterface
class	AudioPlayer
class	AudioPlayerEngineInterface
class	AuthProvider
class	AuthProviderEngineInterface
class	DeviceSetup
class	DeviceSetupEngineInterface
class	DoNotDisturb
class	DoNotDisturbEngineInterface
class	EqualizerController
class	EqualizerControllerEngineInterface
class	ExternalMediaAdapter
class	ExternalMediaAdapterEngineInterface
class	FeatureDiscoveryEngineInterface
class	GlobalPreset
class	LocalMediaSource
class	LocalMediaSourceEngineInterface
class	MediaPlaybackRequestor
class	MediaPlaybackRequestorEngineInterface
class	Notifications
class	PlaybackController
class	PlaybackControllerEngineInterface
class	SpeechRecognizer
class	SpeechRecognizerEngineInterface
class	SpeechSynthesizer
class	TemplateRuntime
class	TemplateRuntimeEngineInterface

Enumerations
enum	FocusState {   FocusState::FOREGROUND,   FocusState::BACKGROUND,   FocusState::NONE }
enum	PlayerActivity {   PlayerActivity::IDLE,   PlayerActivity::PLAYING,   PlayerActivity::STOPPED,   PlayerActivity::PAUSED,   PlayerActivity::BUFFER_UNDERRUN,   PlayerActivity::FINISHED }

Functions
std::string	equalizerBandToString (const EqualizerControllerEngineInterface::EqualizerBand &band)
std::ostream &	operator<< (std::ostream &stream, const EqualizerControllerEngineInterface::EqualizerBand &band)
std::string	invocationReasonToString (const MediaPlaybackRequestorEngineInterface::InvocationReason &invocationReason)
std::ostream &	operator<< (std::ostream &stream, const MediaPlaybackRequestorEngineInterface::InvocationReason &invocationReason)
std::string	deviceSetupStatusCodeToString (const DeviceSetup::StatusCode &statusCode)
std::string	mediaPlaybackRequestorMediaPlaybackRequestStatusToString (const MediaPlaybackRequestor::MediaPlaybackRequestStatus &mediaPlaybackRequestStatus)

Detailed Description

The alexa namespace.

Enumeration Type Documentation

FocusState

enum aace::alexa::FocusState

strong

An enum class used to specify the levels of focus that a Channel can have.

Enumerator
FOREGROUND	Represents the highest focus a Channel can have.
BACKGROUND	Represents the intermediate level focus a Channel can have.
NONE	This focus is used to represent when a Channel is not being used.

PlayerActivity

enum aace::alexa::PlayerActivity

strong

An enum class used to specify player activity for AudioPlayer and audio player state for TemplateRuntime.

Enumerator
IDLE	Audio playback has not yet begun.
PLAYING	Audio is currently playing.
STOPPED	Audio playback is stopped, either from a stop directive or playback error.
PAUSED	Audio playback is paused.
BUFFER_UNDERRUN	Audio playback is stalled because a buffer underrun has occurred.
FINISHED	Audio playback is finished.

Function Documentation

equalizerBandToString()

std::string aace::alexa::equalizerBandToString ( const EqualizerControllerEngineInterface::EqualizerBand &  band )

inline

Provides a string representation for an EqualizerControllerEngineInterface::EqualizerBand

Parameters

band	The EqualizerBand

Returns

A string representation for the EqualizerBand

operator<<() [1/2]

std::ostream& aace::alexa::operator<< ( std::ostream &  stream, const EqualizerControllerEngineInterface::EqualizerBand &  band  )

inline

Write an EqualizerControllerEngineInterface::EqualizerBand value to an ostream as a string

Parameters

stream	The stream to write to
band	The EqualizerBand value to write to the ostream

Returns

The ostream argument that was written to

invocationReasonToString()

std::string aace::alexa::invocationReasonToString ( const MediaPlaybackRequestorEngineInterface::InvocationReason &  invocationReason )

inline

Provides a string representation for an MediaPlaybackRequestorEngineInterface::InvocationReason

Parameters

invocationReason

The InvocationReason

Returns

A string representation for the InvocationReason

operator<<() [2/2]

std::ostream& aace::alexa::operator<< ( std::ostream &  stream, const MediaPlaybackRequestorEngineInterface::InvocationReason &  invocationReason  )

inline

Write an MediaPlaybackRequestorEngineInterface::InvocationReason value to an ostream as a string

Parameters

stream	The stream to write to
band	The InvocationReason value to write to the ostream

Returns

The ostream argument that was written to

deviceSetupStatusCodeToString()

std::string aace::alexa::deviceSetupStatusCodeToString ( const DeviceSetup::StatusCode &  statusCode )

inline

This function returns the std::string equivalent of the input enum value

mediaPlaybackRequestorMediaPlaybackRequestStatusToString()

std::string aace::alexa::mediaPlaybackRequestorMediaPlaybackRequestStatusToString ( const MediaPlaybackRequestor::MediaPlaybackRequestStatus &  mediaPlaybackRequestStatus )

inline

This function returns the std::string equivalent of the input enum value