MediaExtractorCompat

const val SEEK_TO_CLOSEST_SYNC = 2: Int

See SEEK_TO_CLOSEST_SYNC.

const val SEEK_TO_NEXT_SYNC = 1: Int

See SEEK_TO_NEXT_SYNC.

const val SEEK_TO_PREVIOUS_SYNC = 0: Int

See SEEK_TO_PREVIOUS_SYNC.

MediaExtractorCompat(context: Context!)

Creates a new instance.

MediaExtractorCompat(
    extractorsFactory: ExtractorsFactory!,
    dataSourceFactory: DataSource.Factory!
)

Creates a new instance using the given ExtractorsFactory to create the extractors to use for obtaining media samples from a DataSource generated by the given DataSource.Factory.

Note: The DataSource.Factory provided will not be used to generate DataSource when setting data source using methods:

• setDataSource
• setDataSource
• setDataSource

Note: The DataSource.Factory provided may not be used to generate DataSource when setting data source using method setDataSource as the behavior depends on the fallthrough logic related to the scheme of the provided URI.

fun advance(): Boolean

Advances to the next sample. Returns false if no more sample data is available (i.e., end of stream), or true otherwise.

Note: When extracting from a local file, the behavior of advance and readSampleData is undefined if there are concurrent writes to the same file. This may result in an unexpected end of stream being signaled.

fun getCachedDuration(): Long

Returns an estimate of how much data is presently cached in memory, expressed in microseconds, or -1 if this information is unavailable or not applicable (i.e., no cache exists).

fun getDrmInitData(): DrmInitData?

Extracts the DRM initialization data from the available tracks, if it exists.

@RequiresApi(value = 31)
fun getLogSessionId(): LogSessionId!

Returns the LogSessionId for MediaExtractorCompat.

@RequiresApi(value = 26)
fun getMetrics(): PersistableBundle!

Returns a PersistableBundle containing metrics data for the current media container.

The bundle includes attributes and values for the media container, as described in MediaExtractor.MetricsConstants.

fun getPsshInfo(): (Mutable)Map<UUID!, ByteArray<Byte>!>?

Extracts PSSH data from the media, if present.

fun getSampleCryptoInfo(info: MediaCodec.CryptoInfo!): Boolean

Returns true if the current sample is at least partially encrypted and fills the provided MediaCodec.CryptoInfo structure with relevant decryption information.

fun getSampleFlags(): Int

Returns the current sample's flags.

fun getSampleSize(): Long

Returns the current sample's size in bytes, or -1 if no more samples are available.

fun getSampleTime(): Long

Returns the current sample's presentation time in microseconds, or -1 if no more samples are available.

fun getSampleTrackIndex(): Int

Returns the track index the current sample originates from, or -1 if no more samples are available.

fun getTrackCount(): Int

Returns the number of tracks found in the data source.

fun getTrackFormat(trackIndex: Int): MediaFormat!

Returns the track MediaFormat at the specified trackIndex.

fun hasCacheReachedEndOfStream(): Boolean

Returns true if data is being cached and the cache has reached the end of the data stream. This indicates that no additional data is currently available for caching, although a future seek may restart data fetching. This method only returns a meaningful result if getCachedDuration indicates the presence of a cache (i.e., does not return -1).

fun readSampleData(buffer: ByteBuffer!, offset: Int): Int

Retrieves the current encoded sample and stores it in the byte buffer starting at the given offset.

Note:On success, the position and limit of buffer is updated to point to the data just read.

fun release(): Unit

Releases any resources held by this instance.

Note: Make sure you call this when you're done to free up any resources instead of relying on the garbage collector to do this for you at some point in the future.

fun seekTo(timeUs: Long, @MediaExtractorCompat.SeekMode mode: Int): Unit

All selected tracks seek near the requested timeUs according to the specified mode.

fun selectTrack(trackIndex: Int): Unit

Selects a track at the specified trackIndex.

Subsequent calls to readSampleData, getSampleTrackIndex and getSampleTime only retrieve information for the subset of tracks selected.

Note: Selecting the same track multiple times has no effect, the track is only selected once.

fun setDataSource(assetFileDescriptor: AssetFileDescriptor!): Unit

Sets the data source using the media stream obtained from the provided AssetFileDescriptor.

Note: The caller is responsible for closing the AssetFileDescriptor. It is safe to do so immediately after this method returns.

fun setDataSource(fileDescriptor: FileDescriptor!): Unit

Sets the data source using the media stream obtained from the provided FileDescriptor.

fun setDataSource(mediaDataSource: MediaDataSource!): Unit

Sets the data source using the media stream obtained from the given MediaDataSource.

fun setDataSource(path: String!): Unit

Sets the data source using the media stream obtained from the given file path or HTTP URL.

fun setDataSource(path: String!, headers: (Mutable)Map<String!, String!>?): Unit

Sets the data source using the media stream obtained from the given file path or HTTP URL, with optional HTTP request headers.

fun setDataSource(uri: Uri!, offset: Long): Unit

Sets the data source using the media stream obtained from the given Uri at the given offset.

fun setDataSource(
    context: Context!,
    uri: Uri!,
    headers: (Mutable)Map<String!, String!>?
): Unit

Sets the data source using the media stream obtained from the given content URI and optional HTTP request headers.

fun setDataSource(fileDescriptor: FileDescriptor!, offset: Long, length: Long): Unit

Sets the data source using the media stream obtained from the provided FileDescriptor, with a specified offset and length.

@RequiresApi(value = 31)
fun setLogSessionId(logSessionId: LogSessionId!): Unit

Sets the LogSessionId for MediaExtractorCompat.

fun unselectTrack(trackIndex: Int): Unit

Unselects the track at the specified trackIndex.

Subsequent calls to readSampleData, getSampleTrackIndex and getSampleTime only retrieve information for the subset of tracks selected.