Alexa Auto SDK  4.3
Public Member Functions | Public Attributes | List of all members
aace::alexa::LocalMediaSource::PlaybackState Class Reference

Public Member Functions

 PlaybackState ()
 Default constructor.
 

Public Attributes

std::vector< SupportedPlaybackOperationsupportedOperations
 The set of states the default player can move into from its current state. default {}.
 
std::chrono::milliseconds trackOffset
 The offset of the track in milliseconds. default 0.
 
bool shuffleEnabled
 Bool to identify if shuffling is enabled. default false.
 
bool repeatEnabled
 Bool to identify if looping of songs is enabled. default false.
 
bool repeatOneEnabled
 Bool to identify if repeating the track is enabled. default false.
 
Favorites favorites
 The favorite status FAVORITED/UNFAVORITED/NOT_RATED. default NOT_RATED.
 
std::string type
 The type of the media item should be "ExternalMediaAdapterMusicItem". default "ExternalMediaAdapterMusicItem".
 
std::string playbackSource
 The display name for current playback context, e.g. playlist name. default "".
 
std::string playbackSourceId
 
std::string trackName
 The display name for the currently playing trackname of the track. default "".
 
std::string trackId
 The arbitrary identifier for currently playing trackid of the track as per the music provider. default "".
 
std::string trackNumber
 
std::string artistName
 The display name for the currently playing artist. default "".
 
std::string artistId
 
std::string albumName
 The display name of the currently playing album. default "".
 
std::string albumId
 
std::string tinyURL
 The URL for tiny cover art image resource. default "".
 
std::string smallURL
 The URL for small cover art image resource. default "".
 
std::string mediumURL
 The URL for medium cover art image resource. default "".
 
std::string largeURL
 The URL for large cover art image resource. default "".
 
std::string coverId
 
std::string mediaProvider
 
MediaType mediaType
 The Media type TRACK/PODCAST/STATION/AD/SAMPLE/OTHER . default OTHER.
 
std::chrono::milliseconds duration
 Media item duration in milliseconds. default 0.
 

Detailed Description

struct that encapsulates a players playback state.

Member Data Documentation

◆ playbackSourceId

std::string aace::alexa::LocalMediaSource::PlaybackState::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. default ""

◆ trackNumber

std::string aace::alexa::LocalMediaSource::PlaybackState::trackNumber

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

◆ artistId

std::string aace::alexa::LocalMediaSource::PlaybackState::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. default ""

◆ albumId

std::string aace::alexa::LocalMediaSource::PlaybackState::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. default ""

◆ coverId

std::string aace::alexa::LocalMediaSource::PlaybackState::coverId

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

◆ mediaProvider

std::string aace::alexa::LocalMediaSource::PlaybackState::mediaProvider

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


Alexa Auto SDK 4.3 - Copyright 2017-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0