NotificationCompat.MediaStyle

public class NotificationCompat.MediaStyle extends NotificationCompat.Style

java.lang.Object
   ↳ androidx.core.app.NotificationCompat.Style
     ↳ androidx.media.app.NotificationCompat.MediaStyle
Known direct subclasses
NotificationCompat.DecoratedMediaCustomViewStyle

Notification style for media custom views that are decorated by the system.

Notification style for media playback notifications. In the expanded form, up to 5 actions specified with #addAction(int, CharSequence, PendingIntent) addAction will be shown as icon-only pushbuttons, suitable for transport controls. The Bitmap given to #setLargeIcon(android.graphics.Bitmap) setLargeIcon() will be treated as album artwork. Unlike the other styles provided here, MediaStyle can also modify the standard-size content view; by providing action indices to setShowActionsInCompactView you can promote up to 3 actions to be displayed in the standard view alongside the usual content. Notifications created with MediaStyle will have their category set to CATEGORY_TRANSPORT unless you set a different category using setCategory(). Finally, if you attach a MediaSession.Token using setMediaSession, the System UI can identify this as a notification representing an active media session and respond accordingly (by showing album artwork in the lockscreen, for example). To use this style with your Notification, feed it to setStyle like so: 

Notification noti = new NotificationCompat.Builder()
    .setSmallIcon(R.drawable.ic_stat_player)
    .setContentTitle("Track title")
    .setContentText("Artist - Album")
    .setLargeIcon(albumArtBitmap))
    .setStyle(new NotificationCompat.MediaStyle()
        .setMediaSession(mySession))
    .build();
See also
bigContentView

Summary

Public constructors

Public methods
static MediaSessionCompat.Token

Extracts a MediaSessionCompat.Token from the extra values in the MediaStylenotification.
NotificationCompat.MediaStyle

Sets the pending intent to be sent when the cancel button is pressed.
NotificationCompat.MediaStyle

Attaches a MediaSessionCompat.Token to this Notification to provide additional playback information and control to the SystemUI.
@NonNull NotificationCompat.MediaStyle
@RequiresPermission(value = "android.permission.MEDIA_CONTENT_CONTROL")
setRemotePlaybackInfo(
    @NonNull CharSequence deviceName,
    @DrawableRes int iconResource,
    @Nullable PendingIntent chipIntent
)

For media notifications associated with playback on a remote device, provide device information that will replace the default values for the output switcher chip on the media control, as well as an intent to use when the output switcher chip is tapped, on devices where this is supported.
NotificationCompat.MediaStyle

Requests up to 3 actions (by index in the order of addition) to be shown in the compact notification view.
NotificationCompat.MediaStyle
setShowCancelButton(boolean show)

Sets whether a cancel button at the top right should be shown in the notification on platforms before Lollipop.

Inherited methods
From androidx.core.app.NotificationCompat.Style
@Nullable Notification

If this Style object has been set on a notification builder, this method will build that notification and return it.
void

Link this rich notification style with a notification builder.

Public constructors

MediaStyle

Added in 1.1.0
public MediaStyle()

MediaStyle

Added in 1.1.0
public MediaStyle(NotificationCompat.Builder builder)

Public methods

getMediaSession

Added in 1.1.0
public static MediaSessionCompat.Token getMediaSession(Notification notification)

Extracts a MediaSessionCompat.Token from the extra values in the MediaStylenotification.

Parameters
Notification notification

The notification to extract a MediaSessionCompat.Token from.
Returns
MediaSessionCompat.Token

The MediaSessionCompat.Token in the notification if it contains, null otherwise.

setCancelButtonIntent

Added in 1.1.0
public NotificationCompat.MediaStyle setCancelButtonIntent(PendingIntent pendingIntent)

Sets the pending intent to be sent when the cancel button is pressed. See setShowCancelButton.

Parameters
PendingIntent pendingIntent

the intent to be sent when the cancel button is pressed

setMediaSession

Added in 1.1.0
public NotificationCompat.MediaStyle setMediaSession(MediaSessionCompat.Token token)

Attaches a MediaSessionCompat.Token to this Notification to provide additional playback information and control to the SystemUI.

setRemotePlaybackInfo

Added in 1.7.0
@RequiresPermission(value = "android.permission.MEDIA_CONTENT_CONTROL")
public @NonNull NotificationCompat.MediaStyle setRemotePlaybackInfo(
    @NonNull CharSequence deviceName,
    @DrawableRes int iconResource,
    @Nullable PendingIntent chipIntent
)

For media notifications associated with playback on a remote device, provide device information that will replace the default values for the output switcher chip on the media control, as well as an intent to use when the output switcher chip is tapped, on devices where this is supported.

This method is intended for system applications to provide information and/or functionality that would otherwise be unavailable to the default output switcher because the media originated on a remote device.

Also note that this method is a no-op when running on Tiramisu or less.

Parameters
@NonNull CharSequence deviceName

The name of the remote device to display.
@DrawableRes int iconResource

Icon resource, of size 12, representing the device.
@Nullable PendingIntent chipIntent

PendingIntent to send when the output switcher is tapped. May be null, in which case the output switcher will be disabled. This intent should open an Activity or it will be ignored.
Returns
@NonNull NotificationCompat.MediaStyle

MediaStyle

setShowActionsInCompactView

public NotificationCompat.MediaStyle setShowActionsInCompactView(int[] actions)

Requests up to 3 actions (by index in the order of addition) to be shown in the compact notification view.

Parameters
int[] actions

the indices of the actions to show in the compact notification view

setShowCancelButton

Added in 1.1.0
public NotificationCompat.MediaStyle setShowCancelButton(boolean show)

Sets whether a cancel button at the top right should be shown in the notification on platforms before Lollipop.

Prior to Lollipop, there was a bug in the framework which prevented the developer to make a notification dismissable again after having used the same notification as the ongoing notification for a foreground service. When the notification was posted by startForeground, but then the service exited foreground mode via stopForeground, without removing the notification, the notification stayed ongoing, and thus not dismissable.

This is a common scenario for media notifications, as this is exactly the service lifecycle that happens when playing/pausing media. Thus, a workaround is provided by the support library: Instead of making the notification ongoing depending on the playback state, the support library provides the ability to add an explicit cancel button to the notification.

Note that the notification is enforced to be ongoing if a cancel button is shown to provide a consistent user experience.

Also note that this method is a no-op when running on Lollipop and later.

Parameters
boolean show

whether to show a cancel button