TextRenderer

Artifact: androidx.media3:media3-exoplayer

Kotlin |Java

@UnstableApi
public final class TextRenderer extends BaseRenderer implements Handler.Callback

java.lang.Object
↳	androidx.media3.exoplayer.BaseRenderer
	↳	androidx.media3.exoplayer.text.TextRenderer

A Renderer for text.

This implementations decodes sample data to Cue instances. The actual rendering is delegated to a TextOutput.

Summary

Public constructors
`TextRenderer(TextOutput output, @Nullable Looper outputLooper)`
`TextRenderer( TextOutput output, @Nullable Looper outputLooper, SubtitleDecoderFactory subtitleDecoderFactory )`

Public methods
`void`	`experimentalSetLegacyDecodingEnabled(boolean legacyDecodingEnabled)` This method is deprecated. This method (and all support for 'legacy' subtitle decoding during rendering) will be removed in a future release.
`String`	`getName()` Returns the name of this renderer, for logging and debugging purposes.
`boolean`	`handleMessage(Message msg)`
`boolean`	`isEnded()` Whether the renderer is ready for the `ExoPlayer` instance to transition to `STATE_ENDED`.
`boolean`	`isReady()` Whether the renderer is able to immediately render media from the current position.
`void`	`render(long positionUs, long elapsedRealtimeUs)` Incrementally renders the `SampleStream`.
`void`	`setFinalStreamEndPositionUs(long streamEndPositionUs)` Sets the position at which to stop rendering the current stream.
`int`	`@RendererCapabilities.Capabilities supportsFormat(Format format)` Returns the extent to which the `Renderer` supports a given format.

Protected methods
`void`	`onDisabled()` Called when the renderer is disabled.
`void`	`onPositionReset(long positionUs, boolean joining)` Called when the position is reset.
`void`	`onStreamChanged( Format[] formats, long startPositionUs, long offsetUs, MediaSource.MediaPeriodId mediaPeriodId )` Called when the renderer's stream has changed.

Inherited Constants

From androidx.media3.exoplayer.Renderer

`static final long`	`DEFAULT_DURATION_TO_PROGRESS_US = 10000` Default minimum duration that the playback clock must advance before `render` can make progress.
`static final int`	`MSG_CUSTOM_BASE = 10000` Applications or extensions may define custom `MSG_*` constants that can be passed to renderers.
`static final int`	`MSG_SET_AUDIO_ATTRIBUTES = 3` A type of a message that can be passed to an audio renderer via `createMessage`.
`static final int`	`MSG_SET_AUDIO_SESSION_ID = 10` The type of a message that can be passed to audio and video renderers via `createMessage`.
`static final int`	`MSG_SET_AUX_EFFECT_INFO = 6` A type of a message that can be passed to an audio renderer via `createMessage`.
`static final int`	`MSG_SET_CAMERA_MOTION_LISTENER = 8` The type of a message that can be passed to a camera motion renderer via `createMessage`.
`static final int`	`MSG_SET_CHANGE_FRAME_RATE_STRATEGY = 5` The type of a message that can be passed to a video renderer via `createMessage`.
`static final int`	`MSG_SET_IMAGE_OUTPUT = 15` The type of message that can be passed to an image renderer to set a desired image output.
`static final int`	`MSG_SET_PREFERRED_AUDIO_DEVICE = 12` The type of a message that can be passed to audio renderers via `createMessage`.
`static final int`	`MSG_SET_PRIORITY = 16` The type of message that can be passed to a renderer to set its priority.
`static final int`	`MSG_SET_SCALING_MODE = 4` The type of a message that can be passed to a `MediaCodec`-based video renderer via `createMessage`.
`static final int`	`MSG_SET_SKIP_SILENCE_ENABLED = 9` The type of a message that can be passed to an audio renderer via `createMessage`.
`static final int`	`MSG_SET_VIDEO_EFFECTS = 13` The type of a message that can be passed to a video renderer.
`static final int`	`MSG_SET_VIDEO_FRAME_METADATA_LISTENER = 7` The type of a message that can be passed to a video renderer via `createMessage`.
`static final int`	`MSG_SET_VIDEO_OUTPUT = 1` The type of a message that can be passed to a video renderer via `createMessage`.
`static final int`	`MSG_SET_VIDEO_OUTPUT_RESOLUTION = 14` The type of a message that can be passed to a video renderer to set the desired output resolution.
`static final int`	`MSG_SET_VOLUME = 2` A type of a message that can be passed to an audio renderer via `createMessage`.
`static final int`	`MSG_SET_WAKEUP_LISTENER = 11` The type of a message that can be passed to a `Renderer` via `createMessage`, to inform the renderer that it can schedule waking up another component.
`static final int`	`STATE_DISABLED = 0` The renderer is disabled.
`static final int`	`STATE_ENABLED = 1` The renderer is enabled but not started.
`static final int`	`STATE_STARTED = 2` The renderer is started.

