NoSampleRenderer
@UnstableApi
abstract class NoSampleRenderer : Renderer, RendererCapabilities
A Renderer implementation whose track type is TRACK_TYPE_NONE and does not consume data from its SampleStream.
Summary
Public constructors |
|---|
Public functions |
|
|---|---|
Unit |
disable()Disable the renderer, transitioning it to the |
Unit |
enable(Enables the renderer to consume from the specified |
RendererCapabilities! |
Returns the capabilities of the renderer. |
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 |
Int |
Returns the track type that the renderer handles. |
Unit |
handleMessage(@Renderer.MessageType messageType: Int, message: Any?)Handles a message delivered to the target. |
Boolean |
Returns whether the renderer has read the current |
Unit |
Initializes the renderer for playback with a player. |
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. |
Unit |
Throws an error that's preventing the renderer from reading from its |
Unit |
replaceStream(Replaces the |
Unit |
reset()Forces the renderer to give up any resources (e.g. media decoders) that it may be holding. |
Unit |
resetPosition(positionUs: Long, sampleStreamIsResetToKeyFrame: Boolean)Signals to the renderer that a position discontinuity has occurred. |
Unit |
Signals to the renderer that the current |
Unit |
setTimeline(timeline: Timeline!)Sets the timeline that is currently being played. |
Unit |
start()Starts the renderer, meaning that calls to |
Unit |
stop()Stops the renderer, transitioning it to the |
Int |
Returns the extent to which the |
Int |
Returns the extent to which the |
Protected functions |
|
|---|---|
Unit |
Called when the renderer is disabled. |
Unit |
Called when the renderer is enabled. |
Unit |
onPositionReset(Called when the position is reset. |
Unit |
onRendererOffsetChanged(offsetUs: Long)Called when the renderer's offset has been changed. |
Unit |
onReset()Called when the renderer is reset. |
Unit |
Called when the renderer is started. |
Unit |
Called when the renderer is stopped. |
Public properties |
|
|---|---|
Int |
|
SampleStream? |
Protected properties |
|
|---|---|
@MonotonicNonNull RendererConfiguration! |
|
Int |
Inherited Constants |
||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Public constructors
Public functions
disable
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.
enable
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.
| Parameters | |
|---|---|
configuration: RendererConfiguration! |
The renderer configuration. |
formats: Array<Format!>! |
The enabled formats. |
stream: SampleStream! |
The |
positionUs: Long |
The player's current position. |
joining: Boolean |
Whether this renderer is being enabled to join an ongoing playback. |
mayRenderStartOfStream: Boolean |
Whether this renderer is allowed to render the start of the stream even if the state is not |
startPositionUs: Long |
The start position of the stream in renderer time (microseconds). |
offsetUs: Long |
The offset to be added to timestamps of buffers read from |
mediaPeriodId: MediaSource.MediaPeriodId! |
The |
| Throws | |
|---|---|
androidx.media3.exoplayer.ExoPlaybackException |
If an error occurs. |
getCapabilities
fun getCapabilities(): RendererCapabilities!
Returns the capabilities of the renderer.
| Returns | |
|---|---|
RendererCapabilities! |
The capabilities of the renderer. |
getMediaClock
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.
| Returns | |
|---|---|
MediaClock? |
The |
getReadingPositionUs
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.
getTrackType
@C.TrackType
fun getTrackType(): Int
Returns the track type that the renderer handles.
| Returns | |
|---|---|
Int |
The |
| See also | |
|---|---|
getRendererType |
handleMessage
fun handleMessage(@Renderer.MessageType messageType: Int, message: Any?): Unit
Handles a message delivered to the target.
| Parameters | |
|---|---|
@Renderer.MessageType messageType: Int |
The message type. |
message: Any? |
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
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.
init
fun init(index: Int, playerId: PlayerId!, clock: Clock!): Unit
Initializes the renderer for playback with a player.
isCurrentStreamFinal
fun isCurrentStreamFinal(): Boolean
Returns whether the current SampleStream will be the final one supplied before the renderer is next disabled or reset.
isEnded
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.
| Returns | |
|---|---|
Boolean |
Whether the renderer is ready for the player to transition to the ended state. |
isReady
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.
| Returns | |
|---|---|
Boolean |
Whether the renderer is ready to render media. |
maybeThrowStreamError
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.
| Throws | |
|---|---|
java.io.IOException |
An error that's preventing the renderer from making progress or buffering more data. |
replaceStream
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.
| Parameters | |
|---|---|
formats: Array<Format!>! |
The enabled formats. |
stream: SampleStream! |
The |
startPositionUs: Long |
The start position of the new stream in renderer time (microseconds). |
offsetUs: Long |
The offset to be added to timestamps of buffers read from |
mediaPeriodId: MediaSource.MediaPeriodId! |
The |
| Throws | |
|---|---|
androidx.media3.exoplayer.ExoPlaybackException |
If an error occurs. |
reset
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.
resetPosition
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.
| Parameters | |
|---|---|
positionUs: Long |
The new playback position in microseconds. |
sampleStreamIsResetToKeyFrame: Boolean |
Whether the renderer's |
| Throws | |
|---|---|
androidx.media3.exoplayer.ExoPlaybackException |
If an error occurs handling the reset. |
setCurrentStreamFinal
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.
setTimeline
fun setTimeline(timeline: Timeline!): Unit
Sets the timeline that is currently being played.
start
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.
| Throws | |
|---|---|
androidx.media3.exoplayer.ExoPlaybackException |
If an error occurs. |
stop
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.
supportsFormat
@RendererCapabilities.Capabilities
fun supportsFormat(format: Format!): Int
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
fun supportsMixedMimeTypeAdaptation(): Int
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 functions
onDisabled
protected fun onDisabled(): Unit
Called when the renderer is disabled.
The default implementation is a no-op.
onEnabled
protected fun onEnabled(joining: Boolean): Unit
Called when the renderer is enabled.
The default implementation is a no-op.
| Parameters | |
|---|---|
joining: Boolean |
Whether this renderer is being enabled to join an ongoing playback. |
| Throws | |
|---|---|
androidx.media3.exoplayer.ExoPlaybackException |
If an error occurs. |
onPositionReset
protected fun onPositionReset(
positionUs: Long,
joining: Boolean,
sampleStreamIsResetToKeyFrame: Boolean
): Unit
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 | |
|---|---|
positionUs: Long |
The new playback position in microseconds. |
joining: Boolean |
Whether this renderer is being enabled to join an ongoing playback. |
sampleStreamIsResetToKeyFrame: Boolean |
Whether the sample stream is reset to a key frame. |
| Throws | |
|---|---|
androidx.media3.exoplayer.ExoPlaybackException |
If an error occurs. |
onRendererOffsetChanged
protected fun onRendererOffsetChanged(offsetUs: Long): Unit
Called when the renderer's offset has been changed.
The default implementation is a no-op.
| Parameters | |
|---|---|
offsetUs: Long |
The offset that should be subtracted from |
| Throws | |
|---|---|
androidx.media3.exoplayer.ExoPlaybackException |
If an error occurs. |
onReset
protected fun onReset(): Unit
Called when the renderer is reset.
The default implementation is a no-op.
onStarted
protected fun onStarted(): Unit
Called when the renderer is started.
The default implementation is a no-op.
| Throws | |
|---|---|
androidx.media3.exoplayer.ExoPlaybackException |
If an error occurs. |
Protected properties
configuration
@MonotonicNonNull
protected val configuration: @MonotonicNonNull RendererConfiguration!