public final class

DefaultAudioSink.Builder

extends java.lang.Object

 java.lang.Object

↳androidx.media3.exoplayer.audio.DefaultAudioSink.Builder

Overview

A builder to create DefaultAudioSink instances.

Summary

Constructors
publicBuilder()

Creates a new builder.

Methods
public DefaultAudioSinkbuild()

Builds the DefaultAudioSink.

public DefaultAudioSink.BuildersetAudioCapabilities(AudioCapabilities audioCapabilities)

Sets audio capabilities for playback on this device.

public DefaultAudioSink.BuildersetAudioProcessorChain(DefaultAudioSink.AudioProcessorChain audioProcessorChain)

Sets the DefaultAudioSink.AudioProcessorChain to process audio before playback.

public DefaultAudioSink.BuildersetAudioProcessors(AudioProcessor audioProcessors[])

Sets an array of AudioProcessorss that will process PCM audio before output.

public DefaultAudioSink.BuildersetAudioTrackBufferSizeProvider(androidx.media3.exoplayer.audio.DefaultAudioSink.AudioTrackBufferSizeProvider audioTrackBufferSizeProvider)

Sets an to compute the buffer size when DefaultAudioSink.configure(Format, int, int[]) is called with specifiedBufferSize == 0.

public DefaultAudioSink.BuildersetEnableAudioTrackPlaybackParams(boolean enableAudioTrackPlaybackParams)

Sets whether to control the playback speed using the platform implementation (see AudioTrack), if supported.

public DefaultAudioSink.BuildersetEnableFloatOutput(boolean enableFloatOutput)

Sets whether to enable 32-bit float output or integer output.

public DefaultAudioSink.BuildersetOffloadMode(int offloadMode)

Sets the offload mode.

from java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructors

public Builder()

Creates a new builder.

Methods

public DefaultAudioSink.Builder setAudioCapabilities(AudioCapabilities audioCapabilities)

Sets audio capabilities for playback on this device. May be null if the default capabilities (no encoded audio passthrough support) should be assumed.

Default is AudioCapabilities.DEFAULT_AUDIO_CAPABILITIES.

public DefaultAudioSink.Builder setAudioProcessors(AudioProcessor audioProcessors[])

Sets an array of AudioProcessorss that will process PCM audio before output. May be empty. Equivalent of setAudioProcessorChain(new DefaultAudioProcessorChain(audioProcessors).

The default value is an empty array.

public DefaultAudioSink.Builder setAudioProcessorChain(DefaultAudioSink.AudioProcessorChain audioProcessorChain)

Sets the DefaultAudioSink.AudioProcessorChain to process audio before playback. The instance passed in must not be reused in other sinks. Processing chains are only supported for PCM playback (not passthrough or offload).

By default, no processing will be applied.

public DefaultAudioSink.Builder setEnableFloatOutput(boolean enableFloatOutput)

Sets whether to enable 32-bit float output or integer output. Where possible, 32-bit float output will be used if the input is 32-bit float, and also if the input is high resolution (24-bit or 32-bit) integer PCM. Float output is supported from API level 21. Audio processing (for example, speed adjustment) will not be available when float output is in use.

The default value is false.

public DefaultAudioSink.Builder setEnableAudioTrackPlaybackParams(boolean enableAudioTrackPlaybackParams)

Sets whether to control the playback speed using the platform implementation (see AudioTrack), if supported. If set to false, speed up/down of the audio will be done by ExoPlayer (see SonicAudioProcessor). Platform speed adjustment is lower latency, but less reliable.

The default value is false.

public DefaultAudioSink.Builder setOffloadMode(int offloadMode)

Sets the offload mode. If an audio format can be both played with offload and encoded audio passthrough, it will be played in offload. Audio offload is supported from API level 29. Most Android devices can only support one offload AudioTrack at a time and can invalidate it at any time. Thus an app can never be guaranteed that it will be able to play in offload. Audio processing (for example, speed adjustment) will not be available when offload is in use.

The default value is DefaultAudioSink.OFFLOAD_MODE_DISABLED.

public DefaultAudioSink.Builder setAudioTrackBufferSizeProvider(androidx.media3.exoplayer.audio.DefaultAudioSink.AudioTrackBufferSizeProvider audioTrackBufferSizeProvider)

Sets an to compute the buffer size when DefaultAudioSink.configure(Format, int, int[]) is called with specifiedBufferSize == 0.

The default value is .

public DefaultAudioSink build()

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