From androidx.media3.exoplayer.RendererCapabilities

`static final int`	`ADAPTIVE_NOT_SEAMLESS = 8` The `Renderer` can adapt between formats, but may suffer a brief discontinuity (~50-100ms) when adaptation occurs.
`static final int`	`ADAPTIVE_NOT_SUPPORTED = 0` The `Renderer` does not support adaptation between formats.
`static final int`	`ADAPTIVE_SEAMLESS = 16` The `Renderer` can seamlessly adapt between formats.
`static final int`	`ADAPTIVE_SUPPORT_MASK = 24` A mask to apply to `Capabilities` to obtain the `AdaptiveSupport` only.
`static final int`	`AUDIO_OFFLOAD_GAPLESS_SUPPORTED = 1024` The renderer supports audio offload and gapless transitions with this format.
`static final int`	`AUDIO_OFFLOAD_NOT_SUPPORTED = 0` Audio offload is not supported with this format.
`static final int`	`AUDIO_OFFLOAD_SPEED_CHANGE_SUPPORTED = 2048` The renderer supports audio offload and speed changes with this format.
`static final int`	`AUDIO_OFFLOAD_SUPPORTED = 512` The renderer supports audio offload with this format.
`static final int`	`AUDIO_OFFLOAD_SUPPORT_MASK = 3584` A mask to apply to `Capabilities` to obtain `AudioOffloadSupport` only.
`static final int`	`DECODER_SUPPORT_FALLBACK = 0` The format exceeds the primary decoder's capabilities but is supported by fallback decoder
`static final int`	`DECODER_SUPPORT_FALLBACK_MIMETYPE = 256` The format's MIME type is unsupported and the renderer may use a decoder for a fallback MIME type.
`static final int`	`DECODER_SUPPORT_MASK = 384` A mask to apply to `Capabilities` to obtain `DecoderSupport` only.
`static final int`	`DECODER_SUPPORT_PRIMARY = 128` The renderer is able to use the primary decoder for the format's MIME type.
`static final int`	`FORMAT_SUPPORT_MASK = 7` A mask to apply to `Capabilities` to obtain the `C.FormatSupport` only.
`static final int`	`HARDWARE_ACCELERATION_NOT_SUPPORTED = 0` The renderer is not able to use hardware acceleration.
`static final int`	`HARDWARE_ACCELERATION_SUPPORTED = 64` The renderer is able to use hardware acceleration.
`static final int`	`HARDWARE_ACCELERATION_SUPPORT_MASK = 64` A mask to apply to `Capabilities` to obtain `HardwareAccelerationSupport` only.
`static final int`	`TUNNELING_NOT_SUPPORTED = 0` The `Renderer` does not support tunneled output.
`static final int`	`TUNNELING_SUPPORTED = 32` The `Renderer` supports tunneled output.
`static final int`	`TUNNELING_SUPPORT_MASK = 32` A mask to apply to `Capabilities` to obtain `TunnelingSupport` only.

Inherited fields

From androidx.media3.exoplayer.BaseRenderer

`@MonotonicNonNull Clock`	`@MonotonicNonNull clock`
`@Nullable RendererConfiguration`	`configuration`
`final FormatHolder`	`formatHolder`
`int`	`index`
`long`	`lastResetPositionUs`
`@MonotonicNonNull PlayerId`	`@MonotonicNonNull playerId`
`long`	`readingPositionUs`
`int`	`state`
`@Nullable SampleStream`	`stream`
`@Nullable Format[]`	`streamFormats`
`long`	`streamOffsetUs`
`Timeline`	`timeline`
`final int`	`@C.TrackType trackType`

