Added in API level 21

Summary: Ctors | Methods | Inherited Methods

AudioFormat.Builder

Kotlin |Java

public static class AudioFormat.Builder
extends Object

java.lang.Object
↳	android.media.AudioFormat.Builder

Builder class for AudioFormat objects. Use this class to configure and create an AudioFormat instance. By setting format characteristics such as audio encoding, channel mask or sample rate, you indicate which of those are to vary from the default behavior on this device wherever this audio format is used. See AudioFormat for a complete description of the different parameters that can be used to configure an AudioFormat instance.

AudioFormat is for instance used in AudioTrack.AudioTrack(AudioAttributes, AudioFormat, int, int, int). In this constructor, every format characteristic set on the Builder (e.g. with setSampleRate(int)) will alter the default values used by an AudioTrack. In this case for audio playback with AudioTrack, the sample rate set in the Builder would override the platform output sample rate which would otherwise be selected by default.

Summary

Public constructors
`Builder()` Constructs a new Builder with none of the format characteristics set.
`Builder(AudioFormat af)` Constructs a new Builder from a given `AudioFormat`.

Public methods
`AudioFormat`	`build()` Combines all of the format characteristics that have been set and return a new `AudioFormat` object.
`AudioFormat.Builder`	`setChannelIndexMask(int channelIndexMask)` Sets the channel index mask.
`AudioFormat.Builder`	`setChannelMask(int channelMask)` Sets the channel position mask.
`AudioFormat.Builder`	`setEncoding(int encoding)` Sets the data encoding format.
`AudioFormat.Builder`	`setSampleRate(int sampleRate)` Sets the sample rate.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public constructors

Builder

Added in API level 21

public Builder ()

Constructs a new Builder with none of the format characteristics set.

Builder

Added in API level 21

public Builder (AudioFormat af)

Constructs a new Builder from a given AudioFormat.

Parameters
`af`	`AudioFormat`: the `AudioFormat` object whose data will be reused in the new Builder.

Public methods

build

Added in API level 21

public AudioFormat build ()

Combines all of the format characteristics that have been set and return a new AudioFormat object.

Returns
`AudioFormat`	a new `AudioFormat` object

setChannelIndexMask

Added in API level 23

public AudioFormat.Builder setChannelIndexMask (int channelIndexMask)

Sets the channel index mask. A channel index mask specifies the association of audio samples in the frame with numbered endpoint channels. The i-th bit in the channel index mask corresponds to the i-th endpoint channel. For example, an endpoint with four channels is represented as index mask bits 0 through 3. This setChannelMask(int) for a positional mask interpretation.

Both AudioTrack and AudioRecord support a channel index mask. If a channel index mask is specified it is used, otherwise the channel position mask specified by setChannelMask is used. For AudioTrack and AudioRecord, a channel position mask is not required if a channel index mask is specified.

Parameters

Parameters
`channelIndexMask`	`int`: describes the configuration of the audio channels. For output, the `channelIndexMask` is an OR-ed combination of bits representing the mapping of `AudioTrack` write samples to output sink channels. For example, a mask of `0xa`, or binary `1010`, means the `AudioTrack` write frame consists of two samples, which are routed to the second and the fourth channels of the output sink. Unmatched output sink channels are zero filled and unmatched `AudioTrack` write samples are dropped. For input, the `channelIndexMask` is an OR-ed combination of bits representing the mapping of input source channels to `AudioRecord` read samples. For example, a mask of `0x5`, or binary `101`, will read from the first and third channel of the input source device and store them in the first and second sample of the `AudioRecord` read frame. Unmatched input source channels are dropped and unmatched `AudioRecord` read samples are zero filled.

channelIndexMask

int: describes the configuration of the audio channels.

For output, the channelIndexMask is an OR-ed combination of bits representing the mapping of AudioTrack write samples to output sink channels. For example, a mask of 0xa, or binary 1010, means the AudioTrack write frame consists of two samples, which are routed to the second and the fourth channels of the output sink. Unmatched output sink channels are zero filled and unmatched AudioTrack write samples are dropped.

