AudioFormat

Kotlin |Java

class AudioFormat : Parcelable

kotlin.Any
↳	android.media.AudioFormat

The AudioFormat class is used to access a number of audio format and channel configuration constants. They are for instance used in AudioTrackAudioRecord, as valid values in individual parameters of constructors like AudioTrack.AudioTrack(int, int, int, int, int, int), where the fourth parameter is one of the AudioFormat.ENCODING_* constants. The AudioFormat constants are also used in MediaFormat to specify audio related values commonly used in media, such as for MediaFormat.KEY_CHANNEL_MASK

The AudioFormat.Builder class can be used to create instances of the AudioFormat format class. Refer to AudioFormat.Builder for documentation on the mechanics of the configuration and building of such instances. Here we describe the main concepts that the AudioFormat class allow you to convey in each instance, they are:

sample rate
encoding
channel masks

Closely associated with the AudioFormat is the notion of an audio frame, which is used throughout the documentation to represent the minimum size complete unit of audio data.

Sample rate

Expressed in Hz, the sample rate in an AudioFormat instance expresses the number of audio samples for each channel per second in the content you are playing or recording. It is not the sample rate at which content is rendered or produced. For instance a sound at a media sample rate of 8000Hz can be played on a device operating at a sample rate of 48000Hz; the sample rate conversion is automatically handled by the platform, it will not play at 6x speed.

As of API android.os.Build.VERSION_CODES#M, sample rates up to 192kHz are supported for AudioRecord and AudioTrack, with sample rate conversion performed as needed. To improve efficiency and avoid lossy conversions, it is recommended to match the sample rate for AudioRecord and AudioTrack to the endpoint device sample rate, and limit the sample rate to no more than 48kHz unless there are special device capabilities that warrant a higher rate.

Encoding

Audio encoding is used to describe the bit representation of audio data, which can be either linear PCM or compressed audio, such as AC3 or DTS.

For linear PCM, the audio encoding describes the sample size, 8 bits, 16 bits, or 32 bits, and the sample representation, integer or float.

ENCODING_PCM_8BIT: The audio sample is a 8 bit unsigned integer in the range [0, 255], with a 128 offset for zero. This is typically stored as a Java byte in a byte array or ByteBuffer. Since the Java byte is signed, be careful with math operations and conversions as the most significant bit is inverted.
ENCODING_PCM_16BIT: The audio sample is a 16 bit signed integer typically stored as a Java short in a short array, but when the short is stored in a ByteBuffer, it is native endian (as compared to the default Java big endian). The short has full range from [-32768, 32767], and is sometimes interpreted as fixed point Q.15 data.
ENCODING_PCM_FLOAT: Introduced in API android.os.Build.VERSION_CODES#LOLLIPOP, this encoding specifies that the audio sample is a 32 bit IEEE single precision float. The sample can be manipulated as a Java float in a float array, though within a ByteBuffer it is stored in native endian byte order. The nominal range of ENCODING_PCM_FLOAT audio data is [-1.0, 1.0]. It is implementation dependent whether the positive maximum of 1.0 is included in the interval. Values outside of the nominal range are clamped before sending to the endpoint device. Beware that the handling of NaN is undefined; subnormals may be treated as zero; and infinities are generally clamped just like other values for AudioTrack – try to avoid infinities because they can easily generate a NaN.
To achieve higher audio bit depth than a signed 16 bit integer short, it is recommended to use ENCODING_PCM_FLOAT for audio capture, processing, and playback. Floats are efficiently manipulated by modern CPUs, have greater precision than 24 bit signed integers, and have greater dynamic range than 32 bit signed integers. AudioRecord as of API android.os.Build.VERSION_CODES#M and AudioTrack as of API android.os.Build.VERSION_CODES#LOLLIPOP support ENCODING_PCM_FLOAT.
ENCODING_PCM_24BIT_PACKED: Introduced in API android.os.Build.VERSION_CODES#S, this encoding specifies the audio sample is an extended precision 24 bit signed integer stored as a 3 Java bytes in a ByteBuffer or byte array in native endian (see java.nio.ByteOrder#nativeOrder()). Each sample has full range from [-8388608, 8388607], and can be interpreted as fixed point Q.23 data.
ENCODING_PCM_32BIT: Introduced in API android.os.Build.VERSION_CODES#S, this encoding specifies the audio sample is an extended precision 32 bit signed integer stored as a 4 Java bytes in a ByteBuffer or byte array in native endian (see java.nio.ByteOrder#nativeOrder()). Each sample has full range from [-2147483648, 2147483647], and can be interpreted as fixed point Q.31 data.

For compressed audio, the encoding specifies the method of compression, for example ENCODING_AC3 and ENCODING_DTS. The compressed audio data is typically stored as bytes in a byte array or ByteBuffer. When a compressed audio encoding is specified for an AudioTrack, it creates a direct (non-mixed) track for output to an endpoint (such as HDMI) capable of decoding the compressed audio. For (most) other endpoints, which are not capable of decoding such compressed audio, you will need to decode the data first, typically by creating a MediaCodec. Alternatively, one may use MediaPlayer for playback of compressed audio files or streams.

When compressed audio is sent out through a direct AudioTrack, it need not be written in exact multiples of the audio access unit; this differs from MediaCodec input buffers.

Channel mask

Channel masks are used in AudioTrack and AudioRecord to describe the samples and their arrangement in the audio frame. They are also used in the endpoint (e.g. a USB audio interface, a DAC connected to headphones) to specify allowable configurations of a particular device.
As of API android.os.Build.VERSION_CODES#M, there are two types of channel masks: channel position masks and channel index masks.

Channel position masks

Channel position masks are the original Android channel masks, and are used since API android.os.Build.VERSION_CODES#BASE. For input and output, they imply a positional nature - the location of a speaker or a microphone for recording or playback.
For a channel position mask, each allowed channel position corresponds to a bit in the channel mask. If that channel position is present in the audio frame, that bit is set, otherwise it is zero. The order of the bits (from lsb to msb) corresponds to the order of that position's sample in the audio frame.
The canonical channel position masks by channel count are as follows:

