TsExtractor
@UnstableApi
class TsExtractor : Extractor
Extracts data from the MPEG-2 TS container format.
Summary
Nested types |
|---|
@DocumentedFlags controlling the behavior of the extractor. |
@DocumentedModes for the extractor. |
Constants |
|
|---|---|
const Int |
DEFAULT_TIMESTAMP_SEARCH_BYTES = 112800 |
const ExtractorsFactory! |
This property is deprecated. Use |
const Int |
Flag to use the source subtitle formats without modification. |
const Int |
MODE_HLS = 2Enable single PMT mode, map |
const Int |
MODE_MULTI_PMT = 0Behave as defined in ISO/IEC 13818-1. |
const Int |
MODE_SINGLE_PMT = 1Assume only one PMT will be contained in the stream, even if more are declared by the PAT. |
const Int |
TS_PACKET_SIZE = 188 |
const Int |
|
const Int |
|
const Int |
TS_STREAM_TYPE_AC3 = 129 |
const Int |
TS_STREAM_TYPE_AC4 = 172 |
const Int |
TS_STREAM_TYPE_AIT = 257 |
const Int |
TS_STREAM_TYPE_DC2_H262 = 128 |
const Int |
TS_STREAM_TYPE_DTS = 138 |
const Int |
TS_STREAM_TYPE_DTS_HD = 136 |
const Int |
TS_STREAM_TYPE_DTS_UHD = 139 |
const Int |
|
const Int |
TS_STREAM_TYPE_E_AC3 = 135 |
const Int |
|
const Int |
TS_STREAM_TYPE_H263 = 16 |
const Int |
TS_STREAM_TYPE_H264 = 27 |
const Int |
TS_STREAM_TYPE_H265 = 36 |
const Int |
TS_STREAM_TYPE_HDMV_DTS = 130 |
const Int |
TS_STREAM_TYPE_ID3 = 21 |
const Int |
TS_STREAM_TYPE_MHAS = 45 |
const Int |
|
const Int |
|
const Int |
|
const Int |
TS_SYNC_BYTE = 71 |
Public constructors |
|---|
|
This function is deprecated. Use |
This function is deprecated. Use |
TsExtractor(subtitleParserFactory: SubtitleParser.Factory!)Constructs an instance. |
TsExtractor(Constructs an instance. |
This function is deprecated. Use |
This function is deprecated. Use |
This function is deprecated. Use |
TsExtractor(Constructs an instance. |
Public functions |
|
|---|---|
Unit |
init(output: ExtractorOutput!)Initializes the extractor with an |
java-static ExtractorsFactory! |
newFactory(subtitleParserFactory: SubtitleParser.Factory!)Creates a factory for |
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
FLAG_EMIT_RAW_SUBTITLE_DATA
const val FLAG_EMIT_RAW_SUBTITLE_DATA = 1: Int
Flag to use the source subtitle formats without modification. If unset, subtitles will be transcoded to APPLICATION_MEDIA3_CUES during extraction.
MODE_HLS
const val MODE_HLS = 2: Int
Enable single PMT mode, map TrackOutputs by their type (instead of PID) and ignore continuity counters.
MODE_SINGLE_PMT
const val MODE_SINGLE_PMT = 1: Int
Assume only one PMT will be contained in the stream, even if more are declared by the PAT.
Public constructors
TsExtractor
TsExtractor(subtitleParserFactory: SubtitleParser.Factory!)
Constructs an instance.
| Parameters | |
|---|---|
subtitleParserFactory: SubtitleParser.Factory! |
The |
TsExtractor
TsExtractor(
@TsExtractor.Flags extractorFlags: Int,
subtitleParserFactory: SubtitleParser.Factory!
)
Constructs an instance.
| Parameters | |
|---|---|
@TsExtractor.Flags extractorFlags: Int |
Flags that control the extractor's behavior. |
subtitleParserFactory: SubtitleParser.Factory! |
The |
TsExtractor
TsExtractor(
@TsExtractor.Mode mode: Int,
@DefaultTsPayloadReaderFactory.Flags defaultTsPayloadReaderFlags: Int,
timestampSearchBytes: Int
)
TsExtractor
TsExtractor(
@TsExtractor.Mode mode: Int,
timestampAdjuster: TimestampAdjuster!,
payloadReaderFactory: TsPayloadReader.Factory!
)
TsExtractor
TsExtractor(
@TsExtractor.Mode mode: Int,
timestampAdjuster: TimestampAdjuster!,
payloadReaderFactory: TsPayloadReader.Factory!,
timestampSearchBytes: Int
)
TsExtractor
TsExtractor(
@TsExtractor.Mode mode: Int,
@TsExtractor.Flags extractorFlags: Int,
subtitleParserFactory: SubtitleParser.Factory!,
timestampAdjuster: TimestampAdjuster!,
payloadReaderFactory: TsPayloadReader.Factory!,
timestampSearchBytes: Int
)
Constructs an instance.
| Parameters | |
|---|---|
@TsExtractor.Mode mode: Int |
Mode for the extractor. One of |
@TsExtractor.Flags extractorFlags: Int |
Flags that control the extractor's behavior. |
subtitleParserFactory: SubtitleParser.Factory! |
The |
timestampAdjuster: TimestampAdjuster! |
A timestamp adjuster for offsetting and scaling sample timestamps. |
payloadReaderFactory: TsPayloadReader.Factory! |
Factory for injecting a custom set of payload readers. |
timestampSearchBytes: Int |
The number of bytes searched from a given position in the stream to find a PCR timestamp. If this value is too small, the duration might be unknown and seeking might not be supported for high bitrate progressive streams. Setting a large value for this field might be inefficient though because the extractor stores a buffer of |
Public functions
init
fun init(output: ExtractorOutput!): Unit
Initializes the extractor with an ExtractorOutput. Called at most once.
| Parameters | |
|---|---|
output: ExtractorOutput! |
An |
newFactory
java-static fun newFactory(subtitleParserFactory: SubtitleParser.Factory!): ExtractorsFactory!
Creates a factory for TsExtractor instances with the provided SubtitleParser.Factory.
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. |