AlexaClientSDK  1.20.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Namespaces | Classes | Typedefs | Enumerations | Functions
alexaClientSDK::avsCommon::sdkInterfaces Namespace Reference

Namespaces

 audio
 
 bluetooth
 
 diagnostics
 
 endpoints
 
 externalMediaPlayer
 
 modeController
 
 powerController
 
 rangeController
 
 softwareInfo
 
 storage
 
 test
 
 toggleController
 

Classes

class  AlexaEventProcessedObserverInterface
 
class  AlexaInterfaceMessageSenderInterface
 
struct  ApplicationMediaInterfaces
 
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  CapabilitiesObserverInterface
 
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  EventTracerInterface
 
class  ExceptionEncounteredSenderInterface
 
class  ExternalMediaPlayerInterface
 
class  FocusManagerInterface
 
class  FocusManagerObserverInterface
 An interface that clients can extend to register to observe focus changes. More...
 
class  GlobalSettingsObserverInterface
 
class  HTTPContentFetcherInterface
 
class  HTTPContentFetcherInterfaceFactoryInterface
 
class  InteractionModelRequestProcessingObserverInterface
 A directive observer for an InteractionModelCapabilityAgent. More...
 
class  InternetConnectionMonitorInterface
 
class  InternetConnectionObserverInterface
 
class  KeyWordDetectorStateObserverInterface
 
class  KeyWordObserverInterface
 
class  LocaleAssetsManagerInterface
 
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  RevokeAuthorizationObserverInterface
 
class  SingleSettingObserverInterface
 
class  SoftwareInfoSenderObserverInterface
 
class  SpeakerInterface
 
class  SpeakerManagerInterface
 
class  SpeakerManagerObserverInterface
 
class  SpeechInteractionHandlerInterface
 
class  SpeechSynthesizerObserverInterface
 
class  StateProviderInterface
 
class  StateSynchronizerObserverInterface
 
class  SystemClockMonitorObserverInterface
 
class  SystemSoundPlayerInterface
 
class  SystemTimeZoneInterface
 
class  TemplateRuntimeObserverInterface
 
class  UserInactivityMonitorInterface
 
class  UserInactivityMonitorObserverInterface
 

Typedefs

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 }
 

Functions

std::string alexaStateChangeCauseTypeToString (AlexaStateChangeCauseType cause)
 
std::ostream & operator<< (std::ostream &stream, const AudioInputProcessorObserverInterface::State &state)
 
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 CapabilitiesObserverInterface::State &state)
 
std::ostream & operator<< (std::ostream &stream, const CapabilitiesObserverInterface::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)
 
std::ostream & operator<< (std::ostream &os, const HTTPContentFetcherInterface::State &state)
 
std::ostream & operator<< (std::ostream &stream, MessageRequestObserverInterface::Status status)
 
std::ostream & operator<< (std::ostream &stream, SpeakerManagerObserverInterface::Source source)
 
std::ostream & operator<< (std::ostream &stream, const SpeechSynthesizerObserverInterface::SpeechSynthesizerState state)
 

Typedef Documentation

◆ ContextRequestToken

Alias for the token used to identify a context request.

Enumeration Type Documentation

◆ AlexaStateChangeCauseType

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

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.

◆ SetStateResult

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
causeThe AlexaStateChangeCauseType to convert to a string.
Returns
The string conversion of the AlexaStateChangeCauseType.

◆ operator<<() [1/15]

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

Write a Source value to an ostream as a string.

Parameters
streamThe stream to write the value to.
typeThe source value to write to the ostream as a string.
Returns
The ostream that was passed in and written to.

◆ operator<<() [2/15]

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
streamThe stream to write the value to.
stateThe CallState value to write to the ostream as a string.
Returns
The ostream that was passed in and written to.

◆ operator<<() [3/15]

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
streamThe stream to write the value to.
stateThe state value to write to the ostream as a string.
Returns
The ostream that was passed in and written to.

◆ operator<<() [4/15]

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
streamThe stream to write the value to.
stateThe AudioInputProcessorObserverInterface::State value to write to the ostream as a string.
Returns
The ostream that was passed in and written to.

◆ operator<<() [5/15]

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

Write a State value to an ostream as a string.

Parameters
streamThe stream to write the value to.
stateThe state value to write to the ostream as a string.
Returns
The ostream that was passed in and written to.

◆ operator<<() [6/15]

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
streamThe stream to write the value to.
stateThe state value to write to the ostream as a string.
Returns
The ostream that was passed in and written to.

◆ operator<<() [7/15]

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
streamThe stream to write the value to.
reasonThe status to write to the ostream as a string.
Returns
The ostream that was passed in and written to.

◆ operator<<() [8/15]

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
streamThe stream to write the value to.
stateThe DialogUXStateObserverInterface::DialogUXState value to write to the ostream as a string.
Returns
The ostream that was passed in and written to.

◆ operator<<() [9/15]

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

Write an Error value to an ostream as a string.

Parameters
streamThe stream to write the value to.
errorThe error value to write to the ostream as a string.
Returns
The ostream that was passed in and written to.

◆ operator<<() [10/15]

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

Write a Type value to an ostream as a string.

Parameters
streamThe stream to write the value to.
typeThe type value to write to the ostream as a string.
Returns
The ostream that was passed in and written to.

◆ operator<<() [11/15]

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
streamThe stream to write the value to.
statusThe ConnectionStatusObserverInterface::Status value to write to the ostream as a string.
Returns
The ostream that was passed in and written to.

◆ operator<<() [12/15]

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

Write a ContextRequestError value to an ostream as a string.

Parameters
streamThe stream to write the value to.
errorThe error value to write to the ostream as a string.
Returns
The ostream that was passed in and written to.

◆ operator<<() [13/15]

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
streamThe stream to write the value to.
errorThe error value to write to the ostream as a string.
Returns
The ostream that was passed in and written to.

◆ operator<<() [14/15]

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
streamThe stream to write the value to.
reasonThe ConnectionStatusObserverInterface::ChangeReason value to write to the ostream as a string.
Returns
The ostream that was passed in and written to.

◆ operator<<() [15/15]

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

Overwrites the << operator for HTTPContentFetcherInterface::State.

Parameters
osThe output stream pointer.
codeThe HTTPContentFetcherInterface::State to write to the output stream.
Returns
The output stream pointer.

AlexaClientSDK 1.20.0 - Copyright 2016-2020 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0