MediaItem2

public final class MediaItem2
extends Object implements Parcelable

java.lang.Object
↳	android.media.MediaItem2

A class with information on a single media item with the metadata information.

This API is not generally intended for third party application developers. Use the AndroidX Media2 Library for consistent behavior across all devices.

Summary

Nested classes
`class`	`MediaItem2.Builder` Builder for `MediaItem2`.

Constants
`long`	`POSITION_UNKNOWN` Used when a position is unknown.

Inherited constants

From interface android.os.Parcelable

`int`	`CONTENTS_FILE_DESCRIPTOR` Descriptor bit used with `describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int`	`PARCELABLE_WRITE_RETURN_VALUE` Flag for use with `writeToParcel(Parcel, int)`: the object being written is a return value, that is the result of a function such as "`Parcelable someFunction()`", "`void someFunction(out Parcelable)`", or "`void someFunction(inout Parcelable)`".

Fields
`public static final Creator<MediaItem2>`	`CREATOR`

Public methods
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`long`	`getEndPosition()` Return the position in milliseconds at which the playback will end.
`MediaMetadata`	`getMetadata()` Gets the metadata of the media.
`long`	`getStartPosition()` Return the position in milliseconds at which the playback will start.
`void`	`setMetadata(MediaMetadata metadata)` Sets metadata.
`String`	`toString()` Returns a string representation of the object.
`void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeout, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long timeout)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

From interface


        
          android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Constants

POSITION_UNKNOWN

Added in Android Q

public static final long POSITION_UNKNOWN

Used when a position is unknown.

See also:

getEndPosition()

Constant Value: 576460752303423487 (0x07ffffffffffffff)

Fields

CREATOR

Added in Android Q

public static final Creator<MediaItem2> CREATOR

Public methods

describeContents

Added in Android Q

public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
`int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `CONTENTS_FILE_DESCRIPTOR`

getEndPosition

Added in Android Q

public long getEndPosition ()

Return the position in milliseconds at which the playback will end. POSITION_UNKNOWN means ending at the end of source content.

Returns
`long`	the position in milliseconds at which the playback will end

getMetadata

Added in Android Q

public MediaMetadata getMetadata ()

Gets the metadata of the media.

Returns
`MediaMetadata`	metadata from the session This value may be `null`.

getStartPosition

Added in Android Q

public long getStartPosition ()

Return the position in milliseconds at which the playback will start.

Returns
`long`	the position in milliseconds at which the playback will start

setMetadata

Added in Android Q

public void setMetadata (MediaMetadata metadata)

Sets metadata. If the metadata is not null, its id should be matched with this instance's media id.

Parameters
`metadata`	`MediaMetadata`: metadata to update This value may be `null`.

See also:

MediaMetadata.METADATA_KEY_MEDIA_ID

toString

Added in Android Q

public String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())

Returns
`String`	a string representation of the object.

writeToParcel

Added in Android Q

public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
`dest`	`Parcel`: The Parcel in which the object should be written.
`flags`	`int`: Additional flags about how the object should be written. May be 0 or `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

MediaItem2

Summary

Nested classes

Constants

Inherited constants

Fields

Public methods

Inherited methods

Constants

POSITION_UNKNOWN

Fields

CREATOR

Public methods

describeContents

getEndPosition

getMetadata

getStartPosition

setMetadata

toString

writeToParcel