public interface

SubtitleDecoder

implements Decoder<SubtitleInputBuffer, SubtitleOutputBuffer, SubtitleDecoderException>

 androidx.media3.extractor.text.SubtitleDecoder

Subclasses:

ExoplayerCuesDecoder, Tx3gDecoder, SimpleSubtitleDecoder, TtmlDecoder, PgsDecoder, SsaDecoder, SubripDecoder, DvbDecoder, Cea608Decoder, Cea708Decoder, Mp4WebvttDecoder, WebvttDecoder

Gradle dependencies

compile group: 'androidx.media3', name: 'media3-extractor', version: '1.0.0-alpha03'

  • groupId: androidx.media3
  • artifactId: media3-extractor
  • version: 1.0.0-alpha03

Artifact androidx.media3:media3-extractor:1.0.0-alpha03 it located at Google repository (https://maven.google.com/)

Overview

Decodes Subtitles from SubtitleInputBuffers.

Summary

Methods
public voidsetPositionUs(long positionUs)

Informs the decoder of the current playback position.

Methods

public void setPositionUs(long positionUs)

Informs the decoder of the current playback position.

Must be called prior to each attempt to dequeue output buffers from the decoder.

Parameters:

positionUs: The current playback position in microseconds.

Source

/*
 * Copyright (C) 2016 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package androidx.media3.extractor.text;

import androidx.media3.common.util.UnstableApi;
import androidx.media3.decoder.Decoder;

/** Decodes {@link Subtitle}s from {@link SubtitleInputBuffer}s. */
@UnstableApi
public interface SubtitleDecoder
    extends Decoder<SubtitleInputBuffer, SubtitleOutputBuffer, SubtitleDecoderException> {

  /**
   * Informs the decoder of the current playback position.
   *
   * <p>Must be called prior to each attempt to dequeue output buffers from the decoder.
   *
   * @param positionUs The current playback position in microseconds.
   */
  void setPositionUs(long positionUs);
}