alexaClientSDK::avsCommon::sdkInterfaces Namespace Reference

Namespaces
	audio
	bluetooth
	diagnostics
	endpoints
	modeController
	powerController
	rangeController
	softwareInfo
	storage
	test
	timing
	toggleController

Classes
class	AlexaEventProcessedObserverInterface
class	AlexaInterfaceMessageSenderInterface
struct	ApplicationMediaInterfaces
struct	AudioFocusAnnotation
class	AudioInputProcessorObserverInterface
	A state observer for an AudioInputProcessor. More...
class	AuthDelegateInterface
class	AuthObserverInterface
class	AVSConnectionManagerInterface
class	AVSGatewayAssignerInterface
class	AVSGatewayManagerInterface
class	AVSGatewayObserverInterface
class	CallManagerInterface
class	CallStateObserverInterface
class	CapabilitiesDelegateInterface
class	CapabilitiesDelegateObserverInterface
class	CapabilityConfigurationChangeObserverInterface
class	CapabilityConfigurationInterface
class	ChannelObserverInterface
class	ChannelVolumeFactoryInterface
class	ChannelVolumeInterface
class	ComponentReporterInterface
class	ConnectionStatusObserverInterface
class	ContextManagerInterface
class	ContextManagerObserverInterface
class	ContextRequesterInterface
class	DialogUXStateObserverInterface
	A dialog specific UX state observer. More...
class	DirectiveHandlerInterface
class	DirectiveHandlerResultInterface
class	DirectiveSequencerInterface
class	DtmfObserverInterface
class	EventTracerInterface
class	ExceptionEncounteredSenderInterface
class	ExpectSpeechTimeoutHandlerInterface
class	FocusManagerInterface
class	FocusManagerObserverInterface
	An interface that clients can extend to register to observe focus changes. More...
class	GlobalSettingsObserverInterface
class	GUIActivityEventObserverInterface
class	HTTPContentFetcherInterface
class	HTTPContentFetcherInterfaceFactoryInterface
class	InternetConnectionMonitorInterface
class	InternetConnectionObserverInterface
class	KeyWordDetectorStateObserverInterface
class	KeyWordObserverInterface
class	LocaleAssetsManagerInterface
class	LocaleAssetsObserverInterface
class	LocalPlaybackHandlerInterface
class	MediaPropertiesInterface
class	MessageObserverInterface
class	MessageRequestObserverInterface
class	MessageSenderInterface
	This specifies an interface to send a message. More...
class	PlaybackHandlerInterface
class	PlaybackRouterInterface
class	PostConnectOperationInterface
class	PostConnectOperationProviderInterface
class	PowerResourceManagerInterface
class	RenderPlayerInfoCardsObserverInterface
class	RenderPlayerInfoCardsProviderInterface
class	RenderPlayerInfoCardsProviderRegistrarInterface
class	RevokeAuthorizationObserverInterface
class	SingleSettingObserverInterface
class	SoftwareInfoSenderObserverInterface
class	SpeakerInterface
class	SpeakerManagerInterface
class	SpeakerManagerObserverInterface
class	SpeechInteractionHandlerInterface
class	SpeechSynthesizerObserverInterface
class	StateProviderInterface
class	StateSynchronizerObserverInterface
class	SystemSoundPlayerInterface
class	SystemTimeZoneInterface
class	UserInactivityMonitorInterface
class	UserInactivityMonitorObserverInterface
struct	VisualFocusAnnotation

Typedefs
using	CapabilitiesObserverInterface = CapabilitiesDelegateObserverInterface
using	ContextRequestToken = unsigned int
	Alias for the token used to identify a context request. More...

Enumerations
enum	AlexaStateChangeCauseType {   AlexaStateChangeCauseType::ALEXA_INTERACTION, AlexaStateChangeCauseType::APP_INTERACTION, AlexaStateChangeCauseType::PHYSICAL_INTERACTION, AlexaStateChangeCauseType::PERIODIC_POLL,   AlexaStateChangeCauseType::RULE_TRIGGER, AlexaStateChangeCauseType::VOICE_INTERACTION }
enum	SetStateResult { SetStateResult::SUCCESS, SetStateResult::STATE_PROVIDER_NOT_REGISTERED, SetStateResult::STATE_TOKEN_OUTDATED }
enum	ContextRequestError { ContextRequestError::STATE_PROVIDER_TIMEDOUT, ContextRequestError::BUILD_CONTEXT_ERROR, ContextRequestError::ENDPOINT_UNREACHABLE }
enum	GUIActivityEvent { GUIActivityEvent::ACTIVATED, GUIActivityEvent::DEACTIVATED, GUIActivityEvent::INTERRUPT, GUIActivityEvent::UNKNOWN }
	Enumeration of activity events used to indicate the state of a GUI. More...

