spotify-api-kotlin/com.adamratzman.spotify.models/PodcastEpisodeTrack

PodcastEpisodeTrack

@Serializable

data class PodcastEpisodeTrack(val album: SimpleAlbum, val artists: List<SimpleArtist>, availableMarketsString: List<String> = listOf(), val discNumber: Int, val durationMs: Int, val episode: Boolean? = null, val explicit: Boolean, externalUrlsString: Map<String, String>, externalIdsString: Map<String, String> = hashMapOf(), val href: String, val id: String, val isLocal: Boolean? = null, val isPlayable: Boolean = true, val name: String, val popularity: Double, val previewUrl: String? = null, val track: Boolean? = null, val trackNumber: Int, val type: String, val uri: PlayableUri, val linkedTrack: LinkedTrack? = null) : RelinkingAvailableResponse, Playable(source)

An episode (podcast) on Spotify

Parameters

album

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

artists

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

discNumber

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

durationMs

The track length in milliseconds.

explicit

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

isLocal

Whether or not the track is from a local file.

isPlayable

Part of the response when Track Relinking is applied. If true , the track is playable in the given market. Otherwise false.

name

The name of the track.

popularity

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.

previewUrl

A link to a 30 second preview (MP3 format) of the track. Can be null.

track

Whether this episode is also a track.

trackNumber

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

type

The object type: “episode”.

Constructors

PodcastEpisodeTrack

constructor(album: SimpleAlbum, artists: List<SimpleArtist>, availableMarketsString: List<String> = listOf(), discNumber: Int, durationMs: Int, episode: Boolean? = null, explicit: Boolean, externalUrlsString: Map<String, String>, externalIdsString: Map<String, String> = hashMapOf(), href: String, id: String, isLocal: Boolean? = null, isPlayable: Boolean = true, name: String, popularity: Double, previewUrl: String? = null, track: Boolean? = null, trackNumber: Int, type: String, uri: PlayableUri, linkedTrack: LinkedTrack? = null)

Properties

album

val album: SimpleAlbum

api

@Transient

lateinit var api: GenericSpotifyApi

The API client associated with the request

artists

val artists: List<SimpleArtist>

asLocalTrack

open val asLocalTrack: LocalTrack?

This Playable as a local track, or else null if it is an episode or track.

asPodcastEpisodeTrack

open val asPodcastEpisodeTrack: PodcastEpisodeTrack?

This Playable as an episode (podcast), or else null if it is a local track or track.

asTrack

open val asTrack: Track?

This Playable as a track, or else null if it is a local track or episode (podcast).

availableMarkets

val availableMarkets: List<Market>

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

discNumber

@SerialName(value = "disc_number")

val discNumber: Int

durationMs

@SerialName(value = "duration_ms")

val durationMs: Int

episode

val episode: Boolean? = null

explicit

val explicit: Boolean

externalIds

val externalIds: List<ExternalId>

externalUrls

val externalUrls: ExternalUrls

Known external URLs for this object

href

open override val href: String

A link to the Spotify web api endpoint associated with this request

open override val id: String

The Spotify id of the associated object

isLocal

@SerialName(value = "is_local")

val isLocal: Boolean? = null

isPlayable

@SerialName(value = "is_playable")

val isPlayable: Boolean = true

linkedTrack

open override val linkedTrack: LinkedTrack? = null

Part of the response when Track Relinking is applied and is only part of the response if the track linking, in fact, exists. The requested track has been replaced with a different track. The track contains information about the originally requested track.

name

val name: String

popularity

val popularity: Double

previewUrl