# ForwardingRenderer

Artifact: [androidx.media3:media3-exoplayer](https://developer.android.com/jetpack/androidx/releases/media3) [View Source](https://cs.android.com/search?q=file:androidx/media3/exoplayer/ForwardingRenderer.java+class:androidx.media3.exoplayer.ForwardingRenderer)

*** ** * ** ***


```
@UnstableApi
public class ForwardingRenderer implements Renderer
```

<br />

*** ** * ** ***

An overridable `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer` implementation forwarding all methods to another renderer.

## Summary

| ### Public constructors |
|---|
| `https://developer.android.com/reference/androidx/media3/exoplayer/ForwardingRenderer#ForwardingRenderer(androidx.media3.exoplayer.Renderer)(https://developer.android.com/reference/androidx/media3/exoplayer/Renderer renderer)` Creates a new instance that forwards all operations to `renderer`. |

| ### Public methods |
|---|---|
| `void` | `https://developer.android.com/reference/androidx/media3/exoplayer/ForwardingRenderer#disable()()` Disable the renderer, transitioning it to the `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#STATE_DISABLED()` state. |
| `void` | `https://developer.android.com/reference/androidx/media3/exoplayer/ForwardingRenderer#enable(androidx.media3.exoplayer.RendererConfiguration,androidx.media3.common.Format[],androidx.media3.exoplayer.source.SampleStream,long,boolean,boolean,long,long,androidx.media3.exoplayer.source.MediaSource.MediaPeriodId)( https://developer.android.com/reference/androidx/media3/exoplayer/RendererConfiguration configuration, Format[] formats, https://developer.android.com/reference/androidx/media3/exoplayer/source/SampleStream stream, long positionUs, boolean joining, boolean mayRenderStartOfStream, long startPositionUs, long offsetUs, https://developer.android.com/reference/androidx/media3/exoplayer/source/MediaSource.MediaPeriodId mediaPeriodId )` Enables the renderer to consume from the specified `https://developer.android.com/reference/androidx/media3/exoplayer/source/SampleStream`. |
| `void` | `https://developer.android.com/reference/androidx/media3/exoplayer/ForwardingRenderer#enableMayRenderStartOfStream()()` Enables this renderer to render the start of the stream even if the state is not `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#STATE_STARTED()` yet. |
| `https://developer.android.com/reference/androidx/media3/exoplayer/RendererCapabilities` | `https://developer.android.com/reference/androidx/media3/exoplayer/ForwardingRenderer#getCapabilities()()` Returns the capabilities of the renderer. |
| `long` | `https://developer.android.com/reference/androidx/media3/exoplayer/ForwardingRenderer#getDurationToProgressUs(long,long)(long positionUs, long elapsedRealtimeUs)` Returns minimum amount of playback clock time that must pass from `elapsedRealtimeUs` in order for the `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#render(long,long)` call to make progress. |
| `@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/androidx/media3/exoplayer/MediaClock` | `https://developer.android.com/reference/androidx/media3/exoplayer/ForwardingRenderer#getMediaClock()()` If the renderer advances its own playback position then this method returns a corresponding `https://developer.android.com/reference/androidx/media3/exoplayer/MediaClock`. |
| `https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/media3/exoplayer/ForwardingRenderer#getName()()` Returns the name of this renderer, for logging and debugging purposes. |
| `long` | `https://developer.android.com/reference/androidx/media3/exoplayer/ForwardingRenderer#getReadingPositionUs()()` Returns the renderer time up to which the renderer has read samples, in microseconds, or `https://developer.android.com/reference/androidx/media3/common/C#TIME_END_OF_SOURCE()` if the renderer has read the current `https://developer.android.com/reference/androidx/media3/exoplayer/source/SampleStream` to the end. |
| `int` | `@https://developer.android.com/reference/androidx/media3/exoplayer/Renderer.State https://developer.android.com/reference/androidx/media3/exoplayer/ForwardingRenderer#getState()()` Returns the current state of the renderer. |
| `@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/androidx/media3/exoplayer/source/SampleStream` | `https://developer.android.com/reference/androidx/media3/exoplayer/ForwardingRenderer#getStream()()` Returns the `https://developer.android.com/reference/androidx/media3/exoplayer/source/SampleStream` being consumed, or null if the renderer is disabled. |
| `int` | `@https://developer.android.com/reference/androidx/media3/common/C.TrackType https://developer.android.com/reference/androidx/media3/exoplayer/ForwardingRenderer#getTrackType()()` Returns the track type that the renderer handles. |
| `void` | `https://developer.android.com/reference/androidx/media3/exoplayer/ForwardingRenderer#handleMessage(int,java.lang.Object)( @https://developer.android.com/reference/androidx/media3/exoplayer/Renderer.MessageType int messageType, @https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/java/lang/Object.html message )` Handles a message delivered to the target. |
| `boolean` | `https://developer.android.com/reference/androidx/media3/exoplayer/ForwardingRenderer#hasReadStreamToEnd()()` Returns whether the renderer has read the current `https://developer.android.com/reference/androidx/media3/exoplayer/source/SampleStream` to the end. |
| `void` | `https://developer.android.com/reference/androidx/media3/exoplayer/ForwardingRenderer#init(int,androidx.media3.exoplayer.analytics.PlayerId,androidx.media3.common.util.Clock)(int index, https://developer.android.com/reference/androidx/media3/exoplayer/analytics/PlayerId playerId, https://developer.android.com/reference/androidx/media3/common/util/Clock clock)` Initializes the renderer for playback with a player. |
| `boolean` | `https://developer.android.com/reference/androidx/media3/exoplayer/ForwardingRenderer#isCurrentStreamFinal()()` Returns whether the current `https://developer.android.com/reference/androidx/media3/exoplayer/source/SampleStream` will be the final one supplied before the renderer is next disabled or reset. |
| `boolean` | `https://developer.android.com/reference/androidx/media3/exoplayer/ForwardingRenderer#isEnded()()` Whether the renderer is ready for the `https://developer.android.com/reference/androidx/media3/exoplayer/ExoPlayer` instance to transition to `https://developer.android.com/reference/androidx/media3/common/Player#STATE_ENDED()`. |
| `boolean` | `https://developer.android.com/reference/androidx/media3/exoplayer/ForwardingRenderer#isReady()()` Whether the renderer is able to immediately render media from the current position. |
| `void` | `https://developer.android.com/reference/androidx/media3/exoplayer/ForwardingRenderer#maybeThrowStreamError()()` Throws an error that's preventing the renderer from reading from its `https://developer.android.com/reference/androidx/media3/exoplayer/source/SampleStream`. |
| `void` | `https://developer.android.com/reference/androidx/media3/exoplayer/ForwardingRenderer#release()()` Releases the renderer. |
| `void` | `https://developer.android.com/reference/androidx/media3/exoplayer/ForwardingRenderer#render(long,long)(long positionUs, long elapsedRealtimeUs)` Incrementally renders the `https://developer.android.com/reference/androidx/media3/exoplayer/source/SampleStream`. |
| `void` | `https://developer.android.com/reference/androidx/media3/exoplayer/ForwardingRenderer#replaceStream(androidx.media3.common.Format[],androidx.media3.exoplayer.source.SampleStream,long,long,androidx.media3.exoplayer.source.MediaSource.MediaPeriodId)( Format[] formats, https://developer.android.com/reference/androidx/media3/exoplayer/source/SampleStream stream, long startPositionUs, long offsetUs, https://developer.android.com/reference/androidx/media3/exoplayer/source/MediaSource.MediaPeriodId mediaPeriodId )` Replaces the `https://developer.android.com/reference/androidx/media3/exoplayer/source/SampleStream` from which samples will be consumed. |
| `void` | `https://developer.android.com/reference/androidx/media3/exoplayer/ForwardingRenderer#reset()()` Forces the renderer to give up any resources (e.g. media decoders) that it may be holding. |
| `void` | `https://developer.android.com/reference/androidx/media3/exoplayer/ForwardingRenderer#resetPosition(long,boolean)(long positionUs, boolean sampleStreamIsResetToKeyFrame)` Signals to the renderer that a position discontinuity has occurred. |
| `void` | `https://developer.android.com/reference/androidx/media3/exoplayer/ForwardingRenderer#setCurrentStreamFinal()()` Signals to the renderer that the current `https://developer.android.com/reference/androidx/media3/exoplayer/source/SampleStream` will be the final one supplied before it is next disabled or reset. |
| `void` | `https://developer.android.com/reference/androidx/media3/exoplayer/ForwardingRenderer#setPlaybackSpeed(float,float)(float currentPlaybackSpeed, float targetPlaybackSpeed)` Indicates the playback speed to this renderer. |
| `void` | `https://developer.android.com/reference/androidx/media3/exoplayer/ForwardingRenderer#setTimeline(androidx.media3.common.Timeline)(https://developer.android.com/reference/androidx/media3/common/Timeline timeline)` Sets the timeline that is currently being played. |
| `void` | `https://developer.android.com/reference/androidx/media3/exoplayer/ForwardingRenderer#start()()` Starts the renderer, meaning that calls to `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#render(long,long)` will cause media to be rendered. |
| `void` | `https://developer.android.com/reference/androidx/media3/exoplayer/ForwardingRenderer#stop()()` Stops the renderer, transitioning it to the `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#STATE_ENABLED()` state. |
| `boolean` | `https://developer.android.com/reference/androidx/media3/exoplayer/ForwardingRenderer#supportsResetPositionWithoutKeyFrameReset(long)(long positionUs)` Returns whether the renderer can support processing a position discontinuity without a key frame reset. |

| ### Inherited Constants |
|---|
| From [androidx.media3.exoplayer.Renderer](https://developer.android.com/reference/androidx/media3/exoplayer/Renderer) |---|---| | `static final long` | `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#DEFAULT_DURATION_TO_PROGRESS_US() = 10000` Default minimum duration that the playback clock must advance before `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#render(long,long)` can make progress. | | `static final long` | `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#DEFAULT_IDLE_DURATION_TO_PROGRESS_US() = 1000000` Default duration to progress reported if the renderer does not need calls to `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#render(long,long)` to progress, if it's in `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#STATE_ENABLED()` and already `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#isReady()` or `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#isEnded()`. | | `static final int` | `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#MSG_CUSTOM_BASE() = 10000` Applications or extensions may define custom `MSG_*` constants that can be passed to renderers. | | `static final int` | `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#MSG_SET_AUDIO_ATTRIBUTES() = 3` A type of a message that can be passed to an audio renderer via `https://developer.android.com/reference/androidx/media3/exoplayer/ExoPlayer#createMessage(androidx.media3.exoplayer.PlayerMessage.Target)`. | | `static final int` | `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#MSG_SET_AUDIO_OUTPUT_PROVIDER() = 20` The type of a message that can be passed to audio renderers via `https://developer.android.com/reference/androidx/media3/exoplayer/ExoPlayer#createMessage(androidx.media3.exoplayer.PlayerMessage.Target)`. | | `static final int` | `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#MSG_SET_AUDIO_SESSION_ID() = 10` The type of a message that can be passed to audio and video renderers via `https://developer.android.com/reference/androidx/media3/exoplayer/ExoPlayer#createMessage(androidx.media3.exoplayer.PlayerMessage.Target)`. | | `static final int` | `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#MSG_SET_AUX_EFFECT_INFO() = 6` A type of a message that can be passed to an audio renderer via `https://developer.android.com/reference/androidx/media3/exoplayer/ExoPlayer#createMessage(androidx.media3.exoplayer.PlayerMessage.Target)`. | | `static final int` | `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#MSG_SET_CAMERA_MOTION_LISTENER() = 8` The type of a message that can be passed to a camera motion renderer via `https://developer.android.com/reference/androidx/media3/exoplayer/ExoPlayer#createMessage(androidx.media3.exoplayer.PlayerMessage.Target)`. | | `static final int` | `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#MSG_SET_CHANGE_FRAME_RATE_STRATEGY() = 5` The type of a message that can be passed to a video renderer via `https://developer.android.com/reference/androidx/media3/exoplayer/ExoPlayer#createMessage(androidx.media3.exoplayer.PlayerMessage.Target)`. | | `static final int` | `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#MSG_SET_CODEC_PARAMETERS() = 21` The type of a message that can be passed to renderers via `https://developer.android.com/reference/androidx/media3/exoplayer/ExoPlayer#createMessage(androidx.media3.exoplayer.PlayerMessage.Target)`. | | `static final int` | `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#MSG_SET_IMAGE_METADATA_LISTENER() = 23` The type of a message that can be passed to an image renderer via `https://developer.android.com/reference/androidx/media3/exoplayer/ExoPlayer#createMessage(androidx.media3.exoplayer.PlayerMessage.Target)`. | | `static final int` | `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#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` | `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#MSG_SET_PREFERRED_AUDIO_DEVICE() = 12` The type of a message that can be passed to audio renderers via `https://developer.android.com/reference/androidx/media3/exoplayer/ExoPlayer#createMessage(androidx.media3.exoplayer.PlayerMessage.Target)`. | | `static final int` | `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#MSG_SET_PRIORITY() = 16` The type of message that can be passed to a renderer to set its priority. | | `static final int` | `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#MSG_SET_SCALING_MODE() = 4` The type of a message that can be passed to a `https://developer.android.com/reference/android/media/MediaCodec.html`-based video renderer via `https://developer.android.com/reference/androidx/media3/exoplayer/ExoPlayer#createMessage(androidx.media3.exoplayer.PlayerMessage.Target)`. | | `static final int` | `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#MSG_SET_SCRUBBING_MODE() = 18` The type of message that can be passed to a renderer to direct it to enable or disable scrubbing mode. | | `static final int` | `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#MSG_SET_SKIP_SILENCE_ENABLED() = 9` The type of a message that can be passed to an audio renderer via `https://developer.android.com/reference/androidx/media3/exoplayer/ExoPlayer#createMessage(androidx.media3.exoplayer.PlayerMessage.Target)`. | | `static final int` | `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#MSG_SET_SUBSCRIBED_CODEC_PARAMETER_KEYS() = 22` A message to set the keys for which a renderer should report parameter changes. | | `static final int` | `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#MSG_SET_VIDEO_EFFECTS() = 13` The type of a message that can be passed to a video renderer. | | `static final int` | `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#MSG_SET_VIDEO_FRAME_METADATA_LISTENER() = 7` The type of a message that can be passed to a video renderer via `https://developer.android.com/reference/androidx/media3/exoplayer/ExoPlayer#createMessage(androidx.media3.exoplayer.PlayerMessage.Target)`. | | `static final int` | `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#MSG_SET_VIDEO_OUTPUT() = 1` The type of a message that can be passed to a video renderer via `https://developer.android.com/reference/androidx/media3/exoplayer/ExoPlayer#createMessage(androidx.media3.exoplayer.PlayerMessage.Target)`. | | `static final int` | `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#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` | `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#MSG_SET_VIRTUAL_DEVICE_ID() = 19` The type of a message that can be passed to audio renderers via `https://developer.android.com/reference/androidx/media3/exoplayer/ExoPlayer#createMessage(androidx.media3.exoplayer.PlayerMessage.Target)`. | | `static final int` | `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#MSG_SET_VOLUME() = 2` A type of a message that can be passed to an audio renderer via `https://developer.android.com/reference/androidx/media3/exoplayer/ExoPlayer#createMessage(androidx.media3.exoplayer.PlayerMessage.Target)`. | | `static final int` | `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#MSG_SET_WAKEUP_LISTENER() = 11` The type of a message that can be passed to a `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer` via `https://developer.android.com/reference/androidx/media3/exoplayer/ExoPlayer#createMessage(androidx.media3.exoplayer.PlayerMessage.Target)`, to inform the renderer that it can schedule waking up another component. | | `static final int` | `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#MSG_TRANSFER_RESOURCES() = 17` The type of message that can be passed to a renderer to direct it to transfer relevant resources to another renderer. | | `static final int` | `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#STATE_DISABLED() = 0` The renderer is disabled. | | `static final int` | `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#STATE_ENABLED() = 1` The renderer is enabled but not started. | | `static final int` | `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#STATE_STARTED() = 2` The renderer is started. | |

## Public constructors

### ForwardingRenderer

```
public ForwardingRenderer(Renderer renderer)
```

Creates a new instance that forwards all operations to `renderer`.

## Public methods

### disable

```
public void disable()
```

Disable the renderer, transitioning it to the `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#STATE_DISABLED()` state.

This method may be called when the renderer is in the following states: `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#STATE_ENABLED()`.

### enable

```
public 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 `https://developer.android.com/reference/androidx/media3/exoplayer/source/SampleStream`.

This method may be called when the renderer is in the following states: `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#STATE_DISABLED()`.

| Parameters |
|---|---|
| `https://developer.android.com/reference/androidx/media3/exoplayer/RendererConfiguration configuration` | The renderer configuration. |
| `Format[] formats` | The enabled formats. |
| `https://developer.android.com/reference/androidx/media3/exoplayer/source/SampleStream stream` | The `https://developer.android.com/reference/androidx/media3/exoplayer/source/SampleStream` from which the renderer should consume. |
| `long positionUs` | The player's current position. |
| `boolean joining` | Whether this renderer is being enabled to join an ongoing playback. |
| `boolean mayRenderStartOfStream` | Whether this renderer is allowed to render the start of the stream even if the state is not `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#STATE_STARTED()` yet. |
| `long startPositionUs` | The start position of the stream in renderer time (microseconds). |
| `long offsetUs` | The offset to be added to timestamps of buffers read from `stream` before they are rendered. |
| `https://developer.android.com/reference/androidx/media3/exoplayer/source/MediaSource.MediaPeriodId mediaPeriodId` | The `https://developer.android.com/reference/androidx/media3/exoplayer/source/MediaSource.MediaPeriodId` of the `https://developer.android.com/reference/androidx/media3/exoplayer/source/MediaPeriod` producing the ` stream`. |

| Throws |
|---|---|
| `https://developer.android.com/reference/androidx/media3/exoplayer/ExoPlaybackException` | If an error occurs. |

### enableMayRenderStartOfStream

```
public void enableMayRenderStartOfStream()
```

Enables this renderer to render the start of the stream even if the state is not `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#STATE_STARTED()` yet.

This is used to update the value of `mayRenderStartOfStream` passed to `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#enable(androidx.media3.exoplayer.RendererConfiguration,androidx.media3.common.Format[],androidx.media3.exoplayer.source.SampleStream,long,boolean,boolean,long,long,androidx.media3.exoplayer.source.MediaSource.MediaPeriodId)`.

### getCapabilities

```
public RendererCapabilities getCapabilities()
```

Returns the capabilities of the renderer.

| Returns |
|---|---|
| `https://developer.android.com/reference/androidx/media3/exoplayer/RendererCapabilities` | The capabilities of the renderer. |

### getDurationToProgressUs

```
public long getDurationToProgressUs(long positionUs, long elapsedRealtimeUs)
```

Returns minimum amount of playback clock time that must pass from `elapsedRealtimeUs` in order for the `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#render(long,long)` call to make progress.

This method may be called when the renderer is in the following states: `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#STATE_ENABLED()`, `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#STATE_STARTED()`.

The default return time is `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#DEFAULT_DURATION_TO_PROGRESS_US()` if the renderer is in `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#STATE_STARTED()`, or in `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#STATE_ENABLED()` and not yet `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#isReady()` or `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#isEnded()`. Otherwise, it returns `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#DEFAULT_IDLE_DURATION_TO_PROGRESS_US()`.

| Parameters |
|---|---|
| `long positionUs` | The current render position in microseconds, measured at the start of the current iteration of the rendering loop. |
| `long elapsedRealtimeUs` | `https://developer.android.com/reference/android/os/SystemClock.html#elapsedRealtime()` in microseconds, measured at the start of the current iteration of the rendering loop. |

| Returns |
|---|---|
| `long` | Minimum amount of playback clock time that must pass before renderer is able to make progress. |

### getMediaClock

```
public @Nullable MediaClock getMediaClock()
```

If the renderer advances its own playback position then this method returns a corresponding `https://developer.android.com/reference/androidx/media3/exoplayer/MediaClock`. If provided, the player will use the returned `https://developer.android.com/reference/androidx/media3/exoplayer/MediaClock` as its source of time during playback. A player may have at most one renderer that returns a `https://developer.android.com/reference/androidx/media3/exoplayer/MediaClock` from this method.

| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/androidx/media3/exoplayer/MediaClock` | The `https://developer.android.com/reference/androidx/media3/exoplayer/MediaClock` tracking the playback position of the renderer, or null. |

### 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 |
|---|---|
| `https://developer.android.com/reference/java/lang/String.html` | The name of this renderer. |

### getReadingPositionUs

```
public long getReadingPositionUs()
```

Returns the renderer time up to which the renderer has read samples, in microseconds, or `https://developer.android.com/reference/androidx/media3/common/C#TIME_END_OF_SOURCE()` if the renderer has read the current `https://developer.android.com/reference/androidx/media3/exoplayer/source/SampleStream` to the end.

This method may be called when the renderer is in the following states: `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#STATE_ENABLED()`, `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#STATE_STARTED()`.

### getState

```
@Renderer.State
public int getState()
```

Returns the current state of the renderer.

| Returns |
|---|---|
| `int` | The current state. One of `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#STATE_DISABLED()`, `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#STATE_ENABLED()` and `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#STATE_STARTED()`. |

### getStream

```
public @Nullable SampleStream getStream()
```

Returns the `https://developer.android.com/reference/androidx/media3/exoplayer/source/SampleStream` being consumed, or null if the renderer is disabled.

### getTrackType

```
@C.TrackType
public int getTrackType()
```

Returns the track type that the renderer handles.

| Returns |
|---|---|
| `int` | The `https://developer.android.com/reference/androidx/media3/common/C.TrackType`. |

| See also |
|---|---|
| `https://developer.android.com/reference/androidx/media3/exoplayer/ExoPlayer#getRendererType(int)` |   |

### handleMessage

```
public void handleMessage(
    @Renderer.MessageType int messageType,
    @Nullable Object message
)
```

Handles a message delivered to the target.

| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/media3/exoplayer/Renderer.MessageType int messageType` | The message type. |
| `@https://developer.android.com/reference/androidx/annotation/Nullable https://developer.android.com/reference/java/lang/Object.html message` | The message payload. |

| Throws |
|---|---|
| `https://developer.android.com/reference/androidx/media3/exoplayer/ExoPlaybackException` | If an error occurred whilst handling the message. Should only be thrown by targets that handle messages on the playback thread. |

### hasReadStreamToEnd

```
public boolean hasReadStreamToEnd()
```

Returns whether the renderer has read the current `https://developer.android.com/reference/androidx/media3/exoplayer/source/SampleStream` to the end.

This method may be called when the renderer is in the following states: `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#STATE_ENABLED()`, `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#STATE_STARTED()`.

### init

```
public void init(int index, PlayerId playerId, Clock clock)
```

Initializes the renderer for playback with a player.

| Parameters |
|---|---|
| `int index` | The renderer index within the player. |
| `https://developer.android.com/reference/androidx/media3/exoplayer/analytics/PlayerId playerId` | The `https://developer.android.com/reference/androidx/media3/exoplayer/analytics/PlayerId` of the player. |
| `https://developer.android.com/reference/androidx/media3/common/util/Clock clock` | The `https://developer.android.com/reference/androidx/media3/common/util/Clock`. |

### isCurrentStreamFinal

```
public boolean isCurrentStreamFinal()
```

Returns whether the current `https://developer.android.com/reference/androidx/media3/exoplayer/source/SampleStream` will be the final one supplied before the renderer is next disabled or reset.

### isEnded

```
public boolean isEnded()
```

Whether the renderer is ready for the `https://developer.android.com/reference/androidx/media3/exoplayer/ExoPlayer` instance to transition to `https://developer.android.com/reference/androidx/media3/common/Player#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: `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#STATE_ENABLED()`, `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#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 `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#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 `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#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: `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#STATE_ENABLED()`, `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#STATE_STARTED()`.

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

### maybeThrowStreamError

```
public void maybeThrowStreamError()
```

Throws an error that's preventing the renderer from reading from its `https://developer.android.com/reference/androidx/media3/exoplayer/source/SampleStream`. Does nothing if no such error exists.

This method may be called when the renderer is in the following states: `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#STATE_ENABLED()`, `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#STATE_STARTED()`.

| Throws |
|---|---|
| `https://developer.android.com/reference/java/io/IOException.html` | An error that's preventing the renderer from making progress or buffering more data. |

### release

```
public void release()
```

Releases the renderer.

The renderer must not be used after calling this method.

### render

```
public void render(long positionUs, long elapsedRealtimeUs)
```

Incrementally renders the `https://developer.android.com/reference/androidx/media3/exoplayer/source/SampleStream`.

If the renderer is in the `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#STATE_ENABLED()` state then each call to this method will do work toward being ready to render the `https://developer.android.com/reference/androidx/media3/exoplayer/source/SampleStream` when the renderer is started. If the renderer is in the `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#STATE_STARTED()` state then calls to this method will render the `https://developer.android.com/reference/androidx/media3/exoplayer/source/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 `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#STATE_ENABLED()` state, unless it's the initial start of the media after calling `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#enable(androidx.media3.exoplayer.RendererConfiguration,androidx.media3.common.Format[],androidx.media3.exoplayer.source.SampleStream,long,boolean,boolean,long,long,androidx.media3.exoplayer.source.MediaSource.MediaPeriodId)` 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: `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#STATE_ENABLED()`, `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#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` | `https://developer.android.com/reference/android/os/SystemClock.html#elapsedRealtime()` in microseconds, measured at the start of the current iteration of the rendering loop. |

| Throws |
|---|---|
| `https://developer.android.com/reference/androidx/media3/exoplayer/ExoPlaybackException` | If an error occurs. |

### replaceStream

```
public void replaceStream(
    Format[] formats,
    SampleStream stream,
    long startPositionUs,
    long offsetUs,
    MediaSource.MediaPeriodId mediaPeriodId
)
```

Replaces the `https://developer.android.com/reference/androidx/media3/exoplayer/source/SampleStream` from which samples will be consumed.

This method may be called when the renderer is in the following states: `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#STATE_ENABLED()`, `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#STATE_STARTED()`.

| Parameters |
|---|---|
| `Format[] formats` | The enabled formats. |
| `https://developer.android.com/reference/androidx/media3/exoplayer/source/SampleStream stream` | The `https://developer.android.com/reference/androidx/media3/exoplayer/source/SampleStream` from which the renderer should consume. |
| `long startPositionUs` | The start position of the new stream in renderer time (microseconds). |
| `long offsetUs` | The offset to be added to timestamps of buffers read from `stream` before they are rendered. |
| `https://developer.android.com/reference/androidx/media3/exoplayer/source/MediaSource.MediaPeriodId mediaPeriodId` | The `https://developer.android.com/reference/androidx/media3/exoplayer/source/MediaSource.MediaPeriodId` of the `https://developer.android.com/reference/androidx/media3/exoplayer/source/MediaPeriod` producing the ` stream`. |

| Throws |
|---|---|
| `https://developer.android.com/reference/androidx/media3/exoplayer/ExoPlaybackException` | If an error occurs. |

### reset

```
public void reset()
```

Forces the renderer to give up any resources (e.g. media decoders) that it may be holding. If the renderer is not holding any resources, the call is a no-op.

This method may be called when the renderer is in the following states: `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#STATE_DISABLED()`.

### resetPosition

```
public void resetPosition(long positionUs, boolean sampleStreamIsResetToKeyFrame)
```

Signals to the renderer that a position discontinuity has occurred.

If `sampleStreamIsResetToKeyFrame` is `true` then after the position discontinuity, the renderer's `https://developer.android.com/reference/androidx/media3/exoplayer/source/SampleStream` is guaranteed to provide samples starting from a key frame.

`sampleStreamIsResetToKeyFrame` is guaranteed to be `true` unless the implementation overrides `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#supportsResetPositionWithoutKeyFrameReset(long)` to return `true`.

This method may be called when the renderer is in the following states: `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#STATE_ENABLED()`, `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#STATE_STARTED()`.

| Parameters |
|---|---|
| `long positionUs` | The new playback position in microseconds. |
| `boolean sampleStreamIsResetToKeyFrame` | Whether the renderer's `https://developer.android.com/reference/androidx/media3/exoplayer/source/SampleStream` is guaranteed to provide samples starting from a key frame. |

| Throws |
|---|---|
| `https://developer.android.com/reference/androidx/media3/exoplayer/ExoPlaybackException` | If an error occurs handling the reset. |

### setCurrentStreamFinal

```
public void setCurrentStreamFinal()
```

Signals to the renderer that the current `https://developer.android.com/reference/androidx/media3/exoplayer/source/SampleStream` will be the final one supplied before it is next disabled or reset.

This method may be called when the renderer is in the following states: `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#STATE_ENABLED()`, `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#STATE_STARTED()`.

### setPlaybackSpeed

```
public void setPlaybackSpeed(float currentPlaybackSpeed, float targetPlaybackSpeed)
```

Indicates the playback speed to this renderer.

The default implementation is a no-op.

| Parameters |
|---|---|
| `float currentPlaybackSpeed` | The factor by which playback is currently sped up. |
| `float targetPlaybackSpeed` | The target factor by which playback should be sped up. This may be different from `currentPlaybackSpeed`, for example, if the speed is temporarily adjusted for live playback. |

| Throws |
|---|---|
| `https://developer.android.com/reference/androidx/media3/exoplayer/ExoPlaybackException` | If an error occurs handling the playback speed. |

### setTimeline

```
public void setTimeline(Timeline timeline)
```

Sets the timeline that is currently being played.

### start

```
public void start()
```

Starts the renderer, meaning that calls to `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#render(long,long)` will cause media to be rendered.

This method may be called when the renderer is in the following states: `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#STATE_ENABLED()`.

| Throws |
|---|---|
| `https://developer.android.com/reference/androidx/media3/exoplayer/ExoPlaybackException` | If an error occurs. |

### stop

```
public void stop()
```

Stops the renderer, transitioning it to the `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#STATE_ENABLED()` state.

This method may be called when the renderer is in the following states: `https://developer.android.com/reference/androidx/media3/exoplayer/Renderer#STATE_STARTED()`.

### supportsResetPositionWithoutKeyFrameReset

```
public boolean supportsResetPositionWithoutKeyFrameReset(long positionUs)
```

Returns whether the renderer can support processing a position discontinuity without a key frame reset.

| Parameters |
|---|---|
| `long positionUs` | The new playback position in microseconds. |

| Returns |
|---|---|
| `boolean` | Whether the renderer can support processing a position discontinuity without a key frame reset. |