MediaCodecVideoRenderer.Builder

Artifact: androidx.media3:media3-exoplayer

View Source

---

Kotlin |Java

class MediaCodecVideoRenderer.Builder

---

A builder to create MediaCodecVideoRenderer instances.

Summary

Public constructors
Builder(context: Context!) Creates a new builder.

Public functions
MediaCodecVideoRenderer!	build() Builds the MediaCodecVideoRenderer.
MediaCodecVideoRenderer.Builder!	@CanIgnoreReturnValue @ExperimentalApi experimentalSetLateThresholdToDropDecoderInputUs(     lateThresholdToDropDecoderInputUs: Long ) Sets the late threshold for rendered output buffers, in microseconds, after which decoder input buffers may be dropped.
MediaCodecVideoRenderer.Builder!	@CanIgnoreReturnValue setAllowedJoiningTimeMs(allowedJoiningTimeMs: Long) Sets the maximum duration in milliseconds for which this video renderer can attempt to seamlessly join an ongoing playback.
MediaCodecVideoRenderer.Builder!	@CanIgnoreReturnValue setAssumedMinimumCodecOperatingRate(     assumedMinimumCodecOperatingRate: Float ) Sets a codec operating rate that all codecs instantiated by this renderer are assumed to meet implicitly (i.e. without the operating rate being set explicitly using KEY_OPERATING_RATE).
MediaCodecVideoRenderer.Builder!	@CanIgnoreReturnValue setCodecAdapterFactory(codecAdapterFactory: MediaCodecAdapter.Factory!) Sets the MediaCodecAdapter.Factory used to create MediaCodecAdapter instances.
MediaCodecVideoRenderer.Builder!	@CanIgnoreReturnValue @ExperimentalApi setEarlySchedulingThresholdUs(earlySchedulingThresholdUs: Long) Sets the threshold for how early a frame may be scheduled for release on the surface.
MediaCodecVideoRenderer.Builder!	@CanIgnoreReturnValue setEnableDecoderFallback(enableDecoderFallback: Boolean) Sets whether to enable fallback to lower-priority decoders if decoder initialization fails.
MediaCodecVideoRenderer.Builder!	@CanIgnoreReturnValue setEventHandler(eventHandler: Handler?) Sets a handler to use when delivering events to eventListener.
MediaCodecVideoRenderer.Builder!	@CanIgnoreReturnValue setEventListener(eventListener: VideoRendererEventListener?) Sets a listener for VideoRendererEventListener events.
MediaCodecVideoRenderer.Builder!	@CanIgnoreReturnValue setMaxDroppedFramesToNotify(maxDroppedFramesToNotify: Int) Sets the maximum number of frames that can be dropped between invocations of onDroppedFrames.
MediaCodecVideoRenderer.Builder!	@CanIgnoreReturnValue setMediaCodecSelector(mediaCodecSelector: MediaCodecSelector!) Sets the decoder selector.
MediaCodecVideoRenderer.Builder!	@CanIgnoreReturnValue setSkipBuffersWithIdenticalReleaseTime(     skipBuffersWithIdenticalReleaseTime: Boolean ) Sets whether to skip buffers that have an identical release time as the previous released buffer.
MediaCodecVideoRenderer.Builder!	@CanIgnoreReturnValue setVideoSink(videoSink: VideoSink?) Sets a VideoSink to consume the frames.

Public constructors

Builder

Builder(context: Context!)

Creates a new builder.

Parameters
context: Context!	A context.

Public functions

build

fun build(): MediaCodecVideoRenderer!

Builds the MediaCodecVideoRenderer. Must only be called once per Builder instance.

Throws IllegalStateException if the event handler and the event listener are neither both null nor both non- null.

experimentalSetLateThresholdToDropDecoderInputUs

@CanIgnoreReturnValue
@ExperimentalApi
fun experimentalSetLateThresholdToDropDecoderInputUs(
    lateThresholdToDropDecoderInputUs: Long
): MediaCodecVideoRenderer.Builder!

Sets the late threshold for rendered output buffers, in microseconds, after which decoder input buffers may be dropped.

The default value is DEFAULT_LATE_THRESHOLD_TO_DROP_DECODER_INPUT_US and therefore input buffers that are predicted to be rendered late will be dropped.

