Package com.wrapper.spotify.model_objects.specification

Class Track

java.lang.Object

com.wrapper.spotify.model_objects.AbstractModelObject

com.wrapper.spotify.model_objects.specification.Track

All Implemented Interfaces:

IModelObject, IArtistTrackModelObject, ISearchModelObject

public class Track
extends AbstractModelObject
implements IArtistTrackModelObject, ISearchModelObject

Retrieve information about Track objects by building instances from this class.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Track.Builder	Builder class for building Track instances.
static class	Track.JsonUtil	JsonUtil class for building Track instances.

Nested classes/interfaces inherited from interface com.wrapper.spotify.model_objects.IModelObject

IModelObject.IJsonUtil<T>

Method Summary

Modifier and Type	Method	Description
Track.Builder	builder()	Create a builder for building an instance of a model object.
AlbumSimplified	getAlbum()	Get the album on which the track appears.
ArtistSimplified[]	getArtists()	Get the artists who performed the track.
com.neovisionaries.i18n.CountryCode[]	getAvailableMarkets()	Get the country codes of all countries, in which the track is available.
Integer	getDiscNumber()	Get the disc number of the track in its album.
Integer	getDurationMs()	Get the duration of the track in milliseconds.
ExternalId	getExternalIds()	Get the external IDs of the track. Example: isrc -> "International Standard Recording Code".
ExternalUrl	getExternalUrls()	Get the external URLs of the track. Example: Spotify-URL.
String	getHref()	Get the full Spotify Web API endpoint URL of the track.
String	getId()	Get the Spotify ID of the track.
Boolean	getIsExplicit()	Check whether the track is explicit or not.
Boolean	getIsPlayable()	Check whether the track is playable in the market, which may has been specified somewhere before requesting it.
TrackLink	getLinkedFrom()	Get the track link object of the track if Track Relinking was applied and the requested track has been replaced with a different track.
String	getName()	Get the name of the track.
Integer	getPopularity()	Get the popularity of the track.
String	getPreviewUrl()	Get a link to a 30 second preview (MP3 format) of the track.
Restrictions	getRestrictions()	Get the restrictions of the track.
Integer	getTrackNumber()	Get the track number of the track.
ModelObjectType	getType()	Get the model object type, which should be a "track" in this case.
String	getUri()	Get the Spotify track URI.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getAlbum

public AlbumSimplified getAlbum()

Get the album on which the track appears.

Returns:

The album on which the track appears. The (simplified) album object includes a link in href to full information about the album.

getArtists

public ArtistSimplified[] getArtists()

Get the artists who performed the track.

Returns:

The artists who performed the track. Each artist object includes a link in href to more detailed information about the artist.

getAvailableMarkets

public com.neovisionaries.i18n.CountryCode[] getAvailableMarkets()

Get the country codes of all countries, in which the track is available.

Returns:

A list of the countries in which the track can be played, identified by their ISO 3166-1 alpha-2 code.

getDiscNumber

public Integer getDiscNumber()

Get the disc number of the track in its album.

Returns:

The disc number (usually 1 unless the album consists of more than one disc).

getDurationMs

public Integer getDurationMs()

Get the duration of the track in milliseconds.

Returns:

The track length in milliseconds.

getIsExplicit

public Boolean getIsExplicit()

Check whether the track is explicit or not.

Returns:

Whether or not the track has explicit lyrics (true = yes it does; false = no it does not OR unknown).

getExternalIds

public ExternalId getExternalIds()

Get the external IDs of the track.
Example: isrc -> "International Standard Recording Code".

Returns:

Known external IDs for the track.

getExternalUrls

public ExternalUrl getExternalUrls()

Get the external URLs of the track.
Example: Spotify-URL.

Returns:

Known external URLs for this track.

getHref

public String getHref()

Get the full Spotify Web API endpoint URL of the track.

Returns:

A link to the Web API endpoint providing full details of the track.

getId

public String getId()

Get the Spotify ID of the track.

Returns:

The Spotify ID for the track.

getIsPlayable

public Boolean getIsPlayable()

Check whether the track is playable in the market, which may has been specified somewhere before requesting it. Part of the response when Track Relinking is applied.

Returns:

If true, the track is playable in the given market. Otherwise false.

getLinkedFrom

public TrackLink getLinkedFrom()

Get the track link object of the track if Track Relinking was applied and the requested track has been replaced with a different track. The track in the linked_from object contains information about the originally requested track.

Returns:

The track in the linked_from object contains information about the originally requested track.

getRestrictions

public Restrictions getRestrictions()

Get the restrictions of the track. Part of the response when Track Relinking is applied, the original track is not available in the given market, and Spotify did not have any tracks to relink it with. The track response will still contain metadata for the original track, and a restrictions object containing the reason why the track is not available.
Example: "restrictions" : {"reason" : "market"}

Returns:

The track response will still contain metadata for the original track, and a restrictions object containing the reason why the track is not available.

getName

public String getName()

Get the name of the track.

Returns:

Track name.

getPopularity

public Integer getPopularity()

Get the popularity of the track. The value will be between 0 and 100, with 100 being the most popular.

The popularity of a track is a value between 0 and 100, with 100 being the most popular. The popularity is calculated by algorithm and is based, in the most part, on the total number of plays the track has had and how recent those plays are.

Generally speaking, songs that are being played a lot now will have a higher popularity than songs that were played a lot in the past. Duplicate tracks (e.g. the same track from a single and an album) are rated independently. Artist and album popularity is derived mathematically from track popularity. Note that the popularity value may lag actual popularity by a few days: the value is not updated in real time.

Returns:

The popularity of the track. The value will be between 0 and 100, with 100 being the most popular.

getPreviewUrl

public String getPreviewUrl()

Get a link to a 30 second preview (MP3 format) of the track. null if not available.

Returns:

A link to a 30 second preview (MP3 format) of the track. null if not available.

getTrackNumber

public Integer getTrackNumber()

Get the track number of the track. If an album has several discs, the track number is the number on the specified disc.

Returns:

The number of the track.

getType

public ModelObjectType getType()

Get the model object type, which should be a "track" in this case.

Returns:

The object type: "track".

getUri

public String getUri()

Get the Spotify track URI.

Returns:

The Spotify URI for the track.

builder

public Track.Builder builder()

Description copied from interface: IModelObject

Create a builder for building an instance of a model object.
The type of the builder and its methods depend on its corresponding implementation.

Specified by:

builder in interface IModelObject

Returns:

A builder object.