Stay organized with collections Save and categorize content based on your preferences.

TextRenderer

@UnstableApi
class TextRenderer : BaseRenderer, Handler.Callback


A renderer for text.

Subtitles are decoded from sample data using SubtitleDecoder instances obtained from a SubtitleDecoderFactory. The actual rendering of the subtitle Cues is delegated to a TextOutput.

Summary

Public constructors

TextRenderer(output: TextOutput!, outputLooper: Looper?)
TextRenderer(
    output: TextOutput!,
    outputLooper: Looper?,
    decoderFactory: SubtitleDecoderFactory!
)

Public functions

String!

Returns the name of this renderer, for logging and debugging purposes.

Boolean
Boolean

Whether the renderer is ready for the ExoPlayer instance to transition to STATE_ENDED.

Boolean

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

Unit
render(positionUs: Long, elapsedRealtimeUs: Long)

Incrementally renders the SampleStream.

Unit
setFinalStreamEndPositionUs(streamEndPositionUs: Long)

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

Int

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

Protected functions

Unit

Called when the renderer is disabled.

Unit
onPositionReset(positionUs: Long, joining: Boolean)

Called when the position is reset.

Unit
onStreamChanged(
    formats: Array<Format!>!,
    startPositionUs: Long,
    offsetUs: Long
)

Called when the renderer's stream has changed.

Inherited Constants

From androidx.media3.exoplayer.Renderer
const Int

Applications or extensions may define custom MSG_* constants that can be passed to renderers.

const Int

A type of a message that can be passed to an audio renderer via createMessage.

const Int

The type of a message that can be passed to audio and video renderers via createMessage.

const Int

A type of a message that can be passed to an audio renderer via createMessage.

const Int

The type of a message that can be passed to a camera motion renderer via createMessage.

const Int

The type of a message that can be passed to a video renderer via createMessage.

const Int

The type of a message that can be passed to audio renderers via createMessage.

const Int

The type of a message that can be passed to a MediaCodec-based video renderer via createMessage.

const Int

The type of a message that can be passed to an audio renderer via createMessage.

const Int

The type of a message that can be passed to a video renderer via createMessage.

const Int

The type of a message that can be passed to a video renderer via createMessage.

const Int

A type of a message that can be passed to an audio renderer via createMessage.

const Int

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.

const Int

The renderer is disabled.

const Int

The renderer is enabled but not started.

const Int

The renderer is started.

From androidx.media3.exoplayer.RendererCapabilities
const Int

The Renderer can adapt between formats, but may suffer a brief discontinuity (~50-100ms) when adaptation occurs.

const Int

The Renderer does not support adaptation between formats.

const Int

The Renderer can seamlessly adapt between formats.

const Int

A mask to apply to Capabilities to obtain the AdaptiveSupport only.

const Int

The renderer will use a fallback decoder.

const Int

The renderer will use a decoder for fallback mimetype if possible as format's MIME type is unsupported

const Int

The renderer is able to use the primary decoder for the format's MIME type.

const Int

This property is deprecated.

Use FORMAT_EXCEEDS_CAPABILITIES instead.

const Int

This property is deprecated.

Use FORMAT_HANDLED instead.

const Int

A mask to apply to Capabilities to obtain the C.FormatSupport only.

const Int

This property is deprecated.

Use FORMAT_UNSUPPORTED_DRM instead.

const Int

This property is deprecated.

Use FORMAT_UNSUPPORTED_SUBTYPE instead.

const Int

This property is deprecated.

Use FORMAT_UNSUPPORTED_TYPE instead.

const Int

The renderer is not able to use hardware acceleration.

const Int

The renderer is able to use hardware acceleration.

const Int

A mask to apply to Capabilities to obtain HardwareAccelerationSupport only.

const Int

A mask to apply to Capabilities to obtain DecoderSupport only.

const Int

The Renderer does not support tunneled output.

const Int

The Renderer supports tunneled output.

const Int

