MediaExtractorCompat


@UnstableApi
public final class MediaExtractorCompat


A drop-in replacement for MediaExtractor that provides similar functionality, based on the media3.extractor logic.

Summary

Nested types

@IntDef(value = )
@Retention(value = RetentionPolicy.SOURCE)
public annotation MediaExtractorCompat.SeekMode

The seeking mode.

Constants

static final int

See SEEK_TO_CLOSEST_SYNC.

static final int

See SEEK_TO_NEXT_SYNC.

static final int

See SEEK_TO_PREVIOUS_SYNC.

Public fields

final Allocator

Public constructors

Creates a new instance.

MediaExtractorCompat(
    ExtractorsFactory extractorsFactory,
    DataSource.Factory dataSourceFactory
)

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

Public methods

boolean

Advances to the next sample.

Allocator
@VisibleForTesting(otherwise = 5)
getAllocator()
int

Returns the current sample's flags.

long

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

int

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

int

Returns the number of tracks found in the data source.

MediaFormat
getTrackFormat(int trackIndex)

Returns the track MediaFormat at the specified trackIndex.

int
readSampleData(ByteBuffer buffer, int offset)

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

void

Releases any resources held by this instance.

void
seekTo(long timeUs, @MediaExtractorCompat.SeekMode int mode)

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

void
selectTrack(int trackIndex)

Selects a track at the specified trackIndex.

void
setDataSource(Uri uri, long offset)

Initializes the internal state with the media stream obtained from the given uri at the given offset.

void
unselectTrack(int trackIndex)

Unselects the track at the specified trackIndex.

Constants

SEEK_TO_CLOSEST_SYNC

public static final int SEEK_TO_CLOSEST_SYNC = 2

See SEEK_TO_CLOSEST_SYNC.

SEEK_TO_NEXT_SYNC

public static final int SEEK_TO_NEXT_SYNC = 1

See SEEK_TO_NEXT_SYNC.

SEEK_TO_PREVIOUS_SYNC

public static final int SEEK_TO_PREVIOUS_SYNC = 0

See SEEK_TO_PREVIOUS_SYNC.

Public fields

allocator

public final Allocator allocator

Public constructors

MediaExtractorCompat

public MediaExtractorCompat(Context context)

Creates a new instance.

MediaExtractorCompat

public MediaExtractorCompat(
    ExtractorsFactory extractorsFactory,
    DataSource.Factory dataSourceFactory
)

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

Public methods

advance

public boolean advance()

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.

getAllocator

@VisibleForTesting(otherwise = 5)
public Allocator getAllocator()

getSampleFlags

public int getSampleFlags()

Returns the current sample's flags.

getSampleTime

public long getSampleTime()

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

getSampleTrackIndex

public int getSampleTrackIndex()

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

getTrackCount

public int getTrackCount()

Returns the number of tracks found in the data source.

getTrackFormat

public MediaFormat getTrackFormat(int trackIndex)

Returns the track MediaFormat at the specified trackIndex.

readSampleData

public int readSampleData(ByteBuffer buffer, int offset)

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.

Parameters
ByteBuffer buffer

the destination byte buffer.

int offset

The offset into the byte buffer at which to write.

Returns
int

the sample size, or -1 if no more samples are available.

release

public void release()

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.

seekTo

public void seekTo(long timeUs, @MediaExtractorCompat.SeekMode int mode)

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

selectTrack

public void selectTrack(int trackIndex)

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.

setDataSource

public void setDataSource(Uri uri, long offset)

Initializes the internal state with the media stream obtained from the given uri at the given offset.

Parameters
Uri uri

The content Uri to extract from.

long offset

The offset into the file where the data to be extracted starts, in bytes.

Throws
java.io.IOException

If an error occurs while extracting the media.

androidx.media3.exoplayer.source.UnrecognizedInputFormatException

If none of the available extractors successfully sniffs the input.

java.lang.IllegalStateException

If this method is called twice on the same instance.

unselectTrack

public void unselectTrack(int trackIndex)

Unselects the track at the specified trackIndex.

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