#include <PlaybackRouterInterface.h>
The PlaybackRouterInterface
used to get a playback button press and send it it to the current handler.
◆ ~PlaybackRouterInterface()
virtual alexaClientSDK::avsCommon::sdkInterfaces::PlaybackRouterInterface::~PlaybackRouterInterface |
( |
| ) |
|
|
virtualdefault |
◆ buttonPressed()
This method can be called by the client when a Button is pressed on a physical button or on the GUI. A ButtonCommandIssued event message will be sent to the observer. NOTE: Instances may attempt to handle button locally first.
- Parameters
-
button | The PlaybackButton type being pressed |
Implemented in alexaClientSDK::capabilityAgents::playbackController::PlaybackRouter.
◆ localOperation()
◆ localSeekTo()
virtual bool alexaClientSDK::avsCommon::sdkInterfaces::PlaybackRouterInterface::localSeekTo |
( |
std::chrono::milliseconds |
location, |
|
|
bool |
fromStart |
|
) |
| |
|
inlinevirtual |
Request the handler to perform a local seek operation.
- Parameters
-
location | Position to seek to |
fromStart | true to seek to absolute location, false to seek reletive to current location. |
- Returns
- true if successful, false if the operation cannot be performed locally.
Reimplemented in alexaClientSDK::capabilityAgents::playbackController::PlaybackRouter.
◆ setHandler()
This method sets the playback button press handler that any time a button is pressed this handler will be called.
- Parameters
-
handler | - The handler to call on future playback button presses. |
localHandler | The handler to use for local requests. nullptr to disable local requests |
◆ switchToDefaultHandler()
virtual void alexaClientSDK::avsCommon::sdkInterfaces::PlaybackRouterInterface::switchToDefaultHandler |
( |
| ) |
|
|
pure virtual |
◆ togglePressed()
This method can be called by the client when a Toggle is pressed on a physical button or on the GUI. A ToggleCommandIssued event message will be sent to the observer.
- Parameters
-
toggle | The PlaybackToggle type being pressed |
action | The boolean action for the toggle state |
Implemented in alexaClientSDK::capabilityAgents::playbackController::PlaybackRouter.
◆ useDefaultHandlerWith()
virtual void alexaClientSDK::avsCommon::sdkInterfaces::PlaybackRouterInterface::useDefaultHandlerWith |
( |
std::shared_ptr< LocalPlaybackHandlerInterface > |
localHandler | ) |
|
|
inlinevirtual |
This method switches playback button pressess handling to the default handler, and enables the given local Handler.
The documentation for this class was generated from the following file:
AlexaClientSDK 3.0.0 - Copyright 2016-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
Licensed under the Apache License, Version 2.0