channel count	channel position mask
1	`CHANNEL_OUT_MONO`
2	`CHANNEL_OUT_STEREO`
3	`CHANNEL_OUT_STEREO` \| `CHANNEL_OUT_FRONT_CENTER`
4	`CHANNEL_OUT_QUAD`
5	`CHANNEL_OUT_QUAD` \| `CHANNEL_OUT_FRONT_CENTER`
6	`CHANNEL_OUT_5POINT1`
7	`CHANNEL_OUT_5POINT1` \| `CHANNEL_OUT_BACK_CENTER`
8	`CHANNEL_OUT_7POINT1_SURROUND`

These masks are an ORed composite of individual channel masks. For example CHANNEL_OUT_STEREO is composed of CHANNEL_OUT_FRONT_LEFT and CHANNEL_OUT_FRONT_RIGHT.

The following diagram represents the layout of the output channels, as seen from above the listener (in the center at the "lis" position, facing the front-center channel).

TFL ----- TFC ----- TFR     T is Top
        |  \       |       /  |
        |   FL --- FC --- FR  |     F is Front
        |   |\     |     /|   |
        |   | BFL-BFC-BFR |   |     BF is Bottom Front
        |   |             |   |
        |   FWL   lis   FWR   |     W is Wide
        |   |             |   |
       TSL  SL    TC     SR  TSR    S is Side
        |   |             |   |
        |   BL --- BC -- BR   |     B is Back
        |  /               \  |
        TBL ----- TBC ----- TBR     C is Center, L/R is Left/Right

All "T" (top) channels are above the listener, all "BF" (bottom-front) channels are below the listener, all others are in the listener's horizontal plane. When used in conjunction, LFE1 and LFE2 are below the listener, when used alone, LFE plane is undefined. See the channel definitions for the abbreviations

Channel index masks

Channel index masks are introduced in API android.os.Build.VERSION_CODES#M. They allow the selection of a particular channel from the source or sink endpoint by number, i.e. the first channel, the second channel, and so forth. This avoids problems with artificially assigning positions to channels of an endpoint, or figuring what the ith position bit is within an endpoint's channel position mask etc.
Here's an example where channel index masks address this confusion: dealing with a 4 channel USB device. Using a position mask, and based on the channel count, this would be a CHANNEL_OUT_QUAD device, but really one is only interested in channel 0 through channel 3. The USB device would then have the following individual bit channel masks: CHANNEL_OUT_FRONT_LEFT, CHANNEL_OUT_FRONT_RIGHT, CHANNEL_OUT_BACK_LEFT and CHANNEL_OUT_BACK_RIGHT. But which is channel 0 and which is channel 3?
For a channel index mask, each channel number is represented as a bit in the mask, from the lsb (channel 0) upwards to the msb, numerically this bit value is 1 << channelNumber. A set bit indicates that channel is present in the audio frame, otherwise it is cleared. The order of the bits also correspond to that channel number's sample order in the audio frame.
For the previous 4 channel USB device example, the device would have a channel index mask 0xF. Suppose we wanted to select only the first and the third channels; this would correspond to a channel index mask 0x5 (the first and third bits set). If an AudioTrack uses this channel index mask, the audio frame would consist of two samples, the first sample of each frame routed to channel 0, and the second sample of each frame routed to channel 2. The canonical channel index masks by channel count are given by the formula (1 << channelCount) - 1.

Use cases

Channel position mask for an endpoint: CHANNEL_OUT_FRONT_LEFT, CHANNEL_OUT_FRONT_CENTER, etc. for HDMI home theater purposes.
Channel position mask for an audio stream: Creating an AudioTrack to output movie content, where 5.1 multichannel output is to be written.
Channel index mask for an endpoint: USB devices for which input and output do not correspond to left or right speaker or microphone.
Channel index mask for an audio stream: An AudioRecord may only want the third and fourth audio channels of the endpoint (i.e. the second channel pair), and not care the about position it corresponds to, in which case the channel index mask is 0xC. Multichannel AudioRecord sessions should use channel index masks.

Audio Frame

For linear PCM, an audio frame consists of a set of samples captured at the same time, whose count and channel association are given by the channel mask, and whose sample contents are specified by the encoding. For example, a stereo 16 bit PCM frame consists of two 16 bit linear PCM samples, with a frame size of 4 bytes. For compressed audio, an audio frame may alternately refer to an access unit of compressed data bytes that is logically grouped together for decoding and bitstream access (e.g. MediaCodec), or a single byte of compressed data (e.g. AudioTrack.getBufferSizeInFrames()), or the linear PCM frame result from decoding the compressed data (e.g.AudioTrack.getPlaybackHeadPosition()), depending on the context where audio frame is used. For the purposes of AudioFormat.getFrameSizeInBytes(), a compressed data format returns a frame size of 1 byte.

Summary

Nested classes
	`Builder` Builder class for `AudioFormat` objects.

