@UnstableApi
class TsExtractor : Extractor

Extracts data from the MPEG-2 TS container format.

Summary

Nested types
@Documented
@Retention(value = RetentionPolicy.SOURCE)
@Target(value = TYPE_USE)
@IntDef(flag = true, value = )
annotation TsExtractor.Flags

Flags controlling the behavior of the extractor.
@Documented
@Retention(value = RetentionPolicy.SOURCE)
@Target(value = TYPE_USE)
@IntDef(value = )
annotation TsExtractor.Mode

Modes for the extractor.

Constants
const Int
const ExtractorsFactory!

This property is deprecated.

Use newFactory instead.
const Int

Flag to use the source subtitle formats without modification.
const Int

Enable single PMT mode, map TrackOutputs by their type (instead of PID) and ignore continuity counters.
const Int

Behave as defined in ISO/IEC 13818-1.
const Int

Assume only one PMT will be contained in the stream, even if more are declared by the PAT.
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int
const Int

Public constructors

This function is deprecated.

Use TsExtractor instead.
TsExtractor(
    @DefaultTsPayloadReaderFactory.Flags defaultTsPayloadReaderFlags: Int
)

This function is deprecated.

Use TsExtractor instead.
TsExtractor(subtitleParserFactory: SubtitleParser.Factory!)

Constructs an instance.
TsExtractor(
    @TsExtractor.Flags extractorFlags: Int,
    subtitleParserFactory: SubtitleParser.Factory!
)

Constructs an instance.
TsExtractor(
    @TsExtractor.Mode mode: Int,
    @DefaultTsPayloadReaderFactory.Flags defaultTsPayloadReaderFlags: Int,
    timestampSearchBytes: Int
)

This function is deprecated.

Use TsExtractor instead.
TsExtractor(
    @TsExtractor.Mode mode: Int,
    timestampAdjuster: TimestampAdjuster!,
    payloadReaderFactory: TsPayloadReader.Factory!
)

This function is deprecated.

Use TsExtractor instead.
TsExtractor(
    @TsExtractor.Mode mode: Int,
    timestampAdjuster: TimestampAdjuster!,
    payloadReaderFactory: TsPayloadReader.Factory!,
    timestampSearchBytes: Int
)

This function is deprecated.

Use TsExtractor instead.
TsExtractor(
    @TsExtractor.Mode mode: Int,
    @TsExtractor.Flags extractorFlags: Int,
    subtitleParserFactory: SubtitleParser.Factory!,
    timestampAdjuster: TimestampAdjuster!,
    payloadReaderFactory: TsPayloadReader.Factory!,
    timestampSearchBytes: Int
)

Constructs an instance.

Public functions
Unit

Initializes the extractor with an ExtractorOutput.
java-static ExtractorsFactory!
newFactory(subtitleParserFactory: SubtitleParser.Factory!)

Creates a factory for TsExtractor instances with the provided .
Int

Extracts data read from a provided ExtractorInput.
Unit

Releases all kept resources.
Unit
seek(position: Long, timeUs: Long)

Notifies the extractor that a seek has occurred.
Boolean

Returns whether this extractor can extract samples from the ExtractorInput, which must provide data from the start of the stream.

Inherited Constants
From androidx.media3.extractor.Extractor
const Int

Returned by read if the ExtractorInput passed to the next read is required to provide data continuing from the position in the stream reached by the returning call.
const Int

Returned by read if the end of the was reached.
const Int

Returned by read if the ExtractorInput passed to the next read is required to provide data starting from a specified position in the stream.

Inherited functions
From androidx.media3.extractor.Extractor
Extractor!

Returns the 'real' Extractor implementation if this is a delegating instance, or this if this instance does the extraction directly without delegating (the default behaviour).

Constants

DEFAULT_TIMESTAMP_SEARCH_BYTES

const val DEFAULT_TIMESTAMP_SEARCH_BYTES = 112800: Int

FACTORY

const val FACTORY: ExtractorsFactory!

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_MULTI_PMT

const val MODE_MULTI_PMT = 0: Int

Behave as defined in ISO/IEC 13818-1.

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.

TS_PACKET_SIZE

const val TS_PACKET_SIZE = 188: Int

TS_STREAM_TYPE_AAC_ADTS

const val TS_STREAM_TYPE_AAC_ADTS = 15: Int

TS_STREAM_TYPE_AAC_LATM

