SingleSampleExtractor
@UnstableApi
class SingleSampleExtractor : Extractor
Extracts data by loading all the bytes into one sample.
Summary
Constants |
|
|---|---|
const Int |
IMAGE_TRACK_ID = 1024The identifier to use for the image track. |
Public constructors |
|---|
SingleSampleExtractor(Creates an instance. |
Public functions |
|
|---|---|
Unit |
init(output: ExtractorOutput!)Initializes the extractor with an |
Int |
@Extractor.ReadResultExtracts data read from a provided |
Unit |
release()Releases all kept resources. |
Unit |
Notifies the extractor that a seek has occurred. |
Boolean |
sniff(input: ExtractorInput!)Returns whether this extractor can extract samples from the |
Inherited Constants |
||||||
|---|---|---|---|---|---|---|
|
Inherited functions |
||||
|---|---|---|---|---|
|
Constants
IMAGE_TRACK_ID
const val IMAGE_TRACK_ID = 1024: Int
The identifier to use for the image track. Chosen to avoid colliding with track IDs used by Mp4Extractor for motion photos.
Public constructors
SingleSampleExtractor
SingleSampleExtractor(
fileSignature: Int,
fileSignatureLength: Int,
sampleMimeType: String!
)
Creates an instance.
| Parameters | |
|---|---|
fileSignature: Int |
The file signature used to |
fileSignatureLength: Int |
The length of file signature, or |
sampleMimeType: String! |
The mime type of the sample. |
Public functions
init
fun init(output: ExtractorOutput!): Unit
Initializes the extractor with an ExtractorOutput. Called at most once.
| Parameters | |
|---|---|
output: ExtractorOutput! |
An |
read
@Extractor.ReadResult
fun read(input: ExtractorInput!, seekPosition: PositionHolder!): Int
Extracts data read from a provided ExtractorInput. Must not be called before init.
A single call to this method will block until some progress has been made, but will not block for longer than this. Hence each call will consume only a small amount of input data.
In the common case, RESULT_CONTINUE is returned to indicate that the ExtractorInput passed to the next read is required to provide data continuing from the position in the stream reached by the returning call. If the extractor requires data to be provided from a different position, then that position is set in seekPosition and RESULT_SEEK is returned. If the extractor reached the end of the data provided by the ExtractorInput, then RESULT_END_OF_INPUT is returned.
When this method throws an IOException, extraction may continue by providing an ExtractorInput with an unchanged read position to a subsequent call to this method.
| Parameters | |
|---|---|
input: ExtractorInput! |
The |
seekPosition: PositionHolder! |
If |
| Returns | |
|---|---|
Int |
One of the |
| Throws | |
|---|---|
java.io.IOException |
If an error occurred reading from or parsing the input. |
seek
fun seek(position: Long, timeUs: Long): Unit
Notifies the extractor that a seek has occurred.
Following a call to this method, the ExtractorInput passed to the next invocation of read is required to provide data starting from
position in the stream. Valid random access positions are the start of the stream and positions that can be obtained from any SeekMap passed to the ExtractorOutput.
sniff
fun sniff(input: ExtractorInput!): Boolean
Returns whether this extractor can extract samples from the ExtractorInput, which must provide data from the start of the stream.
If true is returned, the input's reading position may have been modified. Otherwise, only its peek position may have been modified.
| Parameters | |
|---|---|
input: ExtractorInput! |
The |
| Returns | |
|---|---|
Boolean |
Whether this extractor can read the provided input. |
| Throws | |
|---|---|
java.io.IOException |
If an error occurred reading from the input. |