ForwardingRenderer


@UnstableApi
public class ForwardingRenderer implements Renderer


An overridable Renderer implementation forwarding all methods to another renderer.

Summary

Public constructors

Creates a new instance that forwards all operations to renderer.

Public methods

void

Disable the renderer, transitioning it to the STATE_DISABLED state.

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

Enables this renderer to render the start of the stream even if the state is not STATE_STARTED yet.

RendererCapabilities

Returns the capabilities of the renderer.

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.

@Nullable MediaClock

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

String

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

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.

@Nullable SampleStream

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

int

Returns the track type that the renderer handles.

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

Handles a message delivered to the target.

boolean

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

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

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

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.

void

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

void

Releases the renderer.

void
render(long positionUs, long elapsedRealtimeUs)

Incrementally renders the SampleStream.

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

Replaces the SampleStream from which samples will be consumed.

void

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

void
resetPosition(long positionUs)

Signals to the renderer that a position discontinuity has occurred.

void

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

void
setPlaybackSpeed(float currentPlaybackSpeed, float targetPlaybackSpeed)

Indicates the playback speed to this renderer.

void

Sets the timeline that is currently being played.

void

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

void

Stops the renderer, transitioning it to the STATE_ENABLED state.

Inherited Constants

From androidx.media3.exoplayer.Renderer
static final long

Default minimum duration that the playback clock must advance before render can make progress.

static final int

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

static final int

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

static final int

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

static final int

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

static final int

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

static final int

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

static final int

The type of message that can be passed to an image renderer to set a desired image output.

static final int

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

static final int

The type of message that can be passed to a renderer to set its priority.

static final int

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

static final int

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

static final int

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

static final int

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

static final int

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

static final int

The type of a message that can be passed to a video renderer to set the desired output resolution.

static final int

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

static final 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.

static final int

The renderer is disabled.

static final int

The renderer is enabled but not started.

static final int

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 STATE_DISABLED state.

This method may be called when the renderer is in the following states: 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 SampleStream.

This method may be called when the renderer is in the following states: STATE_DISABLED.

Parameters
RendererConfiguration configuration

The renderer configuration.

Format[] formats

The enabled formats.

SampleStream stream

The 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 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.

MediaSource.MediaPeriodId mediaPeriodId

The MediaPeriodId of the MediaPeriod producing the stream.

enableMayRenderStartOfStream

public void enableMayRenderStartOfStream()

Enables this renderer to render the start of the stream even if the state is not STATE_STARTED yet.

This is used to update the value of mayRenderStartOfStream passed to enable.

getCapabilities

public RendererCapabilities getCapabilities()

Returns the capabilities of the renderer.

Returns
RendererCapabilities

The capabilities of the renderer.

getDurationToProgressUs

public 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.

The default return time is DEFAULT_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

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 MediaClock. If provided, the player will use the returned MediaClock as its source of time during playback. A player may have at most one renderer that returns a from this method.

Returns
@Nullable MediaClock

The 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
String

The name of this renderer.

getReadingPositionUs

public 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.

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

getState

@Renderer.State
public int getState()

Returns the current state of the renderer.

Returns
int

The current state. One of STATE_DISABLED, STATE_ENABLED and STATE_STARTED.

getStream

public @Nullable SampleStream getStream()

Returns the 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 track type.

See also
getRendererType

handleMessage

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

Handles a message delivered to the target.

Parameters
@Renderer.MessageType int messageType

The message type.

@Nullable Object message

The message payload.

Throws
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 SampleStream to the end.

This method may be called when the renderer is in the following states: STATE_ENABLED, 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.

PlayerId playerId

The PlayerId of the player.

Clock clock

The Clock.

isCurrentStreamFinal

public boolean isCurrentStreamFinal()

Returns whether the current 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 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.

maybeThrowStreamError

public void maybeThrowStreamError()

Throws an error that's preventing the renderer from reading from its SampleStream. Does nothing if no such error exists.

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

Throws
java.io.IOException

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 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.

replaceStream

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

Replaces the SampleStream from which samples will be consumed.

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

Parameters
Format[] formats

The enabled formats.

SampleStream stream

The 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.

MediaSource.MediaPeriodId mediaPeriodId

The MediaPeriodId of the MediaPeriod producing the stream.

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: STATE_DISABLED.

resetPosition

public void resetPosition(long positionUs)

Signals to the renderer that a position discontinuity has occurred.

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

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

Parameters
long positionUs

The new playback position in microseconds.

Throws
androidx.media3.exoplayer.ExoPlaybackException

If an error occurs handling the reset.

setCurrentStreamFinal

public void setCurrentStreamFinal()

Signals to the renderer that the current 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: STATE_ENABLED, 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
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 render will cause media to be rendered.

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

stop

public void stop()

Stops the renderer, transitioning it to the STATE_ENABLED state.

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