const val TS_STREAM_TYPE_AAC_LATM = 17: Int

TS_STREAM_TYPE_AC3

const val TS_STREAM_TYPE_AC3 = 129: Int

TS_STREAM_TYPE_AC4

const val TS_STREAM_TYPE_AC4 = 172: Int

TS_STREAM_TYPE_AIT

const val TS_STREAM_TYPE_AIT = 257: Int

TS_STREAM_TYPE_DC2_H262

const val TS_STREAM_TYPE_DC2_H262 = 128: Int

TS_STREAM_TYPE_DTS

const val TS_STREAM_TYPE_DTS = 138: Int

TS_STREAM_TYPE_DTS_HD

const val TS_STREAM_TYPE_DTS_HD = 136: Int

TS_STREAM_TYPE_DTS_UHD

const val TS_STREAM_TYPE_DTS_UHD = 139: Int

TS_STREAM_TYPE_DVBSUBS

const val TS_STREAM_TYPE_DVBSUBS = 89: Int

TS_STREAM_TYPE_E_AC3

const val TS_STREAM_TYPE_E_AC3 = 135: Int

TS_STREAM_TYPE_H262

const val TS_STREAM_TYPE_H262 = 2: Int

TS_STREAM_TYPE_H263

const val TS_STREAM_TYPE_H263 = 16: Int

TS_STREAM_TYPE_H264

const val TS_STREAM_TYPE_H264 = 27: Int

TS_STREAM_TYPE_H265

const val TS_STREAM_TYPE_H265 = 36: Int

TS_STREAM_TYPE_HDMV_DTS

const val TS_STREAM_TYPE_HDMV_DTS = 130: Int

TS_STREAM_TYPE_ID3

const val TS_STREAM_TYPE_ID3 = 21: Int

TS_STREAM_TYPE_MPA

const val TS_STREAM_TYPE_MPA = 3: Int

TS_STREAM_TYPE_MPA_LSF

const val TS_STREAM_TYPE_MPA_LSF = 4: Int

TS_STREAM_TYPE_SPLICE_INFO

const val TS_STREAM_TYPE_SPLICE_INFO = 134: Int

TS_SYNC_BYTE

const val TS_SYNC_BYTE = 71: Int

Public constructors

TsExtractor

TsExtractor()

TsExtractor

TsExtractor(
    @DefaultTsPayloadReaderFactory.Flags defaultTsPayloadReaderFlags: Int
)

TsExtractor

TsExtractor(subtitleParserFactory: SubtitleParser.Factory!)

Constructs an instance.

Parameters
subtitleParserFactory: SubtitleParser.Factory!

The SubtitleParser.Factory for parsing subtitles during extraction.

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 SubtitleParser.Factory for parsing subtitles during extraction.

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 MODE_MULTI_PMT, MODE_SINGLE_PMT and MODE_HLS.
@TsExtractor.Flags extractorFlags: Int

Flags that control the extractor's behavior.
subtitleParserFactory: SubtitleParser.Factory!

The SubtitleParser.Factory for parsing subtitles during extraction.
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 timestampSearchBytes bytes when determining the duration or when performing a seek operation. The default value is DEFAULT_TIMESTAMP_SEARCH_BYTES. If the number of bytes left in the stream from the current position is less than timestampSearchBytes, the search is performed on the bytes left.

Public functions

init

fun init(output: ExtractorOutput!): Unit

Initializes the extractor with an ExtractorOutput. Called at most once.

Parameters
output: ExtractorOutput!

An ExtractorOutput to receive extracted data.

newFactory

java-static fun newFactory(subtitleParserFactory: SubtitleParser.Factory!): ExtractorsFactory!

Creates a factory for TsExtractor instances with the provided .

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 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 ExtractorInput from which data should be read.
seekPosition: PositionHolder!

If RESULT_SEEK is returned, this holder is updated to hold the position of the required data.
Returns
Int

One of the RESULT_ values defined in this interface.
Throws
java.io.IOException

If an error occurred reading from or parsing the input.

release

fun release(): Unit

Releases all kept resources.

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.

Parameters
position: Long

The byte offset in the stream from which data will be provided.
timeUs: Long

The seek time in microseconds.

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 ExtractorInput from which data should be peeked/read.
Returns
Boolean

Whether this extractor can read the provided input.
Throws
java.io.IOException

If an error occurred reading from the input.