Functions
std::string	alexaStateChangeCauseTypeToString (AlexaStateChangeCauseType cause)
std::ostream &	operator<< (std::ostream &stream, const AudioInputProcessorObserverInterface::State &state)
bool	operator== (const AuthObserverInterface::FullState &lhs, const AuthObserverInterface::FullState &rhs)
std::ostream &	operator<< (std::ostream &stream, const AuthObserverInterface::State &state)
std::ostream &	operator<< (std::ostream &stream, const AuthObserverInterface::Error &error)
std::ostream &	operator<< (std::ostream &stream, const CallStateObserverInterface::CallState &state)
std::ostream &	operator<< (std::ostream &stream, const CapabilitiesDelegateObserverInterface::State &state)
std::ostream &	operator<< (std::ostream &stream, const CapabilitiesDelegateObserverInterface::Error &error)
std::ostream &	operator<< (std::ostream &stream, ChannelVolumeInterface::Type type)
std::ostream &	operator<< (std::ostream &stream, ConnectionStatusObserverInterface::Status status)
std::ostream &	operator<< (std::ostream &stream, ConnectionStatusObserverInterface::ChangedReason reason)
std::ostream &	operator<< (std::ostream &stream, const ContextRequestError &error)
std::ostream &	operator<< (std::ostream &stream, const DialogUXStateObserverInterface::DialogUXState &state)
GUIActivityEvent	guiActivityEventFromString (const std::string &string)
std::string	guiActivityEventToString (GUIActivityEvent event)
std::ostream &	operator<< (std::ostream &stream, const GUIActivityEvent &activityEvent)
std::ostream &	operator<< (std::ostream &os, const HTTPContentFetcherInterface::State &state)
std::ostream &	operator<< (std::ostream &stream, MessageRequestObserverInterface::Status status)
std::string	powerResourceLevelToString (PowerResourceManagerInterface::PowerResourceLevel level)
std::ostream &	operator<< (std::ostream &stream, PowerResourceManagerInterface::PowerResourceLevel level)
std::ostream &	operator<< (std::ostream &stream, SpeakerManagerObserverInterface::Source source)
std::ostream &	operator<< (std::ostream &stream, const SpeechSynthesizerObserverInterface::SpeechSynthesizerState state)

Variables
static const int	ENGINE_TYPE_ALEXA_VOICE_SERVICES = 1

Typedef Documentation

CapabilitiesObserverInterface

using alexaClientSDK::avsCommon::sdkInterfaces::CapabilitiesObserverInterface = typedef CapabilitiesDelegateObserverInterface

Deprecated:

Use CapabilitiesDelegateObserverInterface instead. This interface has been renamed to avoid being confused with the CapabilityConfigurationChangeObserverInterface.

This alias is being maintained for now to support backwards compatibility.

ContextRequestToken

using alexaClientSDK::avsCommon::sdkInterfaces::ContextRequestToken = typedef unsigned int

Alias for the token used to identify a context request.

Enumeration Type Documentation

AlexaStateChangeCauseType

enum alexaClientSDK::avsCommon::sdkInterfaces::AlexaStateChangeCauseType

strong

Enumeration used to identify the cause of a property value change.

Enumerator
ALEXA_INTERACTION
APP_INTERACTION
PHYSICAL_INTERACTION
PERIODIC_POLL
RULE_TRIGGER
VOICE_INTERACTION

ContextRequestError

enum alexaClientSDK::avsCommon::sdkInterfaces::ContextRequestError

strong

This enum expresses the result of a getContext operation.

Enumerator
STATE_PROVIDER_TIMEDOUT	getContext request failed due to a timeout on one or more stateProviderInterfaces.
BUILD_CONTEXT_ERROR	getContext request failed due to an error building the context.
ENDPOINT_UNREACHABLE	getContext request failed due to an error while trying to reach out to the endpoint.

GUIActivityEvent

enum alexaClientSDK::avsCommon::sdkInterfaces::GUIActivityEvent

strong

Enumeration of activity events used to indicate the state of a GUI.

Enumerator
ACTIVATED	GUI switched to active state (audio/video started).
DEACTIVATED	GUI become inactive.
INTERRUPT	Interrupt event (touch/scroll/etc).
UNKNOWN	Guard option for unknown received state.

SetStateResult

enum alexaClientSDK::avsCommon::sdkInterfaces::SetStateResult

strong

This enum expresses the result of a setState operation.

Deprecated:

The setState operation has been deprecated and so is this enumeration.

