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

Namespaces

 attachment
 
 capabilitySemantics
 
 constants
 
 directiveRoutingRule
 
 initialization
 
 resources
 
 speakerConstants
 
 test
 

Classes

class  AbstractAVSConnectionManager
 
class  AVSContext
 
class  AVSDirective
 
struct  AVSDiscoveryEndpointAttributes
 
class  AVSMessage
 
struct  AVSMessageEndpoint
 
class  AVSMessageHeader
 
class  BlockingPolicy
 
class  CapabilityAgent
 
struct  CapabilityConfiguration
 
class  CapabilityResources
 
struct  CapabilityState
 
struct  CapabilityTag
 
struct  ComponentConfiguration
 
class  DialogUXStateAggregator
 
class  EditableMessageRequest
 
class  ExceptionEncounteredSender
 
class  HandlerAndPolicy
 
class  MessageRequest
 
class  NamespaceAndName
 
struct  PlayRequestor
 
class  WaitableMessageRequest
 

Typedefs

using AudioInputStream = utils::sds::SharedDataStream< utils::sds::InProcessSDSTraits >
 The type used store and stream binary data. More...
 
using CapabilityChangeNotifier = notifier::Notifier< avsCommon::sdkInterfaces::CapabilityConfigurationChangeObserverInterface >
 
using CapabilityChangeNotifierInterface = notifierInterfaces::NotifierInterface< sdkInterfaces::CapabilityConfigurationChangeObserverInterface >
 
using DirectiveHandlerConfiguration = std::unordered_map< directiveRoutingRule::DirectiveRoutingRule, BlockingPolicy >
 

Enumerations

enum  AlexaResponseType {
  AlexaResponseType::SUCCESS, AlexaResponseType::ALREADY_IN_OPERATION, AlexaResponseType::BRIDGE_UNREACHABLE, AlexaResponseType::ENDPOINT_BUSY,
  AlexaResponseType::ENDPOINT_LOW_POWER, AlexaResponseType::ENDPOINT_UNREACHABLE, AlexaResponseType::FIRMWARE_OUT_OF_DATE, AlexaResponseType::HARDWARE_MALFUNCTION,
  AlexaResponseType::INSUFFICIENT_PERMISSIONS, AlexaResponseType::INTERNAL_ERROR, AlexaResponseType::INVALID_VALUE, AlexaResponseType::NOT_CALIBRATED,
  AlexaResponseType::NOT_SUPPORTED_IN_CURRENT_MODE, AlexaResponseType::NOT_IN_OPERATION, AlexaResponseType::POWER_LEVEL_NOT_SUPPORTED, AlexaResponseType::RATE_LIMIT_EXCEEDED,
  AlexaResponseType::TEMPERATURE_VALUE_OUT_OF_RANGE, AlexaResponseType::VALUE_OUT_OF_RANGE
}
 
enum  ContentType { ContentType::MIXABLE, ContentType::NONMIXABLE, ContentType::UNDEFINED, ContentType::NUM_CONTENT_TYPE }
 
enum  ExceptionErrorType { ExceptionErrorType::UNEXPECTED_INFORMATION_RECEIVED, ExceptionErrorType::UNSUPPORTED_OPERATION, ExceptionErrorType::INTERNAL_ERROR }
 
enum  FocusState { FocusState::FOREGROUND, FocusState::BACKGROUND, FocusState::NONE }
 
enum  IndicatorState { IndicatorState::OFF = 0, IndicatorState::ON = 1, IndicatorState::UNDEFINED }
 
enum  MixingBehavior {
  MixingBehavior::PRIMARY, MixingBehavior::MAY_DUCK, MixingBehavior::MUST_PAUSE, MixingBehavior::MUST_STOP,
  MixingBehavior::UNDEFINED
}
 
enum  PlaybackButton {
  PlaybackButton::PLAY, PlaybackButton::PAUSE, PlaybackButton::NEXT, PlaybackButton::PREVIOUS,
  PlaybackButton::SKIP_FORWARD, PlaybackButton::SKIP_BACKWARD
}
 Enumeration class for supported playback buttons. More...
 
enum  PlaybackToggle {
  PlaybackToggle::SHUFFLE, PlaybackToggle::LOOP, PlaybackToggle::REPEAT, PlaybackToggle::THUMBS_UP,
  PlaybackToggle::THUMBS_DOWN
}
 
