Alexa Auto SDK  2.0.0
Public Types | Public Member Functions | List of all members
aace::alexa::AudioPlayer Class Reference

Public Types

enum  PlayerActivity {
  PlayerActivity::IDLE,
  PlayerActivity::PLAYING,
  PlayerActivity::STOPPED,
  PlayerActivity::PAUSED,
  PlayerActivity::BUFFER_UNDERRUN,
  PlayerActivity::FINISHED
}
 

Public Member Functions

virtual void playerActivityChanged (PlayerActivity state)
 

Detailed Description

AudioPlayer should be extended to handle audio output from the Engine.

The AudioPlayer MediaPlayer and Speaker will receive directives from the Engine to handle audio playback.

Note
Audio playback control operations such as on-platform button presses must be routed through the PlaybackController.
See also
AudioChannel
PlaybackController
TemplateRuntime::renderPlayerInfo()

Member Enumeration Documentation

◆ PlayerActivity

Specifies the state of audio playback activity

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.

Member Function Documentation

◆ playerActivityChanged()

virtual void aace::alexa::AudioPlayer::playerActivityChanged ( PlayerActivity  state)
inlinevirtual

Notifies the platform implementation of a change in audio playback state

Parameters
[in]stateThe new playback state

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