#include <ExternalMediaAdapterInterface.h>

Collaboration diagram for alexaClientSDK::acsdkExternalMediaPlayerInterfaces::ExternalMediaAdapterInterface::HandlePlayParams:

[legend]

Public Member Functions
	HandlePlayParams (const std::string &playContextToken, int64_t index, std::chrono::milliseconds offset, const std::string &skillToken, const std::string &playbackSessionId, Navigation navigation, bool preload, const avsCommon::avs::PlayRequestor &playRequestor, const std::string &playbackTarget)

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

avsCommon::avs::PlayRequestor	playRequestor
	PlayRequestor for indicating who requested playback. More...

std::string	playbackTarget
	Playback target to play on. More...

Detailed Description

HandlePlayParams is a struct that contains the parameters for the handlePlay method

Constructor & Destructor Documentation

◆ HandlePlayParams()

alexaClientSDK::acsdkExternalMediaPlayerInterfaces::ExternalMediaAdapterInterface::HandlePlayParams::HandlePlayParams	(	const std::string &	playContextToken,
		int64_t	index,
		std::chrono::milliseconds	offset,
		const std::string &	skillToken,
		const std::string &	playbackSessionId,
		Navigation	navigation,
		bool	preload,
		const avsCommon::avs::PlayRequestor &	playRequestor,
		const std::string &	playbackTarget
	)

inline

Construct HandlePlayParams

Parameters

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	The `PlaybackTarget` is used to specify the targeted device that will handle the playback action.

Member Data Documentation

◆ index

int64_t alexaClientSDK::acsdkExternalMediaPlayerInterfaces::ExternalMediaAdapterInterface::HandlePlayParams::index

Index for track.

◆ navigation

Navigation alexaClientSDK::acsdkExternalMediaPlayerInterfaces::ExternalMediaAdapterInterface::HandlePlayParams::navigation

Navigation for indicating foreground or not.

◆ offset

std::chrono::milliseconds alexaClientSDK::acsdkExternalMediaPlayerInterfaces::ExternalMediaAdapterInterface::HandlePlayParams::offset

Offset to play from.

◆ playbackSessionId

std::string alexaClientSDK::acsdkExternalMediaPlayerInterfaces::ExternalMediaAdapterInterface::HandlePlayParams::playbackSessionId

Playback session id for identifying the session.

◆ playbackTarget

std::string alexaClientSDK::acsdkExternalMediaPlayerInterfaces::ExternalMediaAdapterInterface::HandlePlayParams::playbackTarget

Playback target to play on.

◆ playContextToken

std::string alexaClientSDK::acsdkExternalMediaPlayerInterfaces::ExternalMediaAdapterInterface::HandlePlayParams::playContextToken

Play context token for specifying what to play.

◆ playRequestor

avsCommon::avs::PlayRequestor alexaClientSDK::acsdkExternalMediaPlayerInterfaces::ExternalMediaAdapterInterface::HandlePlayParams::playRequestor

PlayRequestor for indicating who requested playback.

◆ preload

bool alexaClientSDK::acsdkExternalMediaPlayerInterfaces::ExternalMediaAdapterInterface::HandlePlayParams::preload

Whether or not to preload first.

◆ skillToken

std::string alexaClientSDK::acsdkExternalMediaPlayerInterfaces::ExternalMediaAdapterInterface::HandlePlayParams::skillToken

Associated skillToken.

The documentation for this struct was generated from the following file:

/workplace/avs-device-sdk/capabilities/ExternalMediaPlayer/acsdkExternalMediaPlayerInterfaces/include/acsdkExternalMediaPlayerInterfaces/ExternalMediaAdapterInterface.h

Public Member Functions

Public Attributes