FileMediaItem

Kotlin |Java

open class FileMediaItem : MediaItem

androidx.media2.common.MediaItem
↳	androidx.media2.common.FileMediaItem

Structure for media item for a file.

Users should use Builder to create FileMediaItem.

You cannot directly send this object across the process through ParcelUtils. See MediaItem for detail.

Summary

Nested classes
	`Builder` This Builder class simplifies the creation of a `FileMediaItem` object.

Constants
static Long	`FD_LENGTH_UNKNOWN` Used when the length of file descriptor is unknown.

Inherited constants

From class MediaItem

Long

POSITION_UNKNOWN

Used when a position is unknown.

Public methods
open Long	`getFileDescriptorLength()` Returns the content length associated with the ParcelFileDescriptor of this media item.
open Long	`getFileDescriptorOffset()` Returns the offset associated with the ParcelFileDescriptor of this media item.
open ParcelFileDescriptor	`getParcelFileDescriptor()` Returns the ParcelFileDescriptor of this media item.

Inherited functions

From class MediaItem

`Long`	`getEndPosition()` Return the position in milliseconds at which the playback will end. `POSITION_UNKNOWN` means ending at the end of source content.
`MediaMetadata?`	`getMetadata()` Gets the metadata of the media.
`Long`	`getStartPosition()` Return the position in milliseconds at which the playback will start.
`Unit`	`setMetadata(@Nullable metadata: MediaMetadata?)` Sets metadata. If the metadata is not `null`, its id should be matched with this instance's media id.
`String`	`toString()`

Constants

FD_LENGTH_UNKNOWN

static val FD_LENGTH_UNKNOWN: Long

Used when the length of file descriptor is unknown.

Value: LONG_MAX

See Also

#getFileDescriptorLength()

Public methods

getFileDescriptorLength

open fun getFileDescriptorLength(): Long

Returns the content length associated with the ParcelFileDescriptor of this media item. FD_LENGTH_UNKNOWN means same as the length of source content.

Return
`Long`	the content length associated with the ParcelFileDescriptor of this media item

getFileDescriptorOffset

open fun getFileDescriptorOffset(): Long

Returns the offset associated with the ParcelFileDescriptor of this media item. It's meaningful only when it has been set by the MediaItem.Builder.

Return
`Long`	the offset associated with the ParcelFileDescriptor of this media item

getParcelFileDescriptor

@NonNull open fun getParcelFileDescriptor(): ParcelFileDescriptor

Returns the ParcelFileDescriptor of this media item.

Return
`ParcelFileDescriptor`	the ParcelFileDescriptor of this media item