TestExoPlayerBuilder

Artifact: androidx.media3:media3-test-utils

Kotlin |Java

@UnstableApi
class TestExoPlayerBuilder

A builder of ExoPlayer instances for testing.

Summary

Public constructors
`TestExoPlayerBuilder(context: Context!)`

Public functions
`ExoPlayer!`	`build()` Builds an `ExoPlayer` using the provided values or their defaults.
`Long`	`getMaxSeekToPreviousPosition()` Returns the max seek to previous position used by the player.
`TestExoPlayerBuilder!`	`@CanIgnoreReturnValue setDeviceVolumeControlEnabled(deviceVolumeControlEnabled: Boolean)` Sets the variable controlling player's ability to get/set device volume.
`TestExoPlayerBuilder!`	`@CanIgnoreReturnValue setDynamicSchedulingEnabled(dynamicSchedulingEnabled: Boolean)` See `experimentalSetDynamicSchedulingEnabled` for details.
`TestExoPlayerBuilder!`	`@CanIgnoreReturnValue setMaxSeekToPreviousPositionMs(maxSeekToPreviousPositionMs: Long)` Sets the max seek to previous position, in milliseconds, to be used by the player.
`TestExoPlayerBuilder!`	`@CanIgnoreReturnValue setPreloadConfiguration( preloadConfiguration: ExoPlayer.PreloadConfiguration! )` Sets the preload configuration.
`TestExoPlayerBuilder!`	`@CanIgnoreReturnValue setRenderers(renderers: Array<Renderer!>!)` Sets the `Renderer`s.
`TestExoPlayerBuilder!`	`@CanIgnoreReturnValue setStuckPlayingDetectionTimeoutMs(stuckPlayingDetectionTimeoutMs: Int)` See `setStuckPlayingDetectionTimeoutMs` for details.
`TestExoPlayerBuilder!`	`@CanIgnoreReturnValue setStuckSuppressedDetectionTimeoutMs( stuckSuppressedDetectionTimeoutMs: Int )` See `setStuckSuppressedDetectionTimeoutMs` for details.
`TestExoPlayerBuilder!`	`@CanIgnoreReturnValue @RequiresApi(value = 35) setSuitableOutputChecker(suitableOutputChecker: SuitableOutputChecker!)` Sets the `SuitableOutputChecker` to check the suitability of the selected outputs for playback.
`TestExoPlayerBuilder!`	`@CanIgnoreReturnValue setSuppressPlaybackOnUnsuitableOutput( suppressPlaybackOnUnsuitableOutput: Boolean )` See `setSuppressPlaybackOnUnsuitableOutput` for details.

Public properties
`BandwidthMeter!`	`bandwidthMeter`
`Clock!`	`clock`
`LoadControl!`	`loadControl`
`@MonotonicNonNull Looper!`	`@MonotonicNonNull looper`
`MediaSource.Factory?`	`mediaSourceFactory`
`Array<Renderer!>?`	`renderers`
`RenderersFactory?`	`renderersFactory`
`Long`	`seekBackIncrementMs`
`Long`	`seekForwardIncrementMs`
`DefaultTrackSelector!`	`trackSelector`
`Boolean`	`useLazyPreparation`

Public constructors

TestExoPlayerBuilder

TestExoPlayerBuilder(context: Context!)

Public functions

build

fun build(): ExoPlayer!

Builds an ExoPlayer using the provided values or their defaults.

getMaxSeekToPreviousPosition

fun getMaxSeekToPreviousPosition(): Long

Returns the max seek to previous position used by the player.

setDeviceVolumeControlEnabled

@CanIgnoreReturnValue
fun setDeviceVolumeControlEnabled(deviceVolumeControlEnabled: Boolean): TestExoPlayerBuilder!

Sets the variable controlling player's ability to get/set device volume.

Parameters
`deviceVolumeControlEnabled: Boolean`	Whether the player can get/set device volume.

Returns
`TestExoPlayerBuilder!`	This builder.

setDynamicSchedulingEnabled

@CanIgnoreReturnValue
fun setDynamicSchedulingEnabled(dynamicSchedulingEnabled: Boolean): TestExoPlayerBuilder!

