Overview

A builder for ExoPlayer instances.

See ExoPlayer.Builder.Builder(Context) for the list of default values.

Summary

Constructors

Creates a builder.

Use ExoPlayer.Builder.Builder(Context, RenderersFactory), ExoPlayer.Builder.Builder(Context, MediaSource.Factory) or ExoPlayer.Builder.Builder(Context, RenderersFactory, MediaSource.Factory) instead, if you intend to provide a custom RenderersFactory, ExtractorsFactory or DefaultMediaSourceFactory. This is to ensure that ProGuard or R8 can remove ExoPlayer's DefaultRenderersFactory, DefaultExtractorsFactory and DefaultMediaSourceFactory from the APK.

The builder uses the following default values:

• RenderersFactory: DefaultRenderersFactory
• TrackSelector: DefaultTrackSelector
• : DefaultMediaSourceFactory
• LoadControl: DefaultLoadControl
• BandwidthMeter: DefaultBandwidthMeter.getSingletonInstance(Context)
• LivePlaybackSpeedControl: DefaultLivePlaybackSpeedControl
• : The associated with the current thread, or the of the application's main thread if the current thread doesn't have a
• AnalyticsCollector: AnalyticsCollector with Clock.DEFAULT
• : C.PRIORITY_PLAYBACK
• PriorityTaskManager: null (not used)
• AudioAttributes: AudioAttributes.DEFAULT, not handling audio focus
• : C.WAKE_MODE_NONE
• handleAudioBecomingNoisy: false
• skipSilenceEnabled: false
• : C.VIDEO_SCALING_MODE_DEFAULT
• : C.VIDEO_CHANGE_FRAME_RATE_STRATEGY_ONLY_IF_SEAMLESS
• useLazyPreparation: true
• SeekParameters: SeekParameters.DEFAULT
• seekBackIncrementMs: C.DEFAULT_SEEK_BACK_INCREMENT_MS
• seekForwardIncrementMs: C.DEFAULT_SEEK_FORWARD_INCREMENT_MS
• maxSeekToPreviousPositionMs: C.DEFAULT_MAX_SEEK_TO_PREVIOUS_POSITION_MS
• releaseTimeoutMs: ExoPlayer.DEFAULT_RELEASE_TIMEOUT_MS
• detachSurfaceTimeoutMs: ExoPlayer.DEFAULT_DETACH_SURFACE_TIMEOUT_MS
• pauseAtEndOfMediaItems: false
• usePlatformDiagnostics: true
• Clock: Clock.DEFAULT
• playbackLooper: null (create new thread)
• dynamicSchedulingEnabled: false

Parameters:

context: A .

Creates a builder with a custom RenderersFactory.

See ExoPlayer.Builder.Builder(Context) for a list of default values.

Note that this constructor is only useful to try and ensure that ExoPlayer's DefaultRenderersFactory can be removed by ProGuard or R8.

Parameters:

context: A .
renderersFactory: A factory for creating Renderers to be used by the player.

Creates a builder with a custom .

See ExoPlayer.Builder.Builder(Context) for a list of default values.

Note that this constructor is only useful to try and ensure that ExoPlayer's DefaultMediaSourceFactory (and therefore DefaultExtractorsFactory) can be removed by ProGuard or R8.

Parameters:

context: A .
mediaSourceFactory: A factory for creating a MediaSource from a MediaItem.

Creates a builder with a custom RenderersFactory and .

See ExoPlayer.Builder.Builder(Context) for a list of default values.

Note that this constructor is only useful to try and ensure that ExoPlayer's DefaultRenderersFactory, DefaultMediaSourceFactory (and therefore DefaultExtractorsFactory) can be removed by ProGuard or R8.

Parameters:

context: A .
renderersFactory: A factory for creating Renderers to be used by the player.
mediaSourceFactory: A factory for creating a MediaSource from a MediaItem.

Creates a builder with the specified custom components.

Note that this constructor is only useful to try and ensure that ExoPlayer's default components can be removed by ProGuard or R8.

Parameters:

context: A .
renderersFactory: A factory for creating Renderers to be used by the player.
mediaSourceFactory: A .
trackSelector: A TrackSelector.
loadControl: A LoadControl.
bandwidthMeter: A BandwidthMeter.
analyticsCollector: An AnalyticsCollector.

Methods

Sets a limit on the time a call to ExoPlayer.setForegroundMode(boolean) can spend. If a call to ExoPlayer.setForegroundMode(boolean) takes more than timeoutMs milliseconds to complete, the player will raise an error via .

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

Parameters:

timeoutMs: The time limit in milliseconds.

Sets whether dynamic scheduling is enabled.

If enabled, ExoPlayer's playback loop will run as rarely as possible by scheduling work for when Renderer progress can be made.

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

Parameters:

dynamicSchedulingEnabled: Whether to enable dynamic scheduling.

Sets whether the player should suppress playback that is attempted on an unsuitable output. An example of an unsuitable audio output is the built-in speaker on a Wear OS device (unless it is explicitly selected by the user).

If called with suppressPlaybackOnUnsuitableOutput = true, then a playback attempt on an unsuitable audio output will result in calls to with the value Player.PLAYBACK_SUPPRESSION_REASON_UNSUITABLE_AUDIO_OUTPUT.

Callers of this may also want to enable ExoPlayer.Builder.setHandleAudioBecomingNoisy(boolean) to prevent playback from continuing on the built-in speaker when a headset is disconnected.

Parameters:

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

Returns:

This builder.

Sets the RenderersFactory that will be used by the player.

Parameters:

renderersFactory: A RenderersFactory.

Returns:

This builder.

Sets the that will be used by the player.

Parameters:

mediaSourceFactory: A .

Returns:

This builder.

Sets the TrackSelector that will be used by the player.

Parameters:

trackSelector: A TrackSelector.

Returns:

This builder.

Sets the LoadControl that will be used by the player.

Parameters:

loadControl: A LoadControl.

Returns:

This builder.

Sets the BandwidthMeter that will be used by the player.

Parameters:

bandwidthMeter: A BandwidthMeter.

Returns:

This builder.

Sets the that must be used for all calls to the player and that is used to call listeners on.

Parameters:

looper: A .

Returns:

This builder.

Sets the AnalyticsCollector that will collect and forward all player events.

Parameters:

analyticsCollector: An AnalyticsCollector.

Returns:

This builder.

Sets the for this player.

The priority may influence resource allocation between multiple players or other components running in the same app.

This priority is used for the PriorityTaskManager, if set.

Parameters:

priority: The .

Sets an PriorityTaskManager that will be used by the player.

The priority set via ExoPlayer.Builder.setPriority(int) (or by default) will be set while the player is loading.

Parameters:

priorityTaskManager: A PriorityTaskManager, or null to not use one.

Returns:

This builder.

Sets AudioAttributes that will be used by the player and whether to handle audio focus.

If audio focus should be handled, the AudioAttributes.usage must be C.USAGE_MEDIA or C.USAGE_GAME. Other usages will throw an java.lang.IllegalArgumentException.

Parameters:

audioAttributes: AudioAttributes.
handleAudioFocus: Whether the player should handle audio focus.

Returns:

This builder.

Sets the that will be used by the player.

Enabling this feature requires the permission. It should be used together with a foreground for use cases where playback occurs and the screen is off (e.g. background audio playback). It is not useful when the screen will be kept on during playback (e.g. foreground video playback).

When enabled, the locks ( / ) will be held whenever the player is in the Player.STATE_READY or Player.STATE_BUFFERING states with playWhenReady = true. The locks held depend on the specified .

Parameters:

wakeMode: A .

Returns:

This builder.

Sets whether the player should pause automatically when audio is rerouted from a headset to device speakers. See the audio becoming noisy documentation for more information.

Parameters:

handleAudioBecomingNoisy: Whether the player should pause automatically when audio is rerouted from a headset to device speakers.

Returns:

This builder.

Sets whether silences silences in the audio stream is enabled.

Parameters:

skipSilenceEnabled: Whether skipping silences is enabled.

Returns:

This builder.

Sets whether the player is allowed to set, increase, decrease or mute device volume.

Parameters:

deviceVolumeControlEnabled: Whether controlling device volume is enabled.

Returns:

This builder.

Sets the that will be used by the player.

The scaling mode only applies if a MediaCodec-based video Renderer is enabled and if the output surface is owned by a .

Parameters:

videoScalingMode: A .

Returns:

This builder.

Sets a that will be used by the player when provided with a video output .

The strategy only applies if a MediaCodec-based video Renderer is enabled. Applications wishing to use should set the mode to C.VIDEO_CHANGE_FRAME_RATE_STRATEGY_OFF to disable calls to from ExoPlayer, and should then call directly from application code.

Parameters:

videoChangeFrameRateStrategy: A .

Returns:

This builder.

Sets whether media sources should be initialized lazily.

If false, all initial preparation steps (e.g., manifest loads) happen immediately. If true, these initial preparations are triggered only when the player starts buffering the media.

Parameters:

useLazyPreparation: Whether to use lazy preparation.

Returns:

This builder.

Sets the parameters that control how seek operations are performed.

Parameters:

seekParameters: The SeekParameters.

Returns:

This builder.

Sets the Player.seekBack() increment.

Parameters:

seekBackIncrementMs: The seek back increment, in milliseconds.

Returns:

This builder.

Sets the Player.seekForward() increment.

Parameters:

seekForwardIncrementMs: The seek forward increment, in milliseconds.

Returns:

This builder.

Sets the maximum position for which Player.seekToPrevious() seeks to the previous MediaItem.

Parameters:

maxSeekToPreviousPositionMs: The maximum position, in milliseconds.

Returns:

This builder.

Sets a timeout for calls to ExoPlayer.release() and ExoPlayer.setForegroundMode(boolean).

If a call to ExoPlayer.release() or ExoPlayer.setForegroundMode(boolean) takes more than timeoutMs to complete, the player will report an error via .

Parameters:

releaseTimeoutMs: The release timeout, in milliseconds.

Returns:

This builder.

Sets a timeout for detaching a surface from the player.

If detaching a surface or replacing a surface takes more than detachSurfaceTimeoutMs to complete, the player will report an error via .

Parameters:

detachSurfaceTimeoutMs: The timeout for detaching a surface, in milliseconds.

Returns:

This builder.

Sets whether to pause playback at the end of each media item.

This means the player will pause at the end of each window in the current timeline. Listeners will be informed by a call to with the reason Player.PLAY_WHEN_READY_CHANGE_REASON_END_OF_MEDIA_ITEM when this happens.

Parameters:

pauseAtEndOfMediaItems: Whether to pause playback at the end of each media item.

Returns:

This builder.

Sets the LivePlaybackSpeedControl that will control the playback speed when playing live streams, in order to maintain a steady target offset from the live stream edge.

Parameters:

livePlaybackSpeedControl: The LivePlaybackSpeedControl.

Returns:

This builder.

Sets whether the player reports diagnostics data to the Android platform.

If enabled, the player will use the to create a and forward playback events and performance data to this session. This helps to provide system performance and debugging information for media playback on the device. This data may also be collected by Google if sharing usage and diagnostics data is enabled by the user of the device.

Parameters:

usePlatformDiagnostics: Whether the player reports diagnostics data to the Android platform.

Returns:

This builder.

Sets the Clock that will be used by the player. Should only be set for testing purposes.

Parameters:

clock: A Clock.

Returns:

This builder.

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:

This builder.

Sets the that will be used for playback.

The backing thread should run with priority java.lang.Process and should handle messages within 10ms.

Parameters:

playbackLooper: A .

Returns:

This builder.

Sets the player name that is included in the PlayerId for informational purpose to recognize the player by its PlayerId.

The default is an empty string.

Parameters:

playerName: A name for the player in the PlayerId.

Returns:

This builder.

Builds an ExoPlayer instance.