# Renderer Artifact: [androidx.media3:media3-exoplayer](https://developer.android.com/jetpack/androidx/releases/media3) [View Source](https://cs.android.com/search?q=file:androidx/media3/exoplayer/Renderer.java+class:androidx.media3.exoplayer.Renderer) *** ** * ** *** ``` @UnstableApi interface Renderer : PlayerMessage.Target ```
Known direct subclasses [BaseRenderer](https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/BaseRenderer), [ForwardingRenderer](https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/ForwardingRenderer), [NoSampleRenderer](https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/NoSampleRenderer) |---|---| | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/BaseRenderer` | An abstract base class suitable for most `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer` implementations. | | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/ForwardingRenderer` | An overridable `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer` implementation forwarding all methods to another renderer. | | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/NoSampleRenderer` | A `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer` implementation whose track type is `https://developer.android.com/reference/kotlin/androidx/media3/common/C#TRACK_TYPE_NONE()` and does not consume data from its `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/SampleStream`. | Known indirect subclasses [CameraMotionRenderer](https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/video/spherical/CameraMotionRenderer), [CapturingRenderersFactory.CapturingMediaCodecVideoRenderer](https://developer.android.com/reference/kotlin/androidx/media3/test/utils/robolectric/CapturingRenderersFactory.CapturingMediaCodecVideoRenderer), [DecoderAudioRenderer](https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/DecoderAudioRenderer), [DecoderVideoRenderer](https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/video/DecoderVideoRenderer), [FakeAudioRenderer](https://developer.android.com/reference/kotlin/androidx/media3/test/utils/FakeAudioRenderer), [FakeMediaClockRenderer](https://developer.android.com/reference/kotlin/androidx/media3/test/utils/FakeMediaClockRenderer), [FakeRenderer](https://developer.android.com/reference/kotlin/androidx/media3/test/utils/FakeRenderer), [FakeVideoRenderer](https://developer.android.com/reference/kotlin/androidx/media3/test/utils/FakeVideoRenderer), [ImageRenderer](https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/image/ImageRenderer), [MediaCodecAudioRenderer](https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/MediaCodecAudioRenderer), [MediaCodecRenderer](https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/mediacodec/MediaCodecRenderer), [MediaCodecVideoRenderer](https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/video/MediaCodecVideoRenderer), [MetadataRenderer](https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/metadata/MetadataRenderer), [TextRenderer](https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/text/TextRenderer) |---|---| | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/video/spherical/CameraMotionRenderer` | A `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer` that parses the camera motion track. | | `https://developer.android.com/reference/kotlin/androidx/media3/test/utils/robolectric/CapturingRenderersFactory.CapturingMediaCodecVideoRenderer` | A `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/video/MediaCodecVideoRenderer` that will not skip or drop buffers due to slow processing. | | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/DecoderAudioRenderer` | Decodes and renders audio using a `https://developer.android.com/reference/kotlin/androidx/media3/decoder/Decoder`. | | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/video/DecoderVideoRenderer` | Decodes and renders video using a `https://developer.android.com/reference/kotlin/androidx/media3/decoder/Decoder`. | | `https://developer.android.com/reference/kotlin/androidx/media3/test/utils/FakeAudioRenderer` | A `https://developer.android.com/reference/kotlin/androidx/media3/test/utils/FakeRenderer` that supports `https://developer.android.com/reference/kotlin/androidx/media3/common/C#TRACK_TYPE_AUDIO()`. | | `https://developer.android.com/reference/kotlin/androidx/media3/test/utils/FakeMediaClockRenderer` | Fake abstract `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer` which is also a `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/MediaClock`. | | `https://developer.android.com/reference/kotlin/androidx/media3/test/utils/FakeRenderer` | Fake `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer` that supports any format with the matching track type. | | `https://developer.android.com/reference/kotlin/androidx/media3/test/utils/FakeVideoRenderer` | A `https://developer.android.com/reference/kotlin/androidx/media3/test/utils/FakeRenderer` that supports `https://developer.android.com/reference/kotlin/androidx/media3/common/C#TRACK_TYPE_VIDEO()`. | | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/image/ImageRenderer` | A `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer` implementation for images. | | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/MediaCodecAudioRenderer` | Decodes and renders audio using `https://developer.android.com/reference/android/media/MediaCodec.html` and an `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/AudioSink`. | | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/mediacodec/MediaCodecRenderer` | An abstract renderer that uses `https://developer.android.com/reference/android/media/MediaCodec.html` to decode samples for rendering. | | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/video/MediaCodecVideoRenderer` | Decodes and renders video using `https://developer.android.com/reference/android/media/MediaCodec.html`. | | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/metadata/MetadataRenderer` | A renderer for metadata. | | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/text/TextRenderer` | A `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer` for text. | *** ** * ** *** Renders media read from a `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/SampleStream`. Internally, a renderer's lifecycle is managed by the owning `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/ExoPlayer`. The renderer is transitioned through various states as the overall playback state and enabled tracks change. The valid state transitions are shown below, annotated with the methods that are called during each transition. ![Renderer state transitions](https://developer.android.com/static/images/reference/androidx/media3/exoplayer/renderer-states.svg) ## Format support The player will select a renderer based on the `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/RendererCapabilities` returned from `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#getCapabilities()`. If the capabilities indicate support for a `https://developer.android.com/reference/kotlin/androidx/media3/common/Format`, the renderer is expected to handle `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/SampleStream` instances containing samples of this `https://developer.android.com/reference/kotlin/androidx/media3/common/Format`. ## Resource management Renderers should acquire resources like codecs when entering `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#STATE_ENABLED()` for the first time. As the renderer may transition quickly to and from `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#STATE_DISABLED()`, it is recommended to hold onto resources even when entering `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#STATE_DISABLED()`. The player will explicitly call `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#reset()` if the renderer is no longer needed, at which point any acquired limited resources should be released. ## Configuration changes As renderers are created once in the lifetime of a player, they may need to be re-configured later based on user settings or other environmental changes. This is generally done by handling `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/PlayerMessage` in `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/PlayerMessage.Target#handleMessage(int,java.lang.Object)`. There are many predefined common reconfigurations in `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer.MessageType`, but custom renderers can add their own handling as needed. ## Reading and rendering samples The renderer receives a `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/SampleStream` to read from when `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#enable(androidx.media3.exoplayer.RendererConfiguration,androidx.media3.common.Format[],androidx.media3.exoplayer.source.SampleStream,long,boolean,boolean,long,long,androidx.media3.exoplayer.source.MediaSource.MediaPeriodId)`. When seamlessly transitioning from one item to another, the renderer may get new `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/SampleStream` instances via `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#replaceStream(androidx.media3.common.Format[],androidx.media3.exoplayer.source.SampleStream,long,long,androidx.media3.exoplayer.source.MediaSource.MediaPeriodId)`. Note that `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#replaceStream(androidx.media3.common.Format[],androidx.media3.exoplayer.source.SampleStream,long,long,androidx.media3.exoplayer.source.MediaSource.MediaPeriodId)` may be called as soon as the `https://developer.android.com/reference/kotlin/androidx/media3/common/C#BUFFER_FLAG_END_OF_STREAM()` has been read from the current `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/SampleStream` to allow reading new samples as early as possible. At this point, the renderer may still be processing samples from the previous stream(s). Once the current stream has been `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#setCurrentStreamFinal()`, no further calls to `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#replaceStream(androidx.media3.common.Format[],androidx.media3.exoplayer.source.SampleStream,long,long,androidx.media3.exoplayer.source.MediaSource.MediaPeriodId)` are allowed to happen without first `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#disable()` the renderer again. The player will regularly call `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#render(long,long)` to let the renderer make progress. Once the renderer has prepared its internal pipeline to handle continuous playback progress, it should report itself as `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#isReady()`. The player will only transition the renderer to `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#STATE_STARTED()` if it reports itself as ready. If the renderer is blocked from making progress, it should return `false` from `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#isReady()`, which will result in a `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#stop()` operation back to `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#STATE_ENABLED()`. As long as it is in `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#STATE_STARTED()`, the renderer is expected to actively output the data it is processing in line with the current playback position passed to `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#render(long,long)`. The only exception is the very first sample (for example the first video frame), that is allowed to be output in `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#STATE_ENABLED()` if the `mayRenderStartOfStream` flag was set in `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#enable(androidx.media3.exoplayer.RendererConfiguration,androidx.media3.common.Format[],androidx.media3.exoplayer.source.SampleStream,long,boolean,boolean,long,long,androidx.media3.exoplayer.source.MediaSource.MediaPeriodId)` or later set via `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#enableMayRenderStartOfStream()`. Once the renderer finished all processing it needs to do (that is, no further call to `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#render(long,long)` is needed) and the current stream is `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#isCurrentStreamFinal()`, it should report itself as `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#isEnded()`. ## Timestamps and offsets The renderer deals with potentially multiple consecutive input streams and has to handle position updates and stream transitions. This means there are multiple types of timestamps and offsets relevant in the context of this class: - **`https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/SampleStream` timestamp** : The timestamp associated with each sample read from a `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/SampleStream`. This corresponds to the time in the `https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline.Period` this stream belongs to. The current playback context can be obtained by using the `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#setTimeline(androidx.media3.common.Timeline)` and the `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/MediaSource.MediaPeriodId` provided together with each `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/SampleStream`. - **Renderer timestamp** : The timestamp of the overall playback. This is a continuously increasing value across all input sample streams and what it passed to `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#render(long,long)` as the current `positionUs`. - **Stream offset** : The constant offset between the current *`https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/SampleStream` timestamps* and the *renderer timestamp* . This value is provided when setting a new stream in `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#enable(androidx.media3.exoplayer.RendererConfiguration,androidx.media3.common.Format[],androidx.media3.exoplayer.source.SampleStream,long,boolean,boolean,long,long,androidx.media3.exoplayer.source.MediaSource.MediaPeriodId)` or `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#replaceStream(androidx.media3.common.Format[],androidx.media3.exoplayer.source.SampleStream,long,long,androidx.media3.exoplayer.source.MediaSource.MediaPeriodId)`. - **Stream start position** : The *renderer timestamp* at which the current `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/SampleStream` first starts playing. This value is provided when setting a new stream in `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#enable(androidx.media3.exoplayer.RendererConfiguration,androidx.media3.common.Format[],androidx.media3.exoplayer.source.SampleStream,long,boolean,boolean,long,long,androidx.media3.exoplayer.source.MediaSource.MediaPeriodId)` or `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#replaceStream(androidx.media3.common.Format[],androidx.media3.exoplayer.source.SampleStream,long,long,androidx.media3.exoplayer.source.MediaSource.MediaPeriodId)`. Note that it may be different from the *Stream offset* as streams can start at non-zero *`https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/SampleStream` timestamps*. - **Reset position** : The *Renderer timestamp* at which continuous playback last started. This is either the *stream start position* provided in `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#enable(androidx.media3.exoplayer.RendererConfiguration,androidx.media3.common.Format[],androidx.media3.exoplayer.source.SampleStream,long,boolean,boolean,long,long,androidx.media3.exoplayer.source.MediaSource.MediaPeriodId)`, or the position set in any subsequent `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#resetPosition(long,boolean)` call. Note that this value is not changed when playback transitions seamlessly to a new stream after calling `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#replaceStream(androidx.media3.common.Format[],androidx.media3.exoplayer.source.SampleStream,long,long,androidx.media3.exoplayer.source.MediaSource.MediaPeriodId)`. After any position reset, the samples read next are those needed to start playback at the intended *reset position* . In some cases, the renderer will encounter output data before the intended *reset position* (for example video frames starting from the previous keyframe). In these cases, the renderer should drop data internally and only start producing output at the intended *reset position*. ## Summary | ### Nested types | |---| | `@https://developer.android.com/reference/java/lang/annotation/Documented.html @https://developer.android.com/reference/java/lang/annotation/Retention.html(value = https://developer.android.com/reference/java/lang/annotation/RetentionPolicy.html#SOURCE) @https://developer.android.com/reference/java/lang/annotation/Target.html(value = https://developer.android.com/reference/java/lang/annotation/ElementType.html#TYPE_USE) @https://developer.android.com/reference/kotlin/androidx/annotation/IntDef(open = true, value = ) annotation https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer.MessageType` Represents a type of message that can be passed to a renderer. | | `@https://developer.android.com/reference/java/lang/annotation/Documented.html @https://developer.android.com/reference/java/lang/annotation/Retention.html(value = https://developer.android.com/reference/java/lang/annotation/RetentionPolicy.html#SOURCE) @https://developer.android.com/reference/java/lang/annotation/Target.html(value = https://developer.android.com/reference/java/lang/annotation/ElementType.html#TYPE_USE) @https://developer.android.com/reference/kotlin/androidx/annotation/IntDef(value = ) annotation https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer.State` The renderer states. | | `interface https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer.WakeupListener` Some renderers can signal when `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#render(long,long)` should be called. | | ### Constants | |---|---| | `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#DEFAULT_DURATION_TO_PROGRESS_US() = 10000` Default minimum duration that the playback clock must advance before `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#render(long,long)` can make progress. | | `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#DEFAULT_IDLE_DURATION_TO_PROGRESS_US() = 1000000` Default duration to progress reported if the renderer does not need calls to `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#render(long,long)` to progress, if it's in `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#STATE_ENABLED()` and already `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#isReady()` or `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#isEnded()`. | | `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#MSG_CUSTOM_BASE() = 10000` Applications or extensions may define custom `MSG_*` constants that can be passed to renderers. | | `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#MSG_SET_AUDIO_ATTRIBUTES() = 3` A type of a message that can be passed to an audio renderer via `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/ExoPlayer#createMessage(androidx.media3.exoplayer.PlayerMessage.Target)`. | | `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#MSG_SET_AUDIO_OUTPUT_PROVIDER() = 20` The type of a message that can be passed to audio renderers via `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/ExoPlayer#createMessage(androidx.media3.exoplayer.PlayerMessage.Target)`. | | `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#MSG_SET_AUDIO_SESSION_ID() = 10` The type of a message that can be passed to audio and video renderers via `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/ExoPlayer#createMessage(androidx.media3.exoplayer.PlayerMessage.Target)`. | | `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#MSG_SET_AUX_EFFECT_INFO() = 6` A type of a message that can be passed to an audio renderer via `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/ExoPlayer#createMessage(androidx.media3.exoplayer.PlayerMessage.Target)`. | | `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#MSG_SET_CAMERA_MOTION_LISTENER() = 8` The type of a message that can be passed to a camera motion renderer via `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/ExoPlayer#createMessage(androidx.media3.exoplayer.PlayerMessage.Target)`. | | `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#MSG_SET_CHANGE_FRAME_RATE_STRATEGY() = 5` The type of a message that can be passed to a video renderer via `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/ExoPlayer#createMessage(androidx.media3.exoplayer.PlayerMessage.Target)`. | | `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#MSG_SET_CODEC_PARAMETERS() = 21` The type of a message that can be passed to renderers via `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/ExoPlayer#createMessage(androidx.media3.exoplayer.PlayerMessage.Target)`. | | `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#MSG_SET_IMAGE_METADATA_LISTENER() = 23` The type of a message that can be passed to an image renderer via `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/ExoPlayer#createMessage(androidx.media3.exoplayer.PlayerMessage.Target)`. | | `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#MSG_SET_IMAGE_OUTPUT() = 15` The type of message that can be passed to an image renderer to set a desired image output. | | `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#MSG_SET_PREFERRED_AUDIO_DEVICE() = 12` The type of a message that can be passed to audio renderers via `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/ExoPlayer#createMessage(androidx.media3.exoplayer.PlayerMessage.Target)`. | | `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#MSG_SET_PRIORITY() = 16` The type of message that can be passed to a renderer to set its priority. | | `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#MSG_SET_SCALING_MODE() = 4` The type of a message that can be passed to a `https://developer.android.com/reference/android/media/MediaCodec.html`-based video renderer via `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/ExoPlayer#createMessage(androidx.media3.exoplayer.PlayerMessage.Target)`. | | `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#MSG_SET_SCRUBBING_MODE() = 18` The type of message that can be passed to a renderer to direct it to enable or disable scrubbing mode. | | `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#MSG_SET_SKIP_SILENCE_ENABLED() = 9` The type of a message that can be passed to an audio renderer via `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/ExoPlayer#createMessage(androidx.media3.exoplayer.PlayerMessage.Target)`. | | `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#MSG_SET_SUBSCRIBED_CODEC_PARAMETER_KEYS() = 22` A message to set the keys for which a renderer should report parameter changes. | | `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#MSG_SET_VIDEO_EFFECTS() = 13` The type of a message that can be passed to a video renderer. | | `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#MSG_SET_VIDEO_FRAME_METADATA_LISTENER() = 7` The type of a message that can be passed to a video renderer via `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/ExoPlayer#createMessage(androidx.media3.exoplayer.PlayerMessage.Target)`. | | `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#MSG_SET_VIDEO_OUTPUT() = 1` The type of a message that can be passed to a video renderer via `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/ExoPlayer#createMessage(androidx.media3.exoplayer.PlayerMessage.Target)`. | | `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#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. | | `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#MSG_SET_VIRTUAL_DEVICE_ID() = 19` The type of a message that can be passed to audio renderers via `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/ExoPlayer#createMessage(androidx.media3.exoplayer.PlayerMessage.Target)`. | | `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#MSG_SET_VOLUME() = 2` A type of a message that can be passed to an audio renderer via `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/ExoPlayer#createMessage(androidx.media3.exoplayer.PlayerMessage.Target)`. | | `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#MSG_SET_WAKEUP_LISTENER() = 11` The type of a message that can be passed to a `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer` via `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/ExoPlayer#createMessage(androidx.media3.exoplayer.PlayerMessage.Target)`, to inform the renderer that it can schedule waking up another component. | | `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#MSG_TRANSFER_RESOURCES() = 17` The type of message that can be passed to a renderer to direct it to transfer relevant resources to another renderer. | | `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#STATE_DISABLED() = 0` The renderer is disabled. | | `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#STATE_ENABLED() = 1` The renderer is enabled but not started. | | `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#STATE_STARTED() = 2` The renderer is started. | | ### Public functions | |---|---| | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#disable()()` Disable the renderer, transitioning it to the `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#STATE_DISABLED()` state. | | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#enable(androidx.media3.exoplayer.RendererConfiguration,androidx.media3.common.Format[],androidx.media3.exoplayer.source.SampleStream,long,boolean,boolean,long,long,androidx.media3.exoplayer.source.MediaSource.MediaPeriodId)( configuration: https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/RendererConfiguration!, formats: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-array/index.html!, stream: https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/SampleStream!, positionUs: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html, joining: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, mayRenderStartOfStream: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, startPositionUs: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html, offsetUs: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html, mediaPeriodId: https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/MediaSource.MediaPeriodId! )` Enables the renderer to consume from the specified `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/SampleStream`. | | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#enableMayRenderStartOfStream()()` Enables this renderer to render the start of the stream even if the state is not `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#STATE_STARTED()` yet. | | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/RendererCapabilities!` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#getCapabilities()()` Returns the capabilities of the renderer. | | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#getDurationToProgressUs(long,long)(positionUs: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html, elapsedRealtimeUs: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html)` Returns minimum amount of playback clock time that must pass from `elapsedRealtimeUs` in order for the `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#render(long,long)` call to make progress. | | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/MediaClock?` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#getMediaClock()()` If the renderer advances its own playback position then this method returns a corresponding `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/MediaClock`. | | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html!` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#getName()()` Returns the name of this renderer, for logging and debugging purposes. | | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#getReadingPositionUs()()` Returns the renderer time up to which the renderer has read samples, in microseconds, or `https://developer.android.com/reference/kotlin/androidx/media3/common/C#TIME_END_OF_SOURCE()` if the renderer has read the current `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/SampleStream` to the end. | | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `@https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer.State https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#getState()()` Returns the current state of the renderer. | | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/SampleStream?` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#getStream()()` Returns the `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/SampleStream` being consumed, or null if the renderer is disabled. | | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `@https://developer.android.com/reference/kotlin/androidx/media3/common/C.TrackType https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#getTrackType()()` Returns the track type that the renderer handles. | | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#hasReadStreamToEnd()()` Returns whether the renderer has read the current `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/SampleStream` to the end. | | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#init(int,androidx.media3.exoplayer.analytics.PlayerId,androidx.media3.common.util.Clock)(index: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, playerId: https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/analytics/PlayerId!, clock: https://developer.android.com/reference/kotlin/androidx/media3/common/util/Clock!)` Initializes the renderer for playback with a player. | | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#isCurrentStreamFinal()()` Returns whether the current `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/SampleStream` will be the final one supplied before the renderer is next disabled or reset. | | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#isEnded()()` Whether the renderer is ready for the `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/ExoPlayer` instance to transition to `https://developer.android.com/reference/kotlin/androidx/media3/common/Player#STATE_ENDED()`. | | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#isReady()()` Whether the renderer is able to immediately render media from the current position. | | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#maybeThrowStreamError()()` Throws an error that's preventing the renderer from reading from its `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/SampleStream`. | | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#release()()` Releases the renderer. | | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#render(long,long)(positionUs: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html, elapsedRealtimeUs: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html)` Incrementally renders the `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/SampleStream`. | | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#replaceStream(androidx.media3.common.Format[],androidx.media3.exoplayer.source.SampleStream,long,long,androidx.media3.exoplayer.source.MediaSource.MediaPeriodId)( formats: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-array/index.html!, stream: https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/SampleStream!, startPositionUs: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html, offsetUs: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html, mediaPeriodId: https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/MediaSource.MediaPeriodId! )` Replaces the `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/SampleStream` from which samples will be consumed. | | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#reset()()` Forces the renderer to give up any resources (e.g. media decoders) that it may be holding. | | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#resetPosition(long,boolean)(positionUs: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html, sampleStreamIsResetToKeyFrame: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)` Signals to the renderer that a position discontinuity has occurred. | | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#setCurrentStreamFinal()()` Signals to the renderer that the current `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/SampleStream` will be the final one supplied before it is next disabled or reset. | | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#setPlaybackSpeed(float,float)(currentPlaybackSpeed: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html, targetPlaybackSpeed: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html)` Indicates the playback speed to this renderer. | | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#setTimeline(androidx.media3.common.Timeline)(timeline: https://developer.android.com/reference/kotlin/androidx/media3/common/Timeline!)` Sets the timeline that is currently being played. | | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#start()()` Starts the renderer, meaning that calls to `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#render(long,long)` will cause media to be rendered. | | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#stop()()` Stops the renderer, transitioning it to the `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#STATE_ENABLED()` state. | | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#supportsResetPositionWithoutKeyFrameReset(long)(positionUs: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html)` Returns whether the renderer can support processing a position discontinuity without a key frame reset. | | ### Inherited functions | |---| | From [androidx.media3.exoplayer.PlayerMessage.Target](https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/PlayerMessage.Target) |---|---| | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/PlayerMessage.Target#handleMessage(int,java.lang.Object)(@https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer.MessageType messageType: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, message: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?)` Handles a message delivered to the target. | | ## Constants ### DEFAULT_DURATION_TO_PROGRESS_US ``` const val DEFAULT_DURATION_TO_PROGRESS_US = 10000: Long ``` Default minimum duration that the playback clock must advance before `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#render(long,long)` can make progress. | See also | |---|---| | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#getDurationToProgressUs(long,long)` | | ### DEFAULT_IDLE_DURATION_TO_PROGRESS_US ``` const val DEFAULT_IDLE_DURATION_TO_PROGRESS_US = 1000000: Long ``` Default duration to progress reported if the renderer does not need calls to `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#render(long,long)` to progress, if it's in `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#STATE_ENABLED()` and already `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#isReady()` or `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#isEnded()`. | See also | |---|---| | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#getDurationToProgressUs(long,long)` | | ### MSG_CUSTOM_BASE ``` const val MSG_CUSTOM_BASE = 10000: Int ``` Applications or extensions may define custom `MSG_*` constants that can be passed to renderers. These custom constants must be greater than or equal to this value. ### MSG_SET_AUDIO_ATTRIBUTES ``` const val MSG_SET_AUDIO_ATTRIBUTES = 3: Int ``` A type of a message that can be passed to an audio renderer via `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/ExoPlayer#createMessage(androidx.media3.exoplayer.PlayerMessage.Target)`. The message payload should be an `https://developer.android.com/reference/kotlin/androidx/media3/common/AudioAttributes` instance that will configure the underlying audio track. If not set, the default audio attributes will be used. They are suitable for general media playback. Setting the audio attributes during playback may introduce a short gap in audio output as the audio track is recreated. A new audio session id will also be generated. If tunneling is enabled by the track selector, the specified audio attributes will be ignored, but they will take effect if audio is later played without tunneling. To get audio attributes that are equivalent to a legacy stream type, pass the stream type to `https://developer.android.com/reference/kotlin/androidx/media3/common/util/Util#getAudioUsageForStreamType(int)` and use the returned `https://developer.android.com/reference/kotlin/androidx/media3/common/C.AudioUsage` to build an audio attributes instance. ### MSG_SET_AUDIO_OUTPUT_PROVIDER ``` const val MSG_SET_AUDIO_OUTPUT_PROVIDER = 20: Int ``` The type of a message that can be passed to audio renderers via `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/ExoPlayer#createMessage(androidx.media3.exoplayer.PlayerMessage.Target)`. The message payload should be an `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/audio/AudioOutputProvider` instance. ### MSG_SET_AUDIO_SESSION_ID ``` const val MSG_SET_AUDIO_SESSION_ID = 10: Int ``` The type of a message that can be passed to audio and video renderers via `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/ExoPlayer#createMessage(androidx.media3.exoplayer.PlayerMessage.Target)`. The message payload should be an `https://developer.android.com/reference/java/lang/Integer.html` instance representing the audio session ID that will be attached to the underlying audio track. Video renderers that support tunneling will use the audio session ID when tunneling is enabled. ### MSG_SET_AUX_EFFECT_INFO ``` const val MSG_SET_AUX_EFFECT_INFO = 6: Int ``` A type of a message that can be passed to an audio renderer via `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/ExoPlayer#createMessage(androidx.media3.exoplayer.PlayerMessage.Target)`. The message payload should be an `https://developer.android.com/reference/kotlin/androidx/media3/common/AuxEffectInfo` instance representing an auxiliary audio effect for the underlying audio track. ### MSG_SET_CAMERA_MOTION_LISTENER ``` const val MSG_SET_CAMERA_MOTION_LISTENER = 8: Int ``` The type of a message that can be passed to a camera motion renderer via `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/ExoPlayer#createMessage(androidx.media3.exoplayer.PlayerMessage.Target)`. The message payload should be a `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/video/spherical/CameraMotionListener` instance, or null. ### MSG_SET_CHANGE_FRAME_RATE_STRATEGY ``` const val MSG_SET_CHANGE_FRAME_RATE_STRATEGY = 5: Int ``` The type of a message that can be passed to a video renderer via `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/ExoPlayer#createMessage(androidx.media3.exoplayer.PlayerMessage.Target)`. The message payload should be one of the integer strategy constants in `https://developer.android.com/reference/kotlin/androidx/media3/common/C.VideoChangeFrameRateStrategy`. ### MSG_SET_CODEC_PARAMETERS ``` const val MSG_SET_CODEC_PARAMETERS = 21: Int ``` The type of a message that can be passed to renderers via `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/ExoPlayer#createMessage(androidx.media3.exoplayer.PlayerMessage.Target)`. The message payload should be a `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/CodecParameters` instance. ### MSG_SET_IMAGE_METADATA_LISTENER ``` const val MSG_SET_IMAGE_METADATA_LISTENER = 23: Int ``` The type of a message that can be passed to an image renderer via `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/ExoPlayer#createMessage(androidx.media3.exoplayer.PlayerMessage.Target)`. The message payload should be an `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/image/ImageMetadataListener` instance, or null. ### MSG_SET_IMAGE_OUTPUT ``` const val MSG_SET_IMAGE_OUTPUT = 15: Int ``` The type of message that can be passed to an image renderer to set a desired image output. The message payload should be an `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/image/ImageOutput`, or null to clear a previously set image output. ### MSG_SET_PREFERRED_AUDIO_DEVICE ``` const val MSG_SET_PREFERRED_AUDIO_DEVICE = 12: Int ``` The type of a message that can be passed to audio renderers via `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/ExoPlayer#createMessage(androidx.media3.exoplayer.PlayerMessage.Target)`. The message payload should be an `https://developer.android.com/reference/android/media/AudioDeviceInfo.html` instance representing the preferred audio device, or null to restore the default. ### MSG_SET_PRIORITY ``` const val MSG_SET_PRIORITY = 16: Int ``` The type of message that can be passed to a renderer to set its priority. The message payload should be an `https://developer.android.com/reference/java/lang/Integer.html` instance for the priority of the renderer. See `C.PRIORITY_` constants for predefined values. ### MSG_SET_SCALING_MODE ``` const val MSG_SET_SCALING_MODE = 4: Int ``` The type of a message that can be passed to a `https://developer.android.com/reference/android/media/MediaCodec.html`-based video renderer via `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/ExoPlayer#createMessage(androidx.media3.exoplayer.PlayerMessage.Target)`. The message payload should be one of the integer scaling modes in `https://developer.android.com/reference/kotlin/androidx/media3/common/C.VideoScalingMode`. Note that the scaling mode only applies if the `https://developer.android.com/reference/android/view/Surface.html` targeted by the renderer is owned by a `https://developer.android.com/reference/android/view/SurfaceView.html`. ### MSG_SET_SCRUBBING_MODE ``` const val MSG_SET_SCRUBBING_MODE = 18: Int ``` The type of message that can be passed to a renderer to direct it to enable or disable scrubbing mode. The message payload should be a `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/ScrubbingModeParameters` instance to enable or `null` to disable scrubbing mode. ### MSG_SET_SKIP_SILENCE_ENABLED ``` const val MSG_SET_SKIP_SILENCE_ENABLED = 9: Int ``` The type of a message that can be passed to an audio renderer via `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/ExoPlayer#createMessage(androidx.media3.exoplayer.PlayerMessage.Target)`. The message payload should be a `https://developer.android.com/reference/java/lang/Boolean.html` instance telling whether to enable or disable skipping silences in the audio stream. ### MSG_SET_SUBSCRIBED_CODEC_PARAMETER_KEYS ``` const val MSG_SET_SUBSCRIBED_CODEC_PARAMETER_KEYS = 22: Int ``` A message to set the keys for which a renderer should report parameter changes. The message payload will be an `ImmutableSet` of keys. ### MSG_SET_VIDEO_EFFECTS ``` const val MSG_SET_VIDEO_EFFECTS = 13: Int ``` The type of a message that can be passed to a video renderer. The message payload should be a `https://developer.android.com/reference/java/util/List.html` containing `https://developer.android.com/reference/kotlin/androidx/media3/common/Effect`. ### MSG_SET_VIDEO_FRAME_METADATA_LISTENER ``` const val MSG_SET_VIDEO_FRAME_METADATA_LISTENER = 7: Int ``` The type of a message that can be passed to a video renderer via `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/ExoPlayer#createMessage(androidx.media3.exoplayer.PlayerMessage.Target)`. The message payload should be a `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/video/VideoFrameMetadataListener` instance, or null. ### MSG_SET_VIDEO_OUTPUT ``` const val MSG_SET_VIDEO_OUTPUT = 1: Int ``` The type of a message that can be passed to a video renderer via `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/ExoPlayer#createMessage(androidx.media3.exoplayer.PlayerMessage.Target)`. The message payload is normally a `https://developer.android.com/reference/android/view/Surface.html`, however some video renderers may accept other outputs (e.g., `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/video/VideoDecoderOutputBufferRenderer`). If the receiving renderer does not support the payload type as an output, then it will clear any existing output that it has. ### MSG_SET_VIDEO_OUTPUT_RESOLUTION ``` const val MSG_SET_VIDEO_OUTPUT_RESOLUTION = 14: Int ``` The type of a message that can be passed to a video renderer to set the desired output resolution. The message payload should be a `https://developer.android.com/reference/kotlin/androidx/media3/common/util/Size` of the desired output width and height. Use this method only when playing with video `https://developer.android.com/reference/kotlin/androidx/media3/common/Effect`. ### MSG_SET_VIRTUAL_DEVICE_ID ``` const val MSG_SET_VIRTUAL_DEVICE_ID = 19: Int ``` The type of a message that can be passed to audio renderers via `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/ExoPlayer#createMessage(androidx.media3.exoplayer.PlayerMessage.Target)`. The message payload should be an `https://developer.android.com/reference/java/lang/Integer.html` instance representing the virtual device id, or `https://developer.android.com/reference/kotlin/androidx/media3/common/C#INDEX_UNSET()` if unspecified. ### MSG_SET_VOLUME ``` const val MSG_SET_VOLUME = 2: Int ``` A type of a message that can be passed to an audio renderer via `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/ExoPlayer#createMessage(androidx.media3.exoplayer.PlayerMessage.Target)`. The message payload should be a `https://developer.android.com/reference/java/lang/Float.html` with 0 being silence and 1 being unity gain. ### MSG_SET_WAKEUP_LISTENER ``` const val MSG_SET_WAKEUP_LISTENER = 11: Int ``` The type of a message that can be passed to a `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer` via `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/ExoPlayer#createMessage(androidx.media3.exoplayer.PlayerMessage.Target)`, to inform the renderer that it can schedule waking up another component. The message payload must be a `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer.WakeupListener` instance. ### MSG_TRANSFER_RESOURCES ``` const val MSG_TRANSFER_RESOURCES = 17: Int ``` The type of message that can be passed to a renderer to direct it to transfer relevant resources to another renderer. The message payload should be a instance of the same `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer` type as the renderer being passed the message. ### STATE_DISABLED ``` const val STATE_DISABLED = 0: Int ``` The renderer is disabled. A renderer in this state will not proactively acquire resources that it requires for rendering (e.g., media decoders), but may continue to hold any that it already has. `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#reset()` can be called to force the renderer to release such resources. ### STATE_ENABLED ``` const val STATE_ENABLED = 1: Int ``` The renderer is enabled but not started. A renderer in this state may render media at the current position (e.g. an initial video frame), but the position will not advance. A renderer in this state will typically hold resources that it requires for rendering (e.g. media decoders). ### STATE_STARTED ``` const val STATE_STARTED = 2: Int ``` The renderer is started. Calls to `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#render(long,long)` will cause media to be rendered. ## Public functions ### disable ``` fun disable(): Unit ``` Disable the renderer, transitioning it to the `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#STATE_DISABLED()` state. This method may be called when the renderer is in the following states: `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#STATE_ENABLED()`. ### enable ``` fun enable(     configuration: RendererConfiguration!,     formats: Array!,     stream: SampleStream!,     positionUs: Long,     joining: Boolean,     mayRenderStartOfStream: Boolean,     startPositionUs: Long,     offsetUs: Long,     mediaPeriodId: MediaSource.MediaPeriodId! ): Unit ``` Enables the renderer to consume from the specified `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/SampleStream`. This method may be called when the renderer is in the following states: `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#STATE_DISABLED()`. | Parameters | |---|---| | `configuration: https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/RendererConfiguration!` | The renderer configuration. | | `formats: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-array/index.html!` | The enabled formats. | | `stream: https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/SampleStream!` | The `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/SampleStream` from which the renderer should consume. | | `positionUs: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html` | The player's current position. | | `joining: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | Whether this renderer is being enabled to join an ongoing playback. | | `mayRenderStartOfStream: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | Whether this renderer is allowed to render the start of the stream even if the state is not `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#STATE_STARTED()` yet. | | `startPositionUs: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html` | The start position of the stream in renderer time (microseconds). | | `offsetUs: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html` | The offset to be added to timestamps of buffers read from `stream` before they are rendered. | | `mediaPeriodId: https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/MediaSource.MediaPeriodId!` | The `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/MediaSource.MediaPeriodId` of the `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/MediaPeriod` producing the ` stream`. | | Throws | |---|---| | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/ExoPlaybackException` | If an error occurs. | ### enableMayRenderStartOfStream ``` fun enableMayRenderStartOfStream(): Unit ``` Enables this renderer to render the start of the stream even if the state is not `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#STATE_STARTED()` yet. This is used to update the value of `mayRenderStartOfStream` passed to `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#enable(androidx.media3.exoplayer.RendererConfiguration,androidx.media3.common.Format[],androidx.media3.exoplayer.source.SampleStream,long,boolean,boolean,long,long,androidx.media3.exoplayer.source.MediaSource.MediaPeriodId)`. ### getCapabilities ``` fun getCapabilities(): RendererCapabilities! ``` Returns the capabilities of the renderer. | Returns | |---|---| | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/RendererCapabilities!` | The capabilities of the renderer. | ### getDurationToProgressUs ``` fun getDurationToProgressUs(positionUs: Long, elapsedRealtimeUs: Long): Long ``` Returns minimum amount of playback clock time that must pass from `elapsedRealtimeUs` in order for the `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#render(long,long)` call to make progress. This method may be called when the renderer is in the following states: `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#STATE_ENABLED()`, `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#STATE_STARTED()`. The default return time is `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#DEFAULT_DURATION_TO_PROGRESS_US()` if the renderer is in `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#STATE_STARTED()`, or in `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#STATE_ENABLED()` and not yet `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#isReady()` or `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#isEnded()`. Otherwise, it returns `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#DEFAULT_IDLE_DURATION_TO_PROGRESS_US()`. | Parameters | |---|---| | `positionUs: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html` | The current render position in microseconds, measured at the start of the current iteration of the rendering loop. | | `elapsedRealtimeUs: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html` | `https://developer.android.com/reference/android/os/SystemClock.html#elapsedRealtime()` in microseconds, measured at the start of the current iteration of the rendering loop. | | Returns | |---|---| | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html` | Minimum amount of playback clock time that must pass before renderer is able to make progress. | ### getMediaClock ``` fun getMediaClock(): MediaClock? ``` If the renderer advances its own playback position then this method returns a corresponding `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/MediaClock`. If provided, the player will use the returned `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/MediaClock` as its source of time during playback. A player may have at most one renderer that returns a `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/MediaClock` from this method. | Returns | |---|---| | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/MediaClock?` | The `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/MediaClock` tracking the playback position of the renderer, or null. | ### getName ``` fun getName(): String! ``` Returns the name of this renderer, for logging and debugging purposes. Should typically be the renderer's (un-obfuscated) class name. | Returns | |---|---| | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html!` | The name of this renderer. | ### getReadingPositionUs ``` fun getReadingPositionUs(): Long ``` Returns the renderer time up to which the renderer has read samples, in microseconds, or `https://developer.android.com/reference/kotlin/androidx/media3/common/C#TIME_END_OF_SOURCE()` if the renderer has read the current `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/SampleStream` to the end. This method may be called when the renderer is in the following states: `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#STATE_ENABLED()`, `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#STATE_STARTED()`. ### getState ``` @Renderer.State fun getState(): Int ``` Returns the current state of the renderer. | Returns | |---|---| | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | The current state. One of `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#STATE_DISABLED()`, `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#STATE_ENABLED()` and `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#STATE_STARTED()`. | ### getStream ``` fun getStream(): SampleStream? ``` Returns the `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/SampleStream` being consumed, or null if the renderer is disabled. ### getTrackType ``` @C.TrackType fun getTrackType(): Int ``` Returns the track type that the renderer handles. | Returns | |---|---| | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | The `https://developer.android.com/reference/kotlin/androidx/media3/common/C.TrackType`. | | See also | |---|---| | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/ExoPlayer#getRendererType(int)` | | ### hasReadStreamToEnd ``` fun hasReadStreamToEnd(): Boolean ``` Returns whether the renderer has read the current `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/SampleStream` to the end. This method may be called when the renderer is in the following states: `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#STATE_ENABLED()`, `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#STATE_STARTED()`. ### init ``` fun init(index: Int, playerId: PlayerId!, clock: Clock!): Unit ``` Initializes the renderer for playback with a player. | Parameters | |---|---| | `index: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | The renderer index within the player. | | `playerId: https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/analytics/PlayerId!` | The `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/analytics/PlayerId` of the player. | | `clock: https://developer.android.com/reference/kotlin/androidx/media3/common/util/Clock!` | The `https://developer.android.com/reference/kotlin/androidx/media3/common/util/Clock`. | ### isCurrentStreamFinal ``` fun isCurrentStreamFinal(): Boolean ``` Returns whether the current `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/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 `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/ExoPlayer` instance to transition to `https://developer.android.com/reference/kotlin/androidx/media3/common/Player#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: `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#STATE_ENABLED()`, `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#STATE_STARTED()`. | Returns | |---|---| | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | 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 `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#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 `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#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: `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#STATE_ENABLED()`, `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#STATE_STARTED()`. | Returns | |---|---| | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | Whether the renderer is ready to render media. | ### maybeThrowStreamError ``` fun maybeThrowStreamError(): Unit ``` Throws an error that's preventing the renderer from reading from its `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/SampleStream`. Does nothing if no such error exists. This method may be called when the renderer is in the following states: `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#STATE_ENABLED()`, `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#STATE_STARTED()`. | Throws | |---|---| | `https://developer.android.com/reference/java/io/IOException.html` | An error that's preventing the renderer from making progress or buffering more data. | ### release ``` fun release(): Unit ``` Releases the renderer. The renderer must not be used after calling this method. ### render ``` fun render(positionUs: Long, elapsedRealtimeUs: Long): Unit ``` Incrementally renders the `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/SampleStream`. If the renderer is in the `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#STATE_ENABLED()` state then each call to this method will do work toward being ready to render the `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/SampleStream` when the renderer is started. If the renderer is in the `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#STATE_STARTED()` state then calls to this method will render the `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/SampleStream` in sync with the specified media positions. The renderer may also render the very start of the media at the current position (e.g. the first frame of a video stream) while still in the `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#STATE_ENABLED()` state, unless it's the initial start of the media after calling `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#enable(androidx.media3.exoplayer.RendererConfiguration,androidx.media3.common.Format[],androidx.media3.exoplayer.source.SampleStream,long,boolean,boolean,long,long,androidx.media3.exoplayer.source.MediaSource.MediaPeriodId)` with ` mayRenderStartOfStream` set to `false`. This method should return quickly, and should not block if the renderer is unable to make useful progress. This method may be called when the renderer is in the following states: `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#STATE_ENABLED()`, `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#STATE_STARTED()`. | Parameters | |---|---| | `positionUs: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html` | The current media time in microseconds, measured at the start of the current iteration of the rendering loop. | | `elapsedRealtimeUs: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html` | `https://developer.android.com/reference/android/os/SystemClock.html#elapsedRealtime()` in microseconds, measured at the start of the current iteration of the rendering loop. | | Throws | |---|---| | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/ExoPlaybackException` | If an error occurs. | ### replaceStream ``` fun replaceStream(     formats: Array!,     stream: SampleStream!,     startPositionUs: Long,     offsetUs: Long,     mediaPeriodId: MediaSource.MediaPeriodId! ): Unit ``` Replaces the `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/SampleStream` from which samples will be consumed. This method may be called when the renderer is in the following states: `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#STATE_ENABLED()`, `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#STATE_STARTED()`. | Parameters | |---|---| | `formats: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-array/index.html!` | The enabled formats. | | `stream: https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/SampleStream!` | The `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/SampleStream` from which the renderer should consume. | | `startPositionUs: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html` | The start position of the new stream in renderer time (microseconds). | | `offsetUs: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html` | The offset to be added to timestamps of buffers read from `stream` before they are rendered. | | `mediaPeriodId: https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/MediaSource.MediaPeriodId!` | The `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/MediaSource.MediaPeriodId` of the `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/MediaPeriod` producing the ` stream`. | | Throws | |---|---| | `https://developer.android.com/reference/kotlin/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: `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#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 `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/SampleStream` is guaranteed to provide samples starting from a key frame. `sampleStreamIsResetToKeyFrame` is guaranteed to be `true` unless the implementation overrides `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#supportsResetPositionWithoutKeyFrameReset(long)` to return `true`. This method may be called when the renderer is in the following states: `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#STATE_ENABLED()`, `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#STATE_STARTED()`. | Parameters | |---|---| | `positionUs: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html` | The new playback position in microseconds. | | `sampleStreamIsResetToKeyFrame: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | Whether the renderer's `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/SampleStream` is guaranteed to provide samples starting from a key frame. | | Throws | |---|---| | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/ExoPlaybackException` | If an error occurs handling the reset. | ### setCurrentStreamFinal ``` fun setCurrentStreamFinal(): Unit ``` Signals to the renderer that the current `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/source/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: `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#STATE_ENABLED()`, `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#STATE_STARTED()`. ### setPlaybackSpeed ``` fun setPlaybackSpeed(currentPlaybackSpeed: Float, targetPlaybackSpeed: Float): Unit ``` Indicates the playback speed to this renderer. The default implementation is a no-op. | Parameters | |---|---| | `currentPlaybackSpeed: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html` | The factor by which playback is currently sped up. | | `targetPlaybackSpeed: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html` | The target factor by which playback should be sped up. This may be different from `currentPlaybackSpeed`, for example, if the speed is temporarily adjusted for live playback. | | Throws | |---|---| | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/ExoPlaybackException` | If an error occurs handling the playback speed. | ### 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 `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#render(long,long)` will cause media to be rendered. This method may be called when the renderer is in the following states: `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#STATE_ENABLED()`. | Throws | |---|---| | `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/ExoPlaybackException` | If an error occurs. | ### stop ``` fun stop(): Unit ``` Stops the renderer, transitioning it to the `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#STATE_ENABLED()` state. This method may be called when the renderer is in the following states: `https://developer.android.com/reference/kotlin/androidx/media3/exoplayer/Renderer#STATE_STARTED()`. ### supportsResetPositionWithoutKeyFrameReset ``` fun supportsResetPositionWithoutKeyFrameReset(positionUs: Long): Boolean ``` Returns whether the renderer can support processing a position discontinuity without a key frame reset. | Parameters | |---|---| | `positionUs: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html` | The new playback position in microseconds. | | Returns | |---|---| | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | Whether the renderer can support processing a position discontinuity without a key frame reset. |