Inherited methods

From androidx.media3.exoplayer.BaseRenderer

`final void`	`clearListener()` Clears the `Listener`.
`final ExoPlaybackException`	`createRendererException( Throwable cause, @Nullable Format format, @PlaybackException.ErrorCode int errorCode )` Creates an `ExoPlaybackException` of type `TYPE_RENDERER` for this renderer.
`final ExoPlaybackException`	`createRendererException( Throwable cause, @Nullable Format format, boolean isRecoverable, @PlaybackException.ErrorCode int errorCode )` Creates an `ExoPlaybackException` of type `TYPE_RENDERER` for this renderer.
`final void`	`disable()` Disable the renderer, transitioning it to the `STATE_DISABLED` state.
`final void`	`enable( RendererConfiguration configuration, Format[] formats, SampleStream stream, long positionUs, boolean joining, boolean mayRenderStartOfStream, long startPositionUs, long offsetUs, MediaSource.MediaPeriodId mediaPeriodId )` Enables the renderer to consume from the specified `SampleStream`.
`final RendererCapabilities`	`getCapabilities()` Returns the capabilities of the renderer.
`final Clock`	`getClock()` Returns the `Clock`.
`final RendererConfiguration`	`getConfiguration()` Returns the configuration set when the renderer was most recently enabled.
`final FormatHolder`	`getFormatHolder()` Returns a clear `FormatHolder`.
`final int`	`getIndex()` Returns the index of the renderer within the player.
`final long`	`getLastResetPositionUs()` Returns the position passed to the most recent call to `enable` or resetPosition.
`@Nullable MediaClock`	`getMediaClock()` If the renderer advances its own playback position then this method returns a corresponding `MediaClock`.
`final PlayerId`	`getPlayerId()` Returns the `PlayerId` of the player using this renderer.
`final long`	`getReadingPositionUs()` Returns the renderer time up to which the renderer has read samples, in microseconds, or `TIME_END_OF_SOURCE` if the renderer has read the current `SampleStream` to the end.
`final int`	`getState()` Returns the current state of the renderer.
`final @Nullable SampleStream`	`getStream()` Returns the `SampleStream` being consumed, or null if the renderer is disabled.
`final Format[]`	`getStreamFormats()` Returns the formats of the currently enabled stream.
`final long`	`getStreamOffsetUs()` Returns the offset added to timestamps of buffers read from the `SampleStream`.
`final Timeline`	`getTimeline()` Returns the current `Timeline` containing the rendered stream.
`final int`	`@C.TrackType getTrackType()` Returns the track type that the renderer handles.
`void`	`handleMessage( @Renderer.MessageType int messageType, @Nullable Object message )` Handles a message delivered to the target.
`final boolean`	`hasReadStreamToEnd()` Returns whether the renderer has read the current `SampleStream` to the end.
`final void`	`init(int index, PlayerId playerId, Clock clock)` Initializes the renderer for playback with a player.
`final boolean`	`isCurrentStreamFinal()` Returns whether the current `SampleStream` will be the final one supplied before the renderer is next disabled or reset.
`final boolean`	`isSourceReady()` Returns whether the upstream source is ready.
`final void`	`maybeThrowStreamError()` Throws an error that's preventing the renderer from reading from its `SampleStream`.
`void`	`onEnabled(boolean joining, boolean mayRenderStartOfStream)` Called when the renderer is enabled.
`void`	`onInit()` Called when the renderer is initialized.
`void`	`onRelease()` Called when the renderer is released.
`final void`	`onRendererCapabilitiesChanged()` Called when the renderer capabilities are changed.
`void`	`onReset()` Called when the renderer is reset.
`void`	`onStarted()` Called when the renderer is started.
`void`	`onStopped()` Called when the renderer is stopped.
`void`	`onTimelineChanged(Timeline timeline)` Called when a new timeline is `set`.
`final int`	`@SampleStream.ReadDataResult readSource( FormatHolder formatHolder, DecoderInputBuffer buffer, @SampleStream.ReadFlags int readFlags )` Reads from the enabled upstream source.
`final void`	`release()` Releases the renderer.
`final void`	`replaceStream( Format[] formats, SampleStream stream, long startPositionUs, long offsetUs, MediaSource.MediaPeriodId mediaPeriodId )` Replaces the `SampleStream` from which samples will be consumed.
`final void`	`reset()` Forces the renderer to give up any resources (e.g. media decoders) that it may be holding.
`final void`	`resetPosition(long positionUs)` Signals to the renderer that a position discontinuity has occurred.
`final void`	`setCurrentStreamFinal()` Signals to the renderer that the current `SampleStream` will be the final one supplied before it is next disabled or reset.
`final void`	`setListener(RendererCapabilities.Listener listener)` Sets the `Listener`.
`final void`	`setTimeline(Timeline timeline)` Sets the timeline that is currently being played.
`int`	`skipSource(long positionUs)` Attempts to skip to the keyframe before the specified position, or to the end of the stream if `positionUs` is beyond it.
`final void`	`start()` Starts the renderer, meaning that calls to `render` will cause media to be rendered.
`final void`	`stop()` Stops the renderer, transitioning it to the `STATE_ENABLED` state.
`int`	`@RendererCapabilities.AdaptiveSupport supportsMixedMimeTypeAdaptation()` Returns the extent to which the `Renderer` supports adapting between supported formats that have different MIME types.