enum  PlayBehavior { PlayBehavior::REPLACE_ALL, PlayBehavior::ENQUEUE, PlayBehavior::REPLACE_ENQUEUED }
 Used to determine how a client must handle queueing and playback of a stream. More...
 
enum  PlayerActivity {
  PlayerActivity::IDLE, PlayerActivity::PLAYING, PlayerActivity::STOPPED, PlayerActivity::PAUSED,
  PlayerActivity::BUFFER_UNDERRUN, PlayerActivity::FINISHED
}
 Identifies the player state. More...
 
enum  Requester { Requester::CLOUD, Requester::DEVICE }
 An enum class indicating whether an operation originated from a Device or Cloud (AVS). More...
 
enum  StateRefreshPolicy { StateRefreshPolicy::NEVER, StateRefreshPolicy::ALWAYS, StateRefreshPolicy::SOMETIMES }
 

Functions

std::ostream & operator<< (std::ostream &stream, AlexaResponseType responseType)
 
std::string avsDirectiveParseStatusToString (AVSDirective::ParseStatus status)
 
std::ostream & operator<< (std::ostream &stream, const AVSDirective::ParseStatus &status)
 
std::ostream & operator<< (std::ostream &stream, const BlockingPolicy &policy)
 
bool operator== (const BlockingPolicy &lhs, const BlockingPolicy &rhs)
 
bool operator!= (const BlockingPolicy &lhs, const BlockingPolicy &rhs)
 
bool operator== (const CapabilityConfiguration::Properties &lhs, const CapabilityConfiguration::Properties &rhs)
 
bool operator!= (const CapabilityConfiguration::Properties &lhs, const CapabilityConfiguration::Properties &rhs)
 
bool operator== (const CapabilityConfiguration &lhs, const CapabilityConfiguration &rhs)
 
bool operator!= (const CapabilityConfiguration &lhs, const CapabilityConfiguration &rhs)
 
bool operator== (const std::shared_ptr< CapabilityConfiguration > &lhs, const std::shared_ptr< CapabilityConfiguration > &rhs)
 
bool operator!= (const std::shared_ptr< CapabilityConfiguration > &lhs, const std::shared_ptr< CapabilityConfiguration > &rhs)
 
std::ostream & operator<< (std::ostream &stream, const CapabilityTag &identifier)
 
bool operator== (const ComponentConfiguration &lhs, const ComponentConfiguration &rhs)
 
bool operator!= (const ComponentConfiguration &lhs, const ComponentConfiguration &rhs)
 
bool operator== (const std::shared_ptr< ComponentConfiguration > &lhs, const std::shared_ptr< ComponentConfiguration > &rhs)
 
bool operator!= (const std::shared_ptr< ComponentConfiguration > &lhs, const std::shared_ptr< ComponentConfiguration > &rhs)
 
std::string contentTypeToString (ContentType contentType)
 
std::ostream & operator<< (std::ostream &stream, const ContentType &contentType)
 
const std::pair< std::string, std::string > buildJsonEventString (const std::string &nameSpace, const std::string &eventName, const std::string &dialogRequestIdValue="", const std::string &jsonPayloadValue="{}", const std::string &jsonContext="")
 
std::string buildJsonEventString (const AVSMessageHeader &eventHeader, const utils::Optional< AVSMessageEndpoint > &endpoint, const std::string &jsonPayloadValue, const std::string &jsonContext)
 
std::string buildJsonEventString (const AVSMessageHeader &eventHeader, const utils::Optional< AVSMessageEndpoint > &endpoint=utils::Optional< AVSMessageEndpoint >(), const std::string &jsonPayloadValue="{}", const utils::Optional< AVSContext > &context=utils::Optional< AVSContext >())
 
std::ostream & operator<< (std::ostream &stream, ExceptionErrorType type)
 
std::string focusStateToString (FocusState state)
 
std::ostream & operator<< (std::ostream &stream, const FocusState &state)
 
bool operator== (const HandlerAndPolicy &lhs, const HandlerAndPolicy &rhs)
 
bool operator!= (const HandlerAndPolicy &lhs, const HandlerAndPolicy &rhs)
 
int indicatorStateToInt (IndicatorState state)
 
IndicatorState intToIndicatorState (int stateNum)
 
std::ostream & operator<< (std::ostream &stream, IndicatorState state)
 
std::string mixingBehaviorToString (MixingBehavior behavior)
 