See experimentalSetDynamicSchedulingEnabled for details.

Parameters
`dynamicSchedulingEnabled: Boolean`	Whether the player should enable dynamically schedule its playback loop for when `Renderer` progress can be made.

Returns
`TestExoPlayerBuilder!`	This builder.

setMaxSeekToPreviousPositionMs

@CanIgnoreReturnValue
fun setMaxSeekToPreviousPositionMs(maxSeekToPreviousPositionMs: Long): TestExoPlayerBuilder!

Sets the max seek to previous position, in milliseconds, to be used by the player.

Parameters
`maxSeekToPreviousPositionMs: Long`	The max seek to previous position to be used by the player.

Returns
`TestExoPlayerBuilder!`	This builder.

setPreloadConfiguration

@CanIgnoreReturnValue
fun setPreloadConfiguration(
    preloadConfiguration: ExoPlayer.PreloadConfiguration!
): TestExoPlayerBuilder!

Sets the preload configuration.

See also
`setPreloadConfiguration`

setRenderers

@CanIgnoreReturnValue
fun setRenderers(renderers: Array<Renderer!>!): TestExoPlayerBuilder!

Sets the Renderers. If not set, the player will use a FakeVideoRenderer and a FakeAudioRenderer. Setting the renderers is not allowed after a call to setRenderersFactory.

Parameters
`renderers: Array<Renderer!>!`	A list of `Renderer`s to be used by the player.

Returns
`TestExoPlayerBuilder!`	This builder.

setStuckPlayingDetectionTimeoutMs

@CanIgnoreReturnValue
fun setStuckPlayingDetectionTimeoutMs(stuckPlayingDetectionTimeoutMs: Int): TestExoPlayerBuilder!

See setStuckPlayingDetectionTimeoutMs for details.

Parameters
`stuckPlayingDetectionTimeoutMs: Int`	The timeout after which the player is assumed stuck playing, in milliseconds.

Returns
`TestExoPlayerBuilder!`	This builder.

setStuckSuppressedDetectionTimeoutMs

@CanIgnoreReturnValue
fun setStuckSuppressedDetectionTimeoutMs(
    stuckSuppressedDetectionTimeoutMs: Int
): TestExoPlayerBuilder!

See setStuckSuppressedDetectionTimeoutMs for details.

Parameters
`stuckSuppressedDetectionTimeoutMs: Int`	The timeout after which the player is assumed stuck in a suppressed state, in milliseconds.

Returns
`TestExoPlayerBuilder!`	This builder.

setSuitableOutputChecker

@CanIgnoreReturnValue
@RequiresApi(value = 35)
fun setSuitableOutputChecker(suitableOutputChecker: SuitableOutputChecker!): TestExoPlayerBuilder!

Sets the SuitableOutputChecker to check the suitability of the selected outputs for playback.

If this method is not called, the library uses a default implementation based on framework APIs.

Returns
`TestExoPlayerBuilder!`	This builder.

setSuppressPlaybackOnUnsuitableOutput

@CanIgnoreReturnValue
fun setSuppressPlaybackOnUnsuitableOutput(
    suppressPlaybackOnUnsuitableOutput: Boolean
): TestExoPlayerBuilder!

See setSuppressPlaybackOnUnsuitableOutput for details.

Parameters
`suppressPlaybackOnUnsuitableOutput: Boolean`	Whether the player should suppress the playback when it is attempted on an unsuitable output.

Returns
`TestExoPlayerBuilder!`	This builder.

Public properties

bandwidthMeter

var bandwidthMeter: BandwidthMeter!

clock

var clock: Clock!

loadControl

var loadControl: LoadControl!

looper

@MonotonicNonNull
var looper: @MonotonicNonNull Looper!

mediaSourceFactory

var mediaSourceFactory: MediaSource.Factory?

renderers

val renderers: Array<Renderer!>?

renderersFactory

var renderersFactory: RenderersFactory?

seekBackIncrementMs

var seekBackIncrementMs: Long

seekForwardIncrementMs

var seekForwardIncrementMs: Long

trackSelector

var trackSelector: DefaultTrackSelector!

useLazyPreparation

var useLazyPreparation: Boolean