BaseRenderer

public long readingPositionUs

public int state

public @Nullable SampleStream stream

@C.TrackType
public final int trackType

@MonotonicNonNull
protected @MonotonicNonNull Clock clock

protected @Nullable RendererConfiguration configuration

protected final FormatHolder formatHolder

protected int index

protected long lastResetPositionUs

@MonotonicNonNull
protected @MonotonicNonNull PlayerId playerId

protected @Nullable Format[] streamFormats

protected Timeline timeline

public BaseRenderer(@C.TrackType int trackType)

public final void clearListener()

Clears the Listener.

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

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

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

public final RendererCapabilities getCapabilities()

Returns the capabilities of the renderer.

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.

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

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

public final int getState()

Returns the current state of the renderer.

public final @Nullable SampleStream getStream()

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

@C.TrackType
public final int getTrackType()

Returns the track type that the renderer handles.

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

Handles a message delivered to the target.

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

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

Initializes the renderer for playback with a player.

public final boolean isCurrentStreamFinal()

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

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

public final void release()

Releases the renderer.

The renderer must not be used after calling this method.

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

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

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

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

public final void setListener(RendererCapabilities.Listener listener)

Sets the Listener.

public final void setTimeline(Timeline timeline)

Sets the timeline that is currently being played.

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

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

@RendererCapabilities.AdaptiveSupport
public int supportsMixedMimeTypeAdaptation()

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

protected final ExoPlaybackException createRendererException(
    Throwable cause,
    @Nullable Format format,
    @PlaybackException.ErrorCode int errorCode
)

Creates an ExoPlaybackException of type TYPE_RENDERER for this renderer.

protected final ExoPlaybackException createRendererException(
    Throwable cause,
    @Nullable Format format,
    boolean isRecoverable,
    @PlaybackException.ErrorCode int errorCode
)

Creates an ExoPlaybackException of type TYPE_RENDERER for this renderer.

protected final Clock getClock()

Returns the Clock.

Must only be used after the renderer has been initialized by the player.

protected final RendererConfiguration getConfiguration()

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

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

protected final FormatHolder getFormatHolder()

Returns a clear FormatHolder.

protected final int getIndex()

Returns the index of the renderer within the player.

Must only be used after the renderer has been initialized by the player.

protected final long getLastResetPositionUs()

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

protected final PlayerId getPlayerId()

Returns the PlayerId of the player using this renderer.

Must only be used after the renderer has been initialized by the player.

protected final Format[] getStreamFormats()

Returns the formats of the currently enabled stream.

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

protected final Timeline getTimeline()

Returns the current Timeline containing the rendered stream.

protected final boolean isSourceReady()

Returns whether the upstream source is ready.

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

protected void onDisabled()

Called when the renderer is disabled.

The default implementation is a no-op.

protected void onEnabled(boolean joining, boolean mayRenderStartOfStream)

Called when the renderer is enabled.

The default implementation is a no-op.

protected void onInit()

Called when the renderer is initialized.

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.

protected void onRelease()

Called when the renderer is released.

The default implementation is a no-op.

protected final void onRendererCapabilitiesChanged()

Called when the renderer capabilities are changed.

protected void onReset()

Called when the renderer is reset.

The default implementation is a no-op.

protected void onStarted()

Called when the renderer is started.

The default implementation is a no-op.

protected void onStopped()

Called when the renderer is stopped.

The default implementation is a no-op.

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.

protected void onTimelineChanged(Timeline timeline)

Called when a new timeline is set.

The default implementation is a no-op.

@SampleStream.ReadDataResult
protected final int readSource(
    FormatHolder formatHolder,
    DecoderInputBuffer buffer,
    @SampleStream.ReadFlags int readFlags
)

Reads from the enabled upstream source. If the upstream source has been read to the end then RESULT_BUFFER_READ is only returned if setCurrentStreamFinal has been called. RESULT_NOTHING_READ is returned otherwise.

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

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

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