The Engine provides a platform interface
aace::alexa::PlaybackController for the platform implementation to report on-device transport control button presses for media playing through Alexa. For example, if the user presses the on-screen pause button while listening to Amazon Music through Alexa's
AudioPlayer interface, the platform implementation publishes a
PlaybackController message to report the button press to the Engine.
PlaybackControllermethod calls to manage
AudioPlayer's state or playback queue proactively report button presses or the equivalent so that Alexa can react; they do not report changes to the playback state that happen locally first. The Alexa cloud manages the playback queue for
AudioPlayercontent, so each
PlaybackControllerpublishing is a request for Alexa to act on the user's local request. The result of the request will come as one or more messages on the
AudioOutputassociated with the channel used for
Note: If your implementation needs to stop
AudioPlayermedia in response to system events, such as audio focus transitions to audio playing outside the scope of the Auto SDK, use
PlaybackControllerto notify the Engine of such changes. However, keep in mind that the expected usage of the interface does not change when it is used in this use case.
PlaybackControlleronly controls media coming from Alexa, i.e. the
PlaybackControllershould not be used with the expectation of controlling playback for non-media Alexa audio sources like
SpeechSynthesizeror Alexa-aware external media sources integrated with
LocalMediaSource. Additionally, pulishing a
PlaybackControllermessage while audio is playing through another Alexa-aware external media source will produce unexpected results and is not recommended.
Whenever Alexa plays media through
AudioPlayer, the Engine sends
TemplateRuntime.RenderPlayerInfo message to provide visual metadata associated with the media that your implementation should render for the end user. The payload of this message includes descriptions of GUI controls to be displayed and the state in which to display them. When the user interacts with these on-screen controls, your implementation must use the
PlaybackController interface to report the button presses to the Engine.
The table below maps the controls from the
RenderPlayerInfo message payload to the corresponding calls in
|RenderPlayerInfo control name
Implement a playback controller by publishing
using namespace aasb::message::alexa::playbackController;
// Publish the ButtonPressedMessage for the button pressed.
msg.payload.button = PlaybackButton::PLAY;
// Publish the TogglePressedMessage for the button pressed.
msg.payload.toggle = PlaybackToggle::SHUFFLE;
msg.payload.action = true;