Constants
static Int	`CHANNEL_CONFIGURATION_DEFAULT`
static Int	`CHANNEL_CONFIGURATION_INVALID`
static Int	`CHANNEL_CONFIGURATION_MONO`
static Int	`CHANNEL_CONFIGURATION_STEREO`
static Int	`CHANNEL_INVALID` Invalid audio channel mask
static Int	`CHANNEL_IN_BACK`
static Int	`CHANNEL_IN_BACK_PROCESSED`
static Int	`CHANNEL_IN_DEFAULT`
static Int	`CHANNEL_IN_FRONT`
static Int	`CHANNEL_IN_FRONT_PROCESSED`
static Int	`CHANNEL_IN_LEFT`
static Int	`CHANNEL_IN_LEFT_PROCESSED`
static Int	`CHANNEL_IN_MONO`
static Int	`CHANNEL_IN_PRESSURE`
static Int	`CHANNEL_IN_RIGHT`
static Int	`CHANNEL_IN_RIGHT_PROCESSED`
static Int	`CHANNEL_IN_STEREO`
static Int	`CHANNEL_IN_VOICE_DNLINK`
static Int	`CHANNEL_IN_VOICE_UPLINK`
static Int	`CHANNEL_IN_X_AXIS`
static Int	`CHANNEL_IN_Y_AXIS`
static Int	`CHANNEL_IN_Z_AXIS`
static Int	`CHANNEL_OUT_5POINT1` Output channel mask for 5.
static Int	`CHANNEL_OUT_5POINT1POINT2` Output channel mask for 5.
static Int	`CHANNEL_OUT_5POINT1POINT4` Output channel mask for 5.
static Int	`CHANNEL_OUT_6POINT1` Output channel mask for 6.
static Int	`CHANNEL_OUT_7POINT1`
static Int	`CHANNEL_OUT_7POINT1POINT2` Output channel mask for 7.
static Int	`CHANNEL_OUT_7POINT1POINT4` Output channel mask for 7.
static Int	`CHANNEL_OUT_7POINT1_SURROUND` Output channel mask for 7.
static Int	`CHANNEL_OUT_9POINT1POINT4` Output channel mask for 9.
static Int	`CHANNEL_OUT_9POINT1POINT6` Output channel mask for 9.
static Int	`CHANNEL_OUT_BACK_CENTER` Back center output channel (see BC in channel diagram)
static Int	`CHANNEL_OUT_BACK_LEFT` Back left output channel (see BL in channel diagram)
static Int	`CHANNEL_OUT_BACK_RIGHT` Back right output channel (see BR in channel diagram)
static Int	`CHANNEL_OUT_BOTTOM_FRONT_CENTER` Bottom front center output channel (see BFC in channel diagram below FC)
static Int	`CHANNEL_OUT_BOTTOM_FRONT_LEFT` Bottom front left output channel (see BFL in channel diagram below FL)
static Int	`CHANNEL_OUT_BOTTOM_FRONT_RIGHT` Bottom front right output channel (see BFR in channel diagram below FR)
static Int	`CHANNEL_OUT_DEFAULT` Default audio channel mask
static Int	`CHANNEL_OUT_FRONT_CENTER` Front center output channel (see FC in channel diagram)
static Int	`CHANNEL_OUT_FRONT_LEFT` Front left output channel (see FL in channel diagram)
static Int	`CHANNEL_OUT_FRONT_LEFT_OF_CENTER`
static Int	`CHANNEL_OUT_FRONT_RIGHT` Front right output channel (see FR in channel diagram)
static Int	`CHANNEL_OUT_FRONT_RIGHT_OF_CENTER`
static Int	`CHANNEL_OUT_FRONT_WIDE_LEFT` Front wide left output channel (see FWL in channel diagram)
static Int	`CHANNEL_OUT_FRONT_WIDE_RIGHT` Front wide right output channel (see FWR in channel diagram)
static Int	`CHANNEL_OUT_LOW_FREQUENCY` LFE "low frequency effect" channel When used in conjunction with `CHANNEL_OUT_LOW_FREQUENCY_2`, it is intended to contain the left low-frequency effect signal, also referred to as "LFE1" in ITU-R BS.
static Int	`CHANNEL_OUT_LOW_FREQUENCY_2` The second LFE channel When used in conjunction with `CHANNEL_OUT_LOW_FREQUENCY`, it is intended to contain the right low-frequency effect signal, also referred to as "LFE2" in ITU-R BS.
static Int	`CHANNEL_OUT_MONO`
static Int	`CHANNEL_OUT_QUAD`
static Int	`CHANNEL_OUT_SIDE_LEFT` Side left output channel (see SL in channel diagram)
static Int	`CHANNEL_OUT_SIDE_RIGHT` Side right output channel (see SR in channel diagram)
static Int	`CHANNEL_OUT_STEREO`
static Int	`CHANNEL_OUT_SURROUND`
static Int	`CHANNEL_OUT_TOP_BACK_CENTER` Top back center output channel (see TBC in channel diagram above BC)
static Int	`CHANNEL_OUT_TOP_BACK_LEFT` Top back left output channel (see TBL in channel diagram above BL)
static Int	`CHANNEL_OUT_TOP_BACK_RIGHT` Top back right output channel (see TBR in channel diagram above BR)
static Int	`CHANNEL_OUT_TOP_CENTER` Top center (above listener) output channel (see TC in channel diagram)
static Int	`CHANNEL_OUT_TOP_FRONT_CENTER` Top front center output channel (see TFC in channel diagram above FC)
static Int	`CHANNEL_OUT_TOP_FRONT_LEFT` Top front left output channel (see TFL in channel diagram above FL)
static Int	`CHANNEL_OUT_TOP_FRONT_RIGHT` Top front right output channel (see TFR in channel diagram above FR)
static Int	`CHANNEL_OUT_TOP_SIDE_LEFT` Top side left output channel (see TSL in channel diagram above SL)
static Int	`CHANNEL_OUT_TOP_SIDE_RIGHT` Top side right output channel (see TSR in channel diagram above SR)
static Int	`ENCODING_AAC_ELD` Audio data format: AAC ELD compressed
static Int	`ENCODING_AAC_HE_V1` Audio data format: AAC HE V1 compressed
static Int	`ENCODING_AAC_HE_V2` Audio data format: AAC HE V2 compressed
static Int	`ENCODING_AAC_LC` Audio data format: AAC LC compressed
static Int	`ENCODING_AAC_XHE` Audio data format: AAC xHE compressed
static Int	`ENCODING_AC3` Audio data format: AC-3 compressed, also known as Dolby Digital
static Int	`ENCODING_AC4` Audio data format: AC-4 (levels 0-3) sync frame transport format
static Int	`ENCODING_DEFAULT` Default audio data format
static Int	`ENCODING_DOLBY_MAT` Audio data format: Dolby MAT (Metadata-enhanced Audio Transmission) Dolby MAT bitstreams are used to transmit Dolby TrueHD, channel-based PCM, or PCM with metadata (object audio) over HDMI (e.g. Dolby Atmos content).
static Int	`ENCODING_DOLBY_TRUEHD` Audio data format: DOLBY TRUEHD compressed
static Int	`ENCODING_DRA` Audio data format: DRA compressed
static Int	`ENCODING_DSD` Audio data format: Direct Stream Digital
static Int	`ENCODING_DTS` Audio data format: DTS compressed
static Int	`ENCODING_DTS_HD` Audio data format: DTS HD compressed
static Int	`ENCODING_DTS_HD_MA` Audio data format: DTS HD Master Audio compressed DTS HD Master Audio stream is variable bit rate and contains lossless audio.
static Int	`ENCODING_DTS_UHD` Audio data format: DTS UHD Profile-1 compressed (aka DTS:X Profile 1) Has the same meaning and value as ENCODING_DTS_UHD_P1.
static Int	`ENCODING_DTS_UHD_P1` Audio data format: DTS UHD Profile-1 compressed (aka DTS:X Profile 1) Has the same meaning and value as the deprecated `ENCODING_DTS_UHD`.
static Int	`ENCODING_DTS_UHD_P2` Audio data format: DTS UHD Profile-2 compressed DTS-UHD Profile-2 supports delivery of Channel-Based Audio, Object-Based Audio and High Order Ambisonic presentations up to the fourth order.
static Int	`ENCODING_E_AC3` Audio data format: E-AC-3 compressed, also known as Dolby Digital Plus or DD+
static Int	`ENCODING_E_AC3_JOC` Audio data format: E-AC-3-JOC compressed E-AC-3-JOC streams can be decoded by downstream devices supporting `ENCODING_E_AC3`.
static Int	`ENCODING_IEC61937` Audio data format: compressed audio wrapped in PCM for HDMI or S/PDIF passthrough.
static Int	`ENCODING_INVALID` Invalid audio data format
static Int	`ENCODING_MP3` Audio data format: MP3 compressed
static Int	`ENCODING_MPEGH_BL_L3` Audio data format: MPEG-H baseline profile, level 3
static Int	`ENCODING_MPEGH_BL_L4` Audio data format: MPEG-H baseline profile, level 4
static Int	`ENCODING_MPEGH_LC_L3` Audio data format: MPEG-H low complexity profile, level 3
static Int	`ENCODING_MPEGH_LC_L4` Audio data format: MPEG-H low complexity profile, level 4
static Int	`ENCODING_OPUS` Audio data format: OPUS compressed.
static Int	`ENCODING_PCM_16BIT` Audio data format: PCM 16 bit per sample.
static Int	`ENCODING_PCM_24BIT_PACKED` Audio data format: PCM 24 bit per sample packed as 3 bytes.
static Int	`ENCODING_PCM_32BIT` Audio data format: PCM 32 bit per sample.
static Int	`ENCODING_PCM_8BIT` Audio data format: PCM 8 bit per sample.
static Int	`ENCODING_PCM_FLOAT` Audio data format: single-precision floating-point per sample
static Int	`SAMPLE_RATE_UNSPECIFIED` Sample rate will be a route-dependent value.