For input, the channelIndexMask is an OR-ed combination of bits representing the mapping of input source channels to AudioRecord read samples. For example, a mask of 0x5, or binary 101, will read from the first and third channel of the input source device and store them in the first and second sample of the AudioRecord read frame. Unmatched input source channels are dropped and unmatched AudioRecord read samples are zero filled.

Returns
`AudioFormat.Builder`	the same `Builder` instance. This value cannot be `null`.

Throws
`IllegalArgumentException`	if the channel index mask is invalid or if both channel index mask and channel position mask are specified but do not have the same channel count.

setChannelMask

Added in API level 21

public AudioFormat.Builder setChannelMask (int channelMask)

Sets the channel position mask. The channel position mask specifies the association between audio samples in a frame with named endpoint channels. The samples in the frame correspond to the named set bits in the channel position mask, in ascending bit order. See setChannelIndexMask(int) to specify channels based on endpoint numbered channels. This description of channel position masks covers the concept in more details.

Parameters

Parameters
`channelMask`	`int`: describes the configuration of the audio channels. For output, the channelMask can be an OR-ed combination of channel position masks, e.g. `AudioFormat.CHANNEL_OUT_FRONT_LEFT`, `AudioFormat.CHANNEL_OUT_FRONT_RIGHT`, `AudioFormat.CHANNEL_OUT_FRONT_CENTER`, `AudioFormat.CHANNEL_OUT_LOW_FREQUENCY` `AudioFormat.CHANNEL_OUT_BACK_LEFT`, `AudioFormat.CHANNEL_OUT_BACK_RIGHT`, `AudioFormat.CHANNEL_OUT_BACK_CENTER`, `AudioFormat.CHANNEL_OUT_SIDE_LEFT`, `AudioFormat.CHANNEL_OUT_SIDE_RIGHT`. For output or `AudioTrack`, channel position masks which do not contain matched left/right pairs are invalid. For input or `AudioRecord`, the mask should be `AudioFormat.CHANNEL_IN_MONO` or `AudioFormat.CHANNEL_IN_STEREO`. `AudioFormat.CHANNEL_IN_MONO` is guaranteed to work on all devices.

channelMask

int: describes the configuration of the audio channels.

For output, the channelMask can be an OR-ed combination of channel position masks, e.g. AudioFormat.CHANNEL_OUT_FRONT_LEFT, AudioFormat.CHANNEL_OUT_FRONT_RIGHT, AudioFormat.CHANNEL_OUT_FRONT_CENTER, AudioFormat.CHANNEL_OUT_LOW_FREQUENCY AudioFormat.CHANNEL_OUT_BACK_LEFT, AudioFormat.CHANNEL_OUT_BACK_RIGHT, AudioFormat.CHANNEL_OUT_BACK_CENTER, AudioFormat.CHANNEL_OUT_SIDE_LEFT, AudioFormat.CHANNEL_OUT_SIDE_RIGHT.

For output or AudioTrack, channel position masks which do not contain matched left/right pairs are invalid.

For input or AudioRecord, the mask should be AudioFormat.CHANNEL_IN_MONO or AudioFormat.CHANNEL_IN_STEREO. AudioFormat.CHANNEL_IN_MONO is guaranteed to work on all devices.

Returns
`AudioFormat.Builder`	the same `Builder` instance. This value cannot be `null`.

Throws
`IllegalArgumentException`	if the channel mask is invalid or if both channel index mask and channel position mask are specified but do not have the same channel count.

setEncoding

Added in API level 21

public AudioFormat.Builder setEncoding (int encoding)

Sets the data encoding format.

Parameters

