AudioTrack.Builder Class

Definition

[Android.Runtime.Register("android/media/AudioTrack$Builder", ApiSince=23, DoNotGenerateAcw=true)]
public class AudioTrack.Builder : Java.Lang.Object

[<Android.Runtime.Register("android/media/AudioTrack$Builder", ApiSince=23, DoNotGenerateAcw=true)>]
type AudioTrack.Builder = class
    inherit Object

Inheritance

Object

Object

AudioTrack.Builder

Attributes

RegisterAttribute

Remarks

Builder class for AudioTrack objects. Use this class to configure and create an AudioTrack instance. By setting audio attributes and audio format parameters, you indicate which of those vary from the default behavior on the device.

Here is an example where Builder is used to specify all AudioFormat parameters, to be used by a new AudioTrack instance:

AudioTrack player = new AudioTrack.Builder()
                    .setAudioAttributes(new AudioAttributes.Builder()
                             .setUsage(AudioAttributes.USAGE_ALARM)
                             .setContentType(AudioAttributes.CONTENT_TYPE_MUSIC)
                             .build())
                    .setAudioFormat(new AudioFormat.Builder()
                            .setEncoding(AudioFormat.ENCODING_PCM_16BIT)
                            .setSampleRate(44100)
                            .setChannelMask(AudioFormat.CHANNEL_OUT_STEREO)
                            .build())
                    .setBufferSizeInBytes(minBuffSize)
                    .build();

If the audio attributes are not set with #setAudioAttributes(AudioAttributes), attributes comprising AudioAttributes#USAGE_MEDIA will be used. <br>If the audio format is not specified or is incomplete, its channel configuration will be AudioFormat#CHANNEL_OUT_STEREO and the encoding will be AudioFormat#ENCODING_PCM_16BIT. The sample rate will depend on the device actually selected for playback and can be queried with #getSampleRate() method. <br>If the buffer size is not specified with #setBufferSizeInBytes(int), and the mode is AudioTrack#MODE_STREAM, the minimum buffer size is used. <br>If the transfer mode is not specified with #setTransferMode(int), MODE_STREAM will be used. <br>If the session ID is not specified with #setSessionId(int), a new one will be generated. <br>Offload is false by default.

Java documentation for android.media.AudioTrack.Builder.

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.