com.smartdevicelink.proxy.rpc

Class MediaServiceData

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.rpc.MediaServiceData

All Implemented Interfaces:

Cloneable

public class MediaServiceData
extends RPCStruct

This data is related to what a media service should provide

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_IS_EXPLICIT
static String	KEY_MEDIA_ALBUM
static String	KEY_MEDIA_ARTIST
static String	KEY_MEDIA_IMAGE
static String	KEY_MEDIA_TITLE
static String	KEY_MEDIA_TYPE
static String	KEY_PLAYLIST_NAME
static String	KEY_QUEUE_CURRENT_TRACK_NUMBER
static String	KEY_QUEUE_PLAYBACK_DURATION
static String	KEY_QUEUE_PLAYBACK_PROGRESS
static String	KEY_QUEUE_TOTAL_TRACK_COUNT
static String	KEY_TRACK_PLAYBACK_DURATION
static String	KEY_TRACK_PLAYBACK_PROGRESS

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

KEY_BULK_DATA, KEY_PROTECTED, store

Constructor Summary

Constructors

Constructor and Description
MediaServiceData()
MediaServiceData(Hashtable<String,Object> hash)

Method Summary

Modifier and Type	Method and Description
Boolean	getIsExplicit()
String	getMediaAlbum() Music: The name of the current album Podcast: The name of the current podcast show Audiobook: The name of the current book
String	getMediaArtist() Music: The name of the current album artist Podcast: The provider of the podcast (hosts, network, company) Audiobook: The book author's name
Image	getMediaImage() Returns the media image associated with the currently playing media Music: The album art of the current track Podcast: The podcast or chapter artwork of the current podcast episode Audiobook: The book or chapter artwork of the current audiobook
String	getMediaTitle() Music: The name of the current track Podcast: The name of the current episode Audiobook: The name of the current chapter
MediaType	getMediaType()
String	getPlaylistName() Music: The name of the playlist or radio station, if the user is playing from a playlist, otherwise, Null Podcast: The name of the playlist, if the user is playing from a playlist, otherwise, Null Audiobook: Likely not applicable, possibly a collection or "playlist" of books
Integer	getQueueCurrentTrackNumber() Music: The current number (1 based) of the track in the playback queue Podcast: The current number (1 based) of the episode in the playback queue Audiobook: The current number (1 based) of the episode in the playback queue (e.g.
Integer	getQueuePlaybackDuration() Music: The total duration of the playback queue in seconds Podcast: The total duration of the playback queue in seconds Audiobook: The total duration of the playback queue (e.g.
Integer	getQueuePlaybackProgress() Music: The current progress of the playback queue in seconds Podcast: The current progress of the playback queue in seconds Audiobook: The current progress of the playback queue (e.g.
Integer	getQueueTotalTrackCount() Music: The total number of tracks in the playback queue Podcast: The total number of episodes in the playback queue Audiobook: The total number of sections in the playback queue (e.g.
Integer	getTrackPlaybackDuration() Music: The total duration of the track in seconds Podcast: The total duration of the episode in seconds Audiobook: The total duration of the current segment (e.g.
Integer	getTrackPlaybackProgress() Music: The current progress of the track in seconds Podcast: The current progress of the episode in seconds Audiobook: The current progress of the current segment (e.g.
MediaServiceData	setIsExplicit(Boolean isExplicit)
MediaServiceData	setMediaAlbum(String mediaAlbum) Music: The name of the current album Podcast: The name of the current podcast show Audiobook: The name of the current book
MediaServiceData	setMediaArtist(String mediaArtist) Music: The name of the current album artist Podcast: The provider of the podcast (hosts, network, company) Audiobook: The book author's name
MediaServiceData	setMediaImage(Image mediaImage) Sets the media image associated with the currently playing media Music: The album art of the current track Podcast: The podcast or chapter artwork of the current podcast episode Audiobook: The book or chapter artwork of the current audiobook
MediaServiceData	setMediaTitle(String mediaTitle) Music: The name of the current track Podcast: The name of the current episode Audiobook: The name of the current chapter
MediaServiceData	setMediaType(MediaType mediaType)
MediaServiceData	setPlaylistName(String playlistName) Music: The name of the playlist or radio station, if the user is playing from a playlist, otherwise, Null Podcast: The name of the playlist, if the user is playing from a playlist, otherwise, Null Audiobook: Likely not applicable, possibly a collection or "playlist" of books
MediaServiceData	setQueueCurrentTrackNumber(Integer queueCurrentTrackNumber) Music: The current number (1 based) of the track in the playback queue Podcast: The current number (1 based) of the episode in the playback queue Audiobook: The current number (1 based) of the episode in the playback queue (e.g.
MediaServiceData	setQueuePlaybackDuration(Integer queuePlaybackDuration) Music: The total duration of the playback queue in seconds Podcast: The total duration of the playback queue in seconds Audiobook: The total duration of the playback queue (e.g.
MediaServiceData	setQueuePlaybackProgress(Integer queuePlaybackProgress) Music: The current progress of the playback queue in seconds Podcast: The current progress of the playback queue in seconds Audiobook: The current progress of the playback queue (e.g.
MediaServiceData	setQueueTotalTrackCount(Integer queueTotalTrackCount) Music: The total number of tracks in the playback queue Podcast: The total number of episodes in the playback queue Audiobook: The total number of sections in the playback queue (e.g.
MediaServiceData	setTrackPlaybackDuration(Integer trackPlaybackDuration) Music: The total duration of the track in seconds Podcast: The total duration of the episode in seconds Audiobook: The total duration of the current segment (e.g.
MediaServiceData	setTrackPlaybackProgress(Integer trackPlaybackProgress) Music: The current progress of the track in seconds Podcast: The current progress of the episode in seconds Audiobook: The current progress of the current segment (e.g.

Methods inherited from class com.smartdevicelink.proxy.RPCStruct

clone, deserializeJSON, equals, format, formatObject, getBoolean, getBulkData, getDouble, getFloat, getInteger, getLong, getMessageTypeName, getObject, getStore, getStoreValue, getString, getValue, getValueForString, hashCode, hasKey, isPayloadProtected, serializeJSON, serializeJSON, setBulkData, setPayloadProtected, setValue

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

KEY_MEDIA_TYPE

public static final String KEY_MEDIA_TYPE

See Also:

Constant Field Values

KEY_MEDIA_TITLE

public static final String KEY_MEDIA_TITLE

See Also:

Constant Field Values

KEY_MEDIA_ARTIST

public static final String KEY_MEDIA_ARTIST

See Also:

Constant Field Values

KEY_MEDIA_ALBUM

public static final String KEY_MEDIA_ALBUM

See Also:

Constant Field Values

KEY_MEDIA_IMAGE

public static final String KEY_MEDIA_IMAGE

See Also:

Constant Field Values

KEY_PLAYLIST_NAME

public static final String KEY_PLAYLIST_NAME

See Also:

Constant Field Values

KEY_IS_EXPLICIT

public static final String KEY_IS_EXPLICIT

See Also:

Constant Field Values

KEY_TRACK_PLAYBACK_PROGRESS

public static final String KEY_TRACK_PLAYBACK_PROGRESS

See Also:

Constant Field Values

KEY_TRACK_PLAYBACK_DURATION

public static final String KEY_TRACK_PLAYBACK_DURATION

See Also:

Constant Field Values

KEY_QUEUE_PLAYBACK_PROGRESS

public static final String KEY_QUEUE_PLAYBACK_PROGRESS

See Also:

Constant Field Values

KEY_QUEUE_PLAYBACK_DURATION

public static final String KEY_QUEUE_PLAYBACK_DURATION

See Also:

Constant Field Values

KEY_QUEUE_CURRENT_TRACK_NUMBER

public static final String KEY_QUEUE_CURRENT_TRACK_NUMBER

See Also:

Constant Field Values

KEY_QUEUE_TOTAL_TRACK_COUNT

public static final String KEY_QUEUE_TOTAL_TRACK_COUNT

See Also:

Constant Field Values

Constructor Detail

MediaServiceData

public MediaServiceData()

MediaServiceData

public MediaServiceData(Hashtable<String,Object> hash)

Method Detail

setMediaType

public MediaServiceData setMediaType(MediaType mediaType)

Parameters:

mediaType - - The type of the currently playing or paused track.

getMediaType

public MediaType getMediaType()

Returns:

mediaType - The type of the currently playing or paused track.

setMediaTitle

public MediaServiceData setMediaTitle(String mediaTitle)

Music: The name of the current track Podcast: The name of the current episode Audiobook: The name of the current chapter

Parameters:

mediaTitle - -

getMediaTitle

public String getMediaTitle()

Music: The name of the current track Podcast: The name of the current episode Audiobook: The name of the current chapter

Returns:

mediaTitle -

setMediaArtist

public MediaServiceData setMediaArtist(String mediaArtist)

Music: The name of the current album artist Podcast: The provider of the podcast (hosts, network, company) Audiobook: The book author's name

Parameters:

mediaArtist - -

getMediaArtist

public String getMediaArtist()

Music: The name of the current album artist Podcast: The provider of the podcast (hosts, network, company) Audiobook: The book author's name

Returns:

mediaArtist -

setMediaAlbum

public MediaServiceData setMediaAlbum(String mediaAlbum)

Music: The name of the current album Podcast: The name of the current podcast show Audiobook: The name of the current book

Parameters:

mediaAlbum - -

getMediaAlbum

public String getMediaAlbum()

Music: The name of the current album Podcast: The name of the current podcast show Audiobook: The name of the current book

Returns:

mediaAlbum -

setMediaImage

public MediaServiceData setMediaImage(Image mediaImage)

Sets the media image associated with the currently playing media Music: The album art of the current track Podcast: The podcast or chapter artwork of the current podcast episode Audiobook: The book or chapter artwork of the current audiobook

Parameters:

mediaImage -

getMediaImage

public Image getMediaImage()

Returns the media image associated with the currently playing media Music: The album art of the current track Podcast: The podcast or chapter artwork of the current podcast episode Audiobook: The book or chapter artwork of the current audiobook

setPlaylistName

public MediaServiceData setPlaylistName(String playlistName)

Music: The name of the playlist or radio station, if the user is playing from a playlist, otherwise, Null Podcast: The name of the playlist, if the user is playing from a playlist, otherwise, Null Audiobook: Likely not applicable, possibly a collection or "playlist" of books

Parameters:

playlistName - -

getPlaylistName

public String getPlaylistName()

Music: The name of the playlist or radio station, if the user is playing from a playlist, otherwise, Null Podcast: The name of the playlist, if the user is playing from a playlist, otherwise, Null Audiobook: Likely not applicable, possibly a collection or "playlist" of books

Returns:

playlistName -

setIsExplicit

public MediaServiceData setIsExplicit(Boolean isExplicit)

Parameters:

isExplicit - - Whether or not the content currently playing (e.g. the track, episode, or book) contains explicit content

getIsExplicit

public Boolean getIsExplicit()

Returns:

isExplicit - Whether or not the content currently playing (e.g. the track, episode, or book) contains explicit content

setTrackPlaybackProgress

public MediaServiceData setTrackPlaybackProgress(Integer trackPlaybackProgress)

Music: The current progress of the track in seconds Podcast: The current progress of the episode in seconds Audiobook: The current progress of the current segment (e.g. the chapter) in seconds

Parameters:

trackPlaybackProgress - -

getTrackPlaybackProgress

public Integer getTrackPlaybackProgress()

Music: The current progress of the track in seconds Podcast: The current progress of the episode in seconds Audiobook: The current progress of the current segment (e.g. the chapter) in seconds

Returns:

trackPlaybackProgress -

setTrackPlaybackDuration

public MediaServiceData setTrackPlaybackDuration(Integer trackPlaybackDuration)

Music: The total duration of the track in seconds Podcast: The total duration of the episode in seconds Audiobook: The total duration of the current segment (e.g. the chapter) in seconds

Parameters:

trackPlaybackDuration - -

getTrackPlaybackDuration

public Integer getTrackPlaybackDuration()

Music: The total duration of the track in seconds Podcast: The total duration of the episode in seconds Audiobook: The total duration of the current segment (e.g. the chapter) in seconds

Returns:

trackPlaybackDuration -

setQueuePlaybackProgress

public MediaServiceData setQueuePlaybackProgress(Integer queuePlaybackProgress)

Music: The current progress of the playback queue in seconds Podcast: The current progress of the playback queue in seconds Audiobook: The current progress of the playback queue (e.g. the book) in seconds

Parameters:

queuePlaybackProgress - -

getQueuePlaybackProgress

public Integer getQueuePlaybackProgress()

Music: The current progress of the playback queue in seconds Podcast: The current progress of the playback queue in seconds Audiobook: The current progress of the playback queue (e.g. the book) in seconds

Returns:

queuePlaybackProgress -

setQueuePlaybackDuration

public MediaServiceData setQueuePlaybackDuration(Integer queuePlaybackDuration)

Music: The total duration of the playback queue in seconds Podcast: The total duration of the playback queue in seconds Audiobook: The total duration of the playback queue (e.g. the book) in seconds

Parameters:

queuePlaybackDuration - -

getQueuePlaybackDuration

public Integer getQueuePlaybackDuration()

Music: The total duration of the playback queue in seconds Podcast: The total duration of the playback queue in seconds Audiobook: The total duration of the playback queue (e.g. the book) in seconds

Returns:

queuePlaybackDuration -

setQueueCurrentTrackNumber

public MediaServiceData setQueueCurrentTrackNumber(Integer queueCurrentTrackNumber)

Music: The current number (1 based) of the track in the playback queue Podcast: The current number (1 based) of the episode in the playback queue Audiobook: The current number (1 based) of the episode in the playback queue (e.g. the chapter number in the book)

Parameters:

queueCurrentTrackNumber - -

getQueueCurrentTrackNumber

public Integer getQueueCurrentTrackNumber()

Music: The current number (1 based) of the track in the playback queue Podcast: The current number (1 based) of the episode in the playback queue Audiobook: The current number (1 based) of the episode in the playback queue (e.g. the chapter number in the book)

Returns:

queueCurrentTrackNumber -

setQueueTotalTrackCount

public MediaServiceData setQueueTotalTrackCount(Integer queueTotalTrackCount)

Music: The total number of tracks in the playback queue Podcast: The total number of episodes in the playback queue Audiobook: The total number of sections in the playback queue (e.g. the number of chapters in the book)

Parameters:

queueTotalTrackCount - -

getQueueTotalTrackCount

public Integer getQueueTotalTrackCount()

Music: The total number of tracks in the playback queue Podcast: The total number of episodes in the playback queue Audiobook: The total number of sections in the playback queue (e.g. the number of chapters in the book)

Returns:

queueTotalTrackCount -