Alexa Auto SDK  2.3.0
Public Types | Static Public Member Functions | List of all members
aace::apl::config::APLConfiguration Class Reference

Public Types

enum  AlexaPresentationTimeoutType { AlexaPresentationTimeoutType::DISPLAY_DOCUMENT_INTERACTION_IDLE_TIMEOUT }
 
using AlexaPresentationTimeout = std::pair< AlexaPresentationTimeoutType, std::chrono::milliseconds >
 

Static Public Member Functions

static std::shared_ptr< aace::core::config::EngineConfigurationcreateAlexaPresentationTimeoutConfig (const std::vector< AlexaPresentationTimeout > &timeoutList)
 

Detailed Description

A factory interface for creating APL configuration objects

Member Typedef Documentation

◆ AlexaPresentationTimeout

Identifies a AlexaPresentationTimeout configuration with a type and value pair.

Member Enumeration Documentation

◆ AlexaPresentationTimeoutType

enum specifying the configurable AlexaPresentation timeout.

Enumerator
DISPLAY_DOCUMENT_INTERACTION_IDLE_TIMEOUT 

RenderDocument timeout in ms for display card timeout.

Member Function Documentation

◆ createAlexaPresentationTimeoutConfig()

static std::shared_ptr<aace::core::config::EngineConfiguration> aace::apl::config::APLConfiguration::createAlexaPresentationTimeoutConfig ( const std::vector< AlexaPresentationTimeout > &  timeoutList)
static

Factory method used to programmatically generate Alexa Presentation configuration data. This is an optional configuration. Following are the accepted keys and their description.

  • displayDocumentInteractionIdleTimeout If present, the timeout in ms for display card timeout. The data generated by this method is equivalent to providing the following JSON values in a configuration file:
{
"alexaPresentationCapabilityAgent": {
"displayDocumentInteractionIdleTimeout": <TIMEOUT_IN_MS>
}
}
Parameters
[in]timeoutListA list of AlexaPresentationTimeout type and value pairs

Alexa Auto SDK 2.3.0 - Copyright 2017-2020 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0