common/dev.brahmkshatriya.echo.common.models/Album

Album

data class Album(val id: String, val title: String, val type: Album.Type? = null, val cover: ImageHolder? = null, val artists: List<Artist> = listOf(), val trackCount: Long? = null, val duration: Long? = null, val releaseDate: Date? = null, val description: String? = null, val background: ImageHolder? = cover, val label: String? = null, val isExplicit: Boolean = false, val subtitle: String? = null, val extras: Map<String, String> = mapOf(), val isRadioSupported: Boolean = true, val isFollowable: Boolean = false, val isSaveable: Boolean = true, val isLikeable: Boolean = false, val isHideable: Boolean = false, val isShareable: Boolean = true) : EchoMediaItem.Lists

A data class representing an album

See also

Constructors

Link copied to clipboard
constructor(id: String, title: String, type: Album.Type? = null, cover: ImageHolder? = null, artists: List<Artist> = listOf(), trackCount: Long? = null, duration: Long? = null, releaseDate: Date? = null, description: String? = null, background: ImageHolder? = cover, label: String? = null, isExplicit: Boolean = false, subtitle: String? = null, extras: Map<String, String> = mapOf(), isRadioSupported: Boolean = true, isFollowable: Boolean = false, isSaveable: Boolean = true, isLikeable: Boolean = false, isHideable: Boolean = false, isShareable: Boolean = true)

Types

Link copied to clipboard
enum Type : Enum<Album.Type>

The type of the album. This can be actual album types like PreRelease, Single, EP, LP, Compilation or Special types like :

Properties

Link copied to clipboard
open override val artists: List<Artist>

The artists of the album

Link copied to clipboard
open override val background: ImageHolder?

The background image of the album

Link copied to clipboard
open override val cover: ImageHolder? = null

The cover image of the album

Link copied to clipboard
open override val date: Date?
Link copied to clipboard
open override val description: String? = null

The description of the album

Link copied to clipboard
open override val duration: Long? = null

The duration of the album in milliseconds

Link copied to clipboard
open override val extras: Map<String, String>

Any extra data you want to associate with the album

Link copied to clipboard
open override val id: String

The id of the album

Link copied to clipboard
open override val isExplicit: Boolean = false

Whether the album is explicit

Link copied to clipboard
open override val isFollowable: Boolean = false

Whether the album can be followed. Checkout FollowClient

Link copied to clipboard
open override val isHideable: Boolean = false

Whether the album can be hidden. Checkout HideClient

Link copied to clipboard
open override val isLikeable: Boolean = false

Whether the album can be liked. Checkout LikeClient

Link copied to clipboard
open val isPrivate: Boolean
Link copied to clipboard
open override val isRadioSupported: Boolean = true

Whether the album can be used to create a radio. Checkout RadioClient

Link copied to clipboard
open override val isSaveable: Boolean = true

Whether the album can be saved to library. Checkout SaveClient

Link copied to clipboard
open override val isShareable: Boolean = true

Whether the album can be shared. Checkout ShareClient

Link copied to clipboard
open override val label: String? = null

The publisher of the album

Link copied to clipboard
val releaseDate: Date? = null

The release date of the album

Link copied to clipboard
open override val subtitle: String? = null

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

Link copied to clipboard
open val subtitleWithE: <Error class: unknown class>
Link copied to clipboard
open override val subtitleWithOutE: String
Link copied to clipboard
open override val title: String

The title of the album

Link copied to clipboard
open override val trackCount: Long? = null

The total number of tracks in the album

Link copied to clipboard
open override val type: Album.Type? = null

The Type of the album.

Functions

Link copied to clipboard
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
Link copied to clipboard
open fun sameAs(other: EchoMediaItem): Boolean
Link copied to clipboard
open fun toShelf(): Shelf.Item