common/dev.brahmkshatriya.echo.common.models/Track

Track

data class Track(val id: String, val title: String, val type: Track.Type = Type.Song, val cover: ImageHolder? = null, val artists: List<Artist> = listOf(), val album: Album? = null, val duration: Long? = null, val playedDuration: Long? = null, val plays: Long? = null, val releaseDate: Date? = null, val description: String? = null, val background: ImageHolder? = cover, val genres: List<String> = listOf(), val isrc: String? = null, val albumOrderNumber: Long? = null, val albumDiscNumber: Long? = null, val playlistAddedDate: Date? = null, val isExplicit: Boolean = false, val subtitle: String? = null, val extras: Map<String, String> = mapOf(), val isPlayable: Track.Playable = Playable.Yes, val streamables: List<Streamable> = listOf(), val isRadioSupported: Boolean = true, val isFollowable: Boolean = false, val isSaveable: Boolean = true, val isLikeable: Boolean = true, val isHideable: Boolean = true, val isShareable: Boolean = true) : EchoMediaItem

A class representing a track that can be played in Echo.

Constructors

Track

constructor(id: String, title: String, type: Track.Type = Type.Song, cover: ImageHolder? = null, artists: List<Artist> = listOf(), album: Album? = null, duration: Long? = null, playedDuration: Long? = null, plays: Long? = null, releaseDate: Date? = null, description: String? = null, background: ImageHolder? = cover, genres: List<String> = listOf(), isrc: String? = null, albumOrderNumber: Long? = null, albumDiscNumber: Long? = null, playlistAddedDate: Date? = null, isExplicit: Boolean = false, subtitle: String? = null, extras: Map<String, String> = mapOf(), isPlayable: Track.Playable = Playable.Yes, streamables: List<Streamable> = listOf(), isRadioSupported: Boolean = true, isFollowable: Boolean = false, isSaveable: Boolean = true, isLikeable: Boolean = true, isHideable: Boolean = true, isShareable: Boolean = true)

Types

Companion

object Companion

Playable

sealed interface Playable

Type

enum Type : Enum<Track.Type>

Properties

album

val album: Album? = null

The album of the track

albumDiscNumber

val albumDiscNumber: Long? = null

The disc number of the track in the album

albumOrderNumber

val albumOrderNumber: Long? = null

The order number of the track in the album, if albumDiscNumber is not null, this is the order number in that disc

artists

val artists: List<Artist>

The artists of the track

background

open override val background: ImageHolder?

The background image of the track

backgrounds

val backgrounds: List<Streamable>

The streamable backgrounds of the track.

cover

open override val cover: ImageHolder? = null

The cover of the track

description

open override val description: String? = null

The description of the track

duration

val duration: Long? = null

The duration of the track in milliseconds

extras

open override val extras: Map<String, String>

Any extra data you want to associate with the track

genres

val genres: List<String>

The genres of the track

open override val id: String

The id of the track

isExplicit

open override val isExplicit: Boolean = false

Whether the track is explicit

isFollowable

open override val isFollowable: Boolean = false

Whether the track can be followed. Checkout FollowClient

isHideable

open override val isHideable: Boolean = true

Whether the track can be hidden. Checkout HideClient

isLikeable

open override val isLikeable: Boolean = true

Whether the track can be liked. Checkout LikeClient

isPlayable

val isPlayable: Track.Playable

Whether the track is playable.

isPrivate

open val isPrivate: Boolean

isRadioSupported

open override val isRadioSupported: Boolean = true

Whether the track can used to create a radio. Checkout RadioClient

isrc

val isrc: String? = null

The IRSC code of the track

isSaveable

open override val isSaveable: Boolean = true

Whether the track can be saved to library. Checkout SaveClient

isShareable

open override val isShareable: Boolean = true

Whether the track can be shared. Checkout ShareClient

playedDuration

val playedDuration: Long? = null

The duration of the track that has been played, in milliseconds

playlistAddedDate

val playlistAddedDate: Date? = null

The date when the track was added to a playlist

plays

val plays: Long? = null

The number of plays of the track

releaseDate

val releaseDate: Date? = null

The release date of the track

servers

val servers: List<Streamable>

The streamable servers of the track.

streamables

val streamables: List<Streamable>

The streamables of the track

subtitle

open override val subtitle: String? = null

The subtitle of the track, used to display information under the title

subtitles

val subtitles: List<Streamable>

The streamable subtitles of the track.

subtitleWithE

open override val subtitleWithE: <Error class: unknown class>

subtitleWithOutE

open override val subtitleWithOutE: String

title

open override val title: String

The title of the track

type

val type: Track.Type

The type of the track, can be Audio, Video, or HorizontalVideo

Functions

copyMediaItem

open fun copyMediaItem(id: String = this.id, title: String = this.title, cover: ImageHolder? = this.cover, description: String? = this.description, subtitle: String? = this.subtitle, extras: Map<String, String> = this.extras, isRadioSupported: Boolean = this.isRadioSupported, isFollowable: Boolean = this.isFollowable, isSaveable: Boolean = this.isSaveable): EchoMediaItem

sameAs

open fun sameAs(other: EchoMediaItem): Boolean

toShelf

open fun toShelf(): Shelf.Item

Track

See also

Constructors

Types

Properties

Functions