NoSampleRenderer

Artifact: androidx.media3:media3-exoplayer

Kotlin |Java

@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`	`state`
`@Nullable SampleStream`	`stream`

Protected fields
`@MonotonicNonNull RendererConfiguration`	`@MonotonicNonNull configuration`
`int`	`index`

Public constructors
`NoSampleRenderer()`

Public methods
`final void`	`disable()` Disable the renderer, transitioning it to the `STATE_DISABLED` state.
`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`.
`final RendererCapabilities`	`getCapabilities()` Returns the capabilities of the renderer.
`@Nullable MediaClock`	`getMediaClock()` If the renderer advances its own playback position then this method returns a corresponding `MediaClock`.
`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.
`final int`	`getState()` Returns the current state of the renderer.
`final @Nullable SampleStream`	`getStream()` Returns the `SampleStream` being consumed, or null if the renderer is disabled.
`final int`	`@C.TrackType getTrackType()` Returns the track type that the renderer handles.
`void`	`handleMessage( @Renderer.MessageType int messageType, @Nullable Object message )` Handles a message delivered to the target.
`final boolean`	`hasReadStreamToEnd()` Returns whether the renderer has read the current `SampleStream` to the end.
`final void`	`init(int index, PlayerId playerId, Clock clock)` Initializes the renderer for playback with a player.
`final boolean`	`isCurrentStreamFinal()` Returns whether the current `SampleStream` will be the final one supplied before the renderer is next disabled or reset.
`boolean`	`isEnded()` Whether the renderer is ready for the `ExoPlayer` instance to transition to `STATE_ENDED`.
`boolean`	`isReady()` Whether the renderer is able to immediately render media from the current position.
`final void`	`maybeThrowStreamError()` Throws an error that's preventing the renderer from reading from its `SampleStream`.
`final void`	`replaceStream( Format[] formats, SampleStream stream, long startPositionUs, long offsetUs, MediaSource.MediaPeriodId mediaPeriodId )` Replaces the `SampleStream` from which samples will be consumed.
`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)` Signals to the renderer that a position discontinuity has occurred.
`final void`	`setCurrentStreamFinal()` Signals to the renderer that the current `SampleStream` will be the final one supplied before it is next disabled or reset.
`void`	`setTimeline(Timeline timeline)` Sets the timeline that is currently being played.
`final void`	`start()` Starts the renderer, meaning that calls to `render` will cause media to be rendered.
`final void`	`stop()` Stops the renderer, transitioning it to the `STATE_ENABLED` state.
`int`	`@RendererCapabilities.Capabilities supportsFormat(Format format)` Returns the extent to which the `Renderer` supports a given format.
`int`	`@RendererCapabilities.AdaptiveSupport supportsMixedMimeTypeAdaptation()` Returns the extent to which the `Renderer` supports adapting between supported formats that have different MIME types.

Protected methods
`final @Nullable RendererConfiguration`	`getConfiguration()` Returns the configuration set when the renderer was most recently enabled, or `null` if the renderer has never been enabled.
`final int`	`getIndex()` Returns the index of the renderer within the player.
`void`	`onDisabled()` Called when the renderer is disabled.
`void`	`onEnabled(boolean joining)` Called when the renderer is enabled.
`void`	`onPositionReset(long positionUs, boolean joining)` 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`	`onStarted()` Called when the renderer is started.
`void`	`onStopped()` Called when the renderer is stopped.

Inherited Constants

From androidx.media3.exoplayer.Renderer

`static final long`	`DEFAULT_DURATION_TO_PROGRESS_US = 10000` Default minimum duration that the playback clock must advance before `render` can make progress.
`static final int`	`MSG_CUSTOM_BASE = 10000` Applications or extensions may define custom `MSG_*` constants that can be passed to renderers.
`static final int`	`MSG_SET_AUDIO_ATTRIBUTES = 3` A type of a message that can be passed to an audio renderer via `createMessage`.
`static final int`	`MSG_SET_AUDIO_SESSION_ID = 10` The type of a message that can be passed to audio and video renderers via `createMessage`.
`static final int`	`MSG_SET_AUX_EFFECT_INFO = 6` A type of a message that can be passed to an audio renderer via `createMessage`.
`static final int`	`MSG_SET_CAMERA_MOTION_LISTENER = 8` The type of a message that can be passed to a camera motion renderer via `createMessage`.
`static final int`	`MSG_SET_CHANGE_FRAME_RATE_STRATEGY = 5` The type of a message that can be passed to a video renderer via `createMessage`.
`static final int`	`MSG_SET_IMAGE_OUTPUT = 15` The type of message that can be passed to an image renderer to set a desired image output.
`static final int`	`MSG_SET_PREFERRED_AUDIO_DEVICE = 12` The type of a message that can be passed to audio renderers via `createMessage`.
`static final int`	`MSG_SET_PRIORITY = 16` The type of message that can be passed to a renderer to set its priority.
`static final int`	`MSG_SET_SCALING_MODE = 4` The type of a message that can be passed to a `MediaCodec`-based video renderer via `createMessage`.
`static final int`	`MSG_SET_SKIP_SILENCE_ENABLED = 9` The type of a message that can be passed to an audio renderer via `createMessage`.
`static final int`	`MSG_SET_VIDEO_EFFECTS = 13` The type of a message that can be passed to a video renderer.
`static final int`	`MSG_SET_VIDEO_FRAME_METADATA_LISTENER = 7` The type of a message that can be passed to a video renderer via `createMessage`.
`static final int`	`MSG_SET_VIDEO_OUTPUT = 1` The type of a message that can be passed to a video renderer via `createMessage`.
`static final int`	`MSG_SET_VIDEO_OUTPUT_RESOLUTION = 14` The type of a message that can be passed to a video renderer to set the desired output resolution.
`static final int`	`MSG_SET_VOLUME = 2` A type of a message that can be passed to an audio renderer via `createMessage`.
`static final int`	`MSG_SET_WAKEUP_LISTENER = 11` 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`	`STATE_DISABLED = 0` The renderer is disabled.
`static final int`	`STATE_ENABLED = 1` The renderer is enabled but not started.
`static final int`	`STATE_STARTED = 2` The renderer is started.

From androidx.media3.exoplayer.RendererCapabilities

`static final int`	`ADAPTIVE_NOT_SEAMLESS = 8` The `Renderer` can adapt between formats, but may suffer a brief discontinuity (~50-100ms) when adaptation occurs.
`static final int`	`ADAPTIVE_NOT_SUPPORTED = 0` The `Renderer` does not support adaptation between formats.
`static final int`	`ADAPTIVE_SEAMLESS = 16` The `Renderer` can seamlessly adapt between formats.
`static final int`	`ADAPTIVE_SUPPORT_MASK = 24` A mask to apply to `Capabilities` to obtain the `AdaptiveSupport` only.
`static final int`	`AUDIO_OFFLOAD_GAPLESS_SUPPORTED = 1024` The renderer supports audio offload and gapless transitions with this format.
`static final int`	`AUDIO_OFFLOAD_NOT_SUPPORTED = 0` Audio offload is not supported with this format.
`static final int`	`AUDIO_OFFLOAD_SPEED_CHANGE_SUPPORTED = 2048` The renderer supports audio offload and speed changes with this format.
`static final int`	`AUDIO_OFFLOAD_SUPPORTED = 512` The renderer supports audio offload with this format.
`static final int`	`AUDIO_OFFLOAD_SUPPORT_MASK = 3584` A mask to apply to `Capabilities` to obtain `AudioOffloadSupport` only.
`static final int`	`DECODER_SUPPORT_FALLBACK = 0` The format exceeds the primary decoder's capabilities but is supported by fallback decoder
`static final int`	`DECODER_SUPPORT_FALLBACK_MIMETYPE = 256` The format's MIME type is unsupported and the renderer may use a decoder for a fallback MIME type.
`static final int`	`DECODER_SUPPORT_MASK = 384` A mask to apply to `Capabilities` to obtain `DecoderSupport` only.
`static final int`	`DECODER_SUPPORT_PRIMARY = 128` The renderer is able to use the primary decoder for the format's MIME type.
`static final int`	`FORMAT_SUPPORT_MASK = 7` A mask to apply to `Capabilities` to obtain the `C.FormatSupport` only.
`static final int`	`HARDWARE_ACCELERATION_NOT_SUPPORTED = 0` The renderer is not able to use hardware acceleration.
`static final int`	`HARDWARE_ACCELERATION_SUPPORTED = 64` The renderer is able to use hardware acceleration.
`static final int`	`HARDWARE_ACCELERATION_SUPPORT_MASK = 64` A mask to apply to `Capabilities` to obtain `HardwareAccelerationSupport` only.
`static final int`	`TUNNELING_NOT_SUPPORTED = 0` The `Renderer` does not support tunneled output.
`static final int`	`TUNNELING_SUPPORTED = 32` The `Renderer` supports tunneled output.
`static final int`	`TUNNELING_SUPPORT_MASK = 32` A mask to apply to `Capabilities` to obtain `TunnelingSupport` only.

Inherited methods

From androidx.media3.exoplayer.Renderer

`void`	`enableMayRenderStartOfStream()` Enables this renderer to render the start of the stream even if the state is not `STATE_STARTED` yet.
`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.
`abstract String`	`getName()` Returns the name of this renderer, for logging and debugging purposes.
`void`	`release()` Releases the renderer.
`abstract void`	`render(long positionUs, long elapsedRealtimeUs)` Incrementally renders the `SampleStream`.
`void`	`setPlaybackSpeed(float currentPlaybackSpeed, float targetPlaybackSpeed)` Indicates the playback speed to this renderer.

From androidx.media3.exoplayer.RendererCapabilities

`void`	`clearListener()` Clears the `Listener`.
`static int`	`@RendererCapabilities.Capabilities create(@C.FormatSupport int formatSupport)` Returns `Capabilities` for the given `C.FormatSupport`.
`static int`	`@RendererCapabilities.Capabilities create( @C.FormatSupport int formatSupport, @RendererCapabilities.AdaptiveSupport int adaptiveSupport, @RendererCapabilities.TunnelingSupport int tunnelingSupport )` Returns `Capabilities` combining the given `C.FormatSupport`, and `TunnelingSupport`.
`static int`	`@RendererCapabilities.Capabilities create( @C.FormatSupport int formatSupport, @RendererCapabilities.AdaptiveSupport int adaptiveSupport, @RendererCapabilities.TunnelingSupport int tunnelingSupport, @RendererCapabilities.AudioOffloadSupport int audioOffloadSupport )` Returns `Capabilities` combining the given `C.FormatSupport`, , `TunnelingSupport`, and `AudioOffloadSupport`.
`static int`	`@RendererCapabilities.Capabilities create( @C.FormatSupport int formatSupport, @RendererCapabilities.AdaptiveSupport int adaptiveSupport, @RendererCapabilities.TunnelingSupport int tunnelingSupport, @RendererCapabilities.HardwareAccelerationSupport int hardwareAccelerationSupport, @RendererCapabilities.DecoderSupport int decoderSupport )` Returns `Capabilities` combining the given `C.FormatSupport`, , `TunnelingSupport`, `HardwareAccelerationSupport`, and .
`static int`	`@RendererCapabilities.Capabilities create( @C.FormatSupport int formatSupport, @RendererCapabilities.AdaptiveSupport int adaptiveSupport, @RendererCapabilities.TunnelingSupport int tunnelingSupport, @RendererCapabilities.HardwareAccelerationSupport int hardwareAccelerationSupport, @RendererCapabilities.DecoderSupport int decoderSupport, @RendererCapabilities.AudioOffloadSupport int audioOffloadSupport )` Returns `Capabilities` combining the given `C.FormatSupport`, , `TunnelingSupport`, `HardwareAccelerationSupport`, and `AudioOffloadSupport`.
`static int`	`@RendererCapabilities.AdaptiveSupport getAdaptiveSupport(@RendererCapabilities.Capabilities int supportFlags)` Returns the `AdaptiveSupport` from the combined `Capabilities`.
`static int`	`@RendererCapabilities.AudioOffloadSupport getAudioOffloadSupport( @RendererCapabilities.Capabilities int supportFlags )` Returns the `AudioOffloadSupport` from the combined `Capabilities`.
`static int`	`@RendererCapabilities.DecoderSupport getDecoderSupport(@RendererCapabilities.Capabilities int supportFlags)` Returns the `DecoderSupport` from the combined `Capabilities`.
`static int`	`@C.FormatSupport getFormatSupport(@RendererCapabilities.Capabilities int supportFlags)` Returns the `C.FormatSupport` from the combined `Capabilities`.
`static int`	`@RendererCapabilities.HardwareAccelerationSupport getHardwareAccelerationSupport( @RendererCapabilities.Capabilities int supportFlags )` Returns the `HardwareAccelerationSupport` from the combined `Capabilities`.
`static int`	`@RendererCapabilities.TunnelingSupport getTunnelingSupport(@RendererCapabilities.Capabilities int supportFlags)` Returns the `TunnelingSupport` from the combined `Capabilities`.
`static boolean`	`isFormatSupported( @RendererCapabilities.Capabilities int supportFlags, boolean allowExceedsCapabilities )` Returns whether the `C.FormatSupport` from the combined `Capabilities` indicates the format is supported.
`void`	`setListener(RendererCapabilities.Listener listener)` Sets the `Listener`.

Public fields

state

public int state

stream

public @Nullable SampleStream stream

Protected fields

configuration

@MonotonicNonNull
protected @MonotonicNonNull RendererConfiguration configuration

index

protected int index

Public constructors

NoSampleRenderer

public NoSampleRenderer()

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

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

Returns
`@Nullable MediaClock`	The `MediaClock` tracking the playback position of the renderer, or null.

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 `STATE_DISABLED`, `STATE_ENABLED` and `STATE_STARTED`.

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

Parameters
`int index`	The renderer index within the player.
`PlayerId playerId`	The `PlayerId` of the player.
`Clock clock`	The `Clock`.

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

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)

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 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 `Capabilities` for this format.

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 `AdaptiveSupport` for adapting between supported formats that have different MIME types.

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.

getIndex

protected final int getIndex()

Returns the index of the renderer within the player.

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)

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.

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 `positionUs` in `render` to get the playback position with respect to the media.

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.