MixingBehavior getMixingBehavior (const std::string &input)
 
std::ostream & operator<< (std::ostream &stream, const MixingBehavior &behavior)
 
std::string PlaybackButtonToString (PlaybackButton button)
 
std::string PlaybackToggleToString (PlaybackToggle toggle)
 
std::ostream & operator<< (std::ostream &stream, const PlaybackButton &button)
 
std::ostream & operator<< (std::ostream &stream, const PlaybackToggle &toggle)
 
std::string playBehaviorToString (PlayBehavior playBehavior)
 
bool stringToPlayBehavior (const std::string &text, PlayBehavior *playBehavior)
 
std::ostream & operator<< (std::ostream &stream, const PlayBehavior &playBehavior)
 
bool convertToValue (const rapidjson::Value &documentNode, PlayBehavior *playBehavior)
 
std::string playerActivityToString (PlayerActivity playerActivity)
 
std::ostream & operator<< (std::ostream &stream, const PlayerActivity &playerActivity)
 
std::istream & operator>> (std::istream &is, PlayerActivity &value)
 
bool operator== (const PlayRequestor &playRequestorA, const PlayRequestor &playRequestorB)
 
std::string requesterToString (Requester requester)
 
std::ostream & operator<< (std::ostream &stream, Requester requester)
 

Variables

static const auto CAPABILITY_INTERFACE_TYPE_KEY = "type"
 Key for interface type in the CapabilityConfiguration map. More...
 
static const auto CAPABILITY_INTERFACE_NAME_KEY = "interface"
 Key for interface name in the CapabilityConfiguration map. More...
 
static const auto CAPABILITY_INTERFACE_VERSION_KEY = "version"
 Key for interface version in the CapabilityConfiguration map. More...
 
static const auto CAPABILITY_INTERFACE_CONFIGURATIONS_KEY = "configurations"
 Key for interface configurations in the CapabilityConfiguration map. More...
 

Typedef Documentation

◆ AudioInputStream

The type used store and stream binary data.

◆ CapabilityChangeNotifier

Implementation of CapabilityChangeNotifierInterface

◆ CapabilityChangeNotifierInterface

Interface for registering to observe capability change.

◆ DirectiveHandlerConfiguration

Map of blocking policies per DirectiveRoutingRule. This is used by a DirectiveHandlerInterface to declare which directives it can handle.

Enumeration Type Documentation

◆ AlexaResponseType

An enum class indicating possible response from the endpoint on a controller API call. Response are derived from

See also
https://developer.amazon.com/docs/alexa/device-apis/alexa-errorresponse.html
Enumerator
SUCCESS 

Success.

ALREADY_IN_OPERATION 

Endpoint already in operation.

BRIDGE_UNREACHABLE 

The bridge is unreachable or offline.

ENDPOINT_BUSY 

The endpoint was busy and could not perform the requested operation.

ENDPOINT_LOW_POWER 

The endpoint could not perform the requested operation as its battery was low.

ENDPOINT_UNREACHABLE 

The endpoint is unreachable or offline.

FIRMWARE_OUT_OF_DATE 

The endpoint was busy and could not perform because its firmware is out of date.

HARDWARE_MALFUNCTION 

The endpoint was busy and could not perform because it has experienced a hardware malfunction.

INSUFFICIENT_PERMISSIONS 

The caller does not have the permission to perform specified operation on endpoint.

INTERNAL_ERROR 

An error occurred that can't be described by one of the other error types.

INVALID_VALUE 

Invalid value or unsupported value passed.

NOT_CALIBRATED 

The endpoint can't handle the requested operation because it is in a calibration phase, such as warming up.

NOT_SUPPORTED_IN_CURRENT_MODE 

The endpoint can't be set to the specified value because of its current mode of operation.

NOT_IN_OPERATION 

The endpoint is not in operation.

POWER_LEVEL_NOT_SUPPORTED 
RATE_LIMIT_EXCEEDED 

The maximum rate at which an endpoint or bridge can handle the requests has been exceeded.

TEMPERATURE_VALUE_OUT_OF_RANGE 

The endpoint can't be set to the specified value because it's outside the acceptable temperature range.

VALUE_OUT_OF_RANGE 

The endpoint can't be set to the specified value because it's outside the acceptable range.

◆ ContentType

Enumerator
MIXABLE 

