MediaItem

Kotlin |Java

public final class MediaItem

Representation of a media item.

Summary

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

Constants
`static final String`	`DEFAULT_MEDIA_ID = ""` The default media ID that is used if the media ID is not explicitly set by `setMediaId`.
`static final MediaItem`	`EMPTY` Empty `MediaItem`.

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

Public methods
`MediaItem.Builder`	`buildUpon()` Returns a `Builder` initialized with the values of this instance.
`boolean`	`equals(@Nullable Object obj)`
`static MediaItem`	`@UnstableApi fromBundle(Bundle bundle)` Restores a `MediaItem` from a `Bundle`.
`static MediaItem`	`fromUri(String uri)` Creates a `MediaItem` for the given URI.
`static MediaItem`	`fromUri(Uri uri)` Creates a `MediaItem` for the given `URI`.
`int`	`hashCode()`
`Bundle`	`@UnstableApi toBundle()` Returns a `Bundle` 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).

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 setMediaId.

EMPTY

public static final MediaItem EMPTY

Empty MediaItem.

Public fields

clippingConfiguration

public final MediaItem.ClippingConfiguration clippingConfiguration

The clipping properties.

clippingProperties

@UnstableApi
public final MediaItem.ClippingProperties clippingProperties

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

requestMetadata

public final MediaItem.RequestMetadata requestMetadata

The media RequestMetadata.

Public methods

buildUpon

public MediaItem.Builder buildUpon()

Returns a Builder initialized with the values of this instance.

equals

public boolean equals(@Nullable Object obj)

fromBundle

@UnstableApi
public static MediaItem fromBundle(Bundle bundle)

Restores a MediaItem from a Bundle.

The localConfiguration of a restored instance will always be null.

fromUri

public static MediaItem fromUri(String uri)

Creates a MediaItem for the given URI.

Parameters
`String uri`	The URI.

Returns
`MediaItem`	An `MediaItem` for the given URI.

fromUri

public static MediaItem fromUri(Uri uri)

Creates a MediaItem for the given URI.

Parameters
`Uri uri`	The `uri`.

Returns
`MediaItem`	An `MediaItem` for the given URI.

hashCode

public int hashCode()

toBundle

@UnstableApi
public Bundle toBundle()

Returns a Bundle representing the information stored in this object.

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

toBundleIncludeLocalConfiguration

@UnstableApi
public Bundle 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).

MediaItem

Summary

Nested types

Constants

Public fields

Public methods

Constants

DEFAULT_MEDIA_ID

EMPTY

Public fields

clippingConfiguration

clippingProperties

liveConfiguration

localConfiguration

mediaId

mediaMetadata

playbackProperties

requestMetadata

Public methods

buildUpon

equals

fromBundle

fromUri

fromUri

hashCode

toBundle

toBundleIncludeLocalConfiguration