AmrExtractor
@UnstableApi
class AmrExtractor : Extractor
Extracts data from the AMR containers format (either AMR or AMR-WB). This follows RFC-4867, section 5.
This extractor only supports single-channel AMR container formats.
Summary
Nested types |
|---|
@DocumentedFlags controlling the behavior of the extractor. |
Constants |
|
|---|---|
const ExtractorsFactory! |
Factory for |
const Int |
Flag to force enable seeking using a constant bitrate assumption in cases where seeking would otherwise not be possible. |
const Int |
Like |
const Int |
Flag to force index seeking, in which a time-to-byte mapping is built as the file is read. |
Public constructors |
|---|
AmrExtractor(@AmrExtractor.Flags flags: Int) |
Public functions |
|
|---|---|
Unit |
init(output: ExtractorOutput!)Initializes the extractor with an |
Int |
read(input: ExtractorInput!, seekPosition: PositionHolder!)Extracts 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
FLAG_ENABLE_CONSTANT_BITRATE_SEEKING
const val FLAG_ENABLE_CONSTANT_BITRATE_SEEKING = 1: Int
Flag to force enable seeking using a constant bitrate assumption in cases where seeking would otherwise not be possible.
This flag is ignored if FLAG_ENABLE_INDEX_SEEKING is set.
FLAG_ENABLE_CONSTANT_BITRATE_SEEKING_ALWAYS
const val FLAG_ENABLE_CONSTANT_BITRATE_SEEKING_ALWAYS = 2: Int
Like FLAG_ENABLE_CONSTANT_BITRATE_SEEKING, except that seeking is also enabled in cases where the content length (and hence the duration of the media) is unknown. Application code should ensure that requested seek positions are valid when using this flag, or be ready to handle playback failures reported through onPlayerError with errorCode set to ERROR_CODE_IO_READ_POSITION_OUT_OF_RANGE.
If this flag is set, then the behavior enabled by FLAG_ENABLE_CONSTANT_BITRATE_SEEKING is implicitly enabled as well.
This flag is ignored if FLAG_ENABLE_INDEX_SEEKING is set.
FLAG_ENABLE_INDEX_SEEKING
const val FLAG_ENABLE_INDEX_SEEKING = 4: Int
Flag to force index seeking, in which a time-to-byte mapping is built as the file is read.
This seeker may require to scan a significant portion of the file to compute a seek point. Therefore, it should only be used if one of the following is true:
- The file is small.
- The bitrate is variable (or it's unknown whether it's variable).
- The file contains silence frames in a constant bitrate stream.
Public constructors
AmrExtractor
AmrExtractor(@AmrExtractor.Flags flags: Int)
| Parameters | |
|---|---|
@AmrExtractor.Flags flags: Int |
Flags that control the extractor's behavior. |
Public functions
init
fun init(output: ExtractorOutput!): Unit
Initializes the extractor with an ExtractorOutput. Called at most once.
| Parameters | |
|---|---|
output: ExtractorOutput! |
An |
read
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. |