#include <ExternalMediaAdapterInterface.h>

Collaboration diagram for alexaClientSDK::acsdkExternalMediaPlayerInterfaces::AdapterPlaybackState:

Public Member Functions
	AdapterPlaybackState ()
	Default constructor. More...

Public Attributes
std::string	playerId

std::string	state
	The players current state. More...

std::set< SupportedPlaybackOperation >	supportedOperations
	The set of states the default player can move into from its current state. More...

std::chrono::milliseconds	trackOffset
	The offset of the track in milliseconds. More...

bool	shuffleEnabled
	Bool to identify if shuffling is enabled or not. More...

bool	repeatEnabled
	Bool to identify if looping of songs is enabled or not. More...

Favorites	favorites
	The favorite status {"FAVORITED"/"UNFAVORITED"/"NOT_RATED"}. More...

std::string	type

std::string	playbackSource
	The display name for current playback context, e.g. playlist name. More...

std::string	playbackSourceId

std::string	playbackId

std::string	trackName
	The display name for the currently playing trackname of the track. More...

std::string	trackId

std::string	trackNumber

std::string	artistName
	The display name for the currently playing artist. More...

std::string	artistId

std::string	albumName
	The display name of the currently playing album. More...

std::string	albumId

std::string	tinyURL
	The URL for tiny cover art image resource} . More...

std::string	smallURL
	The URL for small cover art image resource} . More...

std::string	mediumURL
	The URL for medium cover art image resource} . More...

std::string	largeURL
	The URL for large cover art image resource} . More...

std::string	coverId

std::string	mediaProvider

MediaType	mediaType

std::chrono::milliseconds	duration
	Media item duration in milliseconds. More...

avsCommon::avs::PlayRequestor	playRequestor
	The PlayRequestor object from the `PLAY` directive. More...

Detailed Description

struct that encapsulates an adapter's playback state.

Constructor & Destructor Documentation

◆ AdapterPlaybackState()

alexaClientSDK::acsdkExternalMediaPlayerInterfaces::AdapterPlaybackState::AdapterPlaybackState ( )

inline

Default constructor.

Member Data Documentation

◆ albumId

std::string alexaClientSDK::acsdkExternalMediaPlayerInterfaces::AdapterPlaybackState::albumId

Arbitrary identifier for currently playing album specific to the music provider, e.g. a URI that can be queried to MSP services for additional info.

◆ albumName

std::string alexaClientSDK::acsdkExternalMediaPlayerInterfaces::AdapterPlaybackState::albumName

The display name of the currently playing album.

◆ artistId

std::string alexaClientSDK::acsdkExternalMediaPlayerInterfaces::AdapterPlaybackState::artistId

An arbitrary identifier for currently playing artist as per the music provider, e.g. a URI that can be queried to MSP services for additional info.

◆ artistName

std::string alexaClientSDK::acsdkExternalMediaPlayerInterfaces::AdapterPlaybackState::artistName

The display name for the currently playing artist.

◆ coverId

std::string alexaClientSDK::acsdkExternalMediaPlayerInterfaces::AdapterPlaybackState::coverId

The Arbitrary identifier for cover art image resource specific to the music provider, for retrieval from an MSP API.

◆ duration

std::chrono::milliseconds alexaClientSDK::acsdkExternalMediaPlayerInterfaces::AdapterPlaybackState::duration

Media item duration in milliseconds.

◆ favorites

Favorites alexaClientSDK::acsdkExternalMediaPlayerInterfaces::AdapterPlaybackState::favorites

The favorite status {"FAVORITED"/"UNFAVORITED"/"NOT_RATED"}.

◆ largeURL

std::string alexaClientSDK::acsdkExternalMediaPlayerInterfaces::AdapterPlaybackState::largeURL

The URL for large cover art image resource} .

◆ mediaProvider

std::string alexaClientSDK::acsdkExternalMediaPlayerInterfaces::AdapterPlaybackState::mediaProvider

Music Service Provider name for the currently playing media item; distinct from the application identity although the two may be the same.