Indicates that the corresponding Activity is mixable with other channels Such Activities may duck upon receiving FocusState::BACKGROUND focus

NONMIXABLE 

Indicates that the corresponding Activity is not mixable with other channels Such Activities must pause upon receiving FocusState::BACKGROUND focus

UNDEFINED 

Indicates that the corresponding ContentType was undefined/unitialized.

NUM_CONTENT_TYPE 

Indicates the Number of ContentType enumerations.

◆ ExceptionErrorType

Enumerator
UNEXPECTED_INFORMATION_RECEIVED 

The directive sent to your client was malformed or the payload does not conform to the directive specification.

UNSUPPORTED_OPERATION 

The operation specified by the namespace/name in the directive's header are not supported by the client.

INTERNAL_ERROR 

An error occurred while the device was handling the directive and the error does not fall into the specified categories.

◆ FocusState

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 or when an observer should stop.

◆ IndicatorState

An enum class used to represent the state of the notification indicator.

Note
These values shouldn't be changed before evaluating the effect a change will have on existing databases.
Enumerator
OFF 
ON 
UNDEFINED 

◆ MixingBehavior

Enumerator
PRIMARY 

Indicates that the corresponding Activity is the primary Activity on the AFML Channel.

MAY_DUCK 

Indicates that the corresponding Activity may duck If ducking is not possible, the Activity must pause instead

MUST_PAUSE 

Indicates that the corresponding Activity must pause.

MUST_STOP 

Indicates that the corresponding Activity must stop.

UNDEFINED 

Indicates that the corresponding Activity may adopt any one of the above behaviors.

◆ PlaybackButton

Enumeration class for supported playback buttons.

Enumerator
PLAY 

Playback Controller 'Play' button.

PAUSE 

Playback Controller 'Pause' button.

NEXT 

Playback Controller 'Next' button.

PREVIOUS 

Playback Controller 'Previous' button.

SKIP_FORWARD 
SKIP_BACKWARD 

◆ PlaybackToggle

Enumerator
SHUFFLE 
LOOP 
REPEAT 
THUMBS_UP 
THUMBS_DOWN 

◆ PlayBehavior

Used to determine how a client must handle queueing and playback of a stream.

Enumerator
REPLACE_ALL 

Immediately begin playback of the stream returned with the Play directive, and replace current and enqueued streams.

ENQUEUE 

Adds a stream to the end of the current queue.

REPLACE_ENQUEUED 

Replace all streams in the queue. This does not impact the currently playing stream.

◆ PlayerActivity

Identifies the player state.

Enumerator
IDLE 

Initial state, prior to acting on the first Play directive.

PLAYING 

Indicates that audio is currently playing.

STOPPED 

Indicates that audio playback was stopped due to an error or a directive which stops or replaces the current stream.

PAUSED 

Indicates that the audio stream has been paused.

BUFFER_UNDERRUN 

Indicates that a buffer underrun has occurred and the stream is buffering.

FINISHED 

Indicates that playback has finished.

◆ Requester

An enum class indicating whether an operation originated from a Device or Cloud (AVS).

Enumerator
CLOUD 

The request came from AVS as a result of a directive.

DEVICE 

The request came from the device. Can be from either the AVS device or a connected device.

◆ StateRefreshPolicy

An enum class used to specify the refresh policy for the state information provided by a stateProviderInterface. The stateProviderInterface must specify the refresh policy when it updates its state via setState.

Note: When a stateProviderInterface provides an empty state, the behavior is as follows:

  • For StateRefreshPolicy ALWAYS and NEVER, the empty state is included in the context.
  • For StateRefreshPolicy SOMETIMES, the empty state is NOT included in the context.
Enumerator
NEVER 

Indicates to the ContextManager that the state information need not be updated on a getContext request. The stateProviderInterface is responsible for updating its state manually.

ALWAYS 

Indicates to the ContextManager that the stateProvider needs to be queried and the state refreshed every time it processes a getContext request.

SOMETIMES 

Indicates to the ContextManager that the stateProvider needs to be queried and the state refreshed every time it processes a getContext request. The stateProvider may choose to not report context by supplying an empty jsonState via setState.

Function Documentation

◆ avsDirectiveParseStatusToString()

std::string alexaClientSDK::avsCommon::avs::avsDirectiveParseStatusToString ( AVSDirective::ParseStatus  status)
inline

This function converts the provided ParseStatus to a string.