A mask to apply to Capabilities to obtain TunnelingSupport only.

Inherited functions

From androidx.media3.exoplayer.BaseRenderer
ExoPlaybackException!
createRendererException(
    cause: Throwable!,
    format: Format?,
    @PlaybackException.ErrorCode errorCode: Int
)

Creates an ExoPlaybackException of type TYPE_RENDERER for this renderer.

ExoPlaybackException!
createRendererException(
    cause: Throwable!,
    format: Format?,
    isRecoverable: Boolean,
    @PlaybackException.ErrorCode errorCode: Int
)

Creates an ExoPlaybackException of type TYPE_RENDERER for this renderer.

Unit

Disable the renderer, transitioning it to the STATE_DISABLED state.

Unit
enable(
    configuration: RendererConfiguration!,
    formats: Array<Format!>!,
    stream: SampleStream!,
    positionUs: Long,
    joining: Boolean,
    mayRenderStartOfStream: Boolean,
    startPositionUs: Long,
    offsetUs: Long
)

Enables the renderer to consume from the specified SampleStream.

RendererCapabilities!

Returns the capabilities of the renderer.

RendererConfiguration!

Returns the configuration set when the renderer was most recently enabled.

FormatHolder!

Returns a clear FormatHolder.

Int

Returns the index of the renderer within the player.

Long

Returns the position passed to the most recent call to enable or resetPosition.

MediaClock?

If the renderer advances its own playback position then this method returns a corresponding MediaClock.

PlayerId!

Returns the PlayerId of the player using this renderer.

Long

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.

Int

Returns the current state of the renderer.

SampleStream?

Returns the SampleStream being consumed, or null if the renderer is disabled.

Array<Format!>!

Returns the formats of the currently enabled stream.

Int

Returns the track type that the renderer handles.

Unit
handleMessage(@Renderer.MessageType messageType: Int, message: Any?)

Handles a message delivered to the target.

Boolean

Returns whether the renderer has read the current SampleStream to the end.

Unit
init(index: Int, playerId: PlayerId!)

Initializes the renderer for playback with a player.

Boolean

Returns whether the current SampleStream will be the final one supplied before the renderer is next disabled or reset.

Boolean

Returns whether the upstream source is ready.

Unit

Throws an error that's preventing the renderer from reading from its SampleStream.

Unit
onEnabled(joining: Boolean, mayRenderStartOfStream: Boolean)

Called when the renderer is enabled.

Unit

Called when the renderer is reset.

Unit

Called when the renderer is started.

Unit

Called when the renderer is stopped.

Int
@SampleStream.ReadDataResult
readSource(
    formatHolder: FormatHolder!,
    buffer: DecoderInputBuffer!,
    @SampleStream.ReadFlags readFlags: Int
)

Reads from the enabled upstream source.

Unit
replaceStream(
    formats: Array<Format!>!,
    stream: SampleStream!,
    startPositionUs: Long,
    offsetUs: Long
)

Replaces the SampleStream from which samples will be consumed.

Unit

Forces the renderer to give up any resources (e.g. media decoders) that it may be holding.

Unit
resetPosition(positionUs: Long)

Signals to the renderer that a position discontinuity has occurred.

Unit

Signals to the renderer that the current SampleStream will be the final one supplied before it is next disabled or reset.

Int
skipSource(positionUs: Long)

Attempts to skip to the keyframe before the specified position, or to the end of the stream if positionUs is beyond it.

Unit

Starts the renderer, meaning that calls to render will cause media to be rendered.

Unit

Stops the renderer, transitioning it to the STATE_ENABLED state.

Int

Returns the extent to which the Renderer supports adapting between supported formats that have different MIME types.

From androidx.media3.exoplayer.Renderer
abstract Unit
replaceStream(
    formats: Array<Format!>!,
    stream: SampleStream!,
    startPositionUs: Long,
    offsetUs: Long
)

Replaces the SampleStream from which samples will be consumed.