Inherited constants

From class Parcelable

Int

CONTENTS_FILE_DESCRIPTOR

Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor.

Int

PARCELABLE_WRITE_RETURN_VALUE

Flag for use with writeToParcel: the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point.

Public methods
Int	`describeContents()`
Boolean	`equals(other: Any?)`
Int	`getChannelCount()` Return the channel count.
Int	`getChannelIndexMask()` Return the channel index mask.
Int	`getChannelMask()` Return the channel mask.
Int	`getEncoding()` Return the encoding.
Int	`getFrameSizeInBytes()` Return the frame size in bytes.
Int	`getSampleRate()` Return the sample rate.
Int	`hashCode()`
String	`toString()`
Unit	`writeToParcel(dest: Parcel, flags: Int)`

Properties
static Parcelable.Creator<AudioFormat!>	`CREATOR`

Constants

CHANNEL_CONFIGURATION_DEFAULT

Added in API level 3
Deprecated in API level 15

static val CHANNEL_CONFIGURATION_DEFAULT: Int

Deprecated: Use CHANNEL_OUT_DEFAULT or CHANNEL_IN_DEFAULT instead.

Value: 1

CHANNEL_CONFIGURATION_INVALID

Added in API level 3
Deprecated in API level 15

static val CHANNEL_CONFIGURATION_INVALID: Int

Deprecated: Use CHANNEL_INVALID instead.

Value: 0

CHANNEL_CONFIGURATION_MONO

Added in API level 3
Deprecated in API level 15

static val CHANNEL_CONFIGURATION_MONO: Int

Deprecated: Use CHANNEL_OUT_MONO or CHANNEL_IN_MONO instead.

Value: 2

CHANNEL_CONFIGURATION_STEREO

Added in API level 3
Deprecated in API level 15

static val CHANNEL_CONFIGURATION_STEREO: Int

Deprecated: Use CHANNEL_OUT_STEREO or CHANNEL_IN_STEREO instead.

Value: 3

CHANNEL_INVALID

Added in API level 5

static val CHANNEL_INVALID: Int

Invalid audio channel mask

Value: 0

CHANNEL_IN_BACK

Added in API level 5

static val CHANNEL_IN_BACK: Int

Value: 32

CHANNEL_IN_BACK_PROCESSED

Added in API level 5

static val CHANNEL_IN_BACK_PROCESSED: Int

Value: 512

CHANNEL_IN_DEFAULT

Added in API level 5

static val CHANNEL_IN_DEFAULT: Int

Value: 1

CHANNEL_IN_FRONT

Added in API level 5

static val CHANNEL_IN_FRONT: Int

Value: 16

CHANNEL_IN_FRONT_PROCESSED

Added in API level 5

static val CHANNEL_IN_FRONT_PROCESSED: Int

Value: 256

CHANNEL_IN_LEFT

Added in API level 5

static val CHANNEL_IN_LEFT: Int

Value: 4

CHANNEL_IN_LEFT_PROCESSED

Added in API level 5

static val CHANNEL_IN_LEFT_PROCESSED: Int

Value: 64

CHANNEL_IN_MONO

Added in API level 5

static val CHANNEL_IN_MONO: Int

Value: 16

CHANNEL_IN_PRESSURE

Added in API level 5

static val CHANNEL_IN_PRESSURE: Int

Value: 1024

CHANNEL_IN_RIGHT

Added in API level 5

static val CHANNEL_IN_RIGHT: Int

Value: 8

CHANNEL_IN_RIGHT_PROCESSED

Added in API level 5

static val CHANNEL_IN_RIGHT_PROCESSED: Int

Value: 128

CHANNEL_IN_STEREO

Added in API level 5

static val CHANNEL_IN_STEREO: Int

Value: 12

CHANNEL_IN_VOICE_DNLINK

Added in API level 5

static val CHANNEL_IN_VOICE_DNLINK: Int

Value: 32768