Parameters
statusThe ParseStatus to convert to a string.
Returns
The string conversion of the ParseStatus.

◆ buildJsonEventString() [1/3]

const std::pair<std::string, std::string> alexaClientSDK::avsCommon::avs::buildJsonEventString ( const std::string &  nameSpace,
const std::string &  eventName,
const std::string &  dialogRequestIdValue = "",
const std::string &  jsonPayloadValue = "{}",
const std::string &  jsonContext = "" 
)

Builds a JSON event string which includes the header, the payload and an optional context. The header includes the namespace, name, message Id and an optional dialogRequestId. The message Id required for the header is a random string that is generated and added to the header.

Deprecated:
This method is being deprecated in favor of the method with Endpoint information.
Parameters
nameSpaceThe namespace of the event to be include in the header.
eventNameThe name of the event to be include in the header.
dialogRequestIdStringOptional value associated with the "dialogRequestId" key.
payloadOptional payload value associated with the "payload" key.
contextOptional context to be sent with the event message.
Returns
A pair object consisting of the messageId and the event JSON string if successful, else a pair of empty strings.

◆ buildJsonEventString() [2/3]

std::string alexaClientSDK::avsCommon::avs::buildJsonEventString ( const AVSMessageHeader eventHeader,
const utils::Optional< AVSMessageEndpoint > &  endpoint,
const std::string &  jsonPayloadValue,
const std::string &  jsonContext 
)

Builds a JSON event string which includes the header, optional endpoint (if the endpoint is the source of the event), the payload, and jsonContext.

Parameters
eventHeaderThe event's AVSMessageHeader.
endpointThe optional endpoint which was the source of this event.
jsonPayloadValueThe payload value associated with the "payload" key. The value must be a stringified json.
jsonContextThe context value associated with the "context" key. The value must be a stringified json.
Returns
The event JSON string if successful, else an empty string.

◆ buildJsonEventString() [3/3]

std::string alexaClientSDK::avsCommon::avs::buildJsonEventString ( const AVSMessageHeader eventHeader,
const utils::Optional< AVSMessageEndpoint > &  endpoint = utils::OptionalAVSMessageEndpoint >(),
const std::string &  jsonPayloadValue = "{}",
const utils::Optional< AVSContext > &  context = utils::OptionalAVSContext >() 
)

Builds a JSON event string which includes the header, the payload and an optional context. The header includes the namespace, name, message Id and an optional dialogRequestId. The message Id required for the header is a random string that is generated and added to the header.

Parameters
eventHeaderThe event's AVSMessageHeader.
endpointThe optional endpoint which was the source of this event.
jsonPayloadValueThe payload value associated with the "payload" key. The value must be a stringified json.
contextOptional AVSContext to be sent with the event message.
Returns
The event JSON string if successful, else an empty string.

◆ contentTypeToString()

std::string alexaClientSDK::avsCommon::avs::contentTypeToString ( ContentType  contentType)
inline

This function converts the provided ContentType to a string.

Parameters
contentTypeThe ContentType to convert to a string.
Returns
The string conversion of contentType.

◆ convertToValue()

bool alexaClientSDK::avsCommon::avs::convertToValue ( const rapidjson::Value &  documentNode,
PlayBehavior playBehavior 
)
inline

Convert a PlayBehavior to a rapidjson::Value.

Parameters
documentNodeThe rapidjson::Value to write to.
playBehaviorThe PlayBehavior to convert.
Returns
true if conversion is successful, else false.

◆ focusStateToString()

std::string alexaClientSDK::avsCommon::avs::focusStateToString ( FocusState  state)
inline

This function converts the provided FocusState to a string.

Parameters
stateThe FocusState to convert to a string.
Returns
The string conversion of state.

◆ getMixingBehavior()

MixingBehavior alexaClientSDK::avsCommon::avs::getMixingBehavior ( const std::string &  input)
inline

This function reverse maps the provided string to corresponding MixingBehavior Implementation as specified by mixingBehaviorToString

Parameters
inputstring to convert to corresponding MixingBehavior
Returns
MixingBehavior that corresponds to the input string. In case of error the API returns MixingBehavior::UNDEFINED

◆ indicatorStateToInt()

int alexaClientSDK::avsCommon::avs::indicatorStateToInt ( IndicatorState  state)
inline

Convert an IndicatorState to an int.