Unit
setPlaybackSpeed(currentPlaybackSpeed: Float, targetPlaybackSpeed: Float)

Indicates the playback speed to this renderer.

From androidx.media3.exoplayer.RendererCapabilities
java-static Int

Returns Capabilities for the given C.FormatSupport.

java-static Int

Returns Capabilities combining the given C.FormatSupport, and TunnelingSupport.

java-static Int
@RendererCapabilities.Capabilities
create(
    @C.FormatSupport formatSupport: Int,
    @RendererCapabilities.AdaptiveSupport adaptiveSupport: Int,
    @RendererCapabilities.TunnelingSupport tunnelingSupport: Int,
    @RendererCapabilities.HardwareAccelerationSupport hardwareAccelerationSupport: Int,
    @RendererCapabilities.DecoderSupport decoderSupport: Int
)

Returns Capabilities combining the given C.FormatSupport, , TunnelingSupport, HardwareAccelerationSupport and .

java-static Int

Returns the AdaptiveSupport from the combined Capabilities.

java-static Int

Returns the DecoderSupport from the combined Capabilities.

java-static Int

Returns the C.FormatSupport from the combined Capabilities.

java-static Int

Returns the HardwareAccelerationSupport from the combined Capabilities.

java-static Int

Returns the TunnelingSupport from the combined Capabilities.

Public constructors

TextRenderer

TextRenderer(output: TextOutput!, outputLooper: Looper?)
Parameters
output: TextOutput!

The output.

outputLooper: Looper?

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

TextRenderer(
    output: TextOutput!,
    outputLooper: Looper?,
    decoderFactory: SubtitleDecoderFactory!
)
Parameters
output: TextOutput!

The output.

outputLooper: Looper?

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.

decoderFactory: SubtitleDecoderFactory!

A factory from which to obtain SubtitleDecoder instances.

Public functions

getName

fun getName(): String!

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

fun handleMessage(msg: Message!): Boolean

isEnded

fun isEnded(): Boolean

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

fun isReady(): Boolean

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

fun render(positionUs: Long, elapsedRealtimeUs: Long): Unit

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
positionUs: Long

The current media time in microseconds, measured at the start of the current iteration of the rendering loop.

elapsedRealtimeUs: Long

elapsedRealtime in microseconds, measured at the start of the current iteration of the rendering loop.

Throws
androidx.media3.exoplayer.ExoPlaybackException: androidx.media3.exoplayer.ExoPlaybackException

If an error occurs.

setFinalStreamEndPositionUs

fun setFinalStreamEndPositionUs(streamEndPositionUs: Long): Unit

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

Must be called after setCurrentStreamFinal.

Parameters
streamEndPositionUs: Long

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

supportsFormat

@RendererCapabilities.Capabilities
fun supportsFormat(format: Format!): Int

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: androidx.media3.exoplayer.ExoPlaybackException

If an error occurs.

Protected functions

onDisabled

protected fun onDisabled(): Unit

Called when the renderer is disabled.

The default implementation is a no-op.

onPositionReset

protected fun onPositionReset(positionUs: Long, joining: Boolean): Unit

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
positionUs: Long

The new playback position in microseconds.

joining: Boolean

Whether this renderer is being enabled to join an ongoing playback.

Throws
androidx.media3.exoplayer.ExoPlaybackException: androidx.media3.exoplayer.ExoPlaybackException

If an error occurs.

onStreamChanged

protected fun onStreamChanged(
    formats: Array<Format!>!,
    startPositionUs: Long,
    offsetUs: Long
): Unit

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
formats: Array<Format!>!

The enabled formats.

startPositionUs: Long

The start position of the new stream in renderer time (microseconds).

offsetUs: Long

The offset that will be added to the timestamps of buffers read via readSource so that decoder input buffers have monotonically increasing timestamps.

Throws
androidx.media3.exoplayer.ExoPlaybackException: androidx.media3.exoplayer.ExoPlaybackException

If an error occurs.