AudioTrack.Builder
public
static
class
AudioTrack.Builder
extends Object
| java.lang.Object | |
| ↳ | android.media.AudioTrack.Builder |
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 USAGE_MEDIA will be used.
If the audio format is not specified or is incomplete, its channel configuration will be
CHANNEL_OUT_STEREO and the encoding will be
ENCODING_PCM_16BIT.
The sample rate will depend on the device actually selected for playback and can be queried
with getSampleRate() method.
If the buffer size is not specified with setBufferSizeInBytes(int),
and the mode is MODE_STREAM, the minimum buffer size is used.
If the transfer mode is not specified with setTransferMode(int),
MODE_STREAM will be used.
If the session ID is not specified with setSessionId(int), a new one will
be generated.
Summary
Public constructors | |
|---|---|
AudioTrack.Builder()
Constructs a new Builder with the default values as described above. |
|
Public methods | |
|---|---|
AudioTrack
|
build()
Builds an |
AudioTrack.Builder
|
setAudioAttributes(AudioAttributes attributes)
Sets the |
AudioTrack.Builder
|
setAudioFormat(AudioFormat format)
Sets the format of the audio data to be played by the |
AudioTrack.Builder
|
setBufferSizeInBytes(int bufferSizeInBytes)
Sets the total size (in bytes) of the buffer where audio data is read from for playback. |
AudioTrack.Builder
|
setSessionId(int sessionId)
Sets the session ID the |
AudioTrack.Builder
|
setTransferMode(int mode)
Sets the mode under which buffers of audio data are transferred from the
|
Inherited methods | |
|---|---|
From
class
java.lang.Object
| |
Public constructors
AudioTrack.Builder
AudioTrack.Builder ()
Constructs a new Builder with the default values as described above.
Public methods
build
AudioTrack build ()
Builds an AudioTrack instance initialized with all the parameters set
on this Builder.
| Returns | |
|---|---|
AudioTrack |
a new successfully initialized AudioTrack instance. |
| Throws | |
|---|---|
UnsupportedOperationException |
if the parameters set on the Builder
were incompatible, or if they are not supported by the device,
or if the device was not available.
|
setAudioAttributes
AudioTrack.Builder setAudioAttributes (AudioAttributes attributes)
Sets the AudioAttributes.
| Parameters | |
|---|---|
attributes |
AudioAttributes:
a non-null AudioAttributes instance that describes the audio
data to be played. |
| Returns | |
|---|---|
AudioTrack.Builder |
the same Builder instance. |
| Throws | |
|---|---|
IllegalArgumentException |
|
setAudioFormat
AudioTrack.Builder setAudioFormat (AudioFormat format)
Sets the format of the audio data to be played by the AudioTrack.
See AudioFormat.Builder for configuring the audio format parameters such
as encoding, channel mask and sample rate.
| Parameters | |
|---|---|
format |
AudioFormat:
a non-null AudioFormat instance. |
| Returns | |
|---|---|
AudioTrack.Builder |
the same Builder instance. |
| Throws | |
|---|---|
IllegalArgumentException |
|
setBufferSizeInBytes
AudioTrack.Builder setBufferSizeInBytes (int bufferSizeInBytes)
Sets the total size (in bytes) of the buffer where audio data is read from for playback.
If using the AudioTrack in streaming mode
(see MODE_STREAM, you can write data into this buffer in smaller
chunks than this size. See getMinBufferSize(int, int, int) to determine
the estimated minimum buffer size for the creation of an AudioTrack instance
in streaming mode.
If using the AudioTrack in static mode (see
MODE_STATIC), this is the maximum size of the sound that will be
played by this instance.
| Returns | |
|---|---|
AudioTrack.Builder |
the same Builder instance. |
| Throws | |
|---|---|
IllegalArgumentException |
|
setSessionId
AudioTrack.Builder setSessionId (int sessionId)
Sets the session ID the AudioTrack will be attached to.
| Parameters | |
|---|---|
sessionId |
int:
a strictly positive ID number retrieved from another
AudioTrack via getAudioSessionId() or allocated by
AudioManager via generateAudioSessionId(), or
AUDIO_SESSION_ID_GENERATE. |
| Returns | |
|---|---|
AudioTrack.Builder |
the same Builder instance. |
| Throws | |
|---|---|
IllegalArgumentException |
|
setTransferMode
AudioTrack.Builder setTransferMode (int mode)
Sets the mode under which buffers of audio data are transferred from the
AudioTrack to the framework.
| Parameters | |
|---|---|
mode |
int:
one of MODE_STREAM, MODE_STATIC. |
| Returns | |
|---|---|
AudioTrack.Builder |
the same Builder instance. |
| Throws | |
|---|---|
IllegalArgumentException |
|
Interfaces
- AudioManager.OnAudioFocusChangeListener
- AudioRecord.OnRecordPositionUpdateListener
- AudioRecord.OnRoutingChangedListener
- AudioRouting
- AudioRouting.OnRoutingChangedListener
- AudioTrack.OnPlaybackPositionUpdateListener
- AudioTrack.OnRoutingChangedListener
- ImageReader.OnImageAvailableListener
- ImageWriter.OnImageReleasedListener
- JetPlayer.OnJetEventListener
- MediaCodec.OnFrameRenderedListener
- MediaDrm.OnEventListener
- MediaDrm.OnExpirationUpdateListener
- MediaDrm.OnKeyStatusChangeListener
- MediaPlayer.OnBufferingUpdateListener
- MediaPlayer.OnCompletionListener
- MediaPlayer.OnErrorListener
- MediaPlayer.OnInfoListener
- MediaPlayer.OnPreparedListener
- MediaPlayer.OnSeekCompleteListener
- MediaPlayer.OnTimedMetaDataAvailableListener
- MediaPlayer.OnTimedTextListener
- MediaPlayer.OnVideoSizeChangedListener
- MediaRecorder.OnErrorListener
- MediaRecorder.OnInfoListener
- MediaScannerConnection.MediaScannerConnectionClient
- MediaScannerConnection.OnScanCompletedListener
- MediaSync.OnErrorListener
- RemoteControlClient.OnGetPlaybackPositionListener
- RemoteControlClient.OnMetadataUpdateListener
- RemoteControlClient.OnPlaybackPositionUpdateListener
- RemoteController.OnClientUpdateListener
- SoundPool.OnLoadCompleteListener
Classes
- AsyncPlayer
- AudioAttributes
- AudioAttributes.Builder
- AudioDeviceCallback
- AudioDeviceInfo
- AudioFormat
- AudioFormat.Builder
- AudioManager
- AudioManager.AudioRecordingCallback
- AudioRecord
- AudioRecord.Builder
- AudioRecordingConfiguration
- AudioTimestamp
- AudioTrack
- AudioTrack.Builder
- CamcorderProfile
- CameraProfile
- DrmInitData
- DrmInitData.SchemeInitData
- ExifInterface
- FaceDetector
- FaceDetector.Face
- Image
- Image.Plane
- ImageReader
- ImageWriter
- JetPlayer
- MediaActionSound
- MediaCodec
- MediaCodec.BufferInfo
- MediaCodec.Callback
- MediaCodec.CryptoInfo
- MediaCodec.CryptoInfo.Pattern
- MediaCodecInfo
- MediaCodecInfo.AudioCapabilities
- MediaCodecInfo.CodecCapabilities
- MediaCodecInfo.CodecProfileLevel
- MediaCodecInfo.EncoderCapabilities
- MediaCodecInfo.VideoCapabilities
- MediaCodecList
- MediaCrypto
- MediaDataSource
- MediaDescription
- MediaDescription.Builder
- MediaDrm
- MediaDrm.CryptoSession
- MediaDrm.KeyRequest
- MediaDrm.KeyStatus
- MediaDrm.ProvisionRequest
- MediaExtractor
- MediaFormat
- MediaMetadata
- MediaMetadata.Builder
- MediaMetadataEditor
- MediaMetadataRetriever
- MediaMuxer
- MediaMuxer.OutputFormat
- MediaPlayer
- MediaPlayer.TrackInfo
- MediaRecorder
- MediaRecorder.AudioEncoder
- MediaRecorder.AudioSource
- MediaRecorder.OutputFormat
- MediaRecorder.VideoEncoder
- MediaRecorder.VideoSource
- MediaRouter
- MediaRouter.Callback
- MediaRouter.RouteCategory
- MediaRouter.RouteGroup
- MediaRouter.RouteInfo
- MediaRouter.SimpleCallback
- MediaRouter.UserRouteInfo
- MediaRouter.VolumeCallback
- MediaScannerConnection
- MediaSync
- MediaSync.Callback
- MediaSyncEvent
- MediaTimestamp
- PlaybackParams
- Rating
- RemoteControlClient
- RemoteControlClient.MetadataEditor
- RemoteController
- RemoteController.MetadataEditor
- Ringtone
- RingtoneManager
- SoundPool
- SoundPool.Builder
- SyncParams
- ThumbnailUtils
- TimedMetaData
- TimedText
- ToneGenerator
- VolumeProvider
Exceptions


