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

Public Types

using PlaybackButton = aace::alexa::PlaybackControllerEngineInterface::PlaybackButton
 
using PlaybackToggle = aace::alexa::PlaybackControllerEngineInterface::PlaybackToggle
 

Public Member Functions

void buttonPressed (PlaybackButton button)
 
void togglePressed (PlaybackToggle toggle, bool action)
 

Detailed Description

PlaybackController should be extended to handle playback control operations such as on-platform button presses for the AudioPlayer. The Engine will respond to PlaybackController events with playback control directives on the AudioPlayer MediaPlayer.

Note
The TemplateRuntime::renderPlayerInfo() payload includes information about what playback control buttons should be enabled on screen with a player info display card.
See also
AudioPlayer
Deprecated:
This platform interface is deprecated. Use the Alexa Auto Services Bridge (AASB) message broker to publish and subscribe to AASB messages instead.
See also
aace::core::MessageBroker

Member Typedef Documentation

◆ PlaybackButton

Describes the playback button types

◆ PlaybackToggle

Describes the playback toggle types

Member Function Documentation

◆ buttonPressed()

void aace::alexa::PlaybackController::buttonPressed ( PlaybackButton  button)

Notifies the Engine of a platform button request (i.e. Play/Pause/Next/Previous/Skip Forward/Skip Backward) For certain playback types, the Engine will issue playback directives to the AudioPlayer MediaPlayer to control playback on the platform.

Parameters
[in]buttonThe playback button type

◆ togglePressed()

void aace::alexa::PlaybackController::togglePressed ( PlaybackToggle  toggle,
bool  action 
)

Notifies the Engine of a platform toggle request (i.e. Shuffle/Loop/Repeat/Thumbs Up/Thumbs Down) For certain playback types, the Engine will issue playback directives to the AudioPlayer MediaPlayer to control playback on the platform.

Parameters
[in]toggleThe playback toggle type
[in]actionThe toggle action ( selected/deselected )

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