Parameters
`encoding`	`int`: the specified encoding or default. Value is `AudioFormat.ENCODING_DEFAULT`, `AudioFormat.ENCODING_PCM_16BIT`, `AudioFormat.ENCODING_PCM_8BIT`, `AudioFormat.ENCODING_PCM_FLOAT`, `AudioFormat.ENCODING_AC3`, `AudioFormat.ENCODING_E_AC3`, `AudioFormat.ENCODING_DTS`, `AudioFormat.ENCODING_DTS_HD`, `AudioFormat.ENCODING_MP3`, `AudioFormat.ENCODING_AAC_LC`, `AudioFormat.ENCODING_AAC_HE_V1`, `AudioFormat.ENCODING_AAC_HE_V2`, `AudioFormat.ENCODING_IEC61937`, `AudioFormat.ENCODING_DOLBY_TRUEHD`, `AudioFormat.ENCODING_AAC_ELD`, `AudioFormat.ENCODING_AAC_XHE`, `AudioFormat.ENCODING_AC4`, android.media.AudioFormat.ENCODING_AC4_L4, `AudioFormat.ENCODING_E_AC3_JOC`, `AudioFormat.ENCODING_DOLBY_MAT`, `AudioFormat.ENCODING_OPUS`, `AudioFormat.ENCODING_PCM_24BIT_PACKED`, `AudioFormat.ENCODING_PCM_32BIT`, `AudioFormat.ENCODING_MPEGH_BL_L3`, `AudioFormat.ENCODING_MPEGH_BL_L4`, `AudioFormat.ENCODING_MPEGH_LC_L3`, `AudioFormat.ENCODING_MPEGH_LC_L4`, `AudioFormat.ENCODING_DTS_UHD_P1`, `AudioFormat.ENCODING_DRA`, `AudioFormat.ENCODING_DTS_HD_MA`, `AudioFormat.ENCODING_DTS_UHD_P2`, or `AudioFormat.ENCODING_DSD`

encoding

int: the specified encoding or default. Value is AudioFormat.ENCODING_DEFAULT, AudioFormat.ENCODING_PCM_16BIT, AudioFormat.ENCODING_PCM_8BIT, AudioFormat.ENCODING_PCM_FLOAT, AudioFormat.ENCODING_AC3, AudioFormat.ENCODING_E_AC3, AudioFormat.ENCODING_DTS, AudioFormat.ENCODING_DTS_HD, AudioFormat.ENCODING_MP3, AudioFormat.ENCODING_AAC_LC, AudioFormat.ENCODING_AAC_HE_V1, AudioFormat.ENCODING_AAC_HE_V2, AudioFormat.ENCODING_IEC61937, AudioFormat.ENCODING_DOLBY_TRUEHD, AudioFormat.ENCODING_AAC_ELD, AudioFormat.ENCODING_AAC_XHE, AudioFormat.ENCODING_AC4, android.media.AudioFormat.ENCODING_AC4_L4, AudioFormat.ENCODING_E_AC3_JOC, AudioFormat.ENCODING_DOLBY_MAT, AudioFormat.ENCODING_OPUS, AudioFormat.ENCODING_PCM_24BIT_PACKED, AudioFormat.ENCODING_PCM_32BIT, AudioFormat.ENCODING_MPEGH_BL_L3, AudioFormat.ENCODING_MPEGH_BL_L4, AudioFormat.ENCODING_MPEGH_LC_L3, AudioFormat.ENCODING_MPEGH_LC_L4, AudioFormat.ENCODING_DTS_UHD_P1, AudioFormat.ENCODING_DRA, AudioFormat.ENCODING_DTS_HD_MA, AudioFormat.ENCODING_DTS_UHD_P2, or AudioFormat.ENCODING_DSD

Returns
`AudioFormat.Builder`	the same Builder instance.

Throws
	java.lang.IllegalArgumentException
`IllegalArgumentException`

setSampleRate

Added in API level 21

public AudioFormat.Builder setSampleRate (int sampleRate)

Sets the sample rate.

Parameters
`sampleRate`	`int`: the sample rate expressed in Hz

Returns
`AudioFormat.Builder`	the same Builder instance.

Throws
	java.lang.IllegalArgumentException
`IllegalArgumentException`