alexaClientSDK::avsCommon::sdkInterfaces::PlaybackHandlerInterface Class Reference

#include <PlaybackHandlerInterface.h>

Inheritance diagram for alexaClientSDK::avsCommon::sdkInterfaces::PlaybackHandlerInterface:

Public Member Functions
virtual	~PlaybackHandlerInterface ()=default
virtual void	onButtonPressed (alexaClientSDK::avsCommon::avs::PlaybackButton button)=0
virtual void	onTogglePressed (alexaClientSDK::avsCommon::avs::PlaybackToggle toggle, bool action)=0

Detailed Description

This class allows a playback button press handler to be notified a playback button is pressed.

Constructor & Destructor Documentation

~PlaybackHandlerInterface()

virtual alexaClientSDK::avsCommon::sdkInterfaces::PlaybackHandlerInterface::~PlaybackHandlerInterface ( )

virtualdefault

Destructor.

Member Function Documentation

onButtonPressed()

virtual void alexaClientSDK::avsCommon::sdkInterfaces::PlaybackHandlerInterface::onButtonPressed ( alexaClientSDK::avsCommon::avs::PlaybackButton  button )

pure virtual

Used to notify the handler when a playback button is pressed.

Parameters

button

The button that has been pressed.

Implemented in alexaClientSDK::acsdkExternalMediaPlayer::ExternalMediaPlayer, and alexaClientSDK::capabilityAgents::playbackController::PlaybackController.

onTogglePressed()

virtual void alexaClientSDK::avsCommon::sdkInterfaces::PlaybackHandlerInterface::onTogglePressed ( alexaClientSDK::avsCommon::avs::PlaybackToggle  toggle, bool  action  )

pure virtual

Used to notify the handler when a playback toggle is pressed.

Parameters

toggle	The toggle that has been pressed.
action	The boolean action for the toggle state

Implemented in alexaClientSDK::acsdkExternalMediaPlayer::ExternalMediaPlayer, and alexaClientSDK::capabilityAgents::playbackController::PlaybackController.

---

The documentation for this class was generated from the following file:

• /workplace/avs-device-sdk/AVSCommon/SDKInterfaces/include/AVSCommon/SDKInterfaces/PlaybackHandlerInterface.h