AudioFormat.Builder

public final class AudioFormat.Builder


Builder for constructing AudioFormat instances.

By default, builders are initialized to 44,100 Hz sample rate, 32-bit float PCM encoding (ENCODING_PCM_FLOAT), and 2 (stereo) channels.

Summary

Public constructors

Constructs a new Builder initialized with default audio format properties (44,100 Hz, 32-bit float PCM, 2 channels).

Constructs a new Builder initialized with the properties of an existing AudioFormat.

Public methods

AudioFormat

Builds and returns a new AudioFormat instance with the configured properties.

AudioFormat.Builder

Sets the number of audio channels.

AudioFormat.Builder

Sets the audio encoding format.

AudioFormat.Builder

Sets the audio sample rate in Hz.

Public constructors

Builder

public Builder()

Constructs a new Builder initialized with default audio format properties (44,100 Hz, 32-bit float PCM, 2 channels).

Builder

public Builder(AudioFormat format)

Constructs a new Builder initialized with the properties of an existing AudioFormat.

Parameters
AudioFormat format

the existing format to copy properties from

Throws
java.lang.NullPointerException

if format is null

Public methods

build

public AudioFormat build()

Builds and returns a new AudioFormat instance with the configured properties.

Returns
AudioFormat

a new AudioFormat instance

Throws
java.lang.IllegalArgumentException

if sample rate is outside [8000, 48000] Hz, channel count is not 1 or 2, or encoding is not ENCODING_PCM_FLOAT.

setChannelCount

@CanIgnoreReturnValue
public AudioFormat.Builder setChannelCount(int channelCount)

Sets the number of audio channels.

Parameters
int channelCount

the number of channels (typically 1 for mono, 2 for stereo)

Returns
AudioFormat.Builder

this Builder instance for chaining

setEncoding

@CanIgnoreReturnValue
public AudioFormat.Builder setEncoding(@AudioEncoding int encoding)

Sets the audio encoding format.

Parameters
@AudioEncoding int encoding

the encoding format constant (ENCODING_PCM_FLOAT)

Returns
AudioFormat.Builder

this Builder instance for chaining

setSampleRate

@CanIgnoreReturnValue
public AudioFormat.Builder setSampleRate(int sampleRate)

Sets the audio sample rate in Hz.

Parameters
int sampleRate

the sample rate in Hz (between 8,000 and 48,000 Hz, e.g., 44100, 48000)

Returns
AudioFormat.Builder

this Builder instance for chaining