com.google.android.exoplayer2

Class BaseRenderer

java.lang.Object

com.google.android.exoplayer2.BaseRenderer

All Implemented Interfaces:

ExoPlayer.ExoPlayerComponent, Renderer, RendererCapabilities

Direct Known Subclasses:

MediaCodecRenderer, MetadataRenderer, SimpleDecoderAudioRenderer, TextRenderer

public abstract class BaseRenderer
extends java.lang.Object
implements Renderer, RendererCapabilities

An abstract base class suitable for most Renderer implementations.

Field Summary

Fields inherited from interface com.google.android.exoplayer2.Renderer

STATE_DISABLED, STATE_ENABLED, STATE_STARTED

Fields inherited from interface com.google.android.exoplayer2.RendererCapabilities

ADAPTIVE_NOT_SEAMLESS, ADAPTIVE_NOT_SUPPORTED, ADAPTIVE_SEAMLESS, ADAPTIVE_SUPPORT_MASK, FORMAT_EXCEEDS_CAPABILITIES, FORMAT_HANDLED, FORMAT_SUPPORT_MASK, FORMAT_UNSUPPORTED_SUBTYPE, FORMAT_UNSUPPORTED_TYPE

Constructor Summary

Constructors

Constructor and Description
BaseRenderer(int trackType)

Method Summary

Modifier and Type	Method and Description
void	disable() Disable the renderer, transitioning it to the Renderer.STATE_DISABLED state.
void	enable(Format[] formats, SampleStream stream, long positionUs, boolean joining, long offsetUs) Enables the renderer to consume from the specified SampleStream.
RendererCapabilities	getCapabilities() Returns the capabilities of the renderer.
protected int	getIndex() Returns the index of the renderer within the player.
MediaClock	getMediaClock() If the renderer advances its own playback position then this method returns a corresponding MediaClock.
int	getState() Returns the current state of the renderer.
SampleStream	getStream() Returns the SampleStream being consumed, or null if the renderer is disabled.
int	getTrackType() Returns the track type that the Renderer handles.
void	handleMessage(int what, java.lang.Object object) Handles a message delivered to the component.
boolean	hasReadStreamToEnd() Returns whether the renderer has read the current SampleStream to the end.
protected boolean	isSourceReady() Returns whether the upstream source is ready.
void	maybeThrowStreamError() Throws an error that's preventing the renderer from reading from its SampleStream.
protected void	onDisabled() Called when the renderer is disabled.
protected void	onEnabled(boolean joining) Called when the renderer is enabled.
protected void	onPositionReset(long positionUs, boolean joining) Called when the position is reset.
protected void	onStarted() Called when the renderer is started.
protected void	onStopped() Called when the renderer is stopped.
protected void	onStreamChanged(Format[] formats) Called when the renderer's stream has changed.
protected int	readSource(FormatHolder formatHolder, DecoderInputBuffer buffer) Reads from the enabled upstream source.
void	replaceStream(Format[] formats, SampleStream stream, long offsetUs) Replaces the SampleStream from which samples will be consumed.
void	resetPosition(long positionUs) Signals to the renderer that a position discontinuity has occurred.
void	setCurrentStreamIsFinal() Signals to the renderer that the current SampleStream will be the final one supplied before it is next disabled or reset.
void	setIndex(int index) Sets the index of this renderer within the player.
protected void	skipToKeyframeBefore(long timeUs) Attempts to skip to the keyframe before the specified time.
void	start() Starts the renderer, meaning that calls to Renderer.render(long, long) will cause media to be rendered.
void	stop() Stops the renderer, transitioning it to the Renderer.STATE_ENABLED state.
int	supportsMixedMimeTypeAdaptation() Returns the extent to which the Renderer supports adapting between supported formats that have different mime types.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.google.android.exoplayer2.Renderer

isEnded, isReady, render

Methods inherited from interface com.google.android.exoplayer2.RendererCapabilities

supportsFormat

Constructor Detail

BaseRenderer

public BaseRenderer(int trackType)

Parameters:

trackType - The track type that the renderer handles. One of the C TRACK_TYPE_* constants.

Method Detail

getTrackType

public final int getTrackType()

Description copied from interface: Renderer

Returns the track type that the Renderer handles. For example, a video renderer will return C.TRACK_TYPE_VIDEO, an audio renderer will return C.TRACK_TYPE_AUDIO, a text renderer will return C.TRACK_TYPE_TEXT, and so on.

Specified by:

getTrackType in interface Renderer

Specified by:

getTrackType in interface RendererCapabilities

Returns:

One of the TRACK_TYPE_* constants defined in C.

See Also:

Renderer.getTrackType()

getCapabilities

public final RendererCapabilities getCapabilities()

Description copied from interface: Renderer

Returns the capabilities of the renderer.

Specified by:

getCapabilities in interface Renderer

Returns:

The capabilities of the renderer.

setIndex

public final void setIndex(int index)

Description copied from interface: Renderer

Sets the index of this renderer within the player.

Specified by:

setIndex in interface Renderer

Parameters:

index - The renderer index.

getMediaClock

public MediaClock getMediaClock()

Description copied from interface: Renderer

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.

Specified by:

getMediaClock in interface Renderer

Returns:

The MediaClock tracking the playback position of the renderer, or null.

getState

public final int getState()

Description copied from interface: Renderer

Returns the current state of the renderer.

Specified by:

getState in interface Renderer

Returns:

The current state (one of the STATE_* constants).

enable

public final void enable(Format[] formats,
                         SampleStream stream,
                         long positionUs,
                         boolean joining,
                         long offsetUs)
                  throws ExoPlaybackException

Description copied from interface: Renderer

Enables the renderer to consume from the specified SampleStream.

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

Specified by:

enable in interface Renderer

Parameters:

formats - The enabled formats.

stream - The SampleStream from which the renderer should consume.

positionUs - The player's current position.

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

offsetUs - The offset to be added to timestamps of buffers read from stream before they are rendered.

Throws:

ExoPlaybackException - If an error occurs.

start

public final void start()
                 throws ExoPlaybackException

Description copied from interface: Renderer

Starts the renderer, meaning that calls to Renderer.render(long, long) will cause media to be rendered.

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

Specified by:

start in interface Renderer

Throws:

ExoPlaybackException - If an error occurs.

replaceStream

public final void replaceStream(Format[] formats,
                                SampleStream stream,
                                long offsetUs)
                         throws ExoPlaybackException

Description copied from interface: Renderer

Replaces the SampleStream from which samples will be consumed.

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

Specified by:

replaceStream in interface Renderer

Parameters:

formats - The enabled formats.

stream - The SampleStream from which the renderer should consume.

offsetUs - The offset to be added to timestamps of buffers read from stream before they are rendered.

Throws:

ExoPlaybackException - If an error occurs.

getStream

public final SampleStream getStream()

Description copied from interface: Renderer

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

Specified by:

getStream in interface Renderer

hasReadStreamToEnd

public final boolean hasReadStreamToEnd()

Description copied from interface: Renderer

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: Renderer.STATE_ENABLED, Renderer.STATE_STARTED.

Specified by:

hasReadStreamToEnd in interface Renderer

setCurrentStreamIsFinal

public final void setCurrentStreamIsFinal()

Description copied from interface: Renderer

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: Renderer.STATE_ENABLED, Renderer.STATE_STARTED.

Specified by:

setCurrentStreamIsFinal in interface Renderer

maybeThrowStreamError

public final void maybeThrowStreamError()
                                 throws java.io.IOException

Description copied from interface: Renderer

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: Renderer.STATE_ENABLED, Renderer.STATE_STARTED.

Specified by:

maybeThrowStreamError in interface Renderer

Throws:

java.io.IOException - An error that's preventing the renderer from making progress or buffering more data.

resetPosition

public final void resetPosition(long positionUs)
                         throws ExoPlaybackException

Description copied from interface: Renderer

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: Renderer.STATE_ENABLED, Renderer.STATE_STARTED.

Specified by:

resetPosition in interface Renderer

Parameters:

positionUs - The new playback position in microseconds.

Throws:

ExoPlaybackException - If an error occurs handling the reset.

stop

public final void stop()
                throws ExoPlaybackException

Description copied from interface: Renderer

Stops the renderer, transitioning it to the Renderer.STATE_ENABLED state.

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

Specified by:

stop in interface Renderer

Throws:

ExoPlaybackException - If an error occurs.

disable

public final void disable()

Description copied from interface: Renderer

Disable the renderer, transitioning it to the Renderer.STATE_DISABLED state.

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

Specified by:

disable in interface Renderer

supportsMixedMimeTypeAdaptation

public int supportsMixedMimeTypeAdaptation()
                                    throws ExoPlaybackException

Description copied from interface: RendererCapabilities

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

Specified by:

supportsMixedMimeTypeAdaptation in interface RendererCapabilities

Returns:

The extent to which the renderer supports adapting between supported formats that have different mime types. One of RendererCapabilities.ADAPTIVE_SEAMLESS, RendererCapabilities.ADAPTIVE_NOT_SEAMLESS and RendererCapabilities.ADAPTIVE_NOT_SUPPORTED.

Throws:

ExoPlaybackException - If an error occurs.

handleMessage

public void handleMessage(int what,
                          java.lang.Object object)
                   throws ExoPlaybackException

Description copied from interface: ExoPlayer.ExoPlayerComponent

Handles a message delivered to the component. Called on the playback thread.

Specified by:

handleMessage in interface ExoPlayer.ExoPlayerComponent

Parameters:

what - The message type.

object - The message.

Throws:

ExoPlaybackException - If an error occurred whilst handling the message.

onEnabled

protected void onEnabled(boolean joining)
                  throws ExoPlaybackException

Called when the renderer is enabled.

The default implementation is a no-op.

Parameters:

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

Throws:

ExoPlaybackException - If an error occurs.

onStreamChanged

protected void onStreamChanged(Format[] formats)
                        throws ExoPlaybackException

Called when the renderer's stream has changed. This occurs when the renderer is enabled after onEnabled(boolean) 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 - The enabled formats.

Throws:

ExoPlaybackException - If an error occurs.

onPositionReset

protected void onPositionReset(long positionUs,
                               boolean joining)
                        throws ExoPlaybackException

Called when the position is reset. This occurs when the renderer is enabled after onStreamChanged(Format[]) 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 - The new playback position in microseconds.

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

Throws:

ExoPlaybackException - If an error occurs.

onStarted

protected void onStarted()
                  throws ExoPlaybackException

Called when the renderer is started.

The default implementation is a no-op.

Throws:

ExoPlaybackException - If an error occurs.

onStopped

protected void onStopped()
                  throws ExoPlaybackException

Called when the renderer is stopped.

The default implementation is a no-op.

Throws:

ExoPlaybackException - If an error occurs.

onDisabled

protected void onDisabled()

Called when the renderer is disabled.

The default implementation is a no-op.

getIndex

protected final int getIndex()

Returns the index of the renderer within the player.

Returns:

The index of the renderer within the player.

readSource

protected final int readSource(FormatHolder formatHolder,
                               DecoderInputBuffer buffer)

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

Parameters:

formatHolder - A FormatHolder to populate in the case of reading a format.

buffer - A DecoderInputBuffer to populate in the case of reading a sample or the end of the stream. If the end of the stream has been reached, the C.BUFFER_FLAG_END_OF_STREAM flag will be set on the buffer.

Returns:

The result, which can be C.RESULT_NOTHING_READ, C.RESULT_FORMAT_READ or C.RESULT_BUFFER_READ.

See Also:

SampleStream.readData(FormatHolder, DecoderInputBuffer)

isSourceReady

protected final boolean isSourceReady()

Returns whether the upstream source is ready.

Returns:

Whether the source is ready.

skipToKeyframeBefore

protected void skipToKeyframeBefore(long timeUs)

Attempts to skip to the keyframe before the specified time.

Parameters:

timeUs - The specified time.