AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | Public Attributes | List of all members
alexaClientSDK::acsdkAlerts::Alert::AssetConfiguration Struct Reference

#include <Alert.h>

Public Member Functions

 AssetConfiguration ()
 

Public Attributes

std::unordered_map< std::string, Assetassets
 A map of the custom assets, mapping from asset.id to the asset itself. More...
 
std::vector< std::string > assetPlayOrderItems
 
std::string backgroundAssetId
 The background asset id, if specified by AVS. More...
 
std::chrono::milliseconds loopPause
 The pause time, in milliseconds, that should be taken between each loop of asset rendering. More...
 

Detailed Description

A utility structure to encapsulate the data reflecting custom assets for an alert.

Constructor & Destructor Documentation

◆ AssetConfiguration()

alexaClientSDK::acsdkAlerts::Alert::AssetConfiguration::AssetConfiguration ( )
inline

Constructor.

Member Data Documentation

◆ assetPlayOrderItems

std::vector<std::string> alexaClientSDK::acsdkAlerts::Alert::AssetConfiguration::assetPlayOrderItems

A vector of the play order of the asset ids. AVS sends this list in its SetAlert Directive, and to render the alert, all assets mapping to these ids must be played in sequence.

◆ assets

std::unordered_map<std::string, Asset> alexaClientSDK::acsdkAlerts::Alert::AssetConfiguration::assets

A map of the custom assets, mapping from asset.id to the asset itself.

◆ backgroundAssetId

std::string alexaClientSDK::acsdkAlerts::Alert::AssetConfiguration::backgroundAssetId

The background asset id, if specified by AVS.

◆ loopPause

std::chrono::milliseconds alexaClientSDK::acsdkAlerts::Alert::AssetConfiguration::loopPause

The pause time, in milliseconds, that should be taken between each loop of asset rendering.


The documentation for this struct was generated from the following file:

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