Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Documentation
Sidebar

Class MediaServiceData

Hierarchy

java.lang.Object
     com.smartdevicelink.proxy.RPCStruct

Package
com.smartdevicelink.proxy.rpc

Overview

This data is related to what a media service should provide

Fields

KEY_MEDIA_TYPE

public static final java.lang.String KEY_MEDIA_TYPE
Constant Value
"mediaType"

KEY_MEDIA_TITLE

public static final java.lang.String KEY_MEDIA_TITLE
Constant Value
"mediaTitle"

KEY_MEDIA_ARTIST

public static final java.lang.String KEY_MEDIA_ARTIST
Constant Value
"mediaArtist"

KEY_MEDIA_ALBUM

public static final java.lang.String KEY_MEDIA_ALBUM
Constant Value
"mediaAlbum"

KEY_MEDIA_IMAGE

public static final java.lang.String KEY_MEDIA_IMAGE
Constant Value
"mediaImage"

KEY_PLAYLIST_NAME

public static final java.lang.String KEY_PLAYLIST_NAME
Constant Value
"playlistName"

KEY_IS_EXPLICIT

public static final java.lang.String KEY_IS_EXPLICIT
Constant Value
"isExplicit"

KEY_TRACK_PLAYBACK_PROGRESS

public static final java.lang.String KEY_TRACK_PLAYBACK_PROGRESS
Constant Value
"trackPlaybackProgress"

KEY_TRACK_PLAYBACK_DURATION

public static final java.lang.String KEY_TRACK_PLAYBACK_DURATION
Constant Value
"trackPlaybackDuration"

KEY_QUEUE_PLAYBACK_PROGRESS

public static final java.lang.String KEY_QUEUE_PLAYBACK_PROGRESS
Constant Value
"queuePlaybackProgress"

KEY_QUEUE_PLAYBACK_DURATION

public static final java.lang.String KEY_QUEUE_PLAYBACK_DURATION
Constant Value
"queuePlaybackDuration"

KEY_QUEUE_CURRENT_TRACK_NUMBER

public static final java.lang.String KEY_QUEUE_CURRENT_TRACK_NUMBER
Constant Value
"queueCurrentTrackNumber"

KEY_QUEUE_TOTAL_TRACK_COUNT

public static final java.lang.String KEY_QUEUE_TOTAL_TRACK_COUNT
Constant Value
"queueTotalTrackCount"

Inherited Fields

From Class Fields
com.smartdevicelink.proxy.RPCStruct KEY_BULK_DATA, KEY_PROTECTED, store

Constructors

MediaServiceData()

public MediaServiceData()

MediaServiceData( java.util.Hashtable<java.lang.String, java.lang.Object> hash )

public MediaServiceData(java.util.Hashtable<java.lang.String, java.lang.Object> hash)

Parameters

hash

Methods

setMediaType( MediaType mediaType )

public void setMediaType(MediaType mediaType)

Parameters

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

getMediaType()

public com.smartdevicelink.proxy.rpc.enums.MediaType getMediaType()

setMediaTitle( String mediaTitle )

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

public void setMediaTitle(String mediaTitle)

Parameters

mediaTitle
-

getMediaTitle()

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

public java.lang.String getMediaTitle()

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

public void setMediaArtist(String mediaArtist)

Parameters

mediaArtist
-

getMediaArtist()

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

public java.lang.String getMediaArtist()

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

public void setMediaAlbum(String mediaAlbum)

Parameters

mediaAlbum
-

getMediaAlbum()

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

public java.lang.String getMediaAlbum()

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

public void setMediaImage(Image mediaImage)

Parameters

mediaImage

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

public com.smartdevicelink.proxy.rpc.Image getMediaImage()

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

public void setPlaylistName(String playlistName)

Parameters

playlistName
-

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

public java.lang.String getPlaylistName()

setIsExplicit( Boolean isExplicit )

public void setIsExplicit(Boolean isExplicit)

Parameters

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

getIsExplicit()

public java.lang.Boolean getIsExplicit()

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

public void setTrackPlaybackProgress(Integer trackPlaybackProgress)

Parameters

trackPlaybackProgress
-

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

public java.lang.Integer getTrackPlaybackProgress()

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

public void setTrackPlaybackDuration(Integer trackPlaybackDuration)

Parameters

trackPlaybackDuration
-

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

public java.lang.Integer getTrackPlaybackDuration()

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

public void setQueuePlaybackProgress(Integer queuePlaybackProgress)

Parameters

queuePlaybackProgress
-

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

public java.lang.Integer getQueuePlaybackProgress()

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

public void setQueuePlaybackDuration(Integer queuePlaybackDuration)

Parameters

queuePlaybackDuration
-

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

public java.lang.Integer getQueuePlaybackDuration()

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)

public void setQueueCurrentTrackNumber(Integer queueCurrentTrackNumber)

Parameters

queueCurrentTrackNumber
-

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)

public java.lang.Integer getQueueCurrentTrackNumber()

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)

public void setQueueTotalTrackCount(Integer queueTotalTrackCount)

Parameters

queueTotalTrackCount
-

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)

public java.lang.Integer getQueueTotalTrackCount()

Inherited Methods

From Class Methods
com.smartdevicelink.proxy.RPCStruct getStoreValue, getStore, deserializeJSON, deserializeJSONObject, serializeJSON, serializeJSON, format, getBulkData, setBulkData, setPayloadProtected, isPayloadProtected, getMessageTypeName, hasKey, setValue, getValue, getObject, formatObject, getValueForString, getString, getInteger, getDouble, getFloat, getBoolean, getLong
java.lang.Object getClass, hashCode, equals, clone, toString, notify, notifyAll, wait, wait, wait, finalize
View on GitHub.com
Previous Section Next Section