Enumerator
SUCCESS	setState request was successful.
STATE_PROVIDER_NOT_REGISTERED	setState request failed because the StateProviderInterface is not registered with the ContextManager.
STATE_TOKEN_OUTDATED	setState request failed because the StateProviderInterface provided the wrong token to the ContextManager.

Function Documentation

alexaStateChangeCauseTypeToString()

std::string alexaClientSDK::avsCommon::sdkInterfaces::alexaStateChangeCauseTypeToString ( AlexaStateChangeCauseType  cause )

inline

This function converts the provided AlexaStateChangeCauseType to a string.

Parameters

cause

The AlexaStateChangeCauseType to convert to a string.

Returns

The string conversion of the AlexaStateChangeCauseType.

guiActivityEventFromString()

GUIActivityEvent alexaClientSDK::avsCommon::sdkInterfaces::guiActivityEventFromString ( const std::string &  string )

inline

This function converts the provided string to an GUIActivityEvent.

Parameters

string

The string to convert to GUIActivityEvent.

Returns

The GUIActivityEvent.

guiActivityEventToString()

std::string alexaClientSDK::avsCommon::sdkInterfaces::guiActivityEventToString ( GUIActivityEvent  event )

inline

This function converts a GUIActivityEvent to a string.

Parameters

event

the GUIActivityEvent to be converted.

Returns

the string representation of the GUIActivityEvent.

operator<<() [1/17]

std::ostream& alexaClientSDK::avsCommon::sdkInterfaces::operator<< ( std::ostream &  stream, SpeakerManagerObserverInterface::Source  source  )

inline

Write a Source value to an ostream as a string.

Parameters

stream	The stream to write the value to.
type	The source value to write to the ostream as a string.

Returns

The ostream that was passed in and written to.

operator<<() [2/17]

std::ostream& alexaClientSDK::avsCommon::sdkInterfaces::operator<< ( std::ostream &  stream, const SpeechSynthesizerObserverInterface::SpeechSynthesizerState  state  )

inline

Write a State value to an ostream as a string.

Parameters

stream	The stream to write the value to.
state	The state value to write to the ostream as a string.

Returns

The ostream that was passed in and written to.

operator<<() [3/17]

std::ostream& alexaClientSDK::avsCommon::sdkInterfaces::operator<< ( std::ostream &  stream, const GUIActivityEvent &  activityEvent  )

inline

Write an GUIActivityEvent value to an ostream as a string.

Parameters

stream	The stream to write the value to.
state	The GUIActivityEvent value.

Returns

The ostream that was passed in and written to.

operator<<() [4/17]

std::ostream& alexaClientSDK::avsCommon::sdkInterfaces::operator<< ( std::ostream &  stream, const CapabilitiesDelegateObserverInterface::State &  state  )

inline

Write a State value to an ostream as a string.

Parameters

stream	The stream to write the value to.
state	The state value to write to the ostream as a string.

Returns

The ostream that was passed in and written to.

operator<<() [5/17]

std::ostream& alexaClientSDK::avsCommon::sdkInterfaces::operator<< ( std::ostream &  stream, const AudioInputProcessorObserverInterface::State &  state  )

inline

Write an AudioInputProcessorObserverInterface::State value to an ostream as a string.

Parameters

stream	The stream to write the value to.
state	The AudioInputProcessorObserverInterface::State value to write to the ostream as a string.

Returns

The ostream that was passed in and written to.

operator<<() [6/17]

std::ostream& alexaClientSDK::avsCommon::sdkInterfaces::operator<< ( std::ostream &  stream, const DialogUXStateObserverInterface::DialogUXState &  state  )

inline

Write a DialogUXStateObserverInterface::DialogUXState value to an ostream as a string.

Parameters

stream	The stream to write the value to.
state	The DialogUXStateObserverInterface::DialogUXState value to write to the ostream as a string.

Returns

The ostream that was passed in and written to.

operator<<() [7/17]

std::ostream& alexaClientSDK::avsCommon::sdkInterfaces::operator<< ( std::ostream &  stream, const CapabilitiesDelegateObserverInterface::Error &  error  )

inline

Write an Error value to an ostream as a string.

Parameters

stream	The stream to write the value to.
error	The error value to write to the ostream as a string.

Returns

The ostream that was passed in and written to.

operator<<() [8/17]

std::ostream& alexaClientSDK::avsCommon::sdkInterfaces::operator<< ( std::ostream &  stream, const CallStateObserverInterface::CallState &  state  )

inline

Write a CallState value to an ostream as a string.

Parameters

stream	The stream to write the value to.
state	The CallState value to write to the ostream as a string.