From androidx.media3.exoplayer.Renderer

`abstract void`	`enable( RendererConfiguration configuration, Format[] formats, SampleStream stream, long positionUs, boolean joining, boolean mayRenderStartOfStream, long startPositionUs, long offsetUs, MediaSource.MediaPeriodId mediaPeriodId )` Enables the renderer to consume from the specified `SampleStream`.
`void`	`enableMayRenderStartOfStream()` Enables this renderer to render the start of the stream even if the state is not `STATE_STARTED` yet.
`long`	`getDurationToProgressUs(long positionUs, long elapsedRealtimeUs)` Returns minimum amount of playback clock time that must pass in order for the `render` call to make progress.
`abstract void`	`replaceStream( Format[] formats, SampleStream stream, long startPositionUs, long offsetUs, MediaSource.MediaPeriodId mediaPeriodId )` Replaces the `SampleStream` from which samples will be consumed.
`void`	`setPlaybackSpeed(float currentPlaybackSpeed, float targetPlaybackSpeed)` Indicates the playback speed to this renderer.

From androidx.media3.exoplayer.RendererCapabilities

`static int`	`@RendererCapabilities.Capabilities create(@C.FormatSupport int formatSupport)` Returns `Capabilities` for the given `C.FormatSupport`.
`static int`	`@RendererCapabilities.Capabilities create( @C.FormatSupport int formatSupport, @RendererCapabilities.AdaptiveSupport int adaptiveSupport, @RendererCapabilities.TunnelingSupport int tunnelingSupport )` Returns `Capabilities` combining the given `C.FormatSupport`, and `TunnelingSupport`.
`static int`	`@RendererCapabilities.Capabilities create( @C.FormatSupport int formatSupport, @RendererCapabilities.AdaptiveSupport int adaptiveSupport, @RendererCapabilities.TunnelingSupport int tunnelingSupport, @RendererCapabilities.AudioOffloadSupport int audioOffloadSupport )` Returns `Capabilities` combining the given `C.FormatSupport`, , `TunnelingSupport`, and `AudioOffloadSupport`.
`static int`	`@RendererCapabilities.Capabilities create( @C.FormatSupport int formatSupport, @RendererCapabilities.AdaptiveSupport int adaptiveSupport, @RendererCapabilities.TunnelingSupport int tunnelingSupport, @RendererCapabilities.HardwareAccelerationSupport int hardwareAccelerationSupport, @RendererCapabilities.DecoderSupport int decoderSupport )` Returns `Capabilities` combining the given `C.FormatSupport`, , `TunnelingSupport`, `HardwareAccelerationSupport`, and .
`static int`	`@RendererCapabilities.Capabilities create( @C.FormatSupport int formatSupport, @RendererCapabilities.AdaptiveSupport int adaptiveSupport, @RendererCapabilities.TunnelingSupport int tunnelingSupport, @RendererCapabilities.HardwareAccelerationSupport int hardwareAccelerationSupport, @RendererCapabilities.DecoderSupport int decoderSupport, @RendererCapabilities.AudioOffloadSupport int audioOffloadSupport )` Returns `Capabilities` combining the given `C.FormatSupport`, , `TunnelingSupport`, `HardwareAccelerationSupport`, and `AudioOffloadSupport`.
`static int`	`@RendererCapabilities.AdaptiveSupport getAdaptiveSupport(@RendererCapabilities.Capabilities int supportFlags)` Returns the `AdaptiveSupport` from the combined `Capabilities`.
`static int`	`@RendererCapabilities.AudioOffloadSupport getAudioOffloadSupport( @RendererCapabilities.Capabilities int supportFlags )` Returns the `AudioOffloadSupport` from the combined `Capabilities`.
`static int`	`@RendererCapabilities.DecoderSupport getDecoderSupport(@RendererCapabilities.Capabilities int supportFlags)` Returns the `DecoderSupport` from the combined `Capabilities`.
`static int`	`@C.FormatSupport getFormatSupport(@RendererCapabilities.Capabilities int supportFlags)` Returns the `C.FormatSupport` from the combined `Capabilities`.
`static int`	`@RendererCapabilities.HardwareAccelerationSupport getHardwareAccelerationSupport( @RendererCapabilities.Capabilities int supportFlags )` Returns the `HardwareAccelerationSupport` from the combined `Capabilities`.
`static int`	`@RendererCapabilities.TunnelingSupport getTunnelingSupport(@RendererCapabilities.Capabilities int supportFlags)` Returns the `TunnelingSupport` from the combined `Capabilities`.
`static boolean`	`isFormatSupported( @RendererCapabilities.Capabilities int supportFlags, boolean allowExceedsCapabilities )` Returns whether the `C.FormatSupport` from the combined `Capabilities` indicates the format is supported.
`void`	`setListener(RendererCapabilities.Listener listener)` Sets the `Listener`.

