AlexaClientSDK  1.22.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Namespaces | Classes | Typedefs | Functions | Variables
alexaClientSDK::afml Namespace Reference

Namespaces

 interruptModel
 
 test
 

Classes

class  ActivityTrackerInterface
 
class  AudioActivityTracker
 
class  Channel
 
class  FocusManager
 
class  VisualActivityTracker
 

Typedefs

using FocusManagementComponent = acsdkManufactory::Component< acsdkManufactory::Annotated< avsCommon::sdkInterfaces::AudioFocusAnnotation, avsCommon::sdkInterfaces::FocusManagerInterface >, acsdkManufactory::Import< std::shared_ptr< acsdkShutdownManagerInterfaces::ShutdownNotifierInterface > >, acsdkManufactory::Import< std::shared_ptr< avsCommon::sdkInterfaces::ContextManagerInterface > >, acsdkManufactory::Import< acsdkManufactory::Annotated< avsCommon::sdkInterfaces::endpoints::DefaultEndpointAnnotation, avsCommon::sdkInterfaces::endpoints::EndpointCapabilitiesRegistrarInterface > >, acsdkManufactory::Import< std::shared_ptr< interruptModel::InterruptModel > >>
 
using AudioFocusAnnotation = avsCommon::sdkInterfaces::AudioFocusAnnotation
 

Functions

FocusManagementComponent getComponent ()
 
static const std::string TAG ("AudioActivityTracker")
 String to identify log entries originating from this file. More...
 
static std::shared_ptr< avsCommon::avs::CapabilityConfigurationgetAudioActivityTrackerCapabilityConfiguration ()
 
static const std::string TAG ("Channel")
 String to identify log entries originating from this file. More...
 
static const std::string TAG ("FocusManagementComponent")
 String to identify log entries originating from this file. More...
 
acsdkManufactory::Annotated< AudioFocusAnnotation, avsCommon::sdkInterfaces::FocusManagerInterfacecreateAudioFocusManager (acsdkManufactory::Annotated< AudioFocusAnnotation, ActivityTrackerInterface > annotatedActivityTracker, std::shared_ptr< interruptModel::InterruptModel > interruptModel)
 
static const std::string TAG ("FocusManager")
 String to identify log entries originating from this file. More...
 
static const std::string TAG ("VisualActivityTracker")
 String to identify log entries originating from this file. More...
 
static std::shared_ptr< avsCommon::avs::CapabilityConfigurationgetVisualActivityTrackerCapabilityConfiguration ()
 

Variables

static const std::string AUDIOACTIVITYTRACKER_CAPABILITY_INTERFACE_TYPE = "AlexaInterface"
 
static const std::string AUDIOACTIVITYTRACKER_CAPABILITY_INTERFACE_NAME = "AudioActivityTracker"
 AudioActivityTracker interface name. More...
 
static const std::string AUDIOACTIVITYTRACKER_CAPABILITY_INTERFACE_VERSION = "1.0"
 AudioActivityTracker interface version. More...
 
static const NamespaceAndName CONTEXT_MANAGER_STATE {"AudioActivityTracker", "ActivityState"}
 The state information NamespaceAndName to send to the ContextManager for AudioActivityTracker. More...
 
static const char IDLE_TIME_KEY [] = "idleTimeInMilliseconds"
 The idleTime key used in the AudioActivityTracker context. More...
 
static const char INTERFACE_KEY [] = "interface"
 The interface key used in the AudioActivityTracker context. More...
 
static const std::string AUDIO_CHANNEL_CONFIG_KEY = "audioChannels"
 Key for audio channel array configurations in configuration node. More...
 
static const std::string VIRTUAL_CHANNELS_CONFIG_KEY = "virtualChannels"
 Key for FocusManager configurations in configuration node. More...
 
static const std::string CHANNEL_NAME_KEY = "name"
 Key for the name of the channel in configuration node. More...
 
static const std::string CHANNEL_PRIORITY_KEY = "priority"
 Key for the priority of the channel in configuration node. More...
 
static const std::string VISUALACTIVITYTRACKER_CAPABILITY_INTERFACE_TYPE = "AlexaInterface"
 
static const std::string VISUALACTIVITYTRACKER_CAPABILITY_INTERFACE_NAME = "VisualActivityTracker"
 VisualActivityTracker interface name. More...
 
static const std::string VISUALACTIVITYTRACKER_CAPABILITY_INTERFACE_VERSION = "1.0"
 VisualActivityTracker interface version. More...
 
static const NamespaceAndName CONTEXT_MANAGER_STATE {"VisualActivityTracker", "ActivityState"}
 The state information NamespaceAndName to send to the ContextManager for VisualActivityTracker. More...
 
static const char FOCUSED_KEY [] = "focused"
 The interface key used in the VisualActivityTracker context. More...
 
static const char INTERFACE_KEY [] = "interface"
 The interface key used in the VisualActivityTracker context. More...
 

Typedef Documentation

◆ AudioFocusAnnotation

◆ FocusManagementComponent

Definition of a Manufactory component for focus management.

Function Documentation

◆ createAudioFocusManager()

acsdkManufactory::Annotated<AudioFocusAnnotation, avsCommon::sdkInterfaces::FocusManagerInterface> alexaClientSDK::afml::createAudioFocusManager ( acsdkManufactory::Annotated< AudioFocusAnnotation, ActivityTrackerInterface annotatedActivityTracker,
std::shared_ptr< interruptModel::InterruptModel interruptModel 
)

◆ getAudioActivityTrackerCapabilityConfiguration()

