AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | Public Attributes | List of all members
alexaClientSDK::acsdkExternalMediaPlayerInterfaces::ExternalMediaAdapterHandlerInterface::PlayParams Struct Reference

PlayParams is a struct that contains the parameters for the play method. More...

#include <ExternalMediaAdapterHandlerInterface.h>

Collaboration diagram for alexaClientSDK::acsdkExternalMediaPlayerInterfaces::ExternalMediaAdapterHandlerInterface::PlayParams:
Collaboration graph
[legend]

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...
 

Detailed Description

PlayParams is a struct that contains the parameters for the play method.

Constructor & Destructor Documentation

◆ PlayParams()

alexaClientSDK::acsdkExternalMediaPlayerInterfaces::ExternalMediaAdapterHandlerInterface::PlayParams::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 
)
inline

Construct PlayParams

Parameters
localPlayerIdThe localPlayerId that this play control is targeted at
playContextTokenPlay context {Track/playlist/album/artist/station/podcast} identifier.
indexThe index of the media item in the container, if the container is indexable.
offsetThe offset position within media item, in milliseconds.
skillTokenAn opaque token for the domain or skill that is presently associated with this player.
playbackSessionIdA universally unique identifier (UUID) generated to the RFC 4122 specification.
navigationCommunicates desired visual display behavior for the app associated with playback.
preloadIf true, this Play directive is intended to preload the identified content only but not begin playback.
playRequestorThe PlayRequestor object that is used to distinguish if it's a music alarm or not.
playbackTargetPlayback target to play

Member Data Documentation

◆ index

int64_t alexaClientSDK::acsdkExternalMediaPlayerInterfaces::ExternalMediaAdapterHandlerInterface::PlayParams::index

Index for track.

◆ localPlayerId

std::string alexaClientSDK::acsdkExternalMediaPlayerInterfaces::ExternalMediaAdapterHandlerInterface::PlayParams::localPlayerId

Local player id to play with.

◆ navigation

Navigation alexaClientSDK::acsdkExternalMediaPlayerInterfaces::ExternalMediaAdapterHandlerInterface::PlayParams::navigation

Navigation for indicating foreground or not.

◆ offset

std::chrono::milliseconds alexaClientSDK::acsdkExternalMediaPlayerInterfaces::ExternalMediaAdapterHandlerInterface::PlayParams::offset

Offset to play from.

◆ playbackSessionId

std::string alexaClientSDK::acsdkExternalMediaPlayerInterfaces::ExternalMediaAdapterHandlerInterface::PlayParams::playbackSessionId

Playback session id for identifying the session.

◆ playbackTarget

std::string alexaClientSDK::acsdkExternalMediaPlayerInterfaces::ExternalMediaAdapterHandlerInterface::PlayParams::playbackTarget

Playback target to play on.

◆ playContextToken

std::string alexaClientSDK::acsdkExternalMediaPlayerInterfaces::ExternalMediaAdapterHandlerInterface::PlayParams::playContextToken

Play context token for specifying what to play.

◆ playRequestor

alexaClientSDK::avsCommon::avs::PlayRequestor alexaClientSDK::acsdkExternalMediaPlayerInterfaces::ExternalMediaAdapterHandlerInterface::PlayParams::playRequestor

PlayRequestor for indicating who requested playback.

◆ preload

bool alexaClientSDK::acsdkExternalMediaPlayerInterfaces::ExternalMediaAdapterHandlerInterface::PlayParams::preload

Whether or not to preload first.

◆ skillToken

std::string alexaClientSDK::acsdkExternalMediaPlayerInterfaces::ExternalMediaAdapterHandlerInterface::PlayParams::skillToken

Associated skillToken.


The documentation for this struct 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