Package org.robolectric.shadows

Class ShadowAudioTrack

java.lang.Object

org.robolectric.shadows.ShadowAudioTrack

@Implements(android.media.AudioTrack.class)
public class ShadowAudioTrack
extends Object

Implementation of a couple methods in AudioTrack. Only a couple methods are supported, other methods are expected run through the real class. The two AudioTrack.WriteMode are treated the same.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ShadowAudioTrack.OnAudioDataWrittenListener	Listeners to be notified when data is written to an AudioTrack via AudioTrack.write(ByteBuffer, int, int)

Field Summary

Fields

Modifier and Type	Field	Description
protected static final int	DEFAULT_MIN_BUFFER_SIZE

Constructor Summary

Constructors

Constructor	Description
ShadowAudioTrack()

Method Summary

Modifier and Type	Method	Description
static void	addAllowedNonPcmEncoding(int encoding)	Add a non-PCM encoding for which AudioTrack instances are allowed to be created.
static void	addAudioDataListener(ShadowAudioTrack.OnAudioDataWrittenListener listener)	Registers an ShadowAudioTrack.OnAudioDataWrittenListener to the ShadowAudioTrack.
static void	addDirectPlaybackSupport(AudioFormat format, AudioAttributes attr)	Adds support for direct playback for the pair of AudioFormat and AudioAttributes where the format encoding must be non-PCM.
protected void	addOnRoutingChangedListener(AudioRouting.OnRoutingChangedListener listener, Handler handler)
static void	clearAllowedNonPcmEncodings()	Clears all encodings that have been added with addAllowedNonPcmEncoding(int).
static void	clearDirectPlaybackSupportedFormats()	Clears all encodings that have been added for direct playback support with addDirectPlaybackSupport(android.media.AudioFormat, android.media.AudioAttributes).
static void	enableIllegalStateOnPlay(boolean enabled)	Simulates an AudioTrack IllegalStateException while playing.
protected void	flush()
protected int	getPlaybackHeadPosition()
protected PlaybackParams	getPlaybackParams()
protected AudioDeviceInfo	getRoutedDevice()
protected int	native_get_buffer_size_frames()
protected static int	native_get_FCC_8()
protected int	native_get_latency()	Returns the estimated latency of this AudioTrack, in milliseconds.
protected static int	native_get_min_buff_size(int sampleRateInHz, int channelConfig, int audioFormat)	Returns a predefined or default minimum buffer size.
protected int	native_get_native_frame_count()
protected static boolean	native_is_direct_output_supported(int encoding, int sampleRate, int channelMask, int channelIndexMask, int contentType, int usage, int flags)
protected int	native_setup(Object audioTrack, Object attributes, int[] sampleRate, int channelMask, int channelIndexMask, int audioFormat, int buffSizeInBytes, int mode, int[] sessionId, long nativeAudioTrack)
protected int	native_setup(Object audioTrack, Object attributes, int[] sampleRate, int channelMask, int channelIndexMask, int audioFormat, int buffSizeInBytes, int mode, int[] sessionId, long nativeAudioTrack, boolean offload)
protected int	native_setup(Object audioTrack, Object attributes, int[] sampleRate, int channelMask, int channelIndexMask, int audioFormat, int buffSizeInBytes, int mode, int[] sessionId, long nativeAudioTrack, boolean offload, int encapsulationMode, Object tunerConfiguration)
protected int	native_setup(Object audioTrack, Object attributes, int[] sampleRate, int channelMask, int channelIndexMask, int audioFormat, int buffSizeInBytes, int mode, int[] sessionId, long nativeAudioTrack, boolean offload, int encapsulationMode, Object tunerConfiguration, String opPackageName)
protected int	native_setup(Object audioTrack, Object attributes, int[] sampleRate, int channelMask, int channelIndexMask, int audioFormat, int buffSizeInBytes, int mode, int[] sessionId, Parcel attributionSource, long nativeAudioTrack, boolean offload, int encapsulationMode, Object tunerConfiguration, String opPackageName)
protected int	native_setup(Object audioTrack, Object attributes, int sampleRate, int channelMask, int channelIndexMask, int audioFormat, int buffSizeInBytes, int mode, int[] sessionId)
protected int	native_write_byte(byte[] audioData, int offsetInBytes, int sizeInBytes, int format, boolean isBlocking)	Returns the number of bytes to write.
protected int	native_write_native_bytes(Object audioData, int positionInBytes, int sizeInBytes, int format, boolean blocking)
protected int	native_write_native_bytes(ByteBuffer audioData, int positionInBytes, int sizeInBytes, int format, boolean blocking)
protected void	play()
static void	removeAudioDataListener(ShadowAudioTrack.OnAudioDataWrittenListener listener)	Removes an ShadowAudioTrack.OnAudioDataWrittenListener from the ShadowAudioTrack.
protected void	removeOnRoutingChangedListener(AudioRouting.OnRoutingChangedListener listener)
static void	resetTest()
void	setLatency(int latencyMs)	Sets the estimated latency of this AudioTrack that will be returned by AudioTrack.getLatency(), in milliseconds.
static void	setMinBufferSize(int bufferSize)	In the real class, the minimum buffer size is estimated from audio sample rate and other factors.
void	setPlaybackParams(PlaybackParams params)
static void	setRoutedDevice(AudioDeviceInfo routedDevice)	Sets the routed device returned from AudioTrack.getRoutedDevice() and informs all registered AudioRouting.OnRoutingChangedListener.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULT_MIN_BUFFER_SIZE

