# MediaStyleNotificationHelper.MediaStyle

Artifact: [androidx.media3:media3-session](https://developer.android.com/jetpack/androidx/releases/media3) [View Source](https://cs.android.com/search?q=file:androidx/media3/session/MediaStyleNotificationHelper.java+class:androidx.media3.session.MediaStyleNotificationHelper.MediaStyle)

*** ** * ** ***


```
public class MediaStyleNotificationHelper.MediaStyle extends NotificationCompat.Style
```

<br />

|---|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object.html) |||
| ↳ | [androidx.core.app.NotificationCompat.Style](https://developer.android.com/reference/androidx/core/app/NotificationCompat.Style) ||
|   | ↳ | [androidx.media3.session.MediaStyleNotificationHelper.MediaStyle](https://developer.android.com/reference/androidx/media3/session/MediaStyleNotificationHelper.MediaStyle) |

Known direct subclasses [MediaStyleNotificationHelper.DecoratedMediaCustomViewStyle](https://developer.android.com/reference/androidx/media3/session/MediaStyleNotificationHelper.DecoratedMediaCustomViewStyle)

|---|---|
| `https://developer.android.com/reference/androidx/media3/session/MediaStyleNotificationHelper.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 `https://developer.android.com/reference/androidx/core/app/NotificationCompat.Action` specified with `https://developer.android.com/reference/androidx/core/app/NotificationCompat.Builder` will be shown as icon-only push buttons, suitable for transport controls. The Bitmap given to `https://developer.android.com/reference/androidx/core/app/NotificationCompat.Builder` 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 `https://developer.android.com/reference/androidx/media3/session/MediaStyleNotificationHelper.MediaStyle#setShowActionsInCompactView(int...)` 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 `https://developer.android.com/reference/androidx/core/app/NotificationCompat#CATEGORY_TRANSPORT()` unless you set a different category using `https://developer.android.com/reference/androidx/core/app/NotificationCompat.Builder#setCategory(java.lang.String)`.

Finally, 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 `https://developer.android.com/reference/androidx/core/app/NotificationCompat.Builder#setStyle(androidx.core.app.NotificationCompat.Style)` like so:

```
Notification noti = new NotificationCompat.Builder()
    .setSmallIcon(androidx.media3.R.drawable.media3_notification_small_icon)
    .setContentTitle("Track title")
    .setContentText("Artist - Album")
    .setLargeIcon(albumArtBitmap)
    .setStyle(new MediaStyleNotificationHelper.MediaStyle(mySession))
    .build();
```

| See also |
|---|---|
| `https://developer.android.com/reference/android/app/Notification.html#bigContentView` |   |

## Summary

| ### Public constructors |
|---|
| `https://developer.android.com/reference/androidx/media3/session/MediaStyleNotificationHelper.MediaStyle#MediaStyle(androidx.media3.session.MediaSession)(https://developer.android.com/reference/androidx/media3/session/MediaSession session)` Creates a new instance with a `https://developer.android.com/reference/androidx/media3/session/MediaSession` to this Notification to provide additional playback information and control to the SystemUI. |

| ### Public methods |
|---|---|
| `void` | `https://developer.android.com/reference/androidx/media3/session/MediaStyleNotificationHelper.MediaStyle#apply(androidx.core.app.NotificationBuilderWithBuilderAccessor)(https://developer.android.com/reference/androidx/core/app/NotificationBuilderWithBuilderAccessor builder)` Applies the compat style data to the framework `https://developer.android.com/reference/android/app/Notification.html` in a backwards compatible way. |
| `static @https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/androidx/media3/session/SessionToken` | `https://developer.android.com/reference/androidx/media3/session/MediaStyleNotificationHelper.MediaStyle#getSessionToken(android.app.Notification)(https://developer.android.com/reference/android/app/Notification.html notification)` Extracts a `https://developer.android.com/reference/androidx/media3/session/SessionToken` from the extra values in the `https://developer.android.com/reference/androidx/media3/session/MediaStyleNotificationHelper.MediaStyle``https://developer.android.com/reference/android/app/Notification.html`. |
| `https://developer.android.com/reference/androidx/media3/session/MediaStyleNotificationHelper.MediaStyle` | `@https://checkerframework.org/api/com/google/errorprone/annotations/CanIgnoreReturnValue.html [setCancelButtonIntent](https://developer.android.com/reference/androidx/media3/session/MediaStyleNotificationHelper.MediaStyle#setCancelButtonIntent(android.app.PendingIntent))(https://developer.android.com/reference/android/app/PendingIntent.html pendingIntent)` **This method is deprecated.** This method is a no-op and usages can be safely removed. <br /> |
| `https://developer.android.com/reference/androidx/media3/session/MediaStyleNotificationHelper.MediaStyle` | `@https://checkerframework.org/api/com/google/errorprone/annotations/CanIgnoreReturnValue.html @https://developer.android.com/reference/androidx/annotation/RequiresPermission(value = "android.permission.MEDIA_CONTENT_CONTROL") https://developer.android.com/reference/androidx/media3/session/MediaStyleNotificationHelper.MediaStyle#setRemotePlaybackInfo(java.lang.CharSequence,int,android.app.PendingIntent)( https://developer.android.com/reference/java/lang/CharSequence.html deviceName, @https://developer.android.com/reference/androidx/annotation/DrawableRes int iconResource, @https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/android/app/PendingIntent.html 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. |
| `https://developer.android.com/reference/androidx/media3/session/MediaStyleNotificationHelper.MediaStyle` | `@https://checkerframework.org/api/com/google/errorprone/annotations/CanIgnoreReturnValue.html https://developer.android.com/reference/androidx/media3/session/MediaStyleNotificationHelper.MediaStyle#setShowActionsInCompactView(int...)(int[] actions)` Requests up to 3 actions (by index in the order of addition) to be shown in the compact notification view. |
| `https://developer.android.com/reference/androidx/media3/session/MediaStyleNotificationHelper.MediaStyle` | `@https://checkerframework.org/api/com/google/errorprone/annotations/CanIgnoreReturnValue.html [setShowCancelButton](https://developer.android.com/reference/androidx/media3/session/MediaStyleNotificationHelper.MediaStyle#setShowCancelButton(boolean))(boolean show)` **This method is deprecated.** This method is a no-op and usages can be safely removed. <br /> |

### Inherited methods

From [androidx.core.app.NotificationCompat.Style](https://developer.android.com/reference/androidx/core/app/NotificationCompat.Style) `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/android/app/Notification.html` `https://developer.android.com/reference/androidx/core/app/NotificationCompat.Style#build()()`

If this Style object has been set on a notification builder, this method will build that notification and return it.
`void` `https://developer.android.com/reference/androidx/core/app/NotificationCompat.Style#setBuilder(androidx.core.app.NotificationCompat.Builder)(@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/androidx/core/app/NotificationCompat.Builder builder)`

Link this rich notification style with a notification builder.

## Public constructors

### MediaStyle

```
public MediaStyle(MediaSession session)
```

Creates a new instance with a `https://developer.android.com/reference/androidx/media3/session/MediaSession` to this Notification to provide additional playback information and control to the SystemUI.

## Public methods

### apply

```
public void apply(NotificationBuilderWithBuilderAccessor builder)
```

Applies the compat style data to the framework `https://developer.android.com/reference/android/app/Notification.html` in a backwards compatible way. All other data should be stored within the Notification's extras.

### getSessionToken

```
public static @Nullable SessionToken getSessionToken(Notification notification)
```

Extracts a `https://developer.android.com/reference/androidx/media3/session/SessionToken` from the extra values in the `https://developer.android.com/reference/androidx/media3/session/MediaStyleNotificationHelper.MediaStyle``https://developer.android.com/reference/android/app/Notification.html`.

| Parameters |
|---|---|
| `https://developer.android.com/reference/android/app/Notification.html notification` | The notification to extract a `https://developer.android.com/reference/androidx/media3/session/MediaSession` from. |

| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/androidx/media3/session/SessionToken` | The `https://developer.android.com/reference/androidx/media3/session/SessionToken` in the `notification` if it contains, null otherwise. |

### setCancelButtonIntent

```
@CanIgnoreReturnValue
public MediaStyleNotificationHelper.MediaStyle [setCancelButtonIntent](https://developer.android.com/reference/androidx/media3/session/MediaStyleNotificationHelper.MediaStyle#setCancelButtonIntent(android.app.PendingIntent))(PendingIntent pendingIntent)
```

> [!CAUTION]
> **This method is deprecated.**   
>
> This method is a no-op and usages can be safely removed. There is no recommended alternative (it was previously only operational on API \<21).

### setRemotePlaybackInfo

```
@CanIgnoreReturnValue
@RequiresPermission(value = "android.permission.MEDIA_CONTENT_CONTROL")
public MediaStyleNotificationHelper.MediaStyle setRemotePlaybackInfo(
    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.

Most apps should integrate with `https://developer.android.com/reference/android/media/MediaRouter2.html` instead. This method is only 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 API 33 or lower.

| Parameters |
|---|---|
| `https://developer.android.com/reference/java/lang/CharSequence.html deviceName` | The name of the remote device to display. |
| `@https://developer.android.com/reference/androidx/annotation/DrawableRes int iconResource` | Icon resource, of size 12, representing the device. |
| `@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/android/app/PendingIntent.html 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 `https://developer.android.com/reference/android/app/Activity.html` or it will be ignored. |

### setShowActionsInCompactView

```
@CanIgnoreReturnValue
public MediaStyleNotificationHelper.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

```
@CanIgnoreReturnValue
public MediaStyleNotificationHelper.MediaStyle [setShowCancelButton](https://developer.android.com/reference/androidx/media3/session/MediaStyleNotificationHelper.MediaStyle#setShowCancelButton(boolean))(boolean show)
```

> [!CAUTION]
> **This method is deprecated.**   
>
> This method is a no-op and usages can be safely removed. There is no recommended alternative (it was previously only operational on API \<21).