Public constructors

TextRenderer

public TextRenderer(TextOutput output, @Nullable Looper outputLooper)

Parameters
`TextOutput output`	The output.
`@Nullable Looper outputLooper`	The looper associated with the thread on which the output should be called. If the output makes use of standard Android UI components, then this should normally be the looper associated with the application's main thread, which can be obtained using `getMainLooper`. Null may be passed if the output should be called directly on the player's internal rendering thread.

TextRenderer

public TextRenderer(
    TextOutput output,
    @Nullable Looper outputLooper,
    SubtitleDecoderFactory subtitleDecoderFactory
)

Parameters
`TextOutput output`	The output.
`@Nullable Looper outputLooper`	The looper associated with the thread on which the output should be called. If the output makes use of standard Android UI components, then this should normally be the looper associated with the application's main thread, which can be obtained using `getMainLooper`. Null may be passed if the output should be called directly on the player's internal rendering thread.
`SubtitleDecoderFactory subtitleDecoderFactory`	A factory from which to obtain `SubtitleDecoder` instances.

Public methods

experimentalSetLegacyDecodingEnabled

public void experimentalSetLegacyDecodingEnabled(boolean legacyDecodingEnabled)

Sets whether to decode subtitle data during rendering.

If this is enabled, then the SubtitleDecoderFactory passed to the constructor is used to decode subtitle data during rendering.

If this is disabled this text renderer can only handle tracks with MIME type APPLICATION_MEDIA3_CUES (which have been parsed from their original format during extraction), and will throw an exception if passed data of a different type.

This is disabled by default.

This method is experimental. It may change behavior, be renamed, or removed in a future release.

getName

public String getName()

Returns the name of this renderer, for logging and debugging purposes. Should typically be the renderer's (un-obfuscated) class name.

Returns
`String`	The name of this renderer.

handleMessage

public boolean handleMessage(Message msg)

isEnded

