# MediaItem

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

*** ** * ** ***

<br />

```
public final class MediaItem
```

<br />

*** ** * ** ***

Representation of a media item.

## Summary

| ### Nested types |
|---|
| `public final class https://developer.android.com/reference/androidx/media3/common/MediaItem.AdsConfiguration` Configuration for playing back linear ads with a media item. |
| `public final class https://developer.android.com/reference/androidx/media3/common/MediaItem.AdsConfiguration.Builder` Builder for `https://developer.android.com/reference/androidx/media3/common/MediaItem.AdsConfiguration` instances. |
| `public final class https://developer.android.com/reference/androidx/media3/common/MediaItem.Builder` A builder for `https://developer.android.com/reference/androidx/media3/common/MediaItem` instances. |
| `public class https://developer.android.com/reference/androidx/media3/common/MediaItem.ClippingConfiguration` Optionally clips the media item to a custom start and end position. |
| `public final class https://developer.android.com/reference/androidx/media3/common/MediaItem.ClippingConfiguration.Builder` Builder for `https://developer.android.com/reference/androidx/media3/common/MediaItem.ClippingConfiguration` instances. |
| `@https://developer.android.com/reference/androidx/media3/common/util/UnstableApi public final class https://developer.android.com/reference/androidx/media3/common/MediaItem.ClippingProperties extends https://developer.android.com/reference/androidx/media3/common/MediaItem.ClippingConfiguration` **This class is deprecated.** Use `https://developer.android.com/reference/androidx/media3/common/MediaItem.ClippingConfiguration` instead. <br /> |
| `public final class https://developer.android.com/reference/androidx/media3/common/MediaItem.DrmConfiguration` DRM configuration for a media item. |
| `public final class https://developer.android.com/reference/androidx/media3/common/MediaItem.DrmConfiguration.Builder` Builder for `https://developer.android.com/reference/androidx/media3/common/MediaItem.DrmConfiguration`. |
| `public final class https://developer.android.com/reference/androidx/media3/common/MediaItem.LiveConfiguration` Live playback configuration. |
| `public final class https://developer.android.com/reference/androidx/media3/common/MediaItem.LiveConfiguration.Builder` Builder for `https://developer.android.com/reference/androidx/media3/common/MediaItem.LiveConfiguration` instances. |
| `public final class https://developer.android.com/reference/androidx/media3/common/MediaItem.LocalConfiguration` Properties for local playback. |
| `public final class https://developer.android.com/reference/androidx/media3/common/MediaItem.RequestMetadata` Metadata that helps the player to understand a playback request represented by a `https://developer.android.com/reference/androidx/media3/common/MediaItem`. |
| `public final class https://developer.android.com/reference/androidx/media3/common/MediaItem.RequestMetadata.Builder` Builder for `https://developer.android.com/reference/androidx/media3/common/MediaItem.RequestMetadata` instances. |
| `@https://developer.android.com/reference/androidx/media3/common/util/UnstableApi public final class https://developer.android.com/reference/androidx/media3/common/MediaItem.Subtitle extends https://developer.android.com/reference/androidx/media3/common/MediaItem.SubtitleConfiguration` **This class is deprecated.** Use `https://developer.android.com/reference/androidx/media3/common/MediaItem.SubtitleConfiguration` instead <br /> |
| `public class https://developer.android.com/reference/androidx/media3/common/MediaItem.SubtitleConfiguration` Properties for a text track. |
| `public final class https://developer.android.com/reference/androidx/media3/common/MediaItem.SubtitleConfiguration.Builder` Builder for `https://developer.android.com/reference/androidx/media3/common/MediaItem.SubtitleConfiguration` instances. |

| ### Constants |
|---|---|
| `static final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/media3/common/MediaItem#DEFAULT_MEDIA_ID() = ""` The default media ID that is used if the media ID is not explicitly set by `https://developer.android.com/reference/androidx/media3/common/MediaItem.Builder#setMediaId(java.lang.String)`. |
| `static final https://developer.android.com/reference/androidx/media3/common/MediaItem` | `https://developer.android.com/reference/androidx/media3/common/MediaItem#EMPTY()` Empty `https://developer.android.com/reference/androidx/media3/common/MediaItem`. |

