Most visited

Recently visited

Results for

Added in API level 16

MediaExtractor

public final class MediaExtractor
extends Object

java.lang.Object
↳	android.media.MediaExtractor

MediaExtractor facilitates extraction of demuxed, typically encoded, media data from a data source.

It is generally used like this:

 MediaExtractor extractor = new MediaExtractor();
 extractor.setDataSource(...);
 int numTracks = extractor.getTrackCount();
 for (int i = 0; i < numTracks; ++i) {
   MediaFormat format = extractor.getTrackFormat(i);
   String mime = format.getString(MediaFormat.KEY_MIME);
   if (weAreInterestedInThisTrack) {
     extractor.selectTrack(i);
   }
 }
 ByteBuffer inputBuffer = ByteBuffer.allocate(...)
 while (extractor.readSampleData(inputBuffer, ...) >= 0) {
   int trackIndex = extractor.getSampleTrackIndex();
   long presentationTimeUs = extractor.getSampleTime();
   ...
   extractor.advance();
 }

 extractor.release();
 extractor = null;

Summary

Constants
`int`	`SAMPLE_FLAG_ENCRYPTED` The sample is (at least partially) encrypted, see also the documentation for `queueSecureInputBuffer(int, int, MediaCodec.CryptoInfo, long, int)`
`int`	`SAMPLE_FLAG_SYNC` The sample is a sync sample (or in `MediaCodec`'s terminology it is a key frame.)
`int`	`SEEK_TO_CLOSEST_SYNC` If possible, seek to the sync sample closest to the specified time
`int`	`SEEK_TO_NEXT_SYNC` If possible, seek to a sync sample at or after the specified time
`int`	`SEEK_TO_PREVIOUS_SYNC` If possible, seek to a sync sample at or before the specified time

Public constructors
`MediaExtractor()`

Public methods
`boolean`	`advance()` Advance to the next sample.
`long`	`getCachedDuration()` Returns an estimate of how much data is presently cached in memory expressed in microseconds.
`DrmInitData`	`getDrmInitData()` Extract DRM initialization data if it exists
`Map<UUID, byte[]>`	`getPsshInfo()` Get the PSSH info if present.
`boolean`	`getSampleCryptoInfo(MediaCodec.CryptoInfo info)` If the sample flags indicate that the current sample is at least partially encrypted, this call returns relevant information about the structure of the sample data required for decryption.
`int`	`getSampleFlags()` Returns the current sample's flags.
`long`	`getSampleTime()` Returns the current sample's presentation time in microseconds.
`int`	`getSampleTrackIndex()` Returns the track index the current sample originates from (or -1 if no more samples are available)
`final int`	`getTrackCount()` Count the number of tracks found in the data source.
`MediaFormat`	`getTrackFormat(int index)` Get the track format at the specified index.
`boolean`	`hasCacheReachedEndOfStream()` Returns true iff we are caching data and the cache has reached the end of the data stream (for now, a future seek may of course restart the fetching of data).
`int`	`readSampleData(ByteBuffer byteBuf, int offset)` Retrieve the current encoded sample and store it in the byte buffer starting at the given offset.
`final void`	`release()` 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.
`void`	`seekTo(long timeUs, int mode)` All selected tracks seek near the requested time according to the specified mode.
`void`	`selectTrack(int index)` Subsequent calls to `readSampleData(ByteBuffer, int)`, `getSampleTrackIndex()` and `getSampleTime()` only retrieve information for the subset of tracks selected.
`final void`	`setDataSource(AssetFileDescriptor afd)` Sets the data source (AssetFileDescriptor) to use.
`final void`	`setDataSource(FileDescriptor fd, long offset, long length)` Sets the data source (FileDescriptor) to use.
`final void`	`setDataSource(String path)` Sets the data source (file-path or http URL) to use.
`final void`	`setDataSource(Context context, Uri uri, Map<String, String> headers)` Sets the data source as a content Uri.
`final void`	`setDataSource(FileDescriptor fd)` Sets the data source (FileDescriptor) to use.
`final void`	`setDataSource(String path, Map<String, String> headers)` Sets the data source (file-path or http URL) to use.
`final void`	`setDataSource(MediaDataSource dataSource)` Sets the data source (MediaDataSource) to use.
`void`	`unselectTrack(int index)` Subsequent calls to `readSampleData(ByteBuffer, int)`, `getSampleTrackIndex()` and `getSampleTime()` only retrieve information for the subset of tracks selected.

Protected methods
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

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 millis, 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 millis)` 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.

Constants

SAMPLE_FLAG_ENCRYPTED

Added in API level 16

int SAMPLE_FLAG_ENCRYPTED

The sample is (at least partially) encrypted, see also the documentation for queueSecureInputBuffer(int, int, MediaCodec.CryptoInfo, long, int)

Constant Value: 2 (0x00000002)

SAMPLE_FLAG_SYNC

Added in API level 16

int SAMPLE_FLAG_SYNC

The sample is a sync sample (or in MediaCodec's terminology it is a key frame.)

See also:

BUFFER_FLAG_KEY_FRAME

Constant Value: 1 (0x00000001)

SEEK_TO_CLOSEST_SYNC

Added in API level 16

int SEEK_TO_CLOSEST_SYNC

If possible, seek to the sync sample closest to the specified time

Constant Value: 2 (0x00000002)

SEEK_TO_NEXT_SYNC

Added in API level 16

int SEEK_TO_NEXT_SYNC

If possible, seek to a sync sample at or after the specified time

Constant Value: 1 (0x00000001)

SEEK_TO_PREVIOUS_SYNC

Added in API level 16

int SEEK_TO_PREVIOUS_SYNC

If possible, seek to a sync sample at or before the specified time

Constant Value: 0 (0x00000000)

Public constructors

MediaExtractor

Added in API level 16

MediaExtractor ()

Public methods

advance

Added in API level 16

boolean advance ()

Advance to the next sample. Returns false if no more sample data is available (end of stream).

Returns
`boolean`

getCachedDuration

Added in API level 16

long getCachedDuration ()

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

Returns
`long`

getDrmInitData

Added in API level 24

DrmInitData getDrmInitData ()

Extract DRM initialization data if it exists

Returns
`DrmInitData`	DRM initialization data in the content, or `null` if no recognizable DRM format is found;

See also:

DrmInitData

getPsshInfo

Added in API level 18

Map<UUID, byte[]> getPsshInfo ()

Get the PSSH info if present.

Returns
`Map<UUID, byte[]>`	a map of uuid-to-bytes, with the uuid specifying the crypto scheme, and the bytes being the data specific to that scheme. This can be `null` if the source does not contain PSSH info.

getSampleCryptoInfo

Added in API level 16

boolean getSampleCryptoInfo (MediaCodec.CryptoInfo info)

If the sample flags indicate that the current sample is at least partially encrypted, this call returns relevant information about the structure of the sample data required for decryption.

Parameters
`info`	`MediaCodec.CryptoInfo`: The android.media.MediaCodec.CryptoInfo structure to be filled in.

Returns
`boolean`	true iff the sample flags contain `SAMPLE_FLAG_ENCRYPTED`

getSampleFlags

Added in API level 16

int getSampleFlags ()

Returns the current sample's flags.

Returns
`int`

getSampleTime

Added in API level 16

long getSampleTime ()

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

Returns
`long`

getSampleTrackIndex

Added in API level 16

int getSampleTrackIndex ()

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

Returns
`int`

getTrackCount

Added in API level 16

int getTrackCount ()

Count the number of tracks found in the data source.

Returns
`int`

getTrackFormat

Added in API level 16

MediaFormat getTrackFormat (int index)

Get the track format at the specified index. More detail on the representation can be found at MediaCodec

The following table summarizes support for format keys across android releases:

OS Version(s)	All Tracks	Audio Tracks	Video Tracks
OS Version(s)	`MediaFormat` keys used for
`JELLY_BEAN`	`KEY_MIME`, `KEY_DURATION`, `KEY_MAX_INPUT_SIZE`	`KEY_SAMPLE_RATE`, `KEY_CHANNEL_COUNT`, `KEY_CHANNEL_MASK`, gapless playback information^{.mp3, .mp4}, `KEY_IS_ADTS`^{AAC if streaming}, codec-specific data^{AAC, Vorbis}	`KEY_WIDTH`, `KEY_HEIGHT`, codec-specific data^{AVC, MPEG4}
`JELLY_BEAN_MR1`			`KEY_WIDTH`, `KEY_HEIGHT`, codec-specific data^{AVC, MPEG4}
`JELLY_BEAN_MR2`			as above, plus Pixel aspect ratio information^{AVC, *}
`KITKAT`
`KITKAT_WATCH`
`LOLLIPOP`		as above, plus `KEY_BIT_RATE`^AAC, codec-specific data^Opus	as above, plus `KEY_ROTATION`^.mp4, `KEY_BIT_RATE`^MPEG4, codec-specific data^HEVC
`LOLLIPOP_MR1`		as above, plus `KEY_BIT_RATE`^AAC, codec-specific data^Opus
`M`		as above, plus gapless playback information^Opus	as above, plus `KEY_FRAME_RATE` (integer)
`N`	as above, plus `KEY_TRACK_ID`, `KEY_BIT_RATE`^{#, .mp4}	as above, plus `KEY_PCM_ENCODING`, `KEY_PROFILE`^AAC	as above, plus `KEY_HDR_STATIC_INFO`^{#, .webm}, `KEY_COLOR_STANDARD`^#, `KEY_COLOR_TRANSFER`^#, `KEY_COLOR_RANGE`^#, `KEY_PROFILE`^{MPEG2, H.263, MPEG4, AVC, HEVC, VP9}, `KEY_LEVEL`^{H.263, MPEG4, AVC, HEVC, VP9}, codec-specific data^VP9
Notes: #: container-specified value only. .mp4, .webm…: for listed containers MPEG4, AAC…: for listed codecs
Note that that level information contained in the container many times does not match the level of the actual bitstream. You may want to clear the level using `MediaFormat.setString(KEY_LEVEL, null)` before using the track format to find a decoder that can play back a particular track.
Pixel (sample) aspect ratio is returned in the following keys. The display width can be calculated for example as: display-width = display-height crop-width / crop-height * sar-width / sar-height
Format Key	Value Type	Description
`"sar-width"`	Integer	Pixel aspect ratio width
`"sar-height"`	Integer	Pixel aspect ratio height

Parameters
`index`	`int`

Returns
`MediaFormat`

hasCacheReachedEndOfStream

Added in API level 16

boolean hasCacheReachedEndOfStream ()

Returns true iff we are caching data and the cache has reached the end of the data stream (for now, a future seek may of course restart the fetching of data). This API only returns a meaningful result if getCachedDuration() indicates the presence of a cache, i.e. does NOT return -1.

Returns
`boolean`

readSampleData

Added in API level 16

int readSampleData (ByteBuffer byteBuf, 
                int offset)

Retrieve the current encoded sample and store it in the byte buffer starting at the given offset.

Note:As of API 21, on success the position and limit of byteBuf is updated to point to the data just read.

Parameters
`byteBuf`	`ByteBuffer`: the destination byte buffer
`offset`	`int`

Returns
`int`	the sample size (or -1 if no more samples are available).

release

Added in API level 16

void release ()

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

Added in API level 16

void seekTo (long timeUs, 
                int mode)

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

Parameters
`timeUs`	`long`
`mode`	`int`

selectTrack

Added in API level 16

void selectTrack (int index)

Subsequent calls to readSampleData(ByteBuffer, int), getSampleTrackIndex() and getSampleTime() only retrieve information for the subset of tracks selected. Selecting the same track multiple times has no effect, the track is only selected once.

Parameters
`index`	`int`

setDataSource

Added in API level 24

void setDataSource (AssetFileDescriptor afd)

Sets the data source (AssetFileDescriptor) to use. It is the caller's responsibility to close the file descriptor. It is safe to do so as soon as this call returns.

Parameters
`afd`	`AssetFileDescriptor`: the AssetFileDescriptor for the file you want to extract from.

Throws
`IOException`
`IllegalArgumentException`
`IllegalStateException`

setDataSource

Added in API level 16

void setDataSource (FileDescriptor fd, 
                long offset, 
                long length)

Sets the data source (FileDescriptor) to use. The FileDescriptor must be seekable (N.B. a LocalSocket is not seekable). It is the caller's responsibility to close the file descriptor. It is safe to do so as soon as this call returns.

Parameters
`fd`	`FileDescriptor`: the FileDescriptor for the file you want to extract from.
`offset`	`long`: the offset into the file where the data to be extracted starts, in bytes
`length`	`long`: the length in bytes of the data to be extracted

Throws
`IOException`

setDataSource

Added in API level 16

void setDataSource (String path)

Sets the data source (file-path or http URL) to use.

Parameters

Parameters
`path`	`String`: the path of the file, or the http URL of the stream When `path` refers to a local file, the file may actually be opened by a process other than the calling application. This implies that the pathname should be an absolute path (as any other process runs with unspecified current working directory), and that the pathname should reference a world-readable file. As an alternative, the application could first open the file for reading, and then use the file descriptor form `setDataSource(FileDescriptor)`.

path

String: the path of the file, or the http URL of the stream

When path refers to a local file, the file may actually be opened by a process other than the calling application. This implies that the pathname should be an absolute path (as any other process runs with unspecified current working directory), and that the pathname should reference a world-readable file. As an alternative, the application could first open the file for reading, and then use the file descriptor form setDataSource(FileDescriptor).

Throws
`IOException`

setDataSource

Added in API level 16

void setDataSource (Context context, 
                Uri uri, 
                Map<String, String> headers)

Sets the data source as a content Uri.

Parameters
`context`	`Context`: the Context to use when resolving the Uri
`uri`	`Uri`: the Content URI of the data you want to extract from.
`headers`	`Map`: the headers to be sent together with the request for the data. This can be `null` if no specific headers are to be sent with the request.

Throws
`IOException`

setDataSource

Added in API level 16

void setDataSource (FileDescriptor fd)

Sets the data source (FileDescriptor) to use. It is the caller's responsibility to close the file descriptor. It is safe to do so as soon as this call returns.

Parameters
`fd`	`FileDescriptor`: the FileDescriptor for the file you want to extract from.

Throws
`IOException`

setDataSource

Added in API level 16

void setDataSource (String path, 
                Map<String, String> headers)

Sets the data source (file-path or http URL) to use.

Parameters
`path`	`String`: the path of the file, or the http URL
`headers`	`Map`: the headers associated with the http request for the stream you want to play. This can be `null` if no specific headers are to be sent with the request.

Throws
`IOException`

setDataSource

Added in API level 23

void setDataSource (MediaDataSource dataSource)

Sets the data source (MediaDataSource) to use.

Parameters
`dataSource`	`MediaDataSource`: the MediaDataSource for the media you want to extract from

Throws
`IllegalArgumentException`	if dataSource is invalid.
`IOException`

unselectTrack

Added in API level 16

void unselectTrack (int index)

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

Parameters
`index`	`int`

Protected methods

finalize

Added in API level 16

void finalize ()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. A subclass overrides the finalize method to dispose of system resources or to perform other cleanup.

The general contract of finalize is that it is invoked if and when the Java^TM virtual machine has determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, except as a result of an action taken by the finalization of some other object or class which is ready to be finalized. The finalize method may take any action, including making this object available again to other threads; the usual purpose of finalize, however, is to perform cleanup actions before the object is irrevocably discarded. For example, the finalize method for an object that represents an input/output connection might perform explicit I/O transactions to break the connection before the object is permanently discarded.

The finalize method of class Object performs no special action; it simply returns normally. Subclasses of Object may override this definition.

The Java programming language does not guarantee which thread will invoke the finalize method for any given object. It is guaranteed, however, that the thread that invokes finalize will not be holding any user-visible synchronization locks when finalize is invoked. If an uncaught exception is thrown by the finalize method, the exception is ignored and finalization of that object terminates.

After the finalize method has been invoked for an object, no further action is taken until the Java virtual machine has again determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, including possible actions by other objects or classes which are ready to be finalized, at which point the object may be discarded.

The finalize method is never invoked more than once by a Java virtual machine for any given object.

Any exception thrown by the finalize method causes the finalization of this object to be halted, but is otherwise ignored.