CHANNEL_IN_VOICE_UPLINK

Added in API level 5

static val CHANNEL_IN_VOICE_UPLINK: Int

Value: 16384

CHANNEL_IN_X_AXIS

Added in API level 5

static val CHANNEL_IN_X_AXIS: Int

Value: 2048

CHANNEL_IN_Y_AXIS

Added in API level 5

static val CHANNEL_IN_Y_AXIS: Int

Value: 4096

CHANNEL_IN_Z_AXIS

Added in API level 5

static val CHANNEL_IN_Z_AXIS: Int

Value: 8192

CHANNEL_OUT_5POINT1

Added in API level 5

static val CHANNEL_OUT_5POINT1: Int

Output channel mask for 5.1

Value: 252

CHANNEL_OUT_5POINT1POINT2

Added in API level 32

static val CHANNEL_OUT_5POINT1POINT2: Int

Output channel mask for 5.1.2 Same as 5.1 with the addition of left and right top channels

Value: 3145980

CHANNEL_OUT_5POINT1POINT4

Added in API level 32

static val CHANNEL_OUT_5POINT1POINT4: Int

Output channel mask for 5.1.4 Same as 5.1 with the addition of four top channels

Value: 737532

CHANNEL_OUT_6POINT1

Added in API level 34

static val CHANNEL_OUT_6POINT1: Int

Output channel mask for 6.1 Same as 5.1 with the addition of the back center channel

Value: 1276

CHANNEL_OUT_7POINT1

Added in API level 5
Deprecated in API level 23

static val CHANNEL_OUT_7POINT1: Int

Deprecated: Not the typical 7.1 surround configuration. Use CHANNEL_OUT_7POINT1_SURROUND instead.

Value: 1020

CHANNEL_OUT_7POINT1POINT2

Added in API level 32

static val CHANNEL_OUT_7POINT1POINT2: Int

Output channel mask for 7.1.2 Same as 7.1 with the addition of left and right top channels

Value: 3152124

CHANNEL_OUT_7POINT1POINT4

Added in API level 32

static val CHANNEL_OUT_7POINT1POINT4: Int

Output channel mask for 7.1.4 Same as 7.1 with the addition of four top channels

Value: 743676

CHANNEL_OUT_7POINT1_SURROUND

Added in API level 23

static val CHANNEL_OUT_7POINT1_SURROUND: Int

Output channel mask for 7.1

Value: 6396

CHANNEL_OUT_9POINT1POINT4

Added in API level 32

static val CHANNEL_OUT_9POINT1POINT4: Int

Output channel mask for 9.1.4 Same as 7.1.4 with the addition of left and right front wide channels

Value: 202070268

CHANNEL_OUT_9POINT1POINT6

Added in API level 32

static val CHANNEL_OUT_9POINT1POINT6: Int

Output channel mask for 9.1.6 Same as 9.1.4 with the addition of left and right top side channels

Value: 205215996

CHANNEL_OUT_BACK_CENTER

Added in API level 5

static val CHANNEL_OUT_BACK_CENTER: Int

Back center output channel (see BC in channel diagram)

Value: 1024

CHANNEL_OUT_BACK_LEFT

Added in API level 5

static val CHANNEL_OUT_BACK_LEFT: Int

Back left output channel (see BL in channel diagram)

Value: 64

CHANNEL_OUT_BACK_RIGHT

Added in API level 5

static val CHANNEL_OUT_BACK_RIGHT: Int

Back right output channel (see BR in channel diagram)

Value: 128

CHANNEL_OUT_BOTTOM_FRONT_CENTER

Added in API level 32

static val CHANNEL_OUT_BOTTOM_FRONT_CENTER: Int

Bottom front center output channel (see BFC in channel diagram below FC)

Value: 8388608

CHANNEL_OUT_BOTTOM_FRONT_LEFT

Added in API level 32

static val CHANNEL_OUT_BOTTOM_FRONT_LEFT: Int

Bottom front left output channel (see BFL in channel diagram below FL)

Value: 4194304

CHANNEL_OUT_BOTTOM_FRONT_RIGHT

Added in API level 32

static val CHANNEL_OUT_BOTTOM_FRONT_RIGHT: Int

Bottom front right output channel (see BFR in channel diagram below FR)

Value: 16777216

CHANNEL_OUT_DEFAULT

Added in API level 5

static val CHANNEL_OUT_DEFAULT: Int

Default audio channel mask

Value: 1

CHANNEL_OUT_FRONT_CENTER

Added in API level 5

static val CHANNEL_OUT_FRONT_CENTER: Int

Front center output channel (see FC in channel diagram)

Value: 16

CHANNEL_OUT_FRONT_LEFT

Added in API level 5

static val CHANNEL_OUT_FRONT_LEFT: Int

Front left output channel (see FL in channel diagram)

Value: 4

CHANNEL_OUT_FRONT_LEFT_OF_CENTER

Added in API level 5

static val CHANNEL_OUT_FRONT_LEFT_OF_CENTER: Int

Value: 256

CHANNEL_OUT_FRONT_RIGHT

Added in API level 5

static val CHANNEL_OUT_FRONT_RIGHT: Int

Front right output channel (see FR in channel diagram)

Value: 8

CHANNEL_OUT_FRONT_RIGHT_OF_CENTER

Added in API level 5

static val CHANNEL_OUT_FRONT_RIGHT_OF_CENTER: Int

Value: 512

CHANNEL_OUT_FRONT_WIDE_LEFT

Added in API level 32

static val CHANNEL_OUT_FRONT_WIDE_LEFT: Int

Front wide left output channel (see FWL in channel diagram)

Value: 67108864

CHANNEL_OUT_FRONT_WIDE_RIGHT

Added in API level 32

static val CHANNEL_OUT_FRONT_WIDE_RIGHT: Int

Front wide right output channel (see FWR in channel diagram)

Value: 134217728

CHANNEL_OUT_LOW_FREQUENCY

Added in API level 5

static val CHANNEL_OUT_LOW_FREQUENCY: Int

LFE "low frequency effect" channel When used in conjunction with CHANNEL_OUT_LOW_FREQUENCY_2, it is intended to contain the left low-frequency effect signal, also referred to as "LFE1" in ITU-R BS.2159-8

