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(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.
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Constructs a new Builder with none of the format characteristics set.
| |||||||||||
Constructs a new Builder from a given
AudioFormat .
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Combines all of the format characteristics that have been set and return a new
AudioFormat object.
| |||||||||||
Sets the channel index mask.
| |||||||||||
Sets the channel position mask.
| |||||||||||
Sets the data encoding format.
| |||||||||||
Sets the sample rate.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
|
Constructs a new Builder with none of the format characteristics set.
Constructs a new Builder from a given AudioFormat
.
af | the AudioFormat object whose data will be reused in the new Builder.
|
---|
Combines all of the format characteristics that have been set and return a new
AudioFormat
object.
AudioFormat
object
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.
channelIndexMask | describes the configuration of the audio channels.
For output, the For input, the |
---|
Builder
instance.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. |
---|
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
Parameters
channelMask | describes the configuration of the audio channels.
For output, the channelMask can be an OR-ed combination of
channel position masks, e.g.
For a valid For input or |
---|
Builder
instance.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. |
---|
Sets the data encoding format.
encoding | one of ENCODING_DEFAULT ,
ENCODING_PCM_8BIT ,
ENCODING_PCM_16BIT ,
ENCODING_PCM_FLOAT ,
ENCODING_AC3 ,
ENCODING_E_AC3 .
ENCODING_DTS ,
ENCODING_DTS_HD . |
---|
IllegalArgumentException |
---|
Sets the sample rate.
sampleRate | the sample rate expressed in Hz |
---|
IllegalArgumentException |
---|