ForwardingRenderer

ForwardingRenderer(renderer: Renderer!)

Creates a new instance that forwards all operations to renderer.

fun disable(): Unit

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.

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

Enables the renderer to consume from the specified SampleStream.

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

fun enableMayRenderStartOfStream(): Unit

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.

fun getCapabilities(): RendererCapabilities!

Returns the capabilities of the renderer.

fun getDurationToProgressUs(positionUs: Long, elapsedRealtimeUs: Long): Long

Returns minimum amount of playback clock time that must pass in order for the render call to make progress.

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

The default return time is DEFAULT_DURATION_TO_PROGRESS_US if the renderer is in STATE_STARTED, or in STATE_ENABLED and not yet ready or ended. Otherwise, it returns DEFAULT_IDLE_DURATION_TO_PROGRESS_US.

fun getMediaClock(): MediaClock?

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 MediaClock from this method.

fun getName(): String!

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

fun getReadingPositionUs(): 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.

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

@Renderer.State
fun getState(): Int

Returns the current state of the renderer.

fun getStream(): SampleStream?

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

@C.TrackType
fun getTrackType(): Int

Returns the track type that the renderer handles.

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

Handles a message delivered to the target.

fun hasReadStreamToEnd(): Boolean

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.

fun init(index: Int, playerId: PlayerId!, clock: Clock!): Unit

Initializes the renderer for playback with a player.

fun isCurrentStreamFinal(): Boolean

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

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.

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.

fun maybeThrowStreamError(): Unit

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.

fun release(): Unit

Releases the renderer.

The renderer must not be used after calling this method.

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.

fun replaceStream(
    formats: Array<Format!>!,
    stream: SampleStream!,
    startPositionUs: Long,
    offsetUs: Long,
    mediaPeriodId: MediaSource.MediaPeriodId!
): Unit

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.

fun reset(): Unit

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.

fun resetPosition(positionUs: Long, sampleStreamIsResetToKeyFrame: Boolean): Unit

Signals to the renderer that a position discontinuity has occurred.

If sampleStreamIsResetToKeyFrame is true then after the position discontinuity, the renderer's SampleStream is guaranteed to provide samples starting from a key frame.

sampleStreamIsResetToKeyFrame is guaranteed to be true unless the implementation overrides supportsResetPositionWithoutKeyFrameReset to return true.

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

fun setCurrentStreamFinal(): Unit

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.

fun setPlaybackSpeed(currentPlaybackSpeed: Float, targetPlaybackSpeed: Float): Unit

Indicates the playback speed to this renderer.

The default implementation is a no-op.

fun setTimeline(timeline: Timeline!): Unit

Sets the timeline that is currently being played.

fun start(): Unit

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.

fun stop(): Unit

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.

fun supportsResetPositionWithoutKeyFrameReset(positionUs: Long): Boolean

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