![]() |
AlexaClientSDK
1.22.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
|
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 | 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 | DirectiveHandlerConfiguration = std::unordered_map< directiveRoutingRule::DirectiveRoutingRule, BlockingPolicy > |
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=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) |
static const std::string | TAG ("AbstractAVSConnectionManager") |
String to identify log entries originating from this file. More... | |
static const std::string | TAG ("AVSContext") |
String to identify log entries originating from this file. More... | |
static const std::string | TAG ("AvsDirective") |
String to identify log entries originating from this file. More... | |
static bool | parseDocument (const std::string &unparsedDirective, Document *document) |
static std::shared_ptr< AVSMessageHeader > | parseHeader (const Document &document, AVSDirective::ParseStatus *parseStatus) |
static std::string | parsePayload (const Document &document, AVSDirective::ParseStatus *parseStatus) |
static utils::Optional< AVSMessageEndpoint > | parseEndpoint (const Document &document) |
static const std::string | TAG ("BlockingPolicy") |
String to identify log entries originating from this file. More... | |
static const std::string | TAG ("CapabilityAgent") |
String to identify log entries originating from this file. More... | |
static const std::string | TAG ("CapabilityResources") |
String to identify log entries originating from this file. More... | |
static const std::string | TAG ("ComponentConfiguration") |
String to identify log entries originating from this file. More... | |
static bool | isValidConfiguration (std::string name, std::string version) |
static const std::string | TAG ("DialogUXStateAggregator") |
String to identify log entries originating from this file. More... | |
static void | submitMetric (const std::shared_ptr< MetricRecorderInterface > &metricRecorder, const std::string &eventName) |
static const std::string | TAG ("EventBuilder") |
String to identify log entries originating from this file. More... | |
static std::string | buildHeader (const std::string &nameSpace, const std::string &eventName, const std::string &dialogRequestIdValue, json::JsonGenerator &jsonGenerator) |
static void | addJsonObjectFromMap (const std::string &name, const std::map< std::string, std::string > &map, json::JsonGenerator &jsonGenerator) |
static void | addEndpointToJson (const AVSMessageEndpoint &endpoint, json::JsonGenerator &jsonGenerator) |
static const std::string | TAG ("ExceptionEncountered") |
String to identify log entries originating from this file. More... | |
static const std::string | TAG ("MessageRequest") |
String to identify log entries originating from this file. More... | |
static const std::string | TAG ("WaitableMessageRequest") |
String to identify log entries originating from this file. More... | |
Variables | |
static const std::string | CAPABILITY_INTERFACE_TYPE_KEY = "type" |
Key for interface type in the CapabilityConfiguration map. More... | |
static const std::string | CAPABILITY_INTERFACE_NAME_KEY = "interface" |
Key for interface name in the CapabilityConfiguration map. More... | |
static const std::string | CAPABILITY_INTERFACE_VERSION_KEY = "version" |
Key for interface version in the CapabilityConfiguration map. More... | |
static const std::string | CAPABILITY_INTERFACE_CONFIGURATIONS_KEY = "configurations" |
Key for interface configurations in the CapabilityConfiguration map. More... | |
static const std::string | PROPERTIES_KEY_STRING = "properties" |
Key used to identify the context properties. More... | |
static const std::string | INSTANCE_KEY_STRING = "instance" |
Key used to identify an instance. More... | |
static const std::string | VALUE_KEY_STRING = "value" |
Key used to identify the state value. More... | |
static const std::string | TIME_OF_SAMPLE_KEY_STRING = "timeOfSample" |
Key used to identify the time of sample. More... | |
static const std::string | UNCERTAINTY_KEY_STRING = "uncertaintyInMilliseconds" |
static const std::string | JSON_MESSAGE_DIRECTIVE_KEY = "directive" |
JSON key to get the directive object of a message. More... | |
static const std::string | JSON_MESSAGE_HEADER_KEY = "header" |
JSON key to get the header object of a message. More... | |
static const std::string | JSON_MESSAGE_NAMESPACE_KEY = "namespace" |
JSON key to get the namespace value of a header. More... | |
static const std::string | JSON_MESSAGE_NAME_KEY = "name" |
JSON key to get the name value of a header. More... | |
static const std::string | JSON_MESSAGE_ID_KEY = "messageId" |
JSON key to get the messageId value of a header. More... | |
static const std::string | JSON_MESSAGE_DIALOG_REQUEST_ID_KEY = "dialogRequestId" |
JSON key to get the dialogRequestId value of a header. More... | |
static const std::string | JSON_MESSAGE_PAYLOAD_KEY = "payload" |
JSON key to get the payload object of a message. More... | |
static const std::string | JSON_MESSAGE_INSTANCE_KEY = "instance" |
JSON key to get the optional instance object of a message. More... | |
static const std::string | JSON_MESSAGE_PAYLOAD_VERSION_KEY = "payloadVersion" |
JSON key to get the payload version object of a message. More... | |
static const std::string | JSON_CORRELATION_TOKEN_KEY = "correlationToken" |
JSON key to get the correlationToken value of a header. More... | |
static const std::string | JSON_EVENT_CORRELATION_TOKEN_KEY = "eventCorrelationToken" |
JSON key to get the eventCorrelationToken value of the header. More... | |
static const std::string | JSON_ENDPOINT_KEY = "endpoint" |
JSON key to get the endpoint object of a message. More... | |
static const std::string | JSON_ENDPOINT_ID_KEY = "endpointId" |
JSON key to get the endpointId value of the endpoint. More... | |
static const std::string | JSON_ENDPOINT_COOKIE_KEY = "cookie" |
JSON key to get the cookie value for the endpoint. More... | |
static const std::string | MESSAGE_ID_KEY_STRING = "messageId" |
The message id key in the header of the event. More... | |
static const std::string | DIALOG_REQUEST_ID_KEY_STRING = "dialogRequestId" |
The dialog request Id key in the header of the event. More... | |
static const std::string | EVENT_CORRELATION_KEY_STRING = "eventCorrelationToken" |
The event correlation token key. More... | |
static const std::string | CORRELATION_TOKEN_KEY_STRING = "correlationToken" |
The correlation token key. More... | |
static const std::string | PAYLOAD_VERSION_KEY_STRING = "payloadVersion" |
The payload version key. More... | |
static const std::string | INSTANCE_KEY_STRING = "instance" |
The instance key. More... | |
static const long | MEDIUM_FLAG_AUDIO = 1 |
Flag indicating AUDIO medium is used. More... | |
static const long | MEDIUM_FLAG_VISUAL = 2 |
Flag indicating VISUAL medium is used. More... | |
static const int | CAPABILITY_QUEUE_WARN_SIZE = 10 |
Maximum number of directives that Can be Queued before we emit warning logs. More... | |
static constexpr size_t | MAX_FRIENDLY_NAME_LENGTH = 16000 |
Maximum length of the friendly name. More... | |
static const std::string | CUSTOM_METRIC_PREFIX = "CUSTOM-" |
Custom Metrics prefix used by DialogUXStateAggregator. More... | |
static const std::string | LISTENING_TIMEOUT_EXPIRES = "LISTENING_TIMEOUT_EXPIRES" |
error metric for Listening timeout expires More... | |
static const std::string | THINKING_TIMEOUT_EXPIRES = "THINKING_TIMEOUT_EXPIRES" |
error metric for Thinking timeout expires More... | |
static const std::string | CONTEXT_KEY_STRING = "context" |
The context key in the event. More... | |
static const std::string | COOKIE_KEY_STRING = "cookie" |
The cookie key. More... | |
static const std::string | DIALOG_REQUEST_ID_KEY_STRING = "dialogRequestId" |
The dialog request Id key in the header of the event. More... | |
static const std::string | ENDPOINT_KEY_STRING = "endpoint" |
The endpoint key. More... | |
static const std::string | ENDPOINT_ID_KEY_STRING = "endpointId" |
The endpointId key. More... | |
static const std::string | EVENT_KEY_STRING = "event" |
The event key. More... | |
static const std::string | INSTANCE_KEY_STRING = "instance" |
The instance key. More... | |
static const std::string | MESSAGE_KEY_STRING = "message" |
The message key in the event. More... | |
static const std::string | MESSAGE_ID_KEY_STRING = "messageId" |
The message id key in the header of the event. More... | |
static const std::string | SCOPE_KEY_STRING = "scope" |
The scope key. More... | |
static const std::string | SCOPE_TYPE_KEY_STRING = "type" |
The scope type. More... | |
static const std::string | SCOPE_TOKEN_KEY_STRING = "token" |
The scope token. More... | |
static const std::string | SCOPE_PARTITION_KEY_STRING = "partition" |
The scope partition. More... | |
static const std::string | SCOPE_USER_ID_KEY_STRING = "userId" |
The scope user id. More... | |
static const std::string | BEARER_TOKEN_TYPE = "BearerToken" |
The bearer token type. More... | |
static const std::string | BEARER_TOKEN_WITH_PARTITION_TYPE = "BearerTokenWithPartition" |
The bearer token with partition type. More... | |
static const std::string | TYPE_KEY_STRING = "type" |
The type key in the event. More... | |
static const std::string | NAMESPACE = "System" |
The namespace for this event. More... | |
static const std::string | EXCEPTION_ENCOUNTERED_EVENT_NAME = "ExceptionEncountered" |
JSON value for a ExceptionEncountered event's name. More... | |
static const char | UNPARSED_DIRECTIVE_KEY_STRING [] = "unparsedDirective" |
JSON key for the unparsedDirective field of the ExceptionEncountered event. More... | |
static const char | ERROR_KEY [] = "error" |
JSON key for the error field of the ExceptionEncountered event. More... | |
static const char | ERROR_TYPE_KEY [] = "type" |
JSON key for the ExceptionEncountered event's error type. More... | |
static const char | ERROR_MESSAGE_KEY [] = "message" |
JSON key for the ExceptionEncountered event's error message. More... | |
static const auto | CONNECTION_TIMEOUT = std::chrono::seconds(15) |
The connection timeout indicating how long to wait for the response to be received. More... | |
using alexaClientSDK::avsCommon::avs::AudioInputStream = typedef utils::sds::SharedDataStream<utils::sds::InProcessSDSTraits> |
The type used store and stream binary data.
using alexaClientSDK::avsCommon::avs::DirectiveHandlerConfiguration = typedef std::unordered_map<directiveRoutingRule::DirectiveRoutingRule, BlockingPolicy> |
Map of blocking policies per DirectiveRoutingRule
. This is used by a DirectiveHandlerInterface
to declare which directives it can handle.
An enum class indicating possible response from the endpoint on a controller API call. Response are derived from
|
strong |
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 |
|
strong |
An enum class used to specify the levels of focus that a Channel can have.
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
Used to determine how a client must handle queueing and playback of a stream.
|
strong |
Identifies the player state.
|
strong |
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:
StateRefreshPolicy
ALWAYS
and NEVER
, the empty state is included in the context.StateRefreshPolicy
SOMETIMES
, the empty state is NOT included in the context.
|
static |
Adds a json object representing the endpoint
.
endpoint | The endpoint to be encoded as a json object. |
jsonGenerator | The json generator being used to generate the json object. |
|
static |
Add a json object from a map with the given name.
name | The name of the object. |
map | The key, value pairs to add. |
jsonGenerator | The json generator being used to generate the json object. |
|
inline |
This function converts the provided ParseStatus
to a string.
status | The ParseStatus to convert to a string. |
ParseStatus
.
|
static |
Builds a JSON header object. 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.
nameSpace | The namespace of the event to be included in the header. |
eventName | The name of the event to be included in the header. |
dialogRequestIdValue | The value associated with the "dialogRequestId" key. |
jsonGenerator | The generator that will be populated with the header json. |
std::string alexaClientSDK::avsCommon::avs::buildJsonEventString | ( | const AVSMessageHeader & | eventHeader, |
const utils::Optional< AVSMessageEndpoint > & | endpoint = utils::Optional<AVSMessageEndpoint>() , |
||
const std::string & | jsonPayloadValue = "{}" , |
||
const utils::Optional< AVSContext > & | context = utils::Optional<AVSContext>() |
||
) |
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.
eventHeader | The event's AVSMessageHeader . |
endpoint | The endpoint which was the source of this event. |
payload | The payload value associated with the "payload" key. The value must be a stringified json. |
context | Optional AVSContext to be sent with the event message. |
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.
nameSpace | The namespace of the event to be include in the header. |
eventName | The name of the event to be include in the header. |
dialogRequestIdString | Optional value associated with the "dialogRequestId" key. |
payload | Optional payload value associated with the "payload" key. |
context | Optional context to be sent with the event message. |
|
inline |
This function converts the provided ContentType
to a string.
contentType | The ContentType to convert to a string. |
contentType
.
|
inline |
Convert a PlayBehavior
to a rapidjson::Value
.
documentNode | The rapidjson::Value to write to. |
playBehavior | The PlayBehavior to convert. |
true
if conversion is successful, else false
.
|
inline |
This function converts the provided FocusState
to a string.
state | The FocusState to convert to a string. |
state
.
|
inline |
This function reverse maps the provided string to corresponding MixingBehavior Implementation as specified by mixingBehaviorToString
input | string to convert to corresponding MixingBehavior |
MixingBehavior
that corresponds to the input string. In case of error the API returns MixingBehavior::UNDEFINED
|
inline |
Convert an IndicatorState to an int.
state | The IndicatorState to convert. |
|
inline |
Convert an int into an IndicatorState
.
stateNum | The int to convert. |
|
static |
Helper Function to determine if a configuration is valid
name | The name of the configuration |
version | The version of the configuration |
|
inline |
This function converts the provided MixingBehavior
to a string.
behavior | The MixingBehavior to convert to a string. |
behavior
. bool alexaClientSDK::avsCommon::avs::operator!= | ( | const BlockingPolicy & | lhs, |
const BlockingPolicy & | rhs | ||
) |
Not Equal-to operator comparing two BlockingPolicys
*
lhs | The left side argument. |
rhs | The right side argument. |
lhs
and rhs
are not equal bool alexaClientSDK::avsCommon::avs::operator!= | ( | const CapabilityConfiguration & | lhs, |
const CapabilityConfiguration & | rhs | ||
) |
Operator != for CapabilityConfiguration
lhs | The left hand side of the != operation. |
rhs | The right hand side of the != operation. |
rhs
are not equivalent. bool alexaClientSDK::avsCommon::avs::operator!= | ( | const CapabilityConfiguration::Properties & | lhs, |
const CapabilityConfiguration::Properties & | rhs | ||
) |
Operator != for CapabilityConfiguration::Properties
lhs | The left hand side of the == operation. |
rhs | The right hand side of the == operation. |
rhs
are not equivalent. bool alexaClientSDK::avsCommon::avs::operator!= | ( | const ComponentConfiguration & | lhs, |
const ComponentConfiguration & | rhs | ||
) |
Operator != for ComponentConfiguration
lhs | The left hand side of the != operation. |
rhs | The right hand side of the != operation. |
rhs
are not equivalent. bool alexaClientSDK::avsCommon::avs::operator!= | ( | const HandlerAndPolicy & | lhs, |
const HandlerAndPolicy & | rhs | ||
) |
!= operator.
lhs | The HandlerAndPolicy instance on the left hand side of the == operation. |
rhs | The HandlerAndPolicy instance on the right hand side of the != operation. |
lhs
instance is NOT equal to the rhs
instance. bool alexaClientSDK::avsCommon::avs::operator!= | ( | const std::shared_ptr< CapabilityConfiguration > & | lhs, |
const std::shared_ptr< CapabilityConfiguration > & | rhs | ||
) |
Operator != for std::shared_ptr<CapabilityConfiguration>
lhs | The left hand side of the != operation. |
rhs | The right hand side of the != operation. |
rhs
are not equivalent. bool alexaClientSDK::avsCommon::avs::operator!= | ( | const std::shared_ptr< ComponentConfiguration > & | lhs, |
const std::shared_ptr< ComponentConfiguration > & | rhs | ||
) |
Operator != for shared_ptr of ComponentConfiguration
lhs | The left hand side of the != operation. |
rhs | The right hand side of the != operation. |
rhs
are not equivalent.
|
inline |
Insertion operator.
stream | The std::ostream we are inserting into. |
responseType | The AlexaResponseType whose name to insert into the stream. |
|
inline |
Write a ParseStatus
value to an ostream
as a string.
stream | The stream to write the value to. |
status | The ParseStatus value to write to the ostream as a string. |
ostream
that was passed in and written to.
|
inline |
Write a BlockingPolicy
value to an ostream
as a string.
stream | The stream to write the value to. |
policy | The policy value to write to the ostream as a string. |
ostream
that was passed in and written to.
|
inline |
Write a CapabilityMessageIdentifier
value to an ostream
as a string.
stream | The stream to write the value to. |
identifier | The CapabilityMessageIdentifier value to be written. |
ostream
that was passed in and written to.
|
inline |
Write a ContentType
value to an ostream
as a string.
stream | The stream to write the value to. |
contenType | The ContentType value to write to the ostream as a string. |
ostream
that was passed in and written to.
|
inline |
Write a FocusState
value to an ostream
as a string.
stream | The stream to write the value to. |
state | The FocusState value to write to the ostream as a string. |
ostream
that was passed in and written to.
|
inline |
Write a MixingBehavior
value to an ostream
as a string.
stream | The stream to write the value to. |
behavior | The MixingBehavior value to write to the ostream as a string. |
ostream
that was passed in and written to.
|
inline |
Write a Button
value to an ostream
as a string.
stream | The stream to write the value to. |
button | The Button value to write to the ostream as a string. |
ostream
that was passed in and written to.
|
inline |
Write a Toggle
value to an ostream
as a string.
stream | The stream to write the value to. |
toggle | The Toggle value to write to the ostream as a string. |
ostream
that was passed in and written to.
|
inline |
Write a PlayBehavior
value to an ostream
.
stream | The stream to write the value to. |
playBehavior | The PlayBehavior value to write to the ostream as a string. |
ostream
that was passed in and written to.
|
inline |
Write a PlayerActivity
value to an ostream
.
stream | The stream to write the value to. |
playerActivity | The PlayerActivity value to write to the ostream as a string. |
ostream
that was passed in and written to.
|
inline |
|
inline |
|
inline |
Write a Requester
value to an ostream
as a string.
stream | The stream to write the value to. |
requester | The Requester value to write to the ostream as a string. |
ostream
that was passed in and written to. bool alexaClientSDK::avsCommon::avs::operator== | ( | const BlockingPolicy & | lhs, |
const BlockingPolicy & | rhs | ||
) |
Equal-to operator comparing two BlockingPolicys
lhs | The left side argument. |
rhs | The right side argument. |
lhs
and rhs
are equal bool alexaClientSDK::avsCommon::avs::operator== | ( | const CapabilityConfiguration & | lhs, |
const CapabilityConfiguration & | rhs | ||
) |
Operator == for CapabilityConfiguration
lhs | The left hand side of the == operation. |
rhs | The right hand side of the == operation. |
rhs
are equivalent. bool alexaClientSDK::avsCommon::avs::operator== | ( | const CapabilityConfiguration::Properties & | lhs, |
const CapabilityConfiguration::Properties & | rhs | ||
) |
Operator == for CapabilityConfiguration::Properties
lhs | The left hand side of the == operation. |
rhs | The right hand side of the == operation. |
rhs
are equivalent. bool alexaClientSDK::avsCommon::avs::operator== | ( | const ComponentConfiguration & | lhs, |
const ComponentConfiguration & | rhs | ||
) |
Operator == for ComponentConfiguration
lhs | The left hand side of the == operation. |
rhs | The right hand side of the == operation. |
rhs
are equivalent. bool alexaClientSDK::avsCommon::avs::operator== | ( | const HandlerAndPolicy & | lhs, |
const HandlerAndPolicy & | rhs | ||
) |
== operator.
lhs | The HandlerAndPolicy instance on the left hand side of the == operation. |
rhs | The HandlerAndPolicy instance on the right hand side of the == operation. |
lhs
instance is equal to the rhs
instance.
|
inline |
bool alexaClientSDK::avsCommon::avs::operator== | ( | const std::shared_ptr< CapabilityConfiguration > & | lhs, |
const std::shared_ptr< CapabilityConfiguration > & | rhs | ||
) |
Operator == for std::shared_ptr<CapabilityConfiguration>
lhs | The left hand side of the == operation. |
rhs | The right hand side of the == operation. |
rhs
are equivalent. bool alexaClientSDK::avsCommon::avs::operator== | ( | const std::shared_ptr< ComponentConfiguration > & | lhs, |
const std::shared_ptr< ComponentConfiguration > & | rhs | ||
) |
Operator == for shared_ptr of ComponentConfiguration
lhs | The left hand side of the == operation. |
rhs | The right hand side of the == operation. |
rhs
are equivalent.
|
inline |
Converts an input string stream value to PlayerActivity
.
is | The string stream to retrieve the value from. | |
[out] | value | The value to write to. |
|
static |
Utility function to attempt a JSON parse of the passed in string, and inform the caller if this succeeded or failed.
unparsedDirective | The unparsed JSON string which should represent an AVS Directive. | |
[out] | document | The rapidjson Document which will be set to the parsed structure if the parse succeeds. |
|
static |
Utility function to parse the endpoint attributes from a rapidjson document structure.
document | The constructed document tree |
|
static |
Utility function to parse the header from a rapidjson document structure.
document | The constructed document tree | |
[out] | parseStatus | An out parameter to express if the parse was successful |
|
static |
Utility function to parse the payload from a rapidjson document structure.
document | The constructed document tree | |
[out] | parseStatus | An out parameter to express if the parse was successful |
|
inline |
Convert a PlaybackButton
to std::string
.
button | The PlaybackButton to convert. |
button
.
|
inline |
Convert a PlaybackToggle
to std::string
.
toggle | The PlaybackToggle to convert. |
toggle
.
|
inline |
Convert a PlayBehavior
to an AVS-compliant std::string
.
playBehavior | The PlayBehavior to convert. |
playBehavior
.
|
inline |
|
inline |
Converts an Requester
enum to a string.
requester | The Requester enum. |
|
inline |
Convert an AVS-compliant string
to a PlayBehavior
.
text | The string to convert. | |
[out] | playBehavior | The converted PlayBehavior . |
true
if the string converted succesfully, else false
.
|
static |
Submits a metric of given event name
metricRecorder | The MetricRecorderInterface which records Metric events |
eventName | The name of the metric event |
|
static |
String to identify log entries originating from this file.
|
static |
String to identify log entries originating from this file.
|
static |
String to identify log entries originating from this file.
|
static |
String to identify log entries originating from this file.
|
static |
String to identify log entries originating from this file.
|
static |
String to identify log entries originating from this file.
|
static |
String to identify log entries originating from this file.
|
static |
String to identify log entries originating from this file.
|
static |
String to identify log entries originating from this file.
|
static |
String to identify log entries originating from this file.
|
static |
String to identify log entries originating from this file.
|
static |
String to identify log entries originating from this file.
|
static |
The bearer token type.
|
static |
The bearer token with partition type.
|
static |
Key for interface configurations in the CapabilityConfiguration
map.
|
static |
Key for interface name in the CapabilityConfiguration
map.
|
static |
Key for interface type in the CapabilityConfiguration
map.
|
static |
Key for interface version in the CapabilityConfiguration
map.
|
static |
Maximum number of directives that Can be Queued before we emit warning logs.
|
static |
The connection timeout indicating how long to wait for the response to be received.
|
static |
The context key in the event.
|
static |
The cookie key.
|
static |
The correlation token key.
|
static |
Custom Metrics prefix used by DialogUXStateAggregator.
|
static |
The dialog request Id key in the header of the event.
|
static |
The dialog request Id key in the header of the event.
|
static |
The endpointId key.
|
static |
The endpoint key.
|
static |
JSON key for the error field of the ExceptionEncountered event.
|
static |
JSON key for the ExceptionEncountered event's error message.
|
static |
JSON key for the ExceptionEncountered event's error type.
|
static |
The event correlation token key.
|
static |
The event key.
|
static |
JSON value for a ExceptionEncountered event's name.
|
static |
Key used to identify an instance.
|
static |
The instance key.
|
static |
The instance key.
|
static |
JSON key to get the correlationToken value of a header.
|
static |
JSON key to get the cookie value for the endpoint.
|
static |
JSON key to get the endpointId value of the endpoint.
|
static |
JSON key to get the endpoint object of a message.
|
static |
JSON key to get the eventCorrelationToken value of the header.
|
static |
JSON key to get the dialogRequestId value of a header.
|
static |
JSON key to get the directive object of a message.
|
static |
JSON key to get the header object of a message.
|
static |
JSON key to get the messageId value of a header.
|
static |
JSON key to get the optional instance object of a message.
|
static |
JSON key to get the name value of a header.
|
static |
JSON key to get the namespace value of a header.
|
static |
JSON key to get the payload object of a message.
|
static |
JSON key to get the payload version object of a message.
|
static |
error metric for Listening timeout expires
|
staticconstexpr |
Maximum length of the friendly name.
|
static |
Flag indicating AUDIO
medium is used.
|
static |
Flag indicating VISUAL
medium is used.
|
static |
The message id key in the header of the event.
|
static |
The message id key in the header of the event.
|
static |
The message key in the event.
|
static |
The namespace for this event.
|
static |
The payload version key.
|
static |
Key used to identify the context properties.
|
static |
The scope key.
|
static |
The scope partition.
|
static |
The scope token.
|
static |
The scope type.
|
static |
The scope user id.
|
static |
error metric for Thinking timeout expires
|
static |
Key used to identify the time of sample.
|
static |
The type key in the event.
|
static |
Key used to identify an the uncertainty in milliseconds related to the time of sample. For more information: https://developer.amazon.com/docs/alexa/alexa-voice-service/reportable-state-properties.html#property-object
|
static |
JSON key for the unparsedDirective field of the ExceptionEncountered event.
|
static |
Key used to identify the state value.
AlexaClientSDK 1.22.0 - Copyright 2016-2020 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0