Alexa Auto SDK  2.0.0
Public Member Functions | Static Public Member Functions | List of all members
com.amazon.aace.core.Engine Class Reference

Public Member Functions

boolean configure (EngineConfiguration[] configurationList)
 
boolean start ()
 
boolean stop ()
 
boolean registerPlatformInterface (PlatformInterface platformInterface)
 
boolean setProperty (String key, String value)
 
String getProperty (String key)
 

Static Public Member Functions

static Engine create (Context context)
 

Detailed Description

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.

Member Function Documentation

◆ create()

static Engine com.amazon.aace.core.Engine.create ( Context  context)
static

Creates a new instance of an Engine object.

◆ configure()

boolean com.amazon.aace.core.Engine.configure ( EngineConfiguration []  configurationList)

Sets the Engine configuration to a set of configuration objects

Parameters
configurationListA collection of com.amazon.aace.core.EngineConfiguration objects as an EngineConfiguration[]
Returns
true if the Engine configuration was successful, else false

◆ start()

boolean com.amazon.aace.core.Engine.start ( )

Starts the Engine and attempts to establish a connection to AVS

Returns
true if the Engine was started, else false
See also
stop()

◆ stop()

boolean com.amazon.aace.core.Engine.stop ( )

Stops the Engine and shuts down the connection to AVS

Returns
true if the Engine was stopped, else false
See also
start()

◆ registerPlatformInterface()

boolean com.amazon.aace.core.Engine.registerPlatformInterface ( PlatformInterface  platformInterface)

Registers a PlatformInterface instance with the Engine The platform implementation must register each interface required by the application.

Parameters
platformInterfaceThe PlatformInterface instance to register
Returns
true if the PlatformInterface instance was registered, else false
See also
com.amazon.aace.core.PlatformInterface

◆ setProperty()

boolean com.amazon.aace.core.Engine.setProperty ( String  key,
String  value 
)

Sets a property value in the Engine

Parameters
keyThe key used by the Engine to identify the property
valueThe property value to set in the Engine
Returns
true if property value was set, else false

◆ getProperty()

String com.amazon.aace.core.Engine.getProperty ( String  key)

Returns a property value from the Engine

Parameters
keyThe key used by the Engine to identify the property
Returns
The property value as a string

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