| ### Public fields |
|---|---|
| `final https://developer.android.com/reference/androidx/media3/common/MediaItem.ClippingConfiguration` | `https://developer.android.com/reference/androidx/media3/common/MediaItem#clippingConfiguration()` The clipping properties. |
| `final https://developer.android.com/reference/androidx/media3/common/MediaItem.ClippingProperties` | `@https://developer.android.com/reference/androidx/media3/common/util/UnstableApi https://developer.android.com/reference/androidx/media3/common/MediaItem#clippingProperties()` **This field is deprecated.** Use `https://developer.android.com/reference/androidx/media3/common/MediaItem#clippingConfiguration()` instead. <br /> |
| `final https://developer.android.com/reference/androidx/media3/common/MediaItem.LiveConfiguration` | `https://developer.android.com/reference/androidx/media3/common/MediaItem#liveConfiguration()` The live playback configuration. |
| `final @https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/androidx/media3/common/MediaItem.LocalConfiguration` | `https://developer.android.com/reference/androidx/media3/common/MediaItem#localConfiguration()` Optional configuration for local playback. |
| `final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/media3/common/MediaItem#mediaId()` Identifies the media item. |
| `final https://developer.android.com/reference/androidx/media3/common/MediaMetadata` | `https://developer.android.com/reference/androidx/media3/common/MediaItem#mediaMetadata()` The media metadata. |
| `final @https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/androidx/media3/common/MediaItem.LocalConfiguration` | `@https://developer.android.com/reference/androidx/media3/common/util/UnstableApi https://developer.android.com/reference/androidx/media3/common/MediaItem#playbackProperties()` **This field is deprecated.** Use `https://developer.android.com/reference/androidx/media3/common/MediaItem#localConfiguration()` instead. <br /> |
| `final https://developer.android.com/reference/androidx/media3/common/MediaItem.RequestMetadata` | `https://developer.android.com/reference/androidx/media3/common/MediaItem#requestMetadata()` The media `https://developer.android.com/reference/androidx/media3/common/MediaItem.RequestMetadata`. |

| ### Public methods |
|---|---|
| `https://developer.android.com/reference/androidx/media3/common/MediaItem.Builder` | `https://developer.android.com/reference/androidx/media3/common/MediaItem#buildUpon()()` Returns a `https://developer.android.com/reference/androidx/media3/common/MediaItem.Builder` initialized with the values of this instance. |
| `boolean` | `https://developer.android.com/reference/androidx/media3/common/MediaItem#equals(java.lang.Object)(@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/java/lang/Object.html obj)` |
| `static https://developer.android.com/reference/androidx/media3/common/MediaItem` | `@https://developer.android.com/reference/androidx/media3/common/util/UnstableApi [fromBundle](https://developer.android.com/reference/androidx/media3/common/MediaItem#fromBundle(android.os.Bundle))(https://developer.android.com/reference/android/os/Bundle.html bundle)` **This method is deprecated.** Use `https://developer.android.com/reference/androidx/media3/common/MediaItem#fromBundle(android.os.Bundle,int)` instead. <br /> |
| `static https://developer.android.com/reference/androidx/media3/common/MediaItem` | `@https://developer.android.com/reference/androidx/media3/common/util/UnstableApi https://developer.android.com/reference/androidx/media3/common/MediaItem#fromBundle(android.os.Bundle,int)(https://developer.android.com/reference/android/os/Bundle.html bundle, int interfaceVersion)` Restores a `MediaItem` from a `https://developer.android.com/reference/android/os/Bundle.html`. |
| `static https://developer.android.com/reference/androidx/media3/common/MediaItem` | `https://developer.android.com/reference/androidx/media3/common/MediaItem#fromUri(java.lang.String)(https://developer.android.com/reference/java/lang/String.html uri)` Creates a `https://developer.android.com/reference/androidx/media3/common/MediaItem` for the given URI. |
| `static https://developer.android.com/reference/androidx/media3/common/MediaItem` | `https://developer.android.com/reference/androidx/media3/common/MediaItem#fromUri(android.net.Uri)(https://developer.android.com/reference/android/net/Uri.html uri)` Creates a `https://developer.android.com/reference/androidx/media3/common/MediaItem` for the given `https://developer.android.com/reference/android/net/Uri.html`. |
| `int` | `https://developer.android.com/reference/androidx/media3/common/MediaItem#hashCode()()` |
| `https://developer.android.com/reference/android/os/Bundle.html` | `@https://developer.android.com/reference/androidx/media3/common/util/UnstableApi [toBundle](https://developer.android.com/reference/androidx/media3/common/MediaItem#toBundle())()` **This method is deprecated.** Use `https://developer.android.com/reference/androidx/media3/common/MediaItem#toBundle(int)` instead. <br /> |
| `https://developer.android.com/reference/android/os/Bundle.html` | `@https://developer.android.com/reference/androidx/media3/common/util/UnstableApi https://developer.android.com/reference/androidx/media3/common/MediaItem#toBundle(int)(int interfaceVersion)` Returns a `https://developer.android.com/reference/android/os/Bundle.html` representing the information stored in this object. |
| `https://developer.android.com/reference/android/os/Bundle.html` | `@https://developer.android.com/reference/androidx/media3/common/util/UnstableApi [toBundleIncludeLocalConfiguration](https://developer.android.com/reference/androidx/media3/common/MediaItem#toBundleIncludeLocalConfiguration())()` **This method is deprecated.** Use `https://developer.android.com/reference/androidx/media3/common/MediaItem#toBundleIncludeLocalConfiguration(int)` instead. <br /> |
| `https://developer.android.com/reference/android/os/Bundle.html` | `@https://developer.android.com/reference/androidx/media3/common/util/UnstableApi https://developer.android.com/reference/androidx/media3/common/MediaItem#toBundleIncludeLocalConfiguration(int)(int interfaceVersion)` Returns a `https://developer.android.com/reference/android/os/Bundle.html` representing the information stored in this `https://developer.android.com/reference/androidx/media3/common/MediaItem#MediaItem(java.lang.String,androidx.media3.common.MediaItem.ClippingProperties,androidx.media3.common.MediaItem.LocalConfiguration,androidx.media3.common.MediaItem.LiveConfiguration,androidx.media3.common.MediaMetadata,androidx.media3.common.MediaItem.RequestMetadata)` object, while including the `https://developer.android.com/reference/androidx/media3/common/MediaItem#localConfiguration()` field if it is not null (otherwise skips it). |