◆ mediaType

MediaType alexaClientSDK::acsdkExternalMediaPlayerInterfaces::AdapterPlaybackState::mediaType

The Media type enum value from {TRACK, PODCAST, STATION, AD, SAMPLE, OTHER} type of the media.

◆ mediumURL

std::string alexaClientSDK::acsdkExternalMediaPlayerInterfaces::AdapterPlaybackState::mediumURL

The URL for medium cover art image resource} .

◆ playbackId

std::string alexaClientSDK::acsdkExternalMediaPlayerInterfaces::AdapterPlaybackState::playbackId

An unique identifiier for the current playback of the track. If same track exists twice in a context, each instance will have a unique playbackId. It is valid for only one playback of a track and once the track is played or skipped-over, the playback-id is no longer valid. e.g if you skip a track and then come back to it using skip-prev, the playback-id changes. It is for debugging purposes and it is optional.

◆ playbackSource

std::string alexaClientSDK::acsdkExternalMediaPlayerInterfaces::AdapterPlaybackState::playbackSource

The display name for current playback context, e.g. playlist name.

◆ playbackSourceId

std::string alexaClientSDK::acsdkExternalMediaPlayerInterfaces::AdapterPlaybackState::playbackSourceId

An arbitrary identifier for current playback context as per the music provider, e.g. a URI that can be saved as a preset or queried to Music Service Provider services for additional info.

◆ playerId

std::string alexaClientSDK::acsdkExternalMediaPlayerInterfaces::AdapterPlaybackState::playerId

The playerId of an adapter which is the pre-negotiated business id for a partner music provider.

◆ playRequestor

avsCommon::avs::PlayRequestor alexaClientSDK::acsdkExternalMediaPlayerInterfaces::AdapterPlaybackState::playRequestor

The PlayRequestor object from the PLAY directive.

◆ repeatEnabled

bool alexaClientSDK::acsdkExternalMediaPlayerInterfaces::AdapterPlaybackState::repeatEnabled

Bool to identify if looping of songs is enabled or not.

◆ shuffleEnabled

bool alexaClientSDK::acsdkExternalMediaPlayerInterfaces::AdapterPlaybackState::shuffleEnabled

Bool to identify if shuffling is enabled or not.

◆ smallURL

std::string alexaClientSDK::acsdkExternalMediaPlayerInterfaces::AdapterPlaybackState::smallURL

The URL for small cover art image resource} .

◆ state

std::string alexaClientSDK::acsdkExternalMediaPlayerInterfaces::AdapterPlaybackState::state

The players current state.

◆ supportedOperations

std::set<SupportedPlaybackOperation> alexaClientSDK::acsdkExternalMediaPlayerInterfaces::AdapterPlaybackState::supportedOperations

The set of states the default player can move into from its current state.

◆ tinyURL

std::string alexaClientSDK::acsdkExternalMediaPlayerInterfaces::AdapterPlaybackState::tinyURL

The URL for tiny cover art image resource} .

◆ trackId

std::string alexaClientSDK::acsdkExternalMediaPlayerInterfaces::AdapterPlaybackState::trackId

The arbitrary identifier for currently playing trackid of the track as per the music provider.

◆ trackName

std::string alexaClientSDK::acsdkExternalMediaPlayerInterfaces::AdapterPlaybackState::trackName

The display name for the currently playing trackname of the track.

◆ trackNumber

std::string alexaClientSDK::acsdkExternalMediaPlayerInterfaces::AdapterPlaybackState::trackNumber

The display value for the number or abstract position of the currently playing track in the album or context trackNumber of the track.

◆ trackOffset

std::chrono::milliseconds alexaClientSDK::acsdkExternalMediaPlayerInterfaces::AdapterPlaybackState::trackOffset

The offset of the track in milliseconds.

◆ type

std::string alexaClientSDK::acsdkExternalMediaPlayerInterfaces::AdapterPlaybackState::type

The type of the media item. For now hard-coded to ExternalMediaPlayerMusicItem.

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