astroplayer-core/com.deathsdoor.astroplayer.core

Package-level declarations

Types

data class AstroMediaItem(val mediaId: String, val source: Uri, val metadata: AstroMediaMetadata?)

A data class representing a single media item in the AstroPlayer playlist.

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.

AstroPlayer

expect open class AstroPlayer(nativeMediaPlayer: NativeMediaPLayer)

The main class for controlling media playback.

actual open class AstroPlayer

The main class for controlling media playback.

Howl

external class Howl(properties: HowlerProperties) : HowlerProperties

HowlerProperties

external interface HowlerProperties

NativeMediaPLayer

actual typealias NativeMediaPLayer = MediaController

actual typealias NativeMediaPLayer = <Error class: unknown class>

An class representing the underlying native media player implementation.

expect class NativeMediaPLayer

An class representing the underlying native media player implementation.

actual typealias NativeMediaPLayer = EmbeddedMediaListPlayerComponent

actual typealias NativeMediaPLayer = Howl

RepeatMode

enum RepeatMode : Enum<RepeatMode>

An enum class representing the repeat mode of the AstroPlayer.

Properties

currentMediaMetadata

val AstroPlayer.currentMediaMetadata: AstroMediaMetadata?

The metadata associated with the currently playing media item, or null if no item is playing or the item has no metadata.

hasNextMediaItem

val AstroPlayer.hasNextMediaItem: Boolean

Indicates whether there's a next media item available in the playlist after the current one.

hasPreviousMediaItem

val AstroPlayer.hasPreviousMediaItem: Boolean

Indicates whether there's a previous media item available in the playlist before the current one.

Functions

addListener

fun AstroPlayer.addListener(listener: AstroListener): Int

Registers a listener to receive notifications about playback and media state changes in AstroPlayer.

asAstroMediaItem

fun MediaItem.asAstroMediaItem(mapExtras: (key: String, value: String) -> Any): AstroMediaItem?

Attempts to convert a platform-specific MediaItem object to an AstroMediaItem object.

asAstroMediaMetadata

fun MediaMetadata.asAstroMediaMetadata(mapExtras: (key: String, value: String) -> Any): AstroMediaMetadata

Converts a platform-specific MediaMetadata object to an AstroMediaMetadata object.

asNativeMediaItem

fun AstroMediaItem.asNativeMediaItem(metadata: MediaMetadata? = this.metadata?.asNativeMediaMetadata()): MediaItem

Converts an AstroMediaItem object to a platform-specific MediaItem object suitable for the underlying media player.

asNativeMediaItemBuilder

fun AstroMediaItem.asNativeMediaItemBuilder(metadata: MediaMetadata? = this.metadata?.asNativeMediaMetadata()): MediaItem.Builder

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

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.