## Constants

### DEFAULT_MEDIA_ID

```
public static final String DEFAULT_MEDIA_ID = ""
```

The default media ID that is used if the media ID is not explicitly set by `https://developer.android.com/reference/androidx/media3/common/MediaItem.Builder#setMediaId(java.lang.String)`.

### EMPTY

```
public static final MediaItem EMPTY
```

Empty `https://developer.android.com/reference/androidx/media3/common/MediaItem`.

## Public fields

### clippingConfiguration

```
public final MediaItem.ClippingConfiguration clippingConfiguration
```

The clipping properties.

### clippingProperties

```
@UnstableApi
public final MediaItem.ClippingProperties clippingProperties
```

> [!CAUTION]
> **This field is deprecated.**   
>
> Use `https://developer.android.com/reference/androidx/media3/common/MediaItem#clippingConfiguration()` instead.

### liveConfiguration

```
public final MediaItem.LiveConfiguration liveConfiguration
```

The live playback configuration.

### localConfiguration

```
public final @Nullable MediaItem.LocalConfiguration localConfiguration
```

Optional configuration for local playback. May be `null` if shared over process boundaries.

### mediaId

```
public final String mediaId
```

Identifies the media item.

### mediaMetadata

```
public final MediaMetadata mediaMetadata
```

The media metadata.

### playbackProperties

```
@UnstableApi
public final @Nullable MediaItem.LocalConfiguration playbackProperties
```

> [!CAUTION]
> **This field is deprecated.**   
>
> Use `https://developer.android.com/reference/androidx/media3/common/MediaItem#localConfiguration()` instead.

### requestMetadata

```
public final MediaItem.RequestMetadata requestMetadata
```

The media `https://developer.android.com/reference/androidx/media3/common/MediaItem.RequestMetadata`.

## Public methods

### buildUpon

```
public MediaItem.Builder buildUpon()
```

Returns a `https://developer.android.com/reference/androidx/media3/common/MediaItem.Builder` initialized with the values of this instance.

### equals

```
public boolean equals(@Nullable Object obj)
```

### fromBundle

```
@UnstableApi
public static MediaItem [fromBundle](https://developer.android.com/reference/androidx/media3/common/MediaItem#fromBundle(android.os.Bundle))(Bundle bundle)
```

