Added in API level 26

Summary: Nested Classes | Constants | Inherited Constants | Fields | Methods | Inherited Methods

VolumeShaper.Configuration

---

Kotlin |Java

public static final class VolumeShaper.Configuration
extends Object implements Parcelable

java.lang.Object
↳	android.media.VolumeShaper.Configuration

---

The VolumeShaper.Configuration class contains curve and duration information. It is constructed by the VolumeShaper.Configuration.Builder.

A VolumeShaper.Configuration is used by VolumeAutomation.createVolumeShaper(Configuration) to create a VolumeShaper and by VolumeShaper.replace(Configuration, Operation, boolean) to replace an existing configuration.

The AudioTrack and MediaPlayer classes implement the VolumeAutomation interface.

Summary

Nested classes
class	VolumeShaper.Configuration.Builder Builder class for a VolumeShaper.Configuration object.

Constants
int	INTERPOLATOR_TYPE_CUBIC Cubic interpolated volume curve.
int	INTERPOLATOR_TYPE_CUBIC_MONOTONIC Cubic interpolated volume curve that preserves local monotonicity.
int	INTERPOLATOR_TYPE_LINEAR Linear interpolated volume curve.
int	INTERPOLATOR_TYPE_STEP Stepwise volume curve.

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<VolumeShaper.Configuration>	CREATOR
public static final VolumeShaper.Configuration	CUBIC_RAMP A one second cubic ramp from silence to full volume.
public static final VolumeShaper.Configuration	LINEAR_RAMP A one second linear ramp from silence to full volume.
public static final VolumeShaper.Configuration	SCURVE_RAMP A one second sine-squared s-curve ramp from silence to full volume.
public static final VolumeShaper.Configuration	SINE_RAMP A one second sine curve from silence to full volume for energy preserving cross fades.

Public methods
int	describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
boolean	equals(Object o) Indicates whether some other object is "equal to" this one.
long	getDuration() Returns the duration of the volume shape in milliseconds.
int	getInterpolatorType() Returns the interpolator type.
static int	getMaximumCurvePoints() Returns the maximum number of curve points allowed for VolumeShaper.Configuration.Builder.setCurve(float[], float[]).
float[]	getTimes() Returns the times (x) coordinate array of the volume curve points.
float[]	getVolumes() Returns the volumes (y) coordinate array of the volume curve points.
int	hashCode() Returns a hash code value for the object.
String	toString() Returns a string representation of the object.
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

INTERPOLATOR_TYPE_CUBIC

Added in API level 26

public static final int INTERPOLATOR_TYPE_CUBIC

Cubic interpolated volume curve. This is default if unspecified.

Constant Value: 2 (0x00000002)

INTERPOLATOR_TYPE_CUBIC_MONOTONIC

Added in API level 26

public static final int INTERPOLATOR_TYPE_CUBIC_MONOTONIC

Cubic interpolated volume curve that preserves local monotonicity. So long as the control points are locally monotonic, the curve interpolation between those points are monotonic. This is useful for cubic spline interpolated volume ramps and ducks.

Constant Value: 3 (0x00000003)

INTERPOLATOR_TYPE_LINEAR

Added in API level 26

public static final int INTERPOLATOR_TYPE_LINEAR

Linear interpolated volume curve.

Constant Value: 1 (0x00000001)

INTERPOLATOR_TYPE_STEP

Added in API level 26

public static final int INTERPOLATOR_TYPE_STEP

Stepwise volume curve.

Constant Value: 0 (0x00000000)

Fields

CREATOR

Added in API level 26

public static final Creator<VolumeShaper.Configuration> CREATOR

CUBIC_RAMP

Added in API level 26

public static final VolumeShaper.Configuration CUBIC_RAMP

A one second cubic ramp from silence to full volume. Use VolumeShaper.Configuration.Builder.reflectTimes() or VolumeShaper.Configuration.Builder.invertVolumes() to generate the matching cubic duck.

LINEAR_RAMP

Added in API level 26

public static final VolumeShaper.Configuration LINEAR_RAMP

A one second linear ramp from silence to full volume. Use VolumeShaper.Configuration.Builder.reflectTimes() or VolumeShaper.Configuration.Builder.invertVolumes() to generate the matching linear duck.

SCURVE_RAMP

Added in API level 26

public static final VolumeShaper.Configuration SCURVE_RAMP

A one second sine-squared s-curve ramp from silence to full volume. Use VolumeShaper.Configuration.Builder.reflectTimes() or VolumeShaper.Configuration.Builder.invertVolumes() to generate the matching sine-squared s-curve duck.

SINE_RAMP

Added in API level 26

public static final VolumeShaper.Configuration SINE_RAMP

A one second sine curve from silence to full volume for energy preserving cross fades. Use VolumeShaper.Configuration.Builder.reflectTimes() to generate the matching cosine duck.

Public methods

describeContents

Added in API level 26

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

equals

Added in API level 26

public boolean equals (Object o)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o	Object: the reference object with which to compare.

Returns
boolean	true if this object is the same as the obj argument; false otherwise.

getDuration

Added in API level 26

public long getDuration ()

Returns the duration of the volume shape in milliseconds.

Returns
long

getInterpolatorType

Added in API level 26

public int getInterpolatorType ()

Returns the interpolator type.

Returns
int	Value is INTERPOLATOR_TYPE_STEP, INTERPOLATOR_TYPE_LINEAR, INTERPOLATOR_TYPE_CUBIC, or INTERPOLATOR_TYPE_CUBIC_MONOTONIC

getMaximumCurvePoints

Added in API level 26

public static int getMaximumCurvePoints ()

Returns the maximum number of curve points allowed for VolumeShaper.Configuration.Builder.setCurve(float[], float[]).

Returns
int

getTimes

Added in API level 26

public float[] getTimes ()

Returns the times (x) coordinate array of the volume curve points.

Returns
float[]

getVolumes

Added in API level 26

public float[] getVolumes ()

Returns the volumes (y) coordinate array of the volume curve points.

Returns
float[]

hashCode

Added in API level 26

public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns
int	a hash code value for this object.

toString

Added in API level 26

public String toString ()

Returns a string representation of the object.

Returns
String	a string representation of the object.

writeToParcel

Added in API level 26

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