DefaultMediaDescriptionAdapter


@UnstableApi
class DefaultMediaDescriptionAdapter : PlayerNotificationManager.MediaDescriptionAdapter


Default implementation of MediaDescriptionAdapter.

Uses values from the player mediaMetadata to populate the notification.

Summary

Public constructors

Creates a default MediaDescriptionAdapter.

Public functions

PendingIntent?

Creates a content intent for the current media item.

CharSequence?

Gets the content text for the current media item.

CharSequence!

Gets the content title for the current media item.

Bitmap?

Gets the large icon for the current media item.

Inherited functions

From androidx.media3.ui.PlayerNotificationManager.MediaDescriptionAdapter
CharSequence?

Gets the content sub text for the current media item.

Public constructors

DefaultMediaDescriptionAdapter

DefaultMediaDescriptionAdapter(pendingIntent: PendingIntent?)

Creates a default MediaDescriptionAdapter.

Parameters
pendingIntent: PendingIntent?

The PendingIntent to be returned from createCurrentContentIntent, or null if no intent should be fired.

Public functions

createCurrentContentIntent

fun createCurrentContentIntent(player: Player!): PendingIntent?

Creates a content intent for the current media item.

See setContentIntent.

Parameters
player: Player!

The Player for which a notification is being built.

Returns
PendingIntent?

The content intent for the current media item, or null if no intent should be fired.

getCurrentContentText

fun getCurrentContentText(player: Player!): CharSequence?

Gets the content text for the current media item.

See setContentText.

Parameters
player: Player!

The Player for which a notification is being built.

Returns
CharSequence?

The content text for the current media item, or null if no context text should be displayed.

getCurrentContentTitle

fun getCurrentContentTitle(player: Player!): CharSequence!

Gets the content title for the current media item.

See setContentTitle.

Parameters
player: Player!

The Player for which a notification is being built.

Returns
CharSequence!

The content title for the current media item.

getCurrentLargeIcon

fun getCurrentLargeIcon(
    player: Player!,
    callback: PlayerNotificationManager.BitmapCallback!
): Bitmap?

Gets the large icon for the current media item.

When a bitmap needs to be loaded asynchronously, a placeholder bitmap (or null) should be returned. The actual bitmap should be passed to the BitmapCallback once it has been loaded. Because the adapter may be called multiple times for the same media item, bitmaps should be cached by the app and returned synchronously when possible.

See setLargeIcon.

Parameters
player: Player!

The Player for which a notification is being built.

callback: PlayerNotificationManager.BitmapCallback!

A BitmapCallback to provide a Bitmap asynchronously.

Returns
Bitmap?

The large icon for the current media item, or null if the icon will be returned through the BitmapCallback or if no icon should be displayed.