Value: 32

CHANNEL_OUT_LOW_FREQUENCY_2

Added in API level 32

static val CHANNEL_OUT_LOW_FREQUENCY_2: Int

The second LFE channel When used in conjunction with CHANNEL_OUT_LOW_FREQUENCY, it is intended to contain the right low-frequency effect signal, also referred to as "LFE2" in ITU-R BS.2159-8

Value: 33554432

CHANNEL_OUT_MONO

Added in API level 5

static val CHANNEL_OUT_MONO: Int

Value: 4

CHANNEL_OUT_QUAD

Added in API level 5

static val CHANNEL_OUT_QUAD: Int

Value: 204

CHANNEL_OUT_SIDE_LEFT

Added in API level 21

static val CHANNEL_OUT_SIDE_LEFT: Int

Side left output channel (see SL in channel diagram)

Value: 2048

CHANNEL_OUT_SIDE_RIGHT

Added in API level 21

static val CHANNEL_OUT_SIDE_RIGHT: Int

Side right output channel (see SR in channel diagram)

Value: 4096

CHANNEL_OUT_STEREO

Added in API level 5

static val CHANNEL_OUT_STEREO: Int

Value: 12

CHANNEL_OUT_SURROUND

Added in API level 5

static val CHANNEL_OUT_SURROUND: Int

Value: 1052

CHANNEL_OUT_TOP_BACK_CENTER

Added in API level 32

static val CHANNEL_OUT_TOP_BACK_CENTER: Int

Top back center output channel (see TBC in channel diagram above BC)

Value: 262144

CHANNEL_OUT_TOP_BACK_LEFT

Added in API level 32

static val CHANNEL_OUT_TOP_BACK_LEFT: Int

Top back left output channel (see TBL in channel diagram above BL)

Value: 131072

CHANNEL_OUT_TOP_BACK_RIGHT

Added in API level 32

static val CHANNEL_OUT_TOP_BACK_RIGHT: Int

Top back right output channel (see TBR in channel diagram above BR)

Value: 524288

CHANNEL_OUT_TOP_CENTER

Added in API level 32

static val CHANNEL_OUT_TOP_CENTER: Int

Top center (above listener) output channel (see TC in channel diagram)

Value: 8192

CHANNEL_OUT_TOP_FRONT_CENTER

Added in API level 32

static val CHANNEL_OUT_TOP_FRONT_CENTER: Int

Top front center output channel (see TFC in channel diagram above FC)

Value: 32768

CHANNEL_OUT_TOP_FRONT_LEFT

Added in API level 32

static val CHANNEL_OUT_TOP_FRONT_LEFT: Int

Top front left output channel (see TFL in channel diagram above FL)

Value: 16384

CHANNEL_OUT_TOP_FRONT_RIGHT

Added in API level 32

static val CHANNEL_OUT_TOP_FRONT_RIGHT: Int

Top front right output channel (see TFR in channel diagram above FR)

Value: 65536

CHANNEL_OUT_TOP_SIDE_LEFT

Added in API level 32

static val CHANNEL_OUT_TOP_SIDE_LEFT: Int

Top side left output channel (see TSL in channel diagram above SL)

Value: 1048576

CHANNEL_OUT_TOP_SIDE_RIGHT

Added in API level 32

static val CHANNEL_OUT_TOP_SIDE_RIGHT: Int

Top side right output channel (see TSR in channel diagram above SR)

Value: 2097152

ENCODING_AAC_ELD

Added in API level 28

static val ENCODING_AAC_ELD: Int

Audio data format: AAC ELD compressed

Value: 15

ENCODING_AAC_HE_V1

Added in API level 28

static val ENCODING_AAC_HE_V1: Int

Audio data format: AAC HE V1 compressed

Value: 11

ENCODING_AAC_HE_V2

Added in API level 28

static val ENCODING_AAC_HE_V2: Int

Audio data format: AAC HE V2 compressed

Value: 12

ENCODING_AAC_LC

Added in API level 28

static val ENCODING_AAC_LC: Int

Audio data format: AAC LC compressed

Value: 10

ENCODING_AAC_XHE

Added in API level 28

static val ENCODING_AAC_XHE: Int

Audio data format: AAC xHE compressed

Value: 16

ENCODING_AC3

Added in API level 21

static val ENCODING_AC3: Int

Audio data format: AC-3 compressed, also known as Dolby Digital

Value: 5

ENCODING_AC4

Added in API level 28

static val ENCODING_AC4: Int

Audio data format: AC-4 (levels 0-3) sync frame transport format

Value: 17

ENCODING_DEFAULT

Added in API level 3

static val ENCODING_DEFAULT: Int

Default audio data format

Value: 1

ENCODING_DOLBY_MAT

Added in API level 29

static val ENCODING_DOLBY_MAT: Int

Audio data format: Dolby MAT (Metadata-enhanced Audio Transmission) Dolby MAT bitstreams are used to transmit Dolby TrueHD, channel-based PCM, or PCM with metadata (object audio) over HDMI (e.g. Dolby Atmos content).

Value: 19

ENCODING_DOLBY_TRUEHD

Added in API level 25

static val ENCODING_DOLBY_TRUEHD: Int

Audio data format: DOLBY TRUEHD compressed

Value: 14

ENCODING_DRA

Added in API level 31

static val ENCODING_DRA: Int

Audio data format: DRA compressed

Value: 28

ENCODING_DSD

Added in API level 34

static val ENCODING_DSD: Int

Audio data format: Direct Stream Digital

Value: 31

ENCODING_DTS

Added in API level 23

static val ENCODING_DTS: Int

Audio data format: DTS compressed

Value: 7

ENCODING_DTS_HD

Added in API level 23

static val ENCODING_DTS_HD: Int

Audio data format: DTS HD compressed

Value: 8

ENCODING_DTS_HD_MA

Added in API level 34

static val ENCODING_DTS_HD_MA: Int

Audio data format: DTS HD Master Audio compressed DTS HD Master Audio stream is variable bit rate and contains lossless audio. Use ENCODING_DTS_HD_MA for lossless audio content (DTS-HD MA Lossless) and use ENCODING_DTS_HD for other DTS bitstreams with extension substream (DTS 8Ch Discrete, DTS Hi Res, DTS Express).

