deezer-client-kt

2.0.0

deezer-client-kt/io.github.kingg22.deezer.client.api.objects/Track

Track

class Track @JvmOverloads constructor(val id: Long, val title: String, val titleShort: String, val duration: Int, val rank: Int, val preview: String, val artist: Artist, val isReadable: Boolean? = null, val titleVersion: String? = null, val isUnseen: Boolean? = null, val isrc: String? = null, val link: String? = null, val share: String? = null, val trackPosition: Int? = null, val diskNumber: Int? = null, val releaseDate: LocalDate? = null, val isExplicitLyrics: Boolean, val explicitContentLyrics: Explicit? = null, val explicitContentCover: Explicit? = null, val bpm: Float? = null, val gain: Float? = null, val availableCountries: List<String>? = null, val alternative: Track? = null, val contributors: List<Artist>? = null, val md5Image: String? = null, val trackToken: String? = null, val album: Album? = null, val type: String = "track", val position: Int? = null, val timeAdd: Long? = null) : Resource

Represents a Track object of Deezer API.

Author

Kingg22

See also

Deezer Track Object

Constructors

constructor(id: Long, title: String, titleShort: String, duration: Int, rank: Int, preview: String, artist: Artist, isReadable: Boolean? = null, titleVersion: String? = null, isUnseen: Boolean? = null, isrc: String? = null, link: String? = null, share: String? = null, trackPosition: Int? = null, diskNumber: Int? = null, releaseDate: LocalDate? = null, isExplicitLyrics: Boolean, explicitContentLyrics: Explicit? = null, explicitContentCover: Explicit? = null, bpm: Float? = null, gain: Float? = null, availableCountries: List<String>? = null, alternative: Track? = null, contributors: List<Artist>? = null, md5Image: String? = null, trackToken: String? = null, album: Album? = null, type: String = "track", position: Int? = null, timeAdd: Long? = null)

Types

object Companion

Properties

val album: Album? = null

Album object containing:

val alternative: Track? = null

Return an alternative readable track if the current track is not readable

val artist: Artist

Artist object containing:

availableCountries

@SerialName(value = "available_countries")

val availableCountries: List<String>? = null

List of countries where the track is available

val bpm: Float? = null

Beats per minute

val contributors: List<Artist>? = null

Return a list of contributors on the track

@SerialName(value = "disk_number")

val diskNumber: Int? = null

The track's album's disk number

val duration: Int

The track's duration in seconds

explicitContentCover

@SerialName(value = "explicit_content_cover")

val explicitContentCover: Explicit? = null

The explicit cover value

explicitContentLyrics

@SerialName(value = "explicit_content_lyrics")

val explicitContentLyrics: Explicit? = null

The explicit content lyrics

val gain: Float? = null

Signal strength

open override val id: Long

The track's Deezer id

isExplicitLyrics

@SerialName(value = "explicit_lyrics")

val isExplicitLyrics: Boolean

Whether the track contains explicit lyrics

val isrc: String? = null

The track ISRC (International Standard Recording Code)

@SerialName(value = "readable")

val isReadable: Boolean? = null

If the track is readable in the player for the current user

@SerialName(value = "unseen")

val isUnseen: Boolean? = null

The track unseen status

val link: String? = null

The url of the track on Deezer

@SerialName(value = "md5_image")

val md5Image: String? = null

MD5 value of the image represented as a hexadecimal string.

val position: Int? = null

only on charts The position of the track in the charts

val preview: String

The url of track's preview file. This file contains the first 30 seconds of the track

The track's Deezer rank

@SerialName(value = "release_date")

val releaseDate: LocalDate? = null

The track's release date

val share: String? = null

The share link of the track on Deezer

@SerialName(value = "time_add")

val timeAdd: Long? = null

unofficial only on playlist

val title: String

The track's full title

@SerialName(value = "title_short")

val titleShort: String

The track's short title

@SerialName(value = "title_version")

val titleVersion: String? = null

The track version

@SerialName(value = "track_position")

val trackPosition: Int? = null

The position of the track in its album

@SerialName(value = "track_token")

val trackToken: String? = null

The track token for media service

open override val type: String

unofficial The type of object, usually the name of the class.

Functions

@AfterInitialize

internal fun Resource.client(): DeezerApiClient

The io.github.kingg22.deezer.client.api.DeezerApiClient to make operations easy in Resource

open suspend override fun reload(): Track

Reloads the current resource from the API, getting all of its full properties if it was initially obtained partially, or it's outdated

retrieveImageUrl

fun Track.retrieveImageUrl(): String

Retrieve the image url of the track.