Added in API level 23

Summary: Constants | Inherited Constants | Fields | Ctors | Methods | Inherited Methods

PlaybackParams

---

Kotlin |Java

public final class PlaybackParams
extends Object implements Parcelable

java.lang.Object
↳	android.media.PlaybackParams

---

Structure for common playback params. Used by AudioTrack AudioTrack.getPlaybackParams() and AudioTrack.setPlaybackParams(PlaybackParams) to control playback behavior.

audio fallback mode: select out-of-range parameter handling.

• PlaybackParams.AUDIO_FALLBACK_MODE_DEFAULT: System will determine best handling.
• PlaybackParams.AUDIO_FALLBACK_MODE_MUTE: Play silence for params normally out of range.
• PlaybackParams.AUDIO_FALLBACK_MODE_FAIL: Return IllegalArgumentException from AudioTrack.setPlaybackParams(PlaybackParams).

pitch: increases or decreases the tonal frequency of the audio content. It is expressed as a multiplicative factor, where normal pitch is 1.0f.

speed: increases or decreases the time to play back a set of audio or video frames. It is expressed as a multiplicative factor, where normal speed is 1.0f.

Different combinations of speed and pitch may be used for audio playback; some common ones:

• Pitch equals 1.0f. Speed change will be done with pitch preserved, often called timestretching.
• Pitch equals speed. Speed change will be done by resampling, similar to AudioTrack.setPlaybackRate(int).

Summary

Constants
int	AUDIO_FALLBACK_MODE_DEFAULT
int	AUDIO_FALLBACK_MODE_FAIL
int	AUDIO_FALLBACK_MODE_MUTE

Inherited constants

From interface android.os.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(Parcel, int): 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)".

Fields
public static final Creator<PlaybackParams>	CREATOR

Public constructors
PlaybackParams()

Public methods
PlaybackParams	allowDefaults() Allows defaults to be returned for properties not set.
int	describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
int	getAudioFallbackMode() Retrieves the audio fallback mode.
float	getPitch() Retrieves the pitch factor.
float	getSpeed() Retrieves the speed factor.
PlaybackParams	setAudioFallbackMode(int audioFallbackMode) Sets the audio fallback mode.
PlaybackParams	setPitch(float pitch) Sets the pitch factor.
PlaybackParams	setSpeed(float speed) Sets the speed factor.
void	writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel.

Inherited methods
From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
From interface android.os.Parcelable abstract int describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. abstract void writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel.

Constants

AUDIO_FALLBACK_MODE_DEFAULT

Added in API level 23

public static final int AUDIO_FALLBACK_MODE_DEFAULT

Constant Value: 0 (0x00000000)

AUDIO_FALLBACK_MODE_FAIL

Added in API level 23

public static final int AUDIO_FALLBACK_MODE_FAIL

Constant Value: 2 (0x00000002)

AUDIO_FALLBACK_MODE_MUTE

Added in API level 23

public static final int AUDIO_FALLBACK_MODE_MUTE

Constant Value: 1 (0x00000001)

Fields

CREATOR

Added in API level 23

public static final Creator<PlaybackParams> CREATOR

Public constructors

PlaybackParams

Added in API level 23

public PlaybackParams ()

Public methods

allowDefaults

Added in API level 23

public PlaybackParams allowDefaults ()

Allows defaults to be returned for properties not set. Otherwise a IllegalArgumentException exception is raised when getting those properties which have defaults but have never been set.

Returns
PlaybackParams	this PlaybackParams instance.

describeContents

Added in API level 23

public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
int	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR

getAudioFallbackMode

Added in API level 23

public int getAudioFallbackMode ()

Retrieves the audio fallback mode.

Returns
int	audio fallback mode Value is AUDIO_FALLBACK_MODE_DEFAULT, AUDIO_FALLBACK_MODE_MUTE, or AUDIO_FALLBACK_MODE_FAIL

Throws
IllegalStateException	if the audio fallback mode is not set.

getPitch

Added in API level 23

public float getPitch ()

Retrieves the pitch factor.

Returns
float	pitch

Throws
IllegalStateException	if pitch is not set.

getSpeed

Added in API level 23

public float getSpeed ()

Retrieves the speed factor.

Returns
float	speed

Throws
IllegalStateException	if speed is not set.

setAudioFallbackMode

Added in API level 23

public PlaybackParams setAudioFallbackMode (int audioFallbackMode)

Sets the audio fallback mode.

Parameters
audioFallbackMode	int: Value is AUDIO_FALLBACK_MODE_DEFAULT, AUDIO_FALLBACK_MODE_MUTE, or AUDIO_FALLBACK_MODE_FAIL

Returns
PlaybackParams	this PlaybackParams instance.

setPitch

Added in API level 23

public PlaybackParams setPitch (float pitch)

Sets the pitch factor.

Returns
PlaybackParams	this PlaybackParams instance.

Throws
IllegalArgumentException	if the pitch is negative.

setSpeed

Added in API level 23

public PlaybackParams setSpeed (float speed)

Sets the speed factor.

Returns
PlaybackParams	this PlaybackParams instance.

writeToParcel

Added in API level 23

public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

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.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES