ChunkExtractor.Factory

public interface ChunkExtractor.Factory

Known direct subclasses

Creates ChunkExtractor instances.

Summary

Public methods
abstract @Nullable ChunkExtractor
createProgressiveMediaExtractor(
    @C.TrackType int primaryTrackType,
    Format representationFormat,
    boolean enableEventMessageTrack,
    List<Format> closedCaptionFormats,
    @Nullable TrackOutput playerEmsgTrackOutput,
    PlayerId playerId
)

Returns a new ChunkExtractor instance.
default ChunkExtractor.Factory
@CanIgnoreReturnValue
experimentalParseSubtitlesDuringExtraction(
    boolean parseSubtitlesDuringExtraction
)

Sets whether subtitles should be parsed as part of extraction (before being added to the sample queue) or as part of rendering (when being taken from the sample queue).
default Format

Returns the output Format of emitted text samples which were originally in sourceFormat.
default ChunkExtractor.Factory

Sets the SubtitleParser.Factory to use for parsing subtitles during extraction.

Public methods

createProgressiveMediaExtractor

abstract @Nullable ChunkExtractor createProgressiveMediaExtractor(
    @C.TrackType int primaryTrackType,
    Format representationFormat,
    boolean enableEventMessageTrack,
    List<Format> closedCaptionFormats,
    @Nullable TrackOutput playerEmsgTrackOutput,
    PlayerId playerId
)

Returns a new ChunkExtractor instance.

Parameters
@C.TrackType int primaryTrackType

The type of the primary track.
Format representationFormat

The format of the representation to extract from.
boolean enableEventMessageTrack

Whether to enable the event message track.
List<Format> closedCaptionFormats

The Formats of the Closed-Caption tracks.
@Nullable TrackOutput playerEmsgTrackOutput

The TrackOutput for extracted EMSG messages, or null.
PlayerId playerId

The PlayerId of the player using this chunk extractor.
Returns
@Nullable ChunkExtractor

A new ChunkExtractor instance, or null if not applicable.

experimentalParseSubtitlesDuringExtraction

@CanIgnoreReturnValue
default ChunkExtractor.Factory experimentalParseSubtitlesDuringExtraction(
    boolean parseSubtitlesDuringExtraction
)

Sets whether subtitles should be parsed as part of extraction (before being added to the sample queue) or as part of rendering (when being taken from the sample queue). Defaults to false (i.e. subtitles will be parsed as part of rendering).

This method is experimental and will be renamed or removed in a future release.

Parameters
boolean parseSubtitlesDuringExtraction

Whether to parse subtitles during extraction or rendering.
Returns
ChunkExtractor.Factory

This factory, for convenience.

getOutputTextFormat

default Format getOutputTextFormat(Format sourceFormat)

Returns the output Format of emitted text samples which were originally in sourceFormat.

In many cases, where an Extractor emits samples from the source without mutation, this method simply returns sourceFormat. In other cases, such as an Extractor that transcodes subtitles from the sourceFormat to APPLICATION_MEDIA3_CUES, the format is updated to indicate the transcoding that is taking place.

Non-text source formats are always returned without mutation.

Parameters
Format sourceFormat

The original text-based format.
Returns
Format

The Format that will be associated with a text track.

setSubtitleParserFactory

@CanIgnoreReturnValue
default ChunkExtractor.Factory setSubtitleParserFactory(SubtitleParser.Factory subtitleParserFactory)

Sets the SubtitleParser.Factory to use for parsing subtitles during extraction. The default factory value is implementation dependent.

Parameters
SubtitleParser.Factory subtitleParserFactory

The SubtitleParser.Factory for parsing subtitles during extraction.
Returns
ChunkExtractor.Factory

This factory, for convenience.