Parameters
stateThe IndicatorState to convert.
Returns
The int representation of state

◆ intToIndicatorState()

IndicatorState alexaClientSDK::avsCommon::avs::intToIndicatorState ( int  stateNum)
inline

Convert an int into an IndicatorState.

Parameters
stateNumThe int to convert.
Returns
The IndicatorState representation of stateNum or nullptr if stateNum is invalid.

◆ mixingBehaviorToString()

std::string alexaClientSDK::avsCommon::avs::mixingBehaviorToString ( MixingBehavior  behavior)
inline

This function converts the provided MixingBehavior to a string.

Parameters
behaviorThe MixingBehavior to convert to a string.
Returns
The string conversion of behavior.

◆ operator!=() [1/7]

bool alexaClientSDK::avsCommon::avs::operator!= ( const ComponentConfiguration lhs,
const ComponentConfiguration rhs 
)

Operator != for ComponentConfiguration

Parameters
lhsThe left hand side of the != operation.
rhsThe right hand side of the != operation.
Returns
Whether or not this instance and rhs are not equivalent.

◆ operator!=() [2/7]

bool alexaClientSDK::avsCommon::avs::operator!= ( const HandlerAndPolicy lhs,
const HandlerAndPolicy rhs 
)

!= operator.

Parameters
lhsThe HandlerAndPolicy instance on the left hand side of the == operation.
rhsThe HandlerAndPolicy instance on the right hand side of the != operation.
Returns
Whether the lhs instance is NOT equal to the rhs instance.

◆ operator!=() [3/7]

bool alexaClientSDK::avsCommon::avs::operator!= ( const std::shared_ptr< ComponentConfiguration > &  lhs,
const std::shared_ptr< ComponentConfiguration > &  rhs 
)

Operator != for shared_ptr of ComponentConfiguration

Parameters
lhsThe left hand side of the != operation.
rhsThe right hand side of the != operation.
Returns
Whether or not this instance and rhs are not equivalent.

◆ operator!=() [4/7]

bool alexaClientSDK::avsCommon::avs::operator!= ( const CapabilityConfiguration::Properties lhs,
const CapabilityConfiguration::Properties rhs 
)

Operator != for CapabilityConfiguration::Properties

Parameters
lhsThe left hand side of the == operation.
rhsThe right hand side of the == operation.
Returns
Whether or not this instance and rhs are not equivalent.

◆ operator!=() [5/7]

bool alexaClientSDK::avsCommon::avs::operator!= ( const BlockingPolicy lhs,
const BlockingPolicy rhs 
)

Not Equal-to operator comparing two BlockingPolicys *

Parameters
lhsThe left side argument.
rhsThe right side argument.
Returns
true if lhs and rhs are not equal

◆ operator!=() [6/7]

bool alexaClientSDK::avsCommon::avs::operator!= ( const CapabilityConfiguration lhs,
const CapabilityConfiguration rhs 
)

Operator != for CapabilityConfiguration

Parameters
lhsThe left hand side of the != operation.
rhsThe right hand side of the != operation.
Returns
Whether or not this instance and rhs are not equivalent.

◆ operator!=() [7/7]

bool alexaClientSDK::avsCommon::avs::operator!= ( const std::shared_ptr< CapabilityConfiguration > &  lhs,
const std::shared_ptr< CapabilityConfiguration > &  rhs 
)

Operator != for std::shared_ptr<CapabilityConfiguration>

Parameters
lhsThe left hand side of the != operation.
rhsThe right hand side of the != operation.
Returns
Whether or not this instance and rhs are not equivalent.

◆ operator<<() [1/14]

std::ostream& alexaClientSDK::avsCommon::avs::operator<< ( std::ostream &  stream,
ExceptionErrorType  type 
)
inline

◆ operator<<() [2/14]

std::ostream& alexaClientSDK::avsCommon::avs::operator<< ( std::ostream &  stream,
Requester  requester 
)
inline

Write a Requester value to an ostream as a string.

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

◆ operator<<() [3/14]

std::ostream& alexaClientSDK::avsCommon::avs::operator<< ( std::ostream &  stream,
IndicatorState  state 
)
inline

◆ operator<<() [4/14]

std::ostream& alexaClientSDK::avsCommon::avs::operator<< ( std::ostream &  stream,
const FocusState state 
)
inline

Write a FocusState value to an ostream as a string.

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

◆ operator<<() [5/14]

