AlexaClientSDK
3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
|
PlayParams is a struct that contains the parameters for the play method. More...
#include <ExternalMediaAdapterHandlerInterface.h>
Public Member Functions | |
PlayParams (const std::string &localPlayerId, const std::string &playContextToken, int64_t index, std::chrono::milliseconds offset, const std::string &skillToken, const std::string &playbackSessionId, Navigation navigation, bool preload, const alexaClientSDK::avsCommon::avs::PlayRequestor &playRequestor, const std::string &playbackTarget) | |
Public Attributes | |
std::string | localPlayerId |
Local player id to play with. More... | |
std::string | playContextToken |
Play context token for specifying what to play. More... | |
int64_t | index |
Index for track. More... | |
std::chrono::milliseconds | offset |
Offset to play from. More... | |
std::string | skillToken |
Associated skillToken. More... | |
std::string | playbackSessionId |
Playback session id for identifying the session. More... | |
Navigation | navigation |
Navigation for indicating foreground or not. More... | |
bool | preload |
Whether or not to preload first. More... | |
alexaClientSDK::avsCommon::avs::PlayRequestor | playRequestor |
PlayRequestor for indicating who requested playback. More... | |
std::string | playbackTarget |
Playback target to play on. More... | |
PlayParams is a struct that contains the parameters for the play method.
|
inline |
Construct PlayParams
localPlayerId | The localPlayerId that this play control is targeted at |
playContextToken | Play context {Track/playlist/album/artist/station/podcast} identifier. |
index | The index of the media item in the container, if the container is indexable. |
offset | The offset position within media item, in milliseconds. |
skillToken | An opaque token for the domain or skill that is presently associated with this player. |
playbackSessionId | A universally unique identifier (UUID) generated to the RFC 4122 specification. |
navigation | Communicates desired visual display behavior for the app associated with playback. |
preload | If true, this Play directive is intended to preload the identified content only but not begin playback. |
playRequestor | The PlayRequestor object that is used to distinguish if it's a music alarm or not. |
playbackTarget | Playback target to play |
int64_t alexaClientSDK::acsdkExternalMediaPlayerInterfaces::ExternalMediaAdapterHandlerInterface::PlayParams::index |
Index for track.
std::string alexaClientSDK::acsdkExternalMediaPlayerInterfaces::ExternalMediaAdapterHandlerInterface::PlayParams::localPlayerId |
Local player id to play with.
Navigation alexaClientSDK::acsdkExternalMediaPlayerInterfaces::ExternalMediaAdapterHandlerInterface::PlayParams::navigation |
Navigation for indicating foreground or not.
std::chrono::milliseconds alexaClientSDK::acsdkExternalMediaPlayerInterfaces::ExternalMediaAdapterHandlerInterface::PlayParams::offset |
Offset to play from.
std::string alexaClientSDK::acsdkExternalMediaPlayerInterfaces::ExternalMediaAdapterHandlerInterface::PlayParams::playbackSessionId |
Playback session id for identifying the session.
std::string alexaClientSDK::acsdkExternalMediaPlayerInterfaces::ExternalMediaAdapterHandlerInterface::PlayParams::playbackTarget |
Playback target to play on.
std::string alexaClientSDK::acsdkExternalMediaPlayerInterfaces::ExternalMediaAdapterHandlerInterface::PlayParams::playContextToken |
Play context token for specifying what to play.
alexaClientSDK::avsCommon::avs::PlayRequestor alexaClientSDK::acsdkExternalMediaPlayerInterfaces::ExternalMediaAdapterHandlerInterface::PlayParams::playRequestor |
PlayRequestor for indicating who requested playback.
bool alexaClientSDK::acsdkExternalMediaPlayerInterfaces::ExternalMediaAdapterHandlerInterface::PlayParams::preload |
Whether or not to preload first.
std::string alexaClientSDK::acsdkExternalMediaPlayerInterfaces::ExternalMediaAdapterHandlerInterface::PlayParams::skillToken |
Associated skillToken.
AlexaClientSDK 3.0.0 - Copyright 2016-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0