Save the date! Android Dev Summit is coming to Mountain View, CA on November 7-8, 2018.

PlaybackParams

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.

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

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

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(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.

getAudioFallbackMode

added in API level 23
public int getAudioFallbackMode ()

Retrieves the audio fallback mode.

Returns
int audio fallback mode

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.

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.

flags int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE.