@UnstableApi
public abstract class BaseRenderer implements Renderer, RendererCapabilities

Known direct subclasses
CameraMotionRenderer

A Renderer that parses the camera motion track.

DecoderAudioRenderer

Decodes and renders audio using a Decoder.

DecoderVideoRenderer

Decodes and renders video using a Decoder.

FakeRenderer

Fake Renderer that supports any format with the matching track type.

ImageRenderer

A Renderer implementation for images.

MediaCodecRenderer

An abstract renderer that uses MediaCodec to decode samples for rendering.

MetadataRenderer

A renderer for metadata.

TextRenderer

A Renderer for text.


An abstract base class suitable for most Renderer implementations.

It converts many of the state transitions explained in Renderer docs to protected callbacks and provides utilities to access current state values without tracking them manually:

Summary

Public constructors

BaseRenderer(@C.TrackType int trackType)

Public methods

final void

Clears the Listener.

final void

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

Returns the capabilities of the renderer.

@Nullable MediaClock

If the renderer advances its own playback position then this method returns a corresponding MediaClock.

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

final int

Returns the current state of the renderer.

final @Nullable SampleStream

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

final int

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

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

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

final void

Throws an error that's preventing the renderer from reading from its SampleStream.

final void

Releases the renderer.

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

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

Signals to the renderer that the current SampleStream will be the final one supplied before it is next disabled or reset.

final void

Sets the Listener.

final void

Sets the timeline that is currently being played.

final void

Starts the renderer, meaning that calls to render will cause media to be rendered.

final void

Stops the renderer, transitioning it to the STATE_ENABLED state.

int

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

Protected methods

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

Creates an ExoPlaybackException of type TYPE_RENDERER for this renderer.

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

Creates an ExoPlaybackException of type TYPE_RENDERER for this renderer.

final Clock

Returns the Clock.

final RendererConfiguration

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

final FormatHolder

Returns a clear FormatHolder.

final int

Returns the index of the renderer within the player.

final long

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

final PlayerId

Returns the PlayerId of the player using this renderer.

final Format[]

Returns the formats of the currently enabled stream.

final long

Returns the offset added to timestamps of buffers read from the SampleStream.

final Timeline

Returns the current Timeline containing the rendered stream.

final boolean

Returns whether the upstream source is ready.

void

Called when the renderer is disabled.

void
onEnabled(boolean joining, boolean mayRenderStartOfStream)

Called when the renderer is enabled.

void

Called when the renderer is initialized.

void
onPositionReset(long positionUs, boolean joining)

Called when the position is reset.

void

Called when the renderer is released.

final void

Called when the renderer capabilities are changed.

void

Called when the renderer is reset.

void

Called when the renderer is started.

void

Called when the renderer is stopped.

void
onStreamChanged(
    Format[] formats,
    long startPositionUs,
    long offsetUs,
    MediaSource.MediaPeriodId mediaPeriodId
)

Called when the renderer's stream has changed.

void

Called when a new timeline is set.

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

Reads from the enabled upstream source.

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.

Inherited Constants

From androidx.media3.exoplayer.Renderer
static final long

Default minimum duration that the playback clock must advance before render can make progress.

static final int

Applications or extensions may define custom MSG_* constants that can be passed to renderers.

static final int

A type of a message that can be passed to an audio renderer via createMessage.

static final int

The type of a message that can be passed to audio and video renderers via createMessage.

static final int

A type of a message that can be passed to an audio renderer via createMessage.

static final int

The type of a message that can be passed to a camera motion renderer via createMessage.

static final int

The type of a message that can be passed to a video renderer via createMessage.

static final int

The type of message that can be passed to an image renderer to set a desired image output.

static final int

The type of a message that can be passed to audio renderers via createMessage.

static final int

The type of message that can be passed to a renderer to set its priority.

static final int

The type of a message that can be passed to a MediaCodec-based video renderer via createMessage.

static final int

The type of a message that can be passed to an audio renderer via createMessage.

static final int

The type of a message that can be passed to a video renderer.

static final int

The type of a message that can be passed to a video renderer via createMessage.

static final int

The type of a message that can be passed to a video renderer via createMessage.

static final int

The type of a message that can be passed to a video renderer to set the desired output resolution.

static final int

A type of a message that can be passed to an audio renderer via createMessage.

static final int

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

The renderer is disabled.

static final int

The renderer is enabled but not started.

static final int

The renderer is started.

From androidx.media3.exoplayer.RendererCapabilities
static final int

The Renderer can adapt between formats, but may suffer a brief discontinuity (~50-100ms) when adaptation occurs.

static final int

The Renderer does not support adaptation between formats.

static final int

The Renderer can seamlessly adapt between formats.

static final int

A mask to apply to Capabilities to obtain the AdaptiveSupport only.

static final int

The renderer supports audio offload and gapless transitions with this format.

static final int

Audio offload is not supported with this format.

static final int

The renderer supports audio offload and speed changes with this format.

static final int

The renderer supports audio offload with this format.

static final int

A mask to apply to Capabilities to obtain AudioOffloadSupport only.

static final int

The format exceeds the primary decoder's capabilities but is supported by fallback decoder

static final int

The format's MIME type is unsupported and the renderer may use a decoder for a fallback MIME type.

static final int

A mask to apply to Capabilities to obtain DecoderSupport only.

static final int

The renderer is able to use the primary decoder for the format's MIME type.

static final int

A mask to apply to Capabilities to obtain the C.FormatSupport only.

static final int

The renderer is not able to use hardware acceleration.

static final int

The renderer is able to use hardware acceleration.

static final int

