AlexaClientSDK  1.25.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | List of all members
alexaClientSDK::avsCommon::sdkInterfaces::PlaybackHandlerInterface Class Referenceabstract

#include <PlaybackHandlerInterface.h>

Inheritance diagram for alexaClientSDK::avsCommon::sdkInterfaces::PlaybackHandlerInterface:
Inheritance graph
[legend]

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
buttonThe 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
toggleThe toggle that has been pressed.
actionThe 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:

AlexaClientSDK 1.25.0 - Copyright 2016-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0