public boolean isEnded()

Whether the renderer is ready for the ExoPlayer instance to transition to STATE_ENDED. The player will make this transition as soon as true is returned by all of its renderers.

This method may be called when the renderer is in the following states: STATE_ENABLED, STATE_STARTED.

Returns
`boolean`	Whether the renderer is ready for the player to transition to the ended state.

isReady

public boolean isReady()

Whether the renderer is able to immediately render media from the current position.

If the renderer is in the STATE_STARTED state then returning true indicates that the renderer has everything that it needs to continue playback. Returning false indicates that the player should pause until the renderer is ready.

If the renderer is in the STATE_ENABLED state then returning true indicates that the renderer is ready for playback to be started. Returning false indicates that it is not.

This method may be called when the renderer is in the following states: STATE_ENABLED, STATE_STARTED.

Returns
`boolean`	Whether the renderer is ready to render media.

render

public void render(long positionUs, long elapsedRealtimeUs)

Incrementally renders the SampleStream.

If the renderer is in the STATE_ENABLED state then each call to this method will do work toward being ready to render the SampleStream when the renderer is started. If the renderer is in the STATE_STARTED state then calls to this method will render the SampleStream in sync with the specified media positions.

The renderer may also render the very start of the media at the current position (e.g. the first frame of a video stream) while still in the STATE_ENABLED state, unless it's the initial start of the media after calling enable with mayRenderStartOfStream set to false.

This method should return quickly, and should not block if the renderer is unable to make useful progress.

This method may be called when the renderer is in the following states: STATE_ENABLED, STATE_STARTED.

Parameters
`long positionUs`	The current media time in microseconds, measured at the start of the current iteration of the rendering loop.
`long elapsedRealtimeUs`	`elapsedRealtime` in microseconds, measured at the start of the current iteration of the rendering loop.

Throws
`androidx.media3.exoplayer.ExoPlaybackException`	If an error occurs.

setFinalStreamEndPositionUs

public void setFinalStreamEndPositionUs(long streamEndPositionUs)

Sets the position at which to stop rendering the current stream.

Must be called after setCurrentStreamFinal.

Parameters
`long streamEndPositionUs`	The position to stop rendering at or `LENGTH_UNSET` to render until the end of the current stream.

supportsFormat

@RendererCapabilities.Capabilities
public int supportsFormat(Format format)

Returns the extent to which the Renderer supports a given format.

Parameters
`Format format`	The format.

Returns
`int`	The `Capabilities` for this format.

Throws
`androidx.media3.exoplayer.ExoPlaybackException`	If an error occurs.

Protected methods

onDisabled

protected void onDisabled()

Called when the renderer is disabled.

The default implementation is a no-op.

onPositionReset

protected void onPositionReset(long positionUs, boolean joining)

Called when the position is reset. This occurs when the renderer is enabled after onStreamChanged has been called, and also when a position discontinuity is encountered.

After a position reset, the renderer's SampleStream is guaranteed to provide samples starting from a key frame.

The default implementation is a no-op.

Parameters
`long positionUs`	The new playback position in microseconds.
`boolean joining`	Whether this renderer is being enabled to join an ongoing playback.

Throws
`androidx.media3.exoplayer.ExoPlaybackException`	If an error occurs.

onStreamChanged

protected void onStreamChanged(
    Format[] formats,
    long startPositionUs,
    long offsetUs,
    MediaSource.MediaPeriodId mediaPeriodId
)

Called when the renderer's stream has changed. This occurs when the renderer is enabled after onEnabled has been called, and also when the stream has been replaced whilst the renderer is enabled or started.

The default implementation is a no-op.

Parameters
`Format[] formats`	The enabled formats.
`long startPositionUs`	The start position of the new stream in renderer time (microseconds).
`long offsetUs`	The offset that will be added to the timestamps of buffers read via `readSource` so that decoder input buffers have monotonically increasing timestamps.
`MediaSource.MediaPeriodId mediaPeriodId`	The `MediaSource.MediaPeriodId` of the `MediaPeriod` that produces the stream.

Throws
`androidx.media3.exoplayer.ExoPlaybackException`	If an error occurs.