Value: 29

ENCODING_DTS_UHD

Added in API level 31
Deprecated in API level 34

static val ENCODING_DTS_UHD: Int

Deprecated: Use ENCODING_DTS_UHD_P1 instead.

Audio data format: DTS UHD Profile-1 compressed (aka DTS:X Profile 1) Has the same meaning and value as ENCODING_DTS_UHD_P1.

Value: 27

ENCODING_DTS_UHD_P1

Added in API level 34

static val ENCODING_DTS_UHD_P1: Int

Audio data format: DTS UHD Profile-1 compressed (aka DTS:X Profile 1) Has the same meaning and value as the deprecated ENCODING_DTS_UHD.

Value: 27

ENCODING_DTS_UHD_P2

Added in API level 34

static val ENCODING_DTS_UHD_P2: Int

Audio data format: DTS UHD Profile-2 compressed DTS-UHD Profile-2 supports delivery of Channel-Based Audio, Object-Based Audio and High Order Ambisonic presentations up to the fourth order. Use ENCODING_DTS_UHD_P1 to transmit DTS UHD Profile 1 (aka DTS:X Profile 1) bitstream. Use ENCODING_DTS_UHD_P2 to transmit DTS UHD Profile 2 (aka DTS:X Profile 2) bitstream.

Value: 30

ENCODING_E_AC3

Added in API level 21

static val ENCODING_E_AC3: Int

Audio data format: E-AC-3 compressed, also known as Dolby Digital Plus or DD+

Value: 6

ENCODING_E_AC3_JOC

Added in API level 28

static val ENCODING_E_AC3_JOC: Int

Audio data format: E-AC-3-JOC compressed E-AC-3-JOC streams can be decoded by downstream devices supporting ENCODING_E_AC3. Use ENCODING_E_AC3 as the AudioTrack encoding when the downstream device supports ENCODING_E_AC3 but not ENCODING_E_AC3_JOC.

Value: 18

ENCODING_IEC61937

Added in API level 24

static val ENCODING_IEC61937: Int

Audio data format: compressed audio wrapped in PCM for HDMI or S/PDIF passthrough. For devices whose SDK version is less than android.os.Build.VERSION_CODES#S, the channel mask of IEC61937 track must be CHANNEL_OUT_STEREO. Data should be written to the stream in a short[] array. If the data is written in a byte[] array then there may be endian problems on some platforms when converting to short internally.

Value: 13

ENCODING_INVALID

Added in API level 3

static val ENCODING_INVALID: Int

Invalid audio data format

Value: 0

ENCODING_MP3

Added in API level 28

static val ENCODING_MP3: Int

Audio data format: MP3 compressed

Value: 9

ENCODING_MPEGH_BL_L3

Added in API level 31

static val ENCODING_MPEGH_BL_L3: Int

Audio data format: MPEG-H baseline profile, level 3

Value: 23

ENCODING_MPEGH_BL_L4

Added in API level 31

static val ENCODING_MPEGH_BL_L4: Int

Audio data format: MPEG-H baseline profile, level 4

Value: 24

ENCODING_MPEGH_LC_L3

Added in API level 31

static val ENCODING_MPEGH_LC_L3: Int

Audio data format: MPEG-H low complexity profile, level 3

Value: 25

ENCODING_MPEGH_LC_L4

Added in API level 31

static val ENCODING_MPEGH_LC_L4: Int

Audio data format: MPEG-H low complexity profile, level 4

Value: 26

ENCODING_OPUS

Added in API level 30

static val ENCODING_OPUS: Int

Audio data format: OPUS compressed.

Value: 20

ENCODING_PCM_16BIT

Added in API level 3

static val ENCODING_PCM_16BIT: Int

Audio data format: PCM 16 bit per sample. Guaranteed to be supported by devices.

Value: 2

ENCODING_PCM_24BIT_PACKED

Added in API level 31

static val ENCODING_PCM_24BIT_PACKED: Int

Audio data format: PCM 24 bit per sample packed as 3 bytes. The bytes are in little-endian order, so the least significant byte comes first in the byte array. Not guaranteed to be supported by devices, may be emulated if not supported.

Value: 21

ENCODING_PCM_32BIT

Added in API level 31

static val ENCODING_PCM_32BIT: Int

Audio data format: PCM 32 bit per sample. Not guaranteed to be supported by devices, may be emulated if not supported.

Value: 22

ENCODING_PCM_8BIT

Added in API level 3

static val ENCODING_PCM_8BIT: Int

Audio data format: PCM 8 bit per sample. Not guaranteed to be supported by devices.

Value: 3

ENCODING_PCM_FLOAT

Added in API level 21

static val ENCODING_PCM_FLOAT: Int

Audio data format: single-precision floating-point per sample

Value: 4

SAMPLE_RATE_UNSPECIFIED

Added in API level 24

static val SAMPLE_RATE_UNSPECIFIED: Int

Sample rate will be a route-dependent value. For AudioTrack, it is usually the sink sample rate, and for AudioRecord it is usually the source sample rate.

Value: 0

Public methods

describeContents

Added in API level 24

fun describeContents(): Int

Return
`Int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR`

equals

Added in API level 3

fun equals(other: Any?): Boolean

Parameters
`obj`	the reference object with which to compare.

Return
`Boolean`	`true` if this object is the same as the obj argument; `false` otherwise.

getChannelCount

Added in API level 23

fun getChannelCount(): Int

Return the channel count.

Return
`Int`	the channel count derived from the channel position mask or the channel index mask. Zero is returned if both the channel position mask and the channel index mask are not set.

getChannelIndexMask

Added in API level 23

fun getChannelIndexMask(): Int

Return the channel index mask. See the section on channel masks for more information about the difference between index-based masks, and position-based masks (as returned by getChannelMask()).

Return
`Int`	one of the values that can be set in `Builder.setChannelIndexMask(int)` or `AudioFormat.CHANNEL_INVALID` if not set or an invalid mask was used.

getChannelMask

Added in API level 21

fun getChannelMask(): Int

Return the channel mask. See the section on channel masks for more information about the difference between index-based masks(as returned by getChannelIndexMask()) and the position-based mask returned by this function.