std::shared_ptr< CapabilityConfiguration > alexaClientSDK::afml::getAudioActivityTrackerCapabilityConfiguration ( )
static

Creates the AudioActivityTracker capability configuration.

Returns
The AudioActivityTracker capability configuration.

◆ getComponent()

FocusManagementComponent alexaClientSDK::afml::getComponent ( )

Creates an manufactory component that exports a shared pointer to Annotated FocusManagers.

Returns
A component.

◆ getVisualActivityTrackerCapabilityConfiguration()

std::shared_ptr< CapabilityConfiguration > alexaClientSDK::afml::getVisualActivityTrackerCapabilityConfiguration ( )
static

Creates the VisualActivityTracker capability configuration.

Returns
The VisualActivityTracker capability configuration.

◆ TAG() [1/5]

static const std::string alexaClientSDK::afml::TAG ( "AudioActivityTracker"  )
static

String to identify log entries originating from this file.

◆ TAG() [2/5]

static const std::string alexaClientSDK::afml::TAG ( "Channel"  )
static

String to identify log entries originating from this file.

◆ TAG() [3/5]

static const std::string alexaClientSDK::afml::TAG ( "FocusManagementComponent"  )
static

String to identify log entries originating from this file.

◆ TAG() [4/5]

static const std::string alexaClientSDK::afml::TAG ( "FocusManager"  )
static

String to identify log entries originating from this file.

◆ TAG() [5/5]

static const std::string alexaClientSDK::afml::TAG ( "VisualActivityTracker"  )
static

String to identify log entries originating from this file.

Variable Documentation

◆ AUDIO_CHANNEL_CONFIG_KEY

const std::string alexaClientSDK::afml::AUDIO_CHANNEL_CONFIG_KEY = "audioChannels"
static

Key for audio channel array configurations in configuration node.

◆ AUDIOACTIVITYTRACKER_CAPABILITY_INTERFACE_NAME

const std::string alexaClientSDK::afml::AUDIOACTIVITYTRACKER_CAPABILITY_INTERFACE_NAME = "AudioActivityTracker"
static

AudioActivityTracker interface name.

◆ AUDIOACTIVITYTRACKER_CAPABILITY_INTERFACE_TYPE

const std::string alexaClientSDK::afml::AUDIOACTIVITYTRACKER_CAPABILITY_INTERFACE_TYPE = "AlexaInterface"
static

AudioActivityTracker capability constants AudioActivityTracker interface type

◆ AUDIOACTIVITYTRACKER_CAPABILITY_INTERFACE_VERSION

const std::string alexaClientSDK::afml::AUDIOACTIVITYTRACKER_CAPABILITY_INTERFACE_VERSION = "1.0"
static

AudioActivityTracker interface version.

◆ CHANNEL_NAME_KEY

const std::string alexaClientSDK::afml::CHANNEL_NAME_KEY = "name"
static

Key for the name of the channel in configuration node.

◆ CHANNEL_PRIORITY_KEY

const std::string alexaClientSDK::afml::CHANNEL_PRIORITY_KEY = "priority"
static

Key for the priority of the channel in configuration node.

◆ CONTEXT_MANAGER_STATE [1/2]

const NamespaceAndName alexaClientSDK::afml::CONTEXT_MANAGER_STATE {"VisualActivityTracker", "ActivityState"}
static

The state information NamespaceAndName to send to the ContextManager for VisualActivityTracker.

◆ CONTEXT_MANAGER_STATE [2/2]

const NamespaceAndName alexaClientSDK::afml::CONTEXT_MANAGER_STATE {"AudioActivityTracker", "ActivityState"}
static

The state information NamespaceAndName to send to the ContextManager for AudioActivityTracker.

◆ FOCUSED_KEY

const char alexaClientSDK::afml::FOCUSED_KEY[] = "focused"
static

The interface key used in the VisualActivityTracker context.

◆ IDLE_TIME_KEY

const char alexaClientSDK::afml::IDLE_TIME_KEY[] = "idleTimeInMilliseconds"
static

The idleTime key used in the AudioActivityTracker context.

◆ INTERFACE_KEY [1/2]

const char alexaClientSDK::afml::INTERFACE_KEY[] = "interface"
static

The interface key used in the VisualActivityTracker context.

◆ INTERFACE_KEY [2/2]

const char alexaClientSDK::afml::INTERFACE_KEY[] = "interface"
static

The interface key used in the AudioActivityTracker context.

◆ VIRTUAL_CHANNELS_CONFIG_KEY

const std::string alexaClientSDK::afml::VIRTUAL_CHANNELS_CONFIG_KEY = "virtualChannels"
static

Key for FocusManager configurations in configuration node.

◆ VISUALACTIVITYTRACKER_CAPABILITY_INTERFACE_NAME

const std::string alexaClientSDK::afml::VISUALACTIVITYTRACKER_CAPABILITY_INTERFACE_NAME = "VisualActivityTracker"
static

VisualActivityTracker interface name.

◆ VISUALACTIVITYTRACKER_CAPABILITY_INTERFACE_TYPE

const std::string alexaClientSDK::afml::VISUALACTIVITYTRACKER_CAPABILITY_INTERFACE_TYPE = "AlexaInterface"
static

VisualActivityTracker capability constants VisualActivityTracker interface type

◆ VISUALACTIVITYTRACKER_CAPABILITY_INTERFACE_VERSION

const std::string alexaClientSDK::afml::VISUALACTIVITYTRACKER_CAPABILITY_INTERFACE_VERSION = "1.0"
static

VisualActivityTracker interface version.

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