Returns

The ostream that was passed in and written to.

operator<<() [9/17]

std::ostream& alexaClientSDK::avsCommon::sdkInterfaces::operator<< ( std::ostream &  stream, MessageRequestObserverInterface::Status  status  )

inline

Write a MessageRequestObserverInterface::Status value to an ostream as a string.

Parameters

stream	The stream to write the value to.
reason	The status to write to the ostream as a string.

Returns

The ostream that was passed in and written to.

operator<<() [10/17]

std::ostream& alexaClientSDK::avsCommon::sdkInterfaces::operator<< ( std::ostream &  stream, const ContextRequestError &  error  )

inline

Write a ContextRequestError value to an ostream as a string.

Parameters

stream	The stream to write the value to.
error	The error value to write to the ostream as a string.

Returns

The ostream that was passed in and written to.

operator<<() [11/17]

std::ostream& alexaClientSDK::avsCommon::sdkInterfaces::operator<< ( std::ostream &  stream, ChannelVolumeInterface::Type  type  )

inline

Write a Type value to an ostream as a string.

Parameters

stream	The stream to write the value to.
type	The type value to write to the ostream as a string.

Returns

The ostream that was passed in and written to.

operator<<() [12/17]

std::ostream& alexaClientSDK::avsCommon::sdkInterfaces::operator<< ( std::ostream &  stream, const AuthObserverInterface::State &  state  )

inline

Write a State value to an ostream as a string.

Parameters

stream	The stream to write the value to.
state	The state value to write to the ostream as a string.

Returns

The ostream that was passed in and written to.

operator<<() [13/17]

std::ostream& alexaClientSDK::avsCommon::sdkInterfaces::operator<< ( std::ostream &  stream, ConnectionStatusObserverInterface::Status  status  )

inline

Write a ConnectionStatusObserverInterface::Status value to an ostream as a string.

Parameters

stream	The stream to write the value to.
status	The ConnectionStatusObserverInterface::Status value to write to the ostream as a string.

Returns

The ostream that was passed in and written to.

operator<<() [14/17]

std::ostream& alexaClientSDK::avsCommon::sdkInterfaces::operator<< ( std::ostream &  stream, const AuthObserverInterface::Error &  error  )

inline

Write an Error value to an ostream as a string.

Parameters

stream	The stream to write the value to.
error	The error value to write to the ostream as a string.

Returns

The ostream that was passed in and written to.

operator<<() [15/17]

std::ostream& alexaClientSDK::avsCommon::sdkInterfaces::operator<< ( std::ostream &  stream, ConnectionStatusObserverInterface::ChangedReason  reason  )

inline

Write a ConnectionStatusObserverInterface::ChangeReason value to an ostream as a string.

Parameters

stream	The stream to write the value to.
reason	The ConnectionStatusObserverInterface::ChangeReason value to write to the ostream as a string.

Returns

The ostream that was passed in and written to.

operator<<() [16/17]

std::ostream& alexaClientSDK::avsCommon::sdkInterfaces::operator<< ( std::ostream &  os, const HTTPContentFetcherInterface::State &  state  )

inline

Overwrites the << operator for HTTPContentFetcherInterface::State.

Parameters

os	The output stream pointer.
code	The HTTPContentFetcherInterface::State to write to the output stream.

Returns

The output stream pointer.

operator<<() [17/17]

std::ostream& alexaClientSDK::avsCommon::sdkInterfaces::operator<< ( std::ostream &  stream, PowerResourceManagerInterface::PowerResourceLevel  level  )

inline

Overload for the PowerResourceLevel enum. This will write the PowerResourceLevel as a string to the provided stream.

Parameters

An	ostream to send the level as a string.
The	level to convert.

Returns

The stream.

operator==()

bool alexaClientSDK::avsCommon::sdkInterfaces::operator== ( const AuthObserverInterface::FullState &  lhs, const AuthObserverInterface::FullState &  rhs  )

inline

Operator overload to compare two FullState objects.

Parameters

lhs	The object to compare.
rhs	Another object to compare.

Whether the two objects are considered equivalent.

powerResourceLevelToString()

std::string alexaClientSDK::avsCommon::sdkInterfaces::powerResourceLevelToString ( PowerResourceManagerInterface::PowerResourceLevel  level )

inline

Converts the PowerResourceLevel enum to a string.

Parameters

The	level to convert.

Returns

A string representation of the level.

Variable Documentation

ENGINE_TYPE_ALEXA_VOICE_SERVICES

const int alexaClientSDK::avsCommon::sdkInterfaces::ENGINE_TYPE_ALEXA_VOICE_SERVICES = 1

static