Return
`Int`	one of the values that can be set in `Builder.setChannelMask(int)` or `AudioFormat.CHANNEL_INVALID` if not set.

getEncoding

Added in API level 21

fun getEncoding(): Int

Return the encoding. See the section on encodings for more information about the different types of supported audio encoding.

Return

Int one of the values that can be set in Builder.setEncoding(int) or AudioFormat.ENCODING_INVALID if not set. Value is android.media.AudioFormat#ENCODING_INVALID, android.media.AudioFormat#ENCODING_DEFAULT, android.media.AudioFormat#ENCODING_PCM_16BIT, android.media.AudioFormat#ENCODING_PCM_8BIT, android.media.AudioFormat#ENCODING_PCM_FLOAT, android.media.AudioFormat#ENCODING_AC3, android.media.AudioFormat#ENCODING_E_AC3, android.media.AudioFormat#ENCODING_DTS, android.media.AudioFormat#ENCODING_DTS_HD, android.media.AudioFormat#ENCODING_MP3, android.media.AudioFormat#ENCODING_AAC_LC, android.media.AudioFormat#ENCODING_AAC_HE_V1, android.media.AudioFormat#ENCODING_AAC_HE_V2, android.media.AudioFormat#ENCODING_IEC61937, android.media.AudioFormat#ENCODING_DOLBY_TRUEHD, android.media.AudioFormat#ENCODING_AAC_ELD, android.media.AudioFormat#ENCODING_AAC_XHE, android.media.AudioFormat#ENCODING_AC4, android.media.AudioFormat.ENCODING_AC4_L4, android.media.AudioFormat#ENCODING_E_AC3_JOC, android.media.AudioFormat#ENCODING_DOLBY_MAT, android.media.AudioFormat#ENCODING_OPUS, android.media.AudioFormat#ENCODING_PCM_24BIT_PACKED, android.media.AudioFormat#ENCODING_PCM_32BIT, android.media.AudioFormat#ENCODING_MPEGH_BL_L3, android.media.AudioFormat#ENCODING_MPEGH_BL_L4, android.media.AudioFormat#ENCODING_MPEGH_LC_L3, android.media.AudioFormat#ENCODING_MPEGH_LC_L4, android.media.AudioFormat#ENCODING_DTS_UHD_P1, android.media.AudioFormat#ENCODING_DRA, android.media.AudioFormat#ENCODING_DTS_HD_MA, android.media.AudioFormat#ENCODING_DTS_UHD_P2, or android.media.AudioFormat#ENCODING_DSD

Return
`Int`	one of the values that can be set in `Builder.setEncoding(int)` or `AudioFormat.ENCODING_INVALID` if not set. Value is `android.media.AudioFormat#ENCODING_INVALID`, `android.media.AudioFormat#ENCODING_DEFAULT`, `android.media.AudioFormat#ENCODING_PCM_16BIT`, `android.media.AudioFormat#ENCODING_PCM_8BIT`, `android.media.AudioFormat#ENCODING_PCM_FLOAT`, `android.media.AudioFormat#ENCODING_AC3`, `android.media.AudioFormat#ENCODING_E_AC3`, `android.media.AudioFormat#ENCODING_DTS`, `android.media.AudioFormat#ENCODING_DTS_HD`, `android.media.AudioFormat#ENCODING_MP3`, `android.media.AudioFormat#ENCODING_AAC_LC`, `android.media.AudioFormat#ENCODING_AAC_HE_V1`, `android.media.AudioFormat#ENCODING_AAC_HE_V2`, `android.media.AudioFormat#ENCODING_IEC61937`, `android.media.AudioFormat#ENCODING_DOLBY_TRUEHD`, `android.media.AudioFormat#ENCODING_AAC_ELD`, `android.media.AudioFormat#ENCODING_AAC_XHE`, `android.media.AudioFormat#ENCODING_AC4`, android.media.AudioFormat.ENCODING_AC4_L4, `android.media.AudioFormat#ENCODING_E_AC3_JOC`, `android.media.AudioFormat#ENCODING_DOLBY_MAT`, `android.media.AudioFormat#ENCODING_OPUS`, `android.media.AudioFormat#ENCODING_PCM_24BIT_PACKED`, `android.media.AudioFormat#ENCODING_PCM_32BIT`, `android.media.AudioFormat#ENCODING_MPEGH_BL_L3`, `android.media.AudioFormat#ENCODING_MPEGH_BL_L4`, `android.media.AudioFormat#ENCODING_MPEGH_LC_L3`, `android.media.AudioFormat#ENCODING_MPEGH_LC_L4`, `android.media.AudioFormat#ENCODING_DTS_UHD_P1`, `android.media.AudioFormat#ENCODING_DRA`, `android.media.AudioFormat#ENCODING_DTS_HD_MA`, `android.media.AudioFormat#ENCODING_DTS_UHD_P2`, or `android.media.AudioFormat#ENCODING_DSD`

getFrameSizeInBytes

Added in API level 29

fun getFrameSizeInBytes(): Int

Return the frame size in bytes. For PCM or PCM packed compressed data this is the size of a sample multiplied by the channel count. For all other cases, including invalid/unset channel masks, this will return 1 byte. As an example, a stereo 16-bit PCM format would have a frame size of 4 bytes, an 8 channel float PCM format would have a frame size of 32 bytes, and a compressed data format (not packed in PCM) would have a frame size of 1 byte. Both AudioRecord or AudioTrack process data in multiples of this frame size.

Return
`Int`	The audio frame size in bytes corresponding to the encoding and the channel mask. Value is 1 or greater

getSampleRate

Added in API level 21

fun getSampleRate(): Int

Return the sample rate.

Return
`Int`	one of the values that can be set in `Builder.setSampleRate(int)` or `SAMPLE_RATE_UNSPECIFIED` if not set.

hashCode

Added in API level 3

fun hashCode(): Int

Return
`Int`	a hash code value for this object.

toString

Added in API level 3

fun toString(): String

Return
`String`	a string representation of the object.

writeToParcel

Added in API level 24

fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

Parameters
`dest`	Parcel: The Parcel in which the object should be written. This value cannot be `null`.
`flags`	Int: Additional flags about how the object should be written. May be 0 or `PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of `android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level 24

static val CREATOR: Parcelable.Creator<AudioFormat!>