protected static final int DEFAULT_MIN_BUFFER_SIZE

See Also:

• Constant Field Values

Constructor Details

ShadowAudioTrack

public ShadowAudioTrack()

Method Details

setMinBufferSize

public static void setMinBufferSize(int bufferSize)

In the real class, the minimum buffer size is estimated from audio sample rate and other factors. We do not provide such estimation in native_get_min_buff_size(int, int, int), instead letting users set the minimum for the expected audio sample. Usually higher sample rate requires bigger buffer size.

addDirectPlaybackSupport

public static void addDirectPlaybackSupport(@Nonnull
 AudioFormat format,
 @Nonnull
 AudioAttributes attr)

Adds support for direct playback for the pair of AudioFormat and AudioAttributes where the format encoding must be non-PCM. Calling AudioTrack.isDirectPlaybackSupported(AudioFormat, AudioAttributes) will return true for matching AudioFormat and AudioAttributes. The matching is performed against the format's encoding, sample rate, channel mask and channel index mask, and the attribute's content type, usage and flags.

Parameters:

format - The AudioFormat, which must be of a non-PCM encoding. If the encoding is PCM, the method will throw an IllegalArgumentException.

attr - The AudioAttributes.

clearDirectPlaybackSupportedFormats

public static void clearDirectPlaybackSupportedFormats()

Clears all encodings that have been added for direct playback support with addDirectPlaybackSupport(android.media.AudioFormat, android.media.AudioAttributes).

addAllowedNonPcmEncoding

public static void addAllowedNonPcmEncoding(int encoding)

Add a non-PCM encoding for which AudioTrack instances are allowed to be created.

Parameters:

encoding - One of AudioFormat ENCODING_ constants that represents a non-PCM encoding. If encoding is PCM, this method throws an IllegalArgumentException.

clearAllowedNonPcmEncodings

public static void clearAllowedNonPcmEncodings()

Clears all encodings that have been added with addAllowedNonPcmEncoding(int).

setRoutedDevice

@RequiresApi(24)
public static void setRoutedDevice(@Nullable
 AudioDeviceInfo routedDevice)

Sets the routed device returned from AudioTrack.getRoutedDevice() and informs all registered AudioRouting.OnRoutingChangedListener.

Note that this affects the routed device for all AudioTrack instances.

Parameters:

routedDevice - The route device, or null to reset it to unknown.

native_get_FCC_8

@Implementation(minSdk=24,
                maxSdk=28)
protected static int native_get_FCC_8()

native_is_direct_output_supported

@Implementation(minSdk=29)
protected static boolean native_is_direct_output_supported(int encoding,
 int sampleRate,
 int channelMask,
 int channelIndexMask,
 int contentType,
 int usage,
 int flags)

native_get_min_buff_size

@Implementation
protected static int native_get_min_buff_size(int sampleRateInHz,
 int channelConfig,
 int audioFormat)

Returns a predefined or default minimum buffer size. Audio format and config are neglected.

native_get_native_frame_count

@Implementation(minSdk=23,
                maxSdk=23)
protected int native_get_native_frame_count()

native_get_buffer_size_frames

@Implementation(minSdk=24)
protected int native_get_buffer_size_frames()

native_setup

@Implementation(minSdk=23,
                maxSdk=23)
protected int native_setup(Object audioTrack,
 Object attributes,
 int sampleRate,
 int channelMask,
 int channelIndexMask,
 int audioFormat,
 int buffSizeInBytes,
 int mode,
 int[] sessionId)

native_setup

@Implementation(minSdk=24,
                maxSdk=27)
protected int native_setup(Object audioTrack,
 Object attributes,
 int[] sampleRate,
 int channelMask,
 int channelIndexMask,
 int audioFormat,
 int buffSizeInBytes,
 int mode,
 int[] sessionId,
 long nativeAudioTrack)

native_setup

@Implementation(minSdk=28,
                maxSdk=29)
