PlaybackParams Class

Definition

[Android.Runtime.Register("android/media/PlaybackParams", ApiSince=23, DoNotGenerateAcw=true)]
public sealed class PlaybackParams : Java.Lang.Object, Android.OS.IParcelable, IDisposable, Java.Interop.IJavaPeerable

[<Android.Runtime.Register("android/media/PlaybackParams", ApiSince=23, DoNotGenerateAcw=true)>]
type PlaybackParams = class
    inherit Object
    interface IParcelable
    interface IJavaObject
    interface IDisposable
    interface IJavaPeerable

Inheritance

Object

Object

PlaybackParams

Attributes

RegisterAttribute

Implements

IParcelable IJavaObject IJavaPeerable IDisposable

Remarks

Structure for common playback params.

Used by AudioTrackAudioTrack#getPlaybackParams() and AudioTrack#setPlaybackParams(PlaybackParams) to control playback behavior.

<strong>audio fallback mode:</strong> select out-of-range parameter handling. <ul> <li> PlaybackParams#AUDIO_FALLBACK_MODE_DEFAULT: System will determine best handling. </li> <li> PlaybackParams#AUDIO_FALLBACK_MODE_MUTE: Play silence for params normally out of range.</li> <li> PlaybackParams#AUDIO_FALLBACK_MODE_FAIL: Return java.lang.IllegalArgumentException from AudioTrack.setPlaybackParams(PlaybackParams).</li> </ul>

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

<strong>speed:</strong> 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: <ul> <li> <em>Pitch equals 1.0f.</em> Speed change will be done with pitch preserved, often called <em>timestretching</em>.</li> <li> <em>Pitch equals speed.</em> Speed change will be done by <em>resampling</em>, similar to AudioTrack#setPlaybackRate(int).</li> </ul>

Java documentation for android.media.PlaybackParams.

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Constructors

Properties

Methods

Explicit Interface Implementations

Extension Methods

Applies to