MediaItem

Artifact: androidx.media3:media3-common

View Source

---

Kotlin |Java

class MediaItem : Bundleable

---

Representation of a media item.

Summary

Nested types
class MediaItem.AdsConfiguration : Bundleable Configuration for playing back linear ads with a media item.
class MediaItem.AdsConfiguration.Builder Builder for AdsConfiguration instances.
class MediaItem.Builder A builder for MediaItem instances.
class MediaItem.ClippingConfiguration : Bundleable Optionally clips the media item to a custom start and end position.
class MediaItem.ClippingConfiguration.Builder Builder for ClippingConfiguration instances.
@UnstableApi class MediaItem.ClippingProperties : MediaItem.ClippingConfiguration This class is deprecated. Use ClippingConfiguration instead.
class MediaItem.DrmConfiguration : Bundleable DRM configuration for a media item.
class MediaItem.DrmConfiguration.Builder Builder for DrmConfiguration.
class MediaItem.LiveConfiguration : Bundleable Live playback configuration.
class MediaItem.LiveConfiguration.Builder Builder for LiveConfiguration instances.
class MediaItem.LocalConfiguration : Bundleable Properties for local playback.
class MediaItem.RequestMetadata : Bundleable Metadata that helps the player to understand a playback request represented by a .
class MediaItem.RequestMetadata.Builder Builder for RequestMetadata instances.
@UnstableApi class MediaItem.Subtitle : MediaItem.SubtitleConfiguration This class is deprecated. Use MediaItem.SubtitleConfiguration instead
class MediaItem.SubtitleConfiguration : Bundleable Properties for a text track.
class MediaItem.SubtitleConfiguration.Builder Builder for SubtitleConfiguration instances.

Constants
const Bundleable.Creator<MediaItem!>!	@UnstableApi CREATOR This property is deprecated. Use fromBundle instead.
const String!	DEFAULT_MEDIA_ID = "" The default media ID that is used if the media ID is not explicitly set by setMediaId.
const MediaItem!	EMPTY Empty MediaItem.

Public functions
MediaItem.Builder!	buildUpon() Returns a Builder initialized with the values of this instance.
Boolean	equals(obj: Any?)
java-static MediaItem!	@UnstableApi fromBundle(bundle: Bundle!) Restores a MediaItem from a Bundle.
java-static MediaItem!	fromUri(uri: String!) Creates a MediaItem for the given URI.
java-static MediaItem!	fromUri(uri: Uri!) Creates a MediaItem for the given URI.
Int	hashCode()
Bundle!	@UnstableApi toBundle() Returns a representing the information stored in this object.
Bundle!	@UnstableApi toBundleIncludeLocalConfiguration() Returns a Bundle representing the information stored in this MediaItem object, while including the localConfiguration field if it is not null (otherwise skips it).

Public properties
MediaItem.ClippingConfiguration!	clippingConfiguration The clipping properties.
MediaItem.ClippingProperties!	@UnstableApi clippingProperties This property is deprecated. Use clippingConfiguration instead.
MediaItem.LiveConfiguration!	liveConfiguration The live playback configuration.
MediaItem.LocalConfiguration?	localConfiguration Optional configuration for local playback.
String!	mediaId Identifies the media item.
MediaMetadata!	mediaMetadata The media metadata.
MediaItem.LocalConfiguration?	@UnstableApi playbackProperties This property is deprecated. Use localConfiguration instead.
MediaItem.RequestMetadata!	requestMetadata The media RequestMetadata.

Constants

CREATOR

@UnstableApi
const val CREATOR: Bundleable.Creator<MediaItem!>!

This property is deprecated.

Use fromBundle instead.

An object that can restore MediaItem from a Bundle.

The localConfiguration of a restored instance will always be null.

DEFAULT_MEDIA_ID

const val DEFAULT_MEDIA_ID = "": String!

The default media ID that is used if the media ID is not explicitly set by setMediaId.

EMPTY

const val EMPTY: MediaItem!

Empty MediaItem.

Public functions

buildUpon

fun buildUpon(): MediaItem.Builder!

Returns a Builder initialized with the values of this instance.

equals

fun equals(obj: Any?): Boolean

fromBundle

@UnstableApi
java-static fun fromBundle(bundle: Bundle!): MediaItem!

Restores a MediaItem from a Bundle.

The localConfiguration of a restored instance will always be null.

fromUri

java-static fun fromUri(uri: String!): MediaItem!

Creates a MediaItem for the given URI.

Parameters
uri: String!	The URI.

Returns
MediaItem!	An MediaItem for the given URI.

fromUri

java-static fun fromUri(uri: Uri!): MediaItem!

Creates a MediaItem for the given URI.

Parameters
uri: Uri!	The uri.

Returns
MediaItem!	An MediaItem for the given URI.

hashCode

fun hashCode(): Int

toBundle

@UnstableApi
fun toBundle(): Bundle!

Returns a representing the information stored in this object.

It omits the localConfiguration field. The localConfiguration of an instance restored from such a bundle by CREATOR will be null.

toBundleIncludeLocalConfiguration

@UnstableApi
fun toBundleIncludeLocalConfiguration(): Bundle!

Returns a Bundle representing the information stored in this MediaItem object, while including the localConfiguration field if it is not null (otherwise skips it).

Public properties

clippingConfiguration

val clippingConfiguration: MediaItem.ClippingConfiguration!

The clipping properties.

clippingProperties

@UnstableApi
val clippingProperties: MediaItem.ClippingProperties!

This property is deprecated.

Use clippingConfiguration instead.

liveConfiguration

val liveConfiguration: MediaItem.LiveConfiguration!

The live playback configuration.

localConfiguration

val localConfiguration: MediaItem.LocalConfiguration?

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

mediaId

val mediaId: String!

Identifies the media item.

mediaMetadata

val mediaMetadata: MediaMetadata!

The media metadata.

playbackProperties

@UnstableApi
val playbackProperties: MediaItem.LocalConfiguration?

This property is deprecated.

Use localConfiguration instead.

requestMetadata

val requestMetadata: MediaItem.RequestMetadata!

The media RequestMetadata.