std::ostream& alexaClientSDK::avsCommon::avs::operator<< ( std::ostream &  stream,
const ContentType contentType 
)
inline

Write a ContentType value to an ostream as a string.

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

◆ operator<<() [6/14]

std::ostream& alexaClientSDK::avsCommon::avs::operator<< ( std::ostream &  stream,
const PlayerActivity playerActivity 
)
inline

Write a PlayerActivity value to an ostream.

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

◆ operator<<() [7/14]

std::ostream& alexaClientSDK::avsCommon::avs::operator<< ( std::ostream &  stream,
const CapabilityTag identifier 
)
inline

Write a CapabilityMessageIdentifier value to an ostream as a string.

Parameters
streamThe stream to write the value to.
identifierThe CapabilityMessageIdentifier value to be written.
Returns
The ostream that was passed in and written to.

◆ operator<<() [8/14]

std::ostream& alexaClientSDK::avsCommon::avs::operator<< ( std::ostream &  stream,
const PlayBehavior playBehavior 
)
inline

Write a PlayBehavior value to an ostream.

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

◆ operator<<() [9/14]

std::ostream& alexaClientSDK::avsCommon::avs::operator<< ( std::ostream &  stream,
AlexaResponseType  responseType 
)
inline

Insertion operator.

Parameters
streamThe std::ostream we are inserting into.
responseTypeThe AlexaResponseType whose name to insert into the stream.
Returns
The stream with the name inserted on success, "Unknown AlexaResponseType" on failure.

◆ operator<<() [10/14]

std::ostream& alexaClientSDK::avsCommon::avs::operator<< ( std::ostream &  stream,
const MixingBehavior behavior 
)
inline

Write a MixingBehavior value to an ostream as a string.

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

◆ operator<<() [11/14]

std::ostream& alexaClientSDK::avsCommon::avs::operator<< ( std::ostream &  stream,
const BlockingPolicy policy 
)
inline

Write a BlockingPolicy value to an ostream as a string.

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

◆ operator<<() [12/14]

std::ostream& alexaClientSDK::avsCommon::avs::operator<< ( std::ostream &  stream,
const PlaybackButton button 
)
inline

Write a Button value to an ostream as a string.

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

◆ operator<<() [13/14]

std::ostream& alexaClientSDK::avsCommon::avs::operator<< ( std::ostream &  stream,
const PlaybackToggle toggle 
)
inline

Write a Toggle value to an ostream as a string.

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

◆ operator<<() [14/14]

std::ostream& alexaClientSDK::avsCommon::avs::operator<< ( std::ostream &  stream,
const AVSDirective::ParseStatus status 
)
inline

Write a ParseStatus value to an ostream as a string.

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

◆ operator==() [1/8]

bool alexaClientSDK::avsCommon::avs::operator== ( const PlayRequestor playRequestorA,
const PlayRequestor playRequestorB 
)
inline

◆ operator==() [2/8]

bool alexaClientSDK::avsCommon::avs::operator== ( const ComponentConfiguration lhs,
const ComponentConfiguration rhs 
)

Operator == for ComponentConfiguration

Parameters
lhsThe left hand side of the == operation.
rhsThe right hand side of the == operation.
Returns
Whether or not this instance and rhs are equivalent.

◆ operator==() [3/8]

bool alexaClientSDK::avsCommon::avs::operator== ( const HandlerAndPolicy lhs,
const HandlerAndPolicy rhs 
)

== operator.

Parameters
lhsThe HandlerAndPolicy instance on the left hand side of the == operation.
rhsThe HandlerAndPolicy instance on the right hand side of the == operation.
Returns
Whether the lhs instance is equal to the rhs instance.

◆ operator==() [4/8]

bool alexaClientSDK::avsCommon::avs::operator== ( const std::shared_ptr< ComponentConfiguration > &  lhs,
const std::shared_ptr< ComponentConfiguration > &  rhs 
)

Operator == for shared_ptr of ComponentConfiguration

Parameters
lhsThe left hand side of the == operation.
rhsThe right hand side of the == operation.
Returns
Whether or not this instance and rhs are equivalent.

◆ operator==() [5/8]

bool alexaClientSDK::avsCommon::avs::operator== ( const BlockingPolicy lhs,
const BlockingPolicy rhs 
)

Equal-to operator comparing two BlockingPolicys

