#include <PlaybackController.h>
◆ ~PlaybackController()
virtual alexaClientSDK::capabilityAgents::playbackController::PlaybackController::~PlaybackController |
( |
| ) |
|
|
virtualdefault |
◆ create()
Create an instance of PlaybackController
.
- Parameters
-
contextManager | The ContextManagerInterface used to generate system context for events. |
messageSender | The MessageSenderInterface that sends events to AVS. |
- Returns
nullptr
if the inputs are not defined, else a new instance of PlaybackController
.
◆ createPlaybackHandlerInterface()
Factory method to create an instance of PlaybackHandlerInterface
.
- Parameters
-
contextManager | The ContextManagerInterface used to generate system context for events. |
messageSender | The MessageSenderInterface that sends events to AVS. |
- Returns
nullptr
if the inputs are not defined, else a new instance of PlaybackController
.
◆ getCapabilityConfigurations()
◆ messageSent()
Manage completion of event being sent.
- Parameters
-
PlaybackCommand | The or that was pressed to generate the message sent. |
messageStatus | The status of submitted MessageRequest . |
◆ onButtonPressed()
◆ onContextAvailable()
void alexaClientSDK::capabilityAgents::playbackController::PlaybackController::onContextAvailable |
( |
const std::string & |
jsonContext | ) |
|
|
overridevirtual |
This is called by the ContextManager once the context is ready and available.
- Deprecated:
- This method is being deprecated since it cannot specify the source endpoint.
- Note
- The
ContextRequester
should perform minimum processing and return quickly. Otherwise it will block the processing of updating the of other ContextProviders
.
- Parameters
-
jsonContext | Context information.Context provided is of the format {"context"[{...}, {...}]} |
Reimplemented from alexaClientSDK::avsCommon::sdkInterfaces::ContextRequesterInterface.
◆ onContextFailure()
The contextManager calls this if it is unable to process a getContext
request successfully.
- Deprecated:
- This method is being deprecated since it cannot specify the optional token.
- Note
- The
ContextRequester
should perform minimum processing and return quickly. Otherwise it will block the processing of updating the of other ContextProviders
.
- Parameters
-
error | The reason why the getContext request failed. |
Reimplemented from alexaClientSDK::avsCommon::sdkInterfaces::ContextRequesterInterface.
◆ onTogglePressed()
The documentation for this class was generated from the following file:
- /workplace/avs-device-sdk/CapabilityAgents/PlaybackController/include/PlaybackController/PlaybackController.h
AlexaClientSDK 3.0.0 - Copyright 2016-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
Licensed under the Apache License, Version 2.0