protected int native_setup(Object audioTrack,
 Object attributes,
 int[] sampleRate,
 int channelMask,
 int channelIndexMask,
 int audioFormat,
 int buffSizeInBytes,
 int mode,
 int[] sessionId,
 long nativeAudioTrack,
 boolean offload)

native_setup

@Implementation(minSdk=30,
                maxSdk=30)
protected int native_setup(Object audioTrack,
 Object attributes,
 int[] sampleRate,
 int channelMask,
 int channelIndexMask,
 int audioFormat,
 int buffSizeInBytes,
 int mode,
 int[] sessionId,
 long nativeAudioTrack,
 boolean offload,
 int encapsulationMode,
 Object tunerConfiguration)

native_setup

@Implementation(minSdk=31,
                maxSdk=33)
protected int native_setup(Object audioTrack,
 Object attributes,
 int[] sampleRate,
 int channelMask,
 int channelIndexMask,
 int audioFormat,
 int buffSizeInBytes,
 int mode,
 int[] sessionId,
 long nativeAudioTrack,
 boolean offload,
 int encapsulationMode,
 Object tunerConfiguration,
 String opPackageName)

native_setup

@Implementation(minSdk=34)
protected int native_setup(Object audioTrack,
 Object attributes,
 int[] sampleRate,
 int channelMask,
 int channelIndexMask,
 int audioFormat,
 int buffSizeInBytes,
 int mode,
 int[] sessionId,
 @Nonnull
 Parcel attributionSource,
 long nativeAudioTrack,
 boolean offload,
 int encapsulationMode,
 Object tunerConfiguration,
 @Nonnull
 String opPackageName)

native_write_byte

@Implementation(minSdk=23)
protected int native_write_byte(byte[] audioData,
 int offsetInBytes,
 int sizeInBytes,
 int format,
 boolean isBlocking)

Returns the number of bytes to write. This method returns immediately even with AudioTrack.WRITE_BLOCKING. If the AudioTrack instance was created with a non-PCM encoding and the encoding can no longer be played directly, the method will return AudioTrack.ERROR_DEAD_OBJECT;

native_write_native_bytes

@Implementation(minSdk=23,
                maxSdk=28)
protected int native_write_native_bytes(Object audioData,
 int positionInBytes,
 int sizeInBytes,
 int format,
 boolean blocking)

See Also:

• native_write_byte(byte[], int, int, int, boolean)

native_write_native_bytes

@Implementation(minSdk=29)
protected int native_write_native_bytes(ByteBuffer audioData,
 int positionInBytes,
 int sizeInBytes,
 int format,
 boolean blocking)

See Also:

• native_write_byte(byte[], int, int, int, boolean)

getRoutedDevice

@Implementation(minSdk=24)
protected AudioDeviceInfo getRoutedDevice()

addOnRoutingChangedListener

@Implementation(minSdk=24)
protected void addOnRoutingChangedListener(@Nonnull
 AudioRouting.OnRoutingChangedListener listener,
 Handler handler)

removeOnRoutingChangedListener

@Implementation(minSdk=24)
protected void removeOnRoutingChangedListener(@Nonnull
 AudioRouting.OnRoutingChangedListener listener)

setPlaybackParams

@Implementation(minSdk=23)
public void setPlaybackParams(@Nonnull
 PlaybackParams params)

setLatency

public void setLatency(int latencyMs)

Sets the estimated latency of this AudioTrack that will be returned by AudioTrack.getLatency(), in milliseconds.

native_get_latency

@Implementation
protected int native_get_latency()

Returns the estimated latency of this AudioTrack, in milliseconds.

getPlaybackParams

@Implementation(minSdk=23)
@Nonnull
protected PlaybackParams getPlaybackParams()

getPlaybackHeadPosition

@Implementation
protected int getPlaybackHeadPosition()

play

@Implementation
protected void play()

flush

@Implementation
protected void flush()

addAudioDataListener

public static void addAudioDataListener(ShadowAudioTrack.OnAudioDataWrittenListener listener)

Registers an ShadowAudioTrack.OnAudioDataWrittenListener to the ShadowAudioTrack.

Parameters:

listener - The ShadowAudioTrack.OnAudioDataWrittenListener to be registered.

removeAudioDataListener

public static void removeAudioDataListener(ShadowAudioTrack.OnAudioDataWrittenListener listener)

Removes an ShadowAudioTrack.OnAudioDataWrittenListener from the ShadowAudioTrack.

Parameters:

listener - The ShadowAudioTrack.OnAudioDataWrittenListener to be removed.

enableIllegalStateOnPlay

public static void enableIllegalStateOnPlay(boolean enabled)

Simulates an AudioTrack IllegalStateException while playing.

resetTest

@Resetter
public static void resetTest()