Added in [API level 23](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Constants](https://developer.android.com/reference/android/media/PlaybackParams#constants) \| [Inherited Constants](https://developer.android.com/reference/android/media/PlaybackParams#inhconstants) \| [Fields](https://developer.android.com/reference/android/media/PlaybackParams#lfields) \| [Ctors](https://developer.android.com/reference/android/media/PlaybackParams#pubctors) \| [Methods](https://developer.android.com/reference/android/media/PlaybackParams#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/media/PlaybackParams#inhmethods)

# PlaybackParams

*** ** * ** ***

[Kotlin](https://developer.android.com/reference/kotlin/android/media/PlaybackParams "View this page in Kotlin") \|Java


`
public

final

class
PlaybackParams
`


`

extends https://developer.android.com/reference/java/lang/Object


`

`


implements

https://developer.android.com/reference/android/os/Parcelable


`

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.media.PlaybackParams |

<br />

*** ** * ** ***

Structure for common playback params.

Used by `https://developer.android.com/reference/android/media/AudioTrack` `https://developer.android.com/reference/android/media/AudioTrack#getPlaybackParams()` and
`https://developer.android.com/reference/android/media/AudioTrack#setPlaybackParams(android.media.PlaybackParams)`
to control playback behavior.

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

- `https://developer.android.com/reference/android/media/PlaybackParams#AUDIO_FALLBACK_MODE_DEFAULT`: System will determine best handling.
- `https://developer.android.com/reference/android/media/PlaybackParams#AUDIO_FALLBACK_MODE_MUTE`: Play silence for params normally out of range.
- `https://developer.android.com/reference/android/media/PlaybackParams#AUDIO_FALLBACK_MODE_FAIL`: Return `https://developer.android.com/reference/java/lang/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 `https://developer.android.com/reference/android/media/AudioTrack#setPlaybackRate(int)`.

<br />

## Summary

| ### Constants ||
|---|---|
| `int` | `https://developer.android.com/reference/android/media/PlaybackParams#AUDIO_FALLBACK_MODE_DEFAULT` |
| `int` | `https://developer.android.com/reference/android/media/PlaybackParams#AUDIO_FALLBACK_MODE_FAIL` |
| `int` | `https://developer.android.com/reference/android/media/PlaybackParams#AUDIO_FALLBACK_MODE_MUTE` |

| ### Inherited constants |
|---|
| From interface `https://developer.android.com/reference/android/os/Parcelable` |---|---| | `int` | `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` Descriptor bit used with `https://developer.android.com/reference/android/os/Parcelable#describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor. | | `int` | `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE` Flag for use with `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`: 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 https://developer.android.com/reference/android/os/Parcelable.Creator<https://developer.android.com/reference/android/media/PlaybackParams>` | `https://developer.android.com/reference/android/media/PlaybackParams#CREATOR` |

| ### Public constructors ||
|---|---|
| ` https://developer.android.com/reference/android/media/PlaybackParams#PlaybackParams()() ` |

| ### Public methods ||
|---|---|
| ` https://developer.android.com/reference/android/media/PlaybackParams` | ` https://developer.android.com/reference/android/media/PlaybackParams#allowDefaults()() ` Allows defaults to be returned for properties not set. |
| ` int` | ` https://developer.android.com/reference/android/media/PlaybackParams#describeContents()() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| ` int` | ` https://developer.android.com/reference/android/media/PlaybackParams#getAudioFallbackMode()() ` Retrieves the audio fallback mode. |
| ` float` | ` https://developer.android.com/reference/android/media/PlaybackParams#getPitch()() ` Retrieves the pitch factor. |
| ` float` | ` https://developer.android.com/reference/android/media/PlaybackParams#getSpeed()() ` Retrieves the speed factor. |
| ` https://developer.android.com/reference/android/media/PlaybackParams` | ` https://developer.android.com/reference/android/media/PlaybackParams#setAudioFallbackMode(int)(int audioFallbackMode) ` Sets the audio fallback mode. |
| ` https://developer.android.com/reference/android/media/PlaybackParams` | ` https://developer.android.com/reference/android/media/PlaybackParams#setPitch(float)(float pitch) ` Sets the pitch factor. |
| ` https://developer.android.com/reference/android/media/PlaybackParams` | ` https://developer.android.com/reference/android/media/PlaybackParams#setSpeed(float)(float speed) ` Sets the speed factor. |
| ` void` | ` https://developer.android.com/reference/android/media/PlaybackParams#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags) ` Flatten this object in to a Parcel. |

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

## Constants

### AUDIO_FALLBACK_MODE_DEFAULT

Added in [API level 23](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int AUDIO_FALLBACK_MODE_DEFAULT
```

<br />

<br />

Constant Value:

0
(0x00000000)


### AUDIO_FALLBACK_MODE_FAIL

Added in [API level 23](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int AUDIO_FALLBACK_MODE_FAIL
```

<br />

<br />

Constant Value:

2
(0x00000002)


### AUDIO_FALLBACK_MODE_MUTE

Added in [API level 23](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int AUDIO_FALLBACK_MODE_MUTE
```

<br />

<br />

Constant Value:

1
(0x00000001)


## Fields

### CREATOR

Added in [API level 23](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Creator<PlaybackParams> CREATOR
```

<br />

<br />

## Public constructors

### PlaybackParams

Added in [API level 23](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public PlaybackParams ()
```

<br />

<br />

## Public methods

### allowDefaults

Added in [API level 23](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public PlaybackParams allowDefaults ()
```

Allows defaults to be returned for properties not set.
Otherwise a `https://developer.android.com/reference/java/lang/IllegalArgumentException` exception
is raised when getting those properties
which have defaults but have never been set.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/media/PlaybackParams` | this `PlaybackParams` instance. <br /> |

### describeContents

Added in [API level 23](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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 `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`,
the return value of this method must include the
`https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` bit.

<br />

| Returns ||
|---|---|
| `int` | a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or - `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` |

### getAudioFallbackMode

Added in [API level 23](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getAudioFallbackMode ()
```

Retrieves the audio fallback mode.

<br />

| Returns ||
|---|---|
| `int` | audio fallback mode. Value is one of the following: - `https://developer.android.com/reference/android/media/PlaybackParams#AUDIO_FALLBACK_MODE_DEFAULT` - `https://developer.android.com/reference/android/media/PlaybackParams#AUDIO_FALLBACK_MODE_MUTE` - `https://developer.android.com/reference/android/media/PlaybackParams#AUDIO_FALLBACK_MODE_FAIL` |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalStateException` | if the audio fallback mode is not set. |

### getPitch

Added in [API level 23](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public float getPitch ()
```

Retrieves the pitch factor.

<br />

| Returns ||
|---|---|
| `float` | pitch <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalStateException` | if pitch is not set. |

### getSpeed

Added in [API level 23](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public float getSpeed ()
```

Retrieves the speed factor.

<br />

| Returns ||
|---|---|
| `float` | speed <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalStateException` | if speed is not set. |

### setAudioFallbackMode

Added in [API level 23](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public PlaybackParams setAudioFallbackMode (int audioFallbackMode)
```

Sets the audio fallback mode.

<br />

| Parameters ||
|---|---|
| `audioFallbackMode` | `int`: Value is one of the following: - `https://developer.android.com/reference/android/media/PlaybackParams#AUDIO_FALLBACK_MODE_DEFAULT` - `https://developer.android.com/reference/android/media/PlaybackParams#AUDIO_FALLBACK_MODE_MUTE` - `https://developer.android.com/reference/android/media/PlaybackParams#AUDIO_FALLBACK_MODE_FAIL` |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/media/PlaybackParams` | this `PlaybackParams` instance. <br /> |

### setPitch

Added in [API level 23](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public PlaybackParams setPitch (float pitch)
```

Sets the pitch factor.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/media/PlaybackParams` | this `PlaybackParams` instance. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalArgumentException` | if the pitch is negative. |

### setSpeed

Added in [API level 23](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public PlaybackParams setSpeed (float speed)
```

Sets the speed factor.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/media/PlaybackParams` | this `PlaybackParams` instance. <br /> |

### writeToParcel

Added in [API level 23](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void writeToParcel (Parcel dest, 
                int flags)
```

Flatten this object in to a Parcel.

<br />

| Parameters ||
|---|---|
| `dest` | `Parcel`: The Parcel in which the object should be written. This value cannot be `null`. <br /> |
| `flags` | `int`: Additional flags about how the object should be written. May be 0 or `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of the following: - `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE` |