MediaParserHlsMediaChunkExtractor

Artifact: androidx.media3:media3-exoplayer-hls

Kotlin |Java

@RequiresApi(value = 30)
@UnstableApi
public final class MediaParserHlsMediaChunkExtractor implements HlsMediaChunkExtractor

HlsMediaChunkExtractor implemented on top of the platform's MediaParser.

Summary

Constants
`static final HlsExtractorFactory`	`FACTORY` `HlsExtractorFactory` implementation that produces for all container formats except WebVTT, for which a is returned.

Public constructors
`MediaParserHlsMediaChunkExtractor( MediaParser mediaParser, OutputConsumerAdapterV30 outputConsumerAdapter, Format format, boolean overrideInBandCaptionDeclarations, ImmutableList<MediaFormat> muxedCaptionMediaFormats, int leadingBytesToSkip, PlayerId playerId )` Creates a new instance.

Public methods
`void`	`init(ExtractorOutput extractorOutput)` Initializes the extractor with an `ExtractorOutput`.
`boolean`	`isPackedAudioExtractor()` Returns whether this is a packed audio extractor, as defined in RFC 8216, Section 3.4.
`boolean`	`isReusable()` Returns whether this instance can be used for extracting multiple continuous segments.
`void`	`onTruncatedSegmentParsed()` Resets the sample parsing state.
`boolean`	`read(ExtractorInput extractorInput)` Extracts data read from a provided `ExtractorInput`.
`HlsMediaChunkExtractor`	`recreate()` Returns a new instance for extracting the same type of media as this one.

Constants

FACTORY

public static final HlsExtractorFactory FACTORY

HlsExtractorFactory implementation that produces for all container formats except WebVTT, for which a is returned.

Public constructors

MediaParserHlsMediaChunkExtractor

public MediaParserHlsMediaChunkExtractor(
    MediaParser mediaParser,
    OutputConsumerAdapterV30 outputConsumerAdapter,
    Format format,
    boolean overrideInBandCaptionDeclarations,
    ImmutableList<MediaFormat> muxedCaptionMediaFormats,
    int leadingBytesToSkip,
    PlayerId playerId
)

Creates a new instance.

Parameters
`MediaParser mediaParser`	The `MediaParser` instance to use for extraction of segments. The provided instance must have completed sniffing, or must have been created by name.
`OutputConsumerAdapterV30 outputConsumerAdapter`	The `OutputConsumerAdapterV30` with which `mediaParser` was created.
`Format format`	The `Format` associated with the segment.
`boolean overrideInBandCaptionDeclarations`	Whether to ignore any in-band caption track declarations in favor of using the `muxedCaptionMediaFormats` instead. If false, caption declarations found in the extracted media will be used, causing `muxedCaptionMediaFormats` to be ignored instead.
`ImmutableList<MediaFormat> muxedCaptionMediaFormats`	The list of in-band caption `MediaFormats` that `MediaParser` should expose.
`int leadingBytesToSkip`	The number of bytes to skip from the start of the input before starting extraction.
`PlayerId playerId`	The `PlayerId` of the player using this chunk extractor.

Public methods

init

public void init(ExtractorOutput extractorOutput)

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

Parameters
`ExtractorOutput extractorOutput`	An `ExtractorOutput` to receive extracted data.

isPackedAudioExtractor

public boolean isPackedAudioExtractor()

Returns whether this is a packed audio extractor, as defined in RFC 8216, Section 3.4.

isReusable

public boolean isReusable()

Returns whether this instance can be used for extracting multiple continuous segments.

onTruncatedSegmentParsed

public void onTruncatedSegmentParsed()

Resets the sample parsing state.

Resetting the parsing state allows support for Fragmented MP4 EXT-X-I-FRAME-STREAM-INF segments. EXT-X-I-FRAME-STREAM-INF segments are truncated to include only a leading key frame. After parsing said keyframe, an extractor may reach an unexpected end of file. By resetting its state, we can continue feeding samples from the following segments to the extractor. See #7512 for context.

read

public boolean read(ExtractorInput extractorInput)

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.

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
`ExtractorInput extractorInput`	The input to read from.

Returns
`boolean`	Whether there is any data left to extract. Returns false if the end of input has been reached.

Throws
`java.io.IOException`	If an error occurred reading from or parsing the input.

recreate

public HlsMediaChunkExtractor recreate()

Returns a new instance for extracting the same type of media as this one. Can only be called on instances that are not reusable.