![]() |
Alexa Auto SDK
2.3.1
|
Public Member Functions | |
virtual bool | configure (std::initializer_list< std::shared_ptr< aace::core::config::EngineConfiguration >> configurationList)=0 |
virtual bool | configure (std::vector< std::shared_ptr< aace::core::config::EngineConfiguration >> configurationList)=0 |
virtual bool | configure (std::shared_ptr< aace::core::config::EngineConfiguration > configuration)=0 |
virtual bool | start ()=0 |
virtual bool | stop ()=0 |
virtual bool | shutdown ()=0 |
virtual bool | setProperty (const std::string &key, const std::string &value)=0 |
virtual std::string | getProperty (const std::string &key)=0 |
virtual bool | registerPlatformInterface (std::shared_ptr< aace::core::PlatformInterface > platformInterface)=0 |
virtual bool | registerPlatformInterface (std::initializer_list< std::shared_ptr< aace::core::PlatformInterface >> platformInterfaceList)=0 |
The Engine must be instantiated by the platform implementation. Along with the platform interfaces, it is responsible for managing the interactions between the platform and AVS.
The platform implementation should not extend Engine; it is extended in the SDK.
|
pure virtual |
Sets the Engine configuration to a set of configuration objects
[in] | configurationList | A collection of aace::core::config::EngineConfiguration objects as an std::initializer_list<aace::core::config::EngineConfiguration*> |
true
if the Engine configuration was successful, else false
|
pure virtual |
Sets the Engine configuration to a set of configuration objects
[in] | configurationList | A collection of aace::core::config::EngineConfiguration objects as an std::vector<aace::core::config::EngineConfiguration*> |
true
if the Engine configuration was successful, else false
|
pure virtual |
Sets the Engine configuration to a single configuration object
[in] | configuration | An aace::core::config::EngineConfiguration object |
true
if the Engine configuration was successful, else false
|
pure virtual |
|
pure virtual |
|
pure virtual |
|
pure virtual |
Sets a property value in the Engine
[in] | name | The name used by the Engine to identify the property. The property name must be one of the property constants recognized by the Engine, e.g. the properties in aace::alexa::property::AlexaProperties.h |
[in] | value | The property setting |
true
if the property value was updated or set to the current setting, else false
if an error occured.
|
pure virtual |
Retrieves the setting for the property identified by name
from the Engine
[in] | name | The name used by the Engine to identify the property. The property name must be one of the property constants recognized by the Engine, e.g. the properties in aace::alexa::property::AlexaProperties.h |
|
pure virtual |
Registers a PlatformInterface
instance with the Engine
The platform implementation must register each interface required by the application.
[in] | platformInterface | The PlatformInterface instance to register |
true
if the PlatformInterface
instance was registered, else false
|
pure virtual |
Registers a list of PlatformInterface
instances with the Engine
The platform implementation must register each interface required by the application.
[in] | platformInterfaceList | The list of PlatformInterface instances to register |
true
if all PlatformInterface
instances were registered, else false
Alexa Auto SDK 2.3.1 - Copyright 2017-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0