A mask to apply to Capabilities to obtain HardwareAccelerationSupport only.

static final int

The Renderer does not support tunneled output.

static final int

The Renderer supports tunneled output.

static final int

A mask to apply to Capabilities to obtain TunnelingSupport only.

Inherited methods

From androidx.media3.exoplayer.Renderer
void

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

Returns the name of this renderer, for logging and debugging purposes.

abstract boolean

Whether the renderer is ready for the ExoPlayer instance to transition to STATE_ENDED.

abstract boolean

Whether the renderer is able to immediately render media from the current position.

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
static int

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

Returns the AdaptiveSupport from the combined Capabilities.

static int

Returns the AudioOffloadSupport from the combined Capabilities.

static int

Returns the DecoderSupport from the combined Capabilities.

static int

Returns the C.FormatSupport from the combined Capabilities.

static int

Returns the HardwareAccelerationSupport from the combined Capabilities.

static int

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.

abstract int

Returns the extent to which the Renderer supports a given format.

Public fields

readingPositionUs

public long readingPositionUs

state

public int state

stream

public @Nullable SampleStream stream

trackType

@C.TrackType
public final int trackType

Protected fields

configuration

protected @Nullable RendererConfiguration configuration

formatHolder

protected final FormatHolder formatHolder

index

protected int index

lastResetPositionUs

protected long lastResetPositionUs

streamFormats

protected @Nullable Format[] streamFormats

streamOffsetUs

protected long streamOffsetUs

timeline

protected Timeline timeline

Public constructors

BaseRenderer

public BaseRenderer(@C.TrackType int trackType)
Parameters
@C.TrackType int trackType

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

Public methods

clearListener

public final void clearListener()

Clears the Listener.

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.

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

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.

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.

release

public final void release()

Releases the renderer.

The renderer must not be used after calling this method.

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.

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.

setListener

public final void setListener(RendererCapabilities.Listener listener)

Sets the Listener.

Parameters
RendererCapabilities.Listener listener

The listener to be set.

setTimeline

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

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.

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.

Protected methods

createRendererException

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

Creates an ExoPlaybackException of type TYPE_RENDERER for this renderer.

Parameters
Throwable cause

The cause of the exception.

@Nullable Format format

The current format used by the renderer. May be null.

@PlaybackException.ErrorCode int errorCode

A PlaybackException.ErrorCode to identify the cause of the playback failure.

Returns
ExoPlaybackException

The created instance, in which isRecoverable is false.

createRendererException

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.

Parameters
Throwable cause

The cause of the exception.

@Nullable Format format

The current format used by the renderer. May be null.

boolean isRecoverable

If the error is recoverable by disabling and re-enabling the renderer.

@PlaybackException.ErrorCode int errorCode

A PlaybackException.ErrorCode to identify the cause of the playback failure.

Returns
ExoPlaybackException

The created instance.

getClock

protected final Clock getClock()

Returns the Clock.

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

getConfiguration

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.

getFormatHolder

protected final FormatHolder getFormatHolder()

Returns a clear FormatHolder.

getIndex

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.

getLastResetPositionUs

protected final long getLastResetPositionUs()

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

getPlayerId

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.

getStreamFormats

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.

getStreamOffsetUs

protected final long getStreamOffsetUs()

Returns the offset added to timestamps of buffers read from the SampleStream.

Must only be called if the renderer is at least STATE_ENABLED.

getTimeline

protected final Timeline getTimeline()

Returns the current Timeline containing the rendered stream.

isSourceReady

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.

onDisabled

protected void onDisabled()

Called when the renderer is disabled.

The default implementation is a no-op.

onEnabled

protected void onEnabled(boolean joining, boolean mayRenderStartOfStream)

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.

boolean mayRenderStartOfStream

Whether this renderer is allowed to render the start of the stream even if the state is not STATE_STARTED yet.

onInit

protected void onInit()

Called when the renderer is initialized.

onPositionReset

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.

Parameters
long positionUs

The new playback position in microseconds.

boolean joining

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

onRelease

protected void onRelease()

Called when the renderer is released.

The default implementation is a no-op.

onRendererCapabilitiesChanged

protected final void onRendererCapabilitiesChanged()

Called when the renderer capabilities are changed.

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.

onStopped

protected void onStopped()

Called when the renderer is stopped.

The default implementation is a no-op.

onStreamChanged

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.

Parameters
Format[] formats

The enabled formats.

long startPositionUs

The start position of the new stream in renderer time (microseconds).

long offsetUs

The offset that will be added to the timestamps of buffers read via readSource so that decoder input buffers have monotonically increasing timestamps.

MediaSource.MediaPeriodId mediaPeriodId

The MediaSource.MediaPeriodId of the MediaPeriod that produces the stream.

onTimelineChanged

protected void onTimelineChanged(Timeline timeline)

Called when a new timeline is set.

The default implementation is a no-op.

Parameters
Timeline timeline

The new timeline, which can also be obtained from getTimeline.

readSource

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

Parameters
FormatHolder formatHolder

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

DecoderInputBuffer 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 BUFFER_FLAG_END_OF_STREAM flag will be set on the buffer.

@SampleStream.ReadFlags int readFlags

Flags controlling the behavior of this read operation.

Returns
int

The result of the read operation.

Throws
androidx.media3.decoder.DecoderInputBuffer.InsufficientCapacityException

If the buffer has insufficient capacity to hold the data of a sample being read. The buffer timestamp and flags are populated if this exception is thrown, but the read position is not advanced.

skipSource

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.

Parameters
long positionUs

The position in microseconds.

Returns
int

The number of samples that were skipped.