If TIME_UNSET is passed, decoder input buffers will not be dropped.

This method is experimental and will be renamed or removed in a future release.

Parameters
lateThresholdToDropDecoderInputUs: Long	The threshold in microseconds to drop decoder input buffers, or TIME_UNSET to disable dropping decoder input buffers.

setAllowedJoiningTimeMs

@CanIgnoreReturnValue
fun setAllowedJoiningTimeMs(allowedJoiningTimeMs: Long): MediaCodecVideoRenderer.Builder!

Sets the maximum duration in milliseconds for which this video renderer can attempt to seamlessly join an ongoing playback.

setAssumedMinimumCodecOperatingRate

@CanIgnoreReturnValue
fun setAssumedMinimumCodecOperatingRate(
    assumedMinimumCodecOperatingRate: Float
): MediaCodecVideoRenderer.Builder!

Sets a codec operating rate that all codecs instantiated by this renderer are assumed to meet implicitly (i.e. without the operating rate being set explicitly using KEY_OPERATING_RATE).

setCodecAdapterFactory

@CanIgnoreReturnValue
fun setCodecAdapterFactory(codecAdapterFactory: MediaCodecAdapter.Factory!): MediaCodecVideoRenderer.Builder!

Sets the MediaCodecAdapter.Factory used to create MediaCodecAdapter instances.

setEarlySchedulingThresholdUs

@CanIgnoreReturnValue
@ExperimentalApi
fun setEarlySchedulingThresholdUs(earlySchedulingThresholdUs: Long): MediaCodecVideoRenderer.Builder!

Sets the threshold for how early a frame may be scheduled for release on the surface.

This value is in microseconds. The default value is DEFAULT_EARLY_SCHEDULING_THRESHOLD_US.

This method is experimental and will be renamed or removed in a future release.

Parameters
earlySchedulingThresholdUs: Long	The maximum early time threshold in microseconds.

setEnableDecoderFallback

@CanIgnoreReturnValue
fun setEnableDecoderFallback(enableDecoderFallback: Boolean): MediaCodecVideoRenderer.Builder!

Sets whether to enable fallback to lower-priority decoders if decoder initialization fails. This may result in using a decoder that is slower/less efficient than the primary decoder.

setEventHandler

@CanIgnoreReturnValue
fun setEventHandler(eventHandler: Handler?): MediaCodecVideoRenderer.Builder!

Sets a handler to use when delivering events to eventListener.

The event handler and event listener are linked in that both should be set to either null or non-null values.

setEventListener

@CanIgnoreReturnValue
fun setEventListener(eventListener: VideoRendererEventListener?): MediaCodecVideoRenderer.Builder!

Sets a listener for VideoRendererEventListener events.

The event handler and event listener are linked in that both should be set to either null or non-null values.

setMaxDroppedFramesToNotify

@CanIgnoreReturnValue
fun setMaxDroppedFramesToNotify(maxDroppedFramesToNotify: Int): MediaCodecVideoRenderer.Builder!

Sets the maximum number of frames that can be dropped between invocations of onDroppedFrames.

setMediaCodecSelector

@CanIgnoreReturnValue
fun setMediaCodecSelector(mediaCodecSelector: MediaCodecSelector!): MediaCodecVideoRenderer.Builder!

Sets the decoder selector.

setSkipBuffersWithIdenticalReleaseTime

@CanIgnoreReturnValue
fun setSkipBuffersWithIdenticalReleaseTime(
    skipBuffersWithIdenticalReleaseTime: Boolean
): MediaCodecVideoRenderer.Builder!

Sets whether to skip buffers that have an identical release time as the previous released buffer.

Parameters
skipBuffersWithIdenticalReleaseTime: Boolean	Whether to skip buffers with identical release time.

Returns
MediaCodecVideoRenderer.Builder!	This builder.

setVideoSink

@CanIgnoreReturnValue
fun setVideoSink(videoSink: VideoSink?): MediaCodecVideoRenderer.Builder!

Sets a VideoSink to consume the frames.

If a VideoSink is not set and effects are set, a VideoSink produced by a PlaybackVideoGraphWrapper with its default configuration will be used to apply effects and render the frames on the output.