VolumeShaper.Configuration.Builder | API reference

VolumeShaper.Configuration.Builder | API reference | Android Developers

Summary: Ctors | Methods | Inherited Methods

public static final class VolumeShaper.Configuration.Builder
extends Object

Builder class for a VolumeShaper.Configuration object.

Here is an example where Builder is used to define the VolumeShaper.Configuration.

 VolumeShaper.Configuration LINEAR_RAMP =
         new VolumeShaper.Configuration.Builder()
             .setInterpolatorType(VolumeShaper.Configuration.INTERPOLATOR_TYPE_LINEAR)
             .setCurve(new float[] { 0.f, 1.f }, // times
                       new float[] { 0.f, 1.f }) // volumes
             .setDuration(1000)
             .build();

Summary

Public constructors
`Builder()` Constructs a new `Builder` with the defaults.
`Builder(VolumeShaper.Configuration configuration)` Constructs a new `Builder` with settings copied from a given `VolumeShaper.Configuration`.

Public methods
`VolumeShaper.Configuration`	`build()` Builds a new `VolumeShaper` object.
`VolumeShaper.Configuration.Builder`	`invertVolumes()` Inverts the volume curve so that the max volume becomes the min volume and vice versa.
`VolumeShaper.Configuration.Builder`	`reflectTimes()` Reflects the volume curve so that the shaper changes volume from the end to the start.
`VolumeShaper.Configuration.Builder`	`scaleToEndVolume(float volume)` Scale the curve end volume to a target value.
`VolumeShaper.Configuration.Builder`	`scaleToStartVolume(float volume)` Scale the curve start volume to a target value.
`VolumeShaper.Configuration.Builder`	`setCurve(float[] times, float[] volumes)` Sets the volume curve.
`VolumeShaper.Configuration.Builder`	`setDuration(long durationMillis)` Sets the `VolumeShaper` duration in milliseconds.
`VolumeShaper.Configuration.Builder`	`setInterpolatorType(int interpolatorType)` Sets the interpolator type.

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.

Public constructors

Builder

public Builder ()

Constructs a new Builder with the defaults.

Builder

public Builder (VolumeShaper.Configuration configuration)

Constructs a new Builder with settings copied from a given VolumeShaper.Configuration.

Parameters
`configuration`	`VolumeShaper.Configuration`: prototypical configuration which will be reused in the new `Builder`. This value cannot be `null`.

Public methods

setCurve

public VolumeShaper.Configuration.Builder setCurve (float[] times, 
                float[] volumes)

Sets the volume curve. The volume curve is represented by a set of control points given by two float arrays of equal length, one representing the time (x) coordinates and one corresponding to the volume (y) coordinates. The length must be at least 2 and no greater than VolumeShaper.Configuration.getMaximumCurvePoints().

The volume curve is normalized as follows: time (x) coordinates should be monotonically increasing, from 0.f to 1.f; volume (y) coordinates must be within 0.f to 1.f.

The time scale is set by setDuration(long).

Parameters
`times`	`float`: an array of float values representing the time line of the volume curve. This value cannot be `null`.
`volumes`	`float`: an array of float values representing the amplitude of the volume curve. This value cannot be `null`.

Returns
`VolumeShaper.Configuration.Builder`	the same `Builder` instance. This value cannot be `null`.

Throws
`IllegalArgumentException`	if `times` or `volumes` is invalid.