Parameters
lhsThe left side argument.
rhsThe right side argument.
Returns
true if lhs and rhs are equal

◆ operator==() [6/8]

bool alexaClientSDK::avsCommon::avs::operator== ( const CapabilityConfiguration::Properties lhs,
const CapabilityConfiguration::Properties rhs 
)

Operator == for CapabilityConfiguration::Properties

Parameters
lhsThe left hand side of the == operation.
rhsThe right hand side of the == operation.
Returns
Whether or not this instance and rhs are equivalent.

◆ operator==() [7/8]

bool alexaClientSDK::avsCommon::avs::operator== ( const CapabilityConfiguration lhs,
const CapabilityConfiguration rhs 
)

Operator == for CapabilityConfiguration

Parameters
lhsThe left hand side of the == operation.
rhsThe right hand side of the == operation.
Returns
Whether or not this instance and rhs are equivalent.

◆ operator==() [8/8]

bool alexaClientSDK::avsCommon::avs::operator== ( const std::shared_ptr< CapabilityConfiguration > &  lhs,
const std::shared_ptr< CapabilityConfiguration > &  rhs 
)

Operator == for std::shared_ptr<CapabilityConfiguration>

Parameters
lhsThe left hand side of the == operation.
rhsThe right hand side of the == operation.
Returns
Whether or not this instance and rhs are equivalent.

◆ operator>>()

std::istream& alexaClientSDK::avsCommon::avs::operator>> ( std::istream &  is,
PlayerActivity value 
)
inline

Converts an input string stream value to PlayerActivity.

Parameters
isThe string stream to retrieve the value from.
[out]valueThe value to write to.
Returns
The stream that was passed in.

◆ PlaybackButtonToString()

std::string alexaClientSDK::avsCommon::avs::PlaybackButtonToString ( PlaybackButton  button)
inline

Convert a PlaybackButton to std::string.

Parameters
buttonThe PlaybackButton to convert.
Returns
The representation of button.

◆ PlaybackToggleToString()

std::string alexaClientSDK::avsCommon::avs::PlaybackToggleToString ( PlaybackToggle  toggle)
inline

Convert a PlaybackToggle to std::string.

Parameters
toggleThe PlaybackToggle to convert.
Returns
The representation of toggle.

◆ playBehaviorToString()

std::string alexaClientSDK::avsCommon::avs::playBehaviorToString ( PlayBehavior  playBehavior)
inline

Convert a PlayBehavior to an AVS-compliant std::string.

Parameters
playBehaviorThe PlayBehavior to convert.
Returns
The AVS-compliant string representation of playBehavior.

◆ playerActivityToString()

std::string alexaClientSDK::avsCommon::avs::playerActivityToString ( PlayerActivity  playerActivity)
inline

◆ requesterToString()

std::string alexaClientSDK::avsCommon::avs::requesterToString ( Requester  requester)
inline

Converts an Requester enum to a string.

Parameters
requesterThe Requester enum.
Returns
The string representation of the enum.

◆ stringToPlayBehavior()

bool alexaClientSDK::avsCommon::avs::stringToPlayBehavior ( const std::string &  text,
PlayBehavior playBehavior 
)
inline

Convert an AVS-compliant string to a PlayBehavior.

Parameters
textThe string to convert.
[out]playBehaviorThe converted PlayBehavior.
Returns
true if the string converted succesfully, else false.

Variable Documentation

◆ CAPABILITY_INTERFACE_CONFIGURATIONS_KEY

const auto alexaClientSDK::avsCommon::avs::CAPABILITY_INTERFACE_CONFIGURATIONS_KEY = "configurations"
static

Key for interface configurations in the CapabilityConfiguration map.

◆ CAPABILITY_INTERFACE_NAME_KEY

const auto alexaClientSDK::avsCommon::avs::CAPABILITY_INTERFACE_NAME_KEY = "interface"
static

Key for interface name in the CapabilityConfiguration map.

◆ CAPABILITY_INTERFACE_TYPE_KEY

const auto alexaClientSDK::avsCommon::avs::CAPABILITY_INTERFACE_TYPE_KEY = "type"
static

Key for interface type in the CapabilityConfiguration map.

◆ CAPABILITY_INTERFACE_VERSION_KEY

const auto alexaClientSDK::avsCommon::avs::CAPABILITY_INTERFACE_VERSION_KEY = "version"
static

Key for interface version in the CapabilityConfiguration map.

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