astroplayer-core/com.deathsdoor.astroplayer.core/AstroMediaMetadata

AstroMediaMetadata

data class AstroMediaMetadata(val title: String? = null, val artist: String? = null, val albumTitle: String? = null, val albumArtist: String? = null, val displayTitle: String? = null, val subtitle: String? = null, val description: String? = null, val artworkUri: Uri? = null, val trackNumber: Int? = null, val totalTrackCount: Int? = null, val recordingYear: Int? = null, val recordingMonth: Int? = null, val recordingDay: Int? = null, val releaseYear: Int? = null, val releaseMonth: Int? = null, val releaseDay: Int? = null, val writer: String? = null, val composer: String? = null, val conductor: String? = null, val discNumber: Int? = null, val totalDiscCount: Int? = null, val genre: String? = null, val compilation: String? = null, val station: String? = null, val equalizerIdentifier: String? = null, val extras: Map<String, Any>? = null)

A data class representing metadata associated with a media item in the AstroPlayer playlist. This data class provides optional fields for various metadata categories. Not all fields might be available for all media types, and the specific information available will depend on the media source and the player implementation.

Constructors

AstroMediaMetadata

constructor(title: String? = null, artist: String? = null, albumTitle: String? = null, albumArtist: String? = null, displayTitle: String? = null, subtitle: String? = null, description: String? = null, artworkUri: Uri? = null, trackNumber: Int? = null, totalTrackCount: Int? = null, recordingYear: Int? = null, recordingMonth: Int? = null, recordingDay: Int? = null, releaseYear: Int? = null, releaseMonth: Int? = null, releaseDay: Int? = null, writer: String? = null, composer: String? = null, conductor: String? = null, discNumber: Int? = null, totalDiscCount: Int? = null, genre: String? = null, compilation: String? = null, station: String? = null, equalizerIdentifier: String? = null, extras: Map<String, Any>? = null)

Properties

albumArtist

val albumArtist: String? = null

The artist or performer associated with the album.

albumTitle

val albumTitle: String? = null

The title of the album the media item belongs to.

artist

val artist: String? = null

The artist or performer associated with the media item (e.g., singer, band).

artworkUri

val artworkUri: Uri? = null

The URI of artwork associated with the media item (e.g., album cover).

compilation

val compilation: String? = null

Whether the media is part of a compilation album.

composer

val composer: String? = null

The composer(s) of the media content (e.g., music composer).

conductor

val conductor: String? = null

The conductor associated with the media content (e.g., orchestra conductor).

description

val description: String? = null

A textual description of the media item.

discNumber

val discNumber: Int? = null

The disc number within a multi-disc set (1-based).

displayTitle

val displayTitle: String? = null

An alternative title for display purposes.

equalizerIdentifier

val equalizerIdentifier: String? = null

An identifier for a specific equalizer preset to be applied to this media item (implementation-specific). This is used with AstroPlayer.isSmartEqualizerEnabled for smart equalizer functionality.

extras

val extras: Map<String, Any>? = null

A map containing additional metadata key-value pairs that are not covered by the other properties.

genre

val genre: String? = null

The genre of the media content.

recordingDay

val recordingDay: Int? = null

The day of the month the media was recorded.

recordingMonth

val recordingMonth: Int? = null

The month the media was recorded (1-based).

recordingYear

val recordingYear: Int? = null

The year the media was recorded.

releaseDay

val releaseDay: Int? = null

The day of the month the media was released.

releaseMonth

val releaseMonth: Int? = null

The month the media was released (1-based).

releaseYear

val releaseYear: Int? = null

The year the media was released.

station

val station: String? = null

The radio station associated with the media (if applicable).

subtitle

val subtitle: String? = null

A subtitle or secondary title for the media item.

title

val title: String? = null

The title of the media item (e.g., song title, movie title).

totalDiscCount

val totalDiscCount: Int? = null

The total number of discs in a multi-disc set.

totalTrackCount

val totalTrackCount: Int? = null

The total number of tracks in the album or playlist.

trackNumber

val trackNumber: Int? = null

The track number within the album or playlist (1-based).

writer

val writer: String? = null

The writer(s) of the media content (e.g., songwriter).

Functions

asNativeMediaMetadata

fun AstroMediaMetadata.asNativeMediaMetadata(): MediaMetadata

Converts an AstroMediaMetadata object to a platform-specific MediaMetadata object suitable for the underlying media player.

asNativeMediaMetadataBuilder

fun AstroMediaMetadata.asNativeMediaMetadataBuilder(): MediaMetadata.Builder

Creates a builder object for a platform-specific MediaMetadata compatible with the underlying media player, pre-populated with data from the current AstroMediaItem.metadata.