> [!CAUTION]
> **This method is deprecated.**   
>
> Use `https://developer.android.com/reference/androidx/media3/common/MediaItem#fromBundle(android.os.Bundle,int)` instead.

### fromBundle

```
@UnstableApi
public static MediaItem fromBundle(Bundle bundle, int interfaceVersion)
```

Restores a `MediaItem` from a `https://developer.android.com/reference/android/os/Bundle.html`.

| Parameters |
|---|---|
| `https://developer.android.com/reference/android/os/Bundle.html bundle` | The `https://developer.android.com/reference/android/os/Bundle.html`. |
| `int interfaceVersion` | The `https://developer.android.com/reference/androidx/media3/common/MediaLibraryInfo#INTERFACE_VERSION()` of the sending process. |

### fromUri

```
public static MediaItem fromUri(String uri)
```

Creates a `https://developer.android.com/reference/androidx/media3/common/MediaItem` for the given URI.

| Parameters |
|---|---|
| `https://developer.android.com/reference/java/lang/String.html uri` | The URI. |

| Returns |
|---|---|
| `https://developer.android.com/reference/androidx/media3/common/MediaItem` | An `https://developer.android.com/reference/androidx/media3/common/MediaItem` for the given URI. |

### fromUri

```
public static MediaItem fromUri(Uri uri)
```

Creates a `https://developer.android.com/reference/androidx/media3/common/MediaItem` for the given `https://developer.android.com/reference/android/net/Uri.html`.

| Parameters |
|---|---|
| `https://developer.android.com/reference/android/net/Uri.html uri` | The `https://developer.android.com/reference/android/net/Uri.html`. |

| Returns |
|---|---|
| `https://developer.android.com/reference/androidx/media3/common/MediaItem` | An `https://developer.android.com/reference/androidx/media3/common/MediaItem` for the given URI. |

### hashCode

```
public int hashCode()
```

### toBundle

```
@UnstableApi
public Bundle [toBundle](https://developer.android.com/reference/androidx/media3/common/MediaItem#toBundle())()
```

> [!CAUTION]
> **This method is deprecated.**   
>
> Use `https://developer.android.com/reference/androidx/media3/common/MediaItem#toBundle(int)` instead.

### toBundle

```
@UnstableApi
public Bundle toBundle(int interfaceVersion)
```

Returns a `https://developer.android.com/reference/android/os/Bundle.html` representing the information stored in this object.

It omits the `https://developer.android.com/reference/androidx/media3/common/MediaItem#localConfiguration()` field. The `https://developer.android.com/reference/androidx/media3/common/MediaItem#localConfiguration()` of an instance restored from such a bundle by `https://developer.android.com/reference/androidx/media3/common/MediaItem#fromBundle(android.os.Bundle)` will be `null`.

| Parameters |
|---|---|
| `int interfaceVersion` | The `https://developer.android.com/reference/androidx/media3/common/MediaLibraryInfo#INTERFACE_VERSION()` of the receiving process. |

### toBundleIncludeLocalConfiguration

```
@UnstableApi
public Bundle [toBundleIncludeLocalConfiguration](https://developer.android.com/reference/androidx/media3/common/MediaItem#toBundleIncludeLocalConfiguration())()
```

> [!CAUTION]
> **This method is deprecated.**   
>
> Use `https://developer.android.com/reference/androidx/media3/common/MediaItem#toBundleIncludeLocalConfiguration(int)` instead.

### toBundleIncludeLocalConfiguration

```
@UnstableApi
public Bundle toBundleIncludeLocalConfiguration(int interfaceVersion)
```

Returns a `https://developer.android.com/reference/android/os/Bundle.html` representing the information stored in this `https://developer.android.com/reference/androidx/media3/common/MediaItem#MediaItem(java.lang.String,androidx.media3.common.MediaItem.ClippingProperties,androidx.media3.common.MediaItem.LocalConfiguration,androidx.media3.common.MediaItem.LiveConfiguration,androidx.media3.common.MediaMetadata,androidx.media3.common.MediaItem.RequestMetadata)` object, while including the `https://developer.android.com/reference/androidx/media3/common/MediaItem#localConfiguration()` field if it is not null (otherwise skips it).

| Parameters |
|---|---|
| `int interfaceVersion` | The `https://developer.android.com/reference/androidx/media3/common/MediaLibraryInfo#INTERFACE_VERSION()` of the receiving process. |