NoSampleRenderer
@UnstableApi
public abstract class NoSampleRenderer implements Renderer, RendererCapabilities
A Renderer implementation whose track type is TRACK_TYPE_NONE and does not consume data from its SampleStream.
Summary
Public fields |
|
|---|---|
int |
|
@Nullable SampleStream |
Protected fields |
|
|---|---|
@MonotonicNonNull RendererConfiguration |
|
int |
Public constructors |
|---|
Public methods |
|
|---|---|
final void |
disable()Disable the renderer, transitioning it to the |
final void |
enable(Enables the renderer to consume from the specified |
final RendererCapabilities |
Returns the capabilities of the renderer. |
@Nullable MediaClock |
If the renderer advances its own playback position then this method returns a corresponding |
long |
Returns the renderer time up to which the renderer has read samples, in microseconds, or |
final int |
getState()Returns the current state of the renderer. |
final @Nullable SampleStream |
Returns the |
final int |
Returns the track type that the renderer handles. |
void |
handleMessage(Handles a message delivered to the target. |
final boolean |
Returns whether the renderer has read the current |
final void |
Initializes the renderer for playback with a player. |
final boolean |
Returns whether the current |
boolean |
isEnded()Whether the renderer is ready for the |
boolean |
isReady()Whether the renderer is able to immediately render media from the current position. |
final void |
Throws an error that's preventing the renderer from reading from its |
final void |
replaceStream(Replaces the |
final void |
reset()Forces the renderer to give up any resources (e.g. media decoders) that it may be holding. |
final void |
resetPosition(long positionUs, boolean sampleStreamIsResetToKeyFrame)Signals to the renderer that a position discontinuity has occurred. |
final void |
Signals to the renderer that the current |
void |
setTimeline(Timeline timeline)Sets the timeline that is currently being played. |
final void |
start()Starts the renderer, meaning that calls to |
final void |
stop()Stops the renderer, transitioning it to the |
int |
Returns the extent to which the |
int |
Returns the extent to which the |
Protected methods |
|
|---|---|
final @Nullable RendererConfiguration |
Returns the configuration set when the renderer was most recently enabled, or |
final int |
getIndex()Returns the index of the renderer within the player. |
void |
Called when the renderer is disabled. |
void |
onEnabled(boolean joining)Called when the renderer is enabled. |
void |
onPositionReset(Called when the position is reset. |
void |
onRendererOffsetChanged(long offsetUs)Called when the renderer's offset has been changed. |
void |
onReset()Called when the renderer is reset. |
void |
Called when the renderer is started. |
void |
Called when the renderer is stopped. |
Inherited Constants |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Protected fields
Public constructors
Public methods
disable
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.
enable
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.
| Parameters | |
|---|---|
RendererConfiguration configuration |
The renderer configuration. |
Format[] formats |
The enabled formats. |
SampleStream stream |
The |
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 |
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 |
MediaSource.MediaPeriodId mediaPeriodId |
The |
| Throws | |
|---|---|
androidx.media3.exoplayer.ExoPlaybackException |
If an error occurs. |
getCapabilities
public final RendererCapabilities getCapabilities()
Returns the capabilities of the renderer.
| Returns | |
|---|---|
RendererCapabilities |
The capabilities of the renderer. |
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 MediaClock from this method.
| Returns | |
|---|---|
@Nullable MediaClock |
The |
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
public final int getState()
Returns the current state of the renderer.
| Returns | |
|---|---|
int |
The current state. One of |
getStream
public final @Nullable SampleStream getStream()
Returns the SampleStream being consumed, or null if the renderer is disabled.
getTrackType
@C.TrackType
public final int getTrackType()
Returns the track type that the renderer handles.
| Returns | |
|---|---|
int |
The |
| 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 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.
init
public final void init(int index, PlayerId playerId, Clock clock)
Initializes the renderer for playback with a player.
isCurrentStreamFinal
public final 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 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.
| Throws | |
|---|---|
java.io.IOException |
An error that's preventing the renderer from making progress or buffering more data. |
replaceStream
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.
| Parameters | |
|---|---|
Format[] formats |
The enabled formats. |
SampleStream stream |
The |
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 |
MediaSource.MediaPeriodId mediaPeriodId |
The |
| Throws | |
|---|---|
androidx.media3.exoplayer.ExoPlaybackException |
If an error occurs. |
reset
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.
resetPosition
public final 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 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.
| Parameters | |
|---|---|
long positionUs |
The new playback position in microseconds. |
boolean sampleStreamIsResetToKeyFrame |
Whether the renderer's |
| Throws | |
|---|---|
androidx.media3.exoplayer.ExoPlaybackException |
If an error occurs handling the reset. |
setCurrentStreamFinal
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.
setTimeline
public void setTimeline(Timeline timeline)
Sets the timeline that is currently being played.
start
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.
| Throws | |
|---|---|
androidx.media3.exoplayer.ExoPlaybackException |
If an error occurs. |
stop
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.
supportsFormat
@RendererCapabilities.Capabilities
public int supportsFormat(Format format)
Returns the extent to which the Renderer supports a given format.
| Parameters | |
|---|---|
Format format |
The format. |
| Returns | |
|---|---|
int |
The |
| Throws | |
|---|---|
androidx.media3.exoplayer.ExoPlaybackException |
If an error occurs. |
supportsMixedMimeTypeAdaptation
@RendererCapabilities.AdaptiveSupport
public int supportsMixedMimeTypeAdaptation()
Returns the extent to which the Renderer supports adapting between supported formats that have different MIME types.
| Returns | |
|---|---|
int |
The |
| Throws | |
|---|---|
androidx.media3.exoplayer.ExoPlaybackException |
If an error occurs. |
Protected methods
getConfiguration
protected final @Nullable RendererConfiguration getConfiguration()
Returns the configuration set when the renderer was most recently enabled, or null if the renderer has never been enabled.
onDisabled
protected void onDisabled()
Called when the renderer is disabled.
The default implementation is a no-op.
onEnabled
protected void onEnabled(boolean joining)
Called when the renderer is enabled.
The default implementation is a no-op.
| Parameters | |
|---|---|
boolean joining |
Whether this renderer is being enabled to join an ongoing playback. |
| Throws | |
|---|---|
androidx.media3.exoplayer.ExoPlaybackException |
If an error occurs. |
onPositionReset
protected void onPositionReset(
long positionUs,
boolean joining,
boolean sampleStreamIsResetToKeyFrame
)
Called when the position is reset. This occurs when the renderer is enabled after onRendererOffsetChanged has been called, and also when a position discontinuity is encountered.
The default implementation is a no-op.
| Parameters | |
|---|---|
long positionUs |
The new playback position in microseconds. |
boolean joining |
Whether this renderer is being enabled to join an ongoing playback. |
boolean sampleStreamIsResetToKeyFrame |
Whether the sample stream is reset to a key frame. |
| Throws | |
|---|---|
androidx.media3.exoplayer.ExoPlaybackException |
If an error occurs. |
onRendererOffsetChanged
protected void onRendererOffsetChanged(long offsetUs)
Called when the renderer's offset has been changed.
The default implementation is a no-op.
| Parameters | |
|---|---|
long offsetUs |
The offset that should be subtracted from |
| Throws | |
|---|---|
androidx.media3.exoplayer.ExoPlaybackException |
If an error occurs. |
onReset
protected void onReset()
Called when the renderer is reset.
The default implementation is a no-op.
onStarted
protected void onStarted()
Called when the renderer is started.
The default implementation is a no-op.
| Throws | |
|---|---|
androidx.media3.exoplayer.ExoPlaybackException |
If an error occurs. |
onStopped
protected void onStopped()
Called when the renderer is stopped.
The default implementation is a no-op.