Alexa Auto SDK  2.3.0
Classes | Enumerations | Functions
aace::alexa Namespace Reference

Classes

class  Alerts
 
class  AlertsEngineInterface
 
class  AlexaClient
 
class  AlexaClientEngineInterface
 
class  AlexaSpeaker
 
class  AlexaSpeakerEngineInterface
 
class  AudioPlayer
 
class  AudioPlayerEngineInterface
 
class  AuthProvider
 
class  AuthProviderEngineInterface
 
class  DoNotDisturb
 
class  DoNotDisturbEngineInterface
 
class  EqualizerController
 
class  EqualizerControllerEngineInterface
 
class  ExternalMediaAdapterEngineInterface
 
class  LocalMediaSource
 
class  LocalMediaSourceEngineInterface
 
class  Notifications
 
class  PlaybackController
 
class  PlaybackControllerEngineInterface
 
class  SpeechRecognizer
 
class  SpeechRecognizerEngineInterface
 
class  SpeechSynthesizer
 
class  TemplateRuntime
 
class  TemplateRuntimeEngineInterface
 

Enumerations

enum  FocusState {
  FocusState::FOREGROUND,
  FocusState::BACKGROUND,
  FocusState::NONE
}
 
enum  PlayerActivity {
  PlayerActivity::IDLE,
  PlayerActivity::PLAYING,
  PlayerActivity::STOPPED,
  PlayerActivity::PAUSED,
  PlayerActivity::BUFFER_UNDERRUN,
  PlayerActivity::FINISHED
}
 

Functions

std::string equalizerBandToString (const EqualizerControllerEngineInterface::EqualizerBand &band)
 
std::ostream & operator<< (std::ostream &stream, const EqualizerControllerEngineInterface::EqualizerBand &band)
 

Detailed Description

The alexa namespace.

Enumeration Type Documentation

◆ FocusState

An enum class used to specify the levels of focus that a Channel can have.

Enumerator
FOREGROUND 

Represents the highest focus a Channel can have.

BACKGROUND 

Represents the intermediate level focus a Channel can have.

NONE 

This focus is used to represent when a Channel is not being used.

◆ PlayerActivity

An enum class used to specify player activity for AudioPlayer and audio player state for TemplateRuntime.

Enumerator
IDLE 

Audio playback has not yet begun.

PLAYING 

Audio is currently playing.

STOPPED 

Audio playback is stopped, either from a stop directive or playback error.

PAUSED 

Audio playback is paused.

BUFFER_UNDERRUN 

Audio playback is stalled because a buffer underrun has occurred.

FINISHED 

Audio playback is finished.

Function Documentation

◆ equalizerBandToString()

std::string aace::alexa::equalizerBandToString ( const EqualizerControllerEngineInterface::EqualizerBand band)
inline

Provides a string representation for an EqualizerControllerEngineInterface::EqualizerBand

Parameters
bandThe EqualizerBand
Returns
A string representation for the EqualizerBand

◆ operator<<()

std::ostream& aace::alexa::operator<< ( std::ostream &  stream,
const EqualizerControllerEngineInterface::EqualizerBand band 
)
inline

Write an EqualizerControllerEngineInterface::EqualizerBand value to an ostream as a string

Parameters
streamThe stream to write to
bandThe EqualizerBand value to write to the ostream
Returns
The ostream argument that was written to

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