common/dev.brahmkshatriya.echo.common.models

Package-level declarations

Types

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

Artist

data class Artist(val id: String, val name: String, val cover: ImageHolder? = null, val bio: String? = null, val background: ImageHolder? = cover, val banners: List<ImageHolder> = listOf(), val subtitle: String? = null, val extras: Map<String, String> = mapOf(), val isRadioSupported: Boolean = true, val isFollowable: Boolean = true, val isSaveable: Boolean = true, val isLikeable: Boolean = false, val isHideable: Boolean = false, val isShareable: Boolean = true) : EchoMediaItem

A data class representing an artist

Chapter

data class Chapter(val name: String, val startTime: Long, val endTime: Long? = null, val skipType: Chapter.SkipType = NONE)

Represents a chapter in a track.

Date

data class Date(val epochTimeMs: Long) : Comparable<Date>

DownloadContext

data class DownloadContext(val extensionId: String, val track: Track, val sortOrder: Int? = null, val context: EchoMediaItem? = null)

Download context for a track

EchoMediaItem

sealed interface EchoMediaItem

A class representing a media item in Echo.

ExtensionType

enum ExtensionType : Enum<ExtensionType>

Enum class to define the type of extension

Feed

data class Feed<T : Any>(val tabs: List<Tab>, val getPagedData: suspend (Tab?) -> Feed.Data<T>)

Represents a feed of multiple T items, Used in various contexts like home, library, etc.

ImageHolder

sealed class ImageHolder

A class representing an image.

ImportType

enum ImportType : Enum<ImportType>

Enum class to define the type of import,

Lyrics

data class Lyrics(val id: String, val title: String, val subtitle: String? = null, val lyrics: Lyrics.Lyric? = null, val extras: Map<String, String> = emptyMap())

Represents lyrics of a song, can be loaded later in LyricsClient.loadLyrics.

Message

data class Message(val message: String, val action: Message.Action? = null)

A message to be sent to the app.

Metadata

data class Metadata(val className: String, val path: String, val importType: ImportType, val type: ExtensionType, val id: String, val name: String, val version: String, val description: String, val author: String, val authorUrl: String? = null, val icon: ImageHolder? = null, val repoUrl: String? = null, val updateUrl: String? = null, val preservedPackages: List<String> = listOf(), val isEnabled: Boolean = true)

Metadata for an extension.

NetworkConnection

enum NetworkConnection : Enum<NetworkConnection>

Enum class to define the type of network,

NetworkRequest

data class NetworkRequest(val url: String, val headers: Map<String, String> = emptyMap(), val method: NetworkRequest.Method = GET, val bodyBase64: String? = null)

A data class to represent a network request.

Playlist

data class Playlist(val id: String, val title: String, val isEditable: Boolean, val isPrivate: Boolean = true, val cover: ImageHolder? = null, val authors: List<Artist> = listOf(), val trackCount: Long? = null, val duration: Long? = null, val creationDate: Date? = null, val description: String? = null, val background: ImageHolder? = cover, 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 a playlist

Progress

data class Progress(val size: Long = 0, val progress: Long = 0, val speed: Long = 0)

Progress data class to hold the progress of the download.

QuickSearchItem

sealed class QuickSearchItem

Represents a quick search item. This can be a Query or a Media item.

Radio

data class Radio(val id: String, val title: String, val cover: ImageHolder? = null, val authors: List<Artist> = listOf(), val trackCount: Long? = null, val description: String? = null, val subtitle: String? = null, val extras: Map<String, String> = mapOf(), val isFollowable: Boolean = false, val isSaveable: Boolean = false, val isLikeable: Boolean = false, val isHideable: Boolean = false, val isShareable: Boolean = true) : EchoMediaItem.Lists

A data class representing a radio, that can load tracks and be directly played when clicked.

Shelf

sealed interface Shelf

Represents a shelf (group of Media Items or Categories) in the app feed.

Streamable

data class Streamable(val id: String, val quality: Int, val type: Streamable.MediaType, val title: String? = null, val extras: Map<String, String> = mapOf())

A data class representing an unloaded streamable item that is used when playing a Track The streamable item can be of three types:

Tab

data class Tab(val id: String, val title: String, val isSort: Boolean = false, val extras: Map<String, String> = emptyMap())

A data class representing a tab

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.

TrackDetails

data class TrackDetails(val extensionId: String, val track: Track, val context: EchoMediaItem?, val currentPosition: Long, val totalDuration: Long?)

A data class that holds the details of a track that is in the player.

User

data class User(val id: String, val name: String, val cover: ImageHolder? = null, val subtitle: String? = null, val extras: Map<String, String> = emptyMap())

A data class representing a user