Class SubtitleExtractor
- java.lang.Object
-
- com.google.android.exoplayer2.text.SubtitleExtractor
-
- All Implemented Interfaces:
Extractor
@Deprecated public class SubtitleExtractor extends Object implements Extractor
Deprecated.com.google.android.exoplayer2 is deprecated. Please migrate to androidx.media3 (which contains the same ExoPlayer code). See the migration guide for more details, including a script to help with the migration.Generic extractor for extracting subtitles from various subtitle formats.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface com.google.android.exoplayer2.extractor.Extractor
Extractor.ReadResult
-
-
Field Summary
-
Fields inherited from interface com.google.android.exoplayer2.extractor.Extractor
RESULT_CONTINUE, RESULT_END_OF_INPUT, RESULT_SEEK
-
-
Constructor Summary
Constructors Constructor Description SubtitleExtractor(SubtitleDecoder subtitleDecoder, Format format)
Deprecated.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
init(ExtractorOutput output)
Deprecated.Initializes the extractor with anExtractorOutput
.int
read(ExtractorInput input, PositionHolder seekPosition)
Deprecated.Extracts data read from a providedExtractorInput
.void
release()
Deprecated.Releases the extractor's resources, including theSubtitleDecoder
.void
seek(long position, long timeUs)
Deprecated.Notifies the extractor that a seek has occurred.boolean
sniff(ExtractorInput input)
Deprecated.Returns whether this extractor can extract samples from theExtractorInput
, which must provide data from the start of the stream.
-
-
-
Constructor Detail
-
SubtitleExtractor
public SubtitleExtractor(SubtitleDecoder subtitleDecoder, Format format)
Deprecated.- Parameters:
subtitleDecoder
- The decoder used for decoding the subtitle data. The extractor will release the decoder inrelease()
.format
- Format that describes subtitle data.
-
-
Method Detail
-
sniff
public boolean sniff(ExtractorInput input) throws IOException
Deprecated.Description copied from interface:Extractor
Returns whether this extractor can extract samples from theExtractorInput
, which must provide data from the start of the stream.If
true
is returned, theinput
's reading position may have been modified. Otherwise, only its peek position may have been modified.- Specified by:
sniff
in interfaceExtractor
- Parameters:
input
- TheExtractorInput
from which data should be peeked/read.- Returns:
- Whether this extractor can read the provided input.
- Throws:
IOException
- If an error occurred reading from the input.
-
init
public void init(ExtractorOutput output)
Deprecated.Description copied from interface:Extractor
Initializes the extractor with anExtractorOutput
. Called at most once.- Specified by:
init
in interfaceExtractor
- Parameters:
output
- AnExtractorOutput
to receive extracted data.
-
read
public int read(ExtractorInput input, PositionHolder seekPosition) throws IOException
Deprecated.Description copied from interface:Extractor
Extracts data read from a providedExtractorInput
. Must not be called beforeExtractor.init(ExtractorOutput)
.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,
Extractor.RESULT_CONTINUE
is returned to indicate that theExtractorInput
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 inseekPosition
andExtractor.RESULT_SEEK
is returned. If the extractor reached the end of the data provided by theExtractorInput
, thenExtractor.RESULT_END_OF_INPUT
is returned.When this method throws an
IOException
, extraction may continue by providing anExtractorInput
with an unchangedread position
to a subsequent call to this method.- Specified by:
read
in interfaceExtractor
- Parameters:
input
- TheExtractorInput
from which data should be read.seekPosition
- IfExtractor.RESULT_SEEK
is returned, this holder is updated to hold the position of the required data.- Returns:
- One of the
RESULT_
values defined in this interface. - Throws:
IOException
- If an error occurred reading from or parsing the input.
-
seek
public void seek(long position, long timeUs)
Deprecated.Description copied from interface:Extractor
Notifies the extractor that a seek has occurred.Following a call to this method, the
ExtractorInput
passed to the next invocation ofExtractor.read(ExtractorInput, PositionHolder)
is required to provide data starting fromposition
in the stream. Valid random access positions are the start of the stream and positions that can be obtained from anySeekMap
passed to theExtractorOutput
.
-
release
public void release()
Deprecated.Releases the extractor's resources, including theSubtitleDecoder
.
-
-