Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Ctors](https://developer.android.com/reference/android/media/VolumeShaper.Configuration.Builder#pubctors) \| [Methods](https://developer.android.com/reference/android/media/VolumeShaper.Configuration.Builder#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/media/VolumeShaper.Configuration.Builder#inhmethods)

# VolumeShaper.Configuration.Builder

*** ** * ** ***


`
public
static
final

class
VolumeShaper.Configuration.Builder
`


`

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


`

`


`

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

<br />

*** ** * ** ***

Builder class for a `https://developer.android.com/reference/android/media/VolumeShaper.Configuration` object.

Here is an example where `Builder` is used to define the
`https://developer.android.com/reference/android/media/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();
```

<br />

## Summary

| ### Public constructors ||
|---|---|
| ` https://developer.android.com/reference/android/media/VolumeShaper.Configuration.Builder#Builder()() ` Constructs a new `Builder` with the defaults. |
| ` https://developer.android.com/reference/android/media/VolumeShaper.Configuration.Builder#Builder(android.media.VolumeShaper.Configuration)(https://developer.android.com/reference/android/media/VolumeShaper.Configuration configuration) ` Constructs a new `Builder` with settings copied from a given `VolumeShaper.Configuration`. |

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

| ### 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*. | ||

## Public constructors

### Builder

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

```
public Builder ()
```

Constructs a new `Builder` with the defaults.

<br />

### Builder

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

```
public Builder (VolumeShaper.Configuration configuration)
```

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

<br />

| Parameters ||
|---|---|
| `configuration` | `VolumeShaper.Configuration`: prototypical configuration which will be reused in the new `Builder`. This value cannot be `null`. <br /> |

## Public methods

### build

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

```
public VolumeShaper.Configuration build ()
```

Builds a new `https://developer.android.com/reference/android/media/VolumeShaper` object.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/media/VolumeShaper.Configuration` | a new `https://developer.android.com/reference/android/media/VolumeShaper` object. This value cannot be `null`. <br /> |

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

### invertVolumes

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

```
public VolumeShaper.Configuration.Builder invertVolumes ()
```

Inverts the volume curve so that the max volume
becomes the min volume and vice versa.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/media/VolumeShaper.Configuration.Builder` | the same `Builder` instance. This value cannot be `null`. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalStateException` | if curve has not been set. |

### reflectTimes

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

```
public VolumeShaper.Configuration.Builder reflectTimes ()
```

Reflects the volume curve so that
the shaper changes volume from the end
to the start.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/media/VolumeShaper.Configuration.Builder` | the same `Builder` instance. This value cannot be `null`. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalStateException` | if curve has not been set. |

### scaleToEndVolume

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

```
public VolumeShaper.Configuration.Builder scaleToEndVolume (float volume)
```

Scale the curve end volume to a target value.

Keeps the start volume the same.
This works best if the volume curve is monotonic.

<br />

| Parameters ||
|---|---|
| `volume` | `float`: the target end volume to use. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/media/VolumeShaper.Configuration.Builder` | the same `Builder` instance. This value cannot be `null`. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalArgumentException` | if `volume` is not valid. |
| `https://developer.android.com/reference/java/lang/IllegalStateException` | if curve has not been set. |

### scaleToStartVolume

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

```
public VolumeShaper.Configuration.Builder scaleToStartVolume (float volume)
```

Scale the curve start volume to a target value.

Keeps the end volume the same.
This works best if the volume curve is monotonic.

<br />

| Parameters ||
|---|---|
| `volume` | `float`: the target start volume to use. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/media/VolumeShaper.Configuration.Builder` | the same `Builder` instance. This value cannot be `null`. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalArgumentException` | if `volume` is not valid. |
| `https://developer.android.com/reference/java/lang/IllegalStateException` | if curve has not been set. |

### setCurve

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

```
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 `https://developer.android.com/reference/android/media/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 `https://developer.android.com/reference/android/media/VolumeShaper.Configuration.Builder#setDuration(long)`.

<br />

<br />

| Parameters ||
|---|---|
| `times` | `float`: an array of float values representing the time line of the volume curve. This value cannot be `null`. <br /> |
| `volumes` | `float`: an array of float values representing the amplitude of the volume curve. This value cannot be `null`. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/media/VolumeShaper.Configuration.Builder` | the same `Builder` instance. This value cannot be `null`. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalArgumentException` | if `times` or `volumes` is invalid. |

### setDuration

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

```
public VolumeShaper.Configuration.Builder setDuration (long durationMillis)
```

Sets the `VolumeShaper` duration in milliseconds.

If omitted, the default duration is 1 second.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/media/VolumeShaper.Configuration.Builder` | the same `Builder` instance. This value cannot be `null`. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalArgumentException` | if `durationMillis` is not strictly positive. |

### setInterpolatorType

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

```
public VolumeShaper.Configuration.Builder setInterpolatorType (int interpolatorType)
```

Sets the interpolator type.

If omitted the default interpolator type is `https://developer.android.com/reference/android/media/VolumeShaper.Configuration#INTERPOLATOR_TYPE_CUBIC`.

<br />

| Parameters ||
|---|---|
| `interpolatorType` | `int`: method of interpolation used for the volume curve. One of `https://developer.android.com/reference/android/media/VolumeShaper.Configuration#INTERPOLATOR_TYPE_STEP`, `https://developer.android.com/reference/android/media/VolumeShaper.Configuration#INTERPOLATOR_TYPE_LINEAR`, `https://developer.android.com/reference/android/media/VolumeShaper.Configuration#INTERPOLATOR_TYPE_CUBIC`, `https://developer.android.com/reference/android/media/VolumeShaper.Configuration#INTERPOLATOR_TYPE_CUBIC_MONOTONIC`. Value is one of the following: - `https://developer.android.com/reference/android/media/VolumeShaper.Configuration#INTERPOLATOR_TYPE_STEP` - `https://developer.android.com/reference/android/media/VolumeShaper.Configuration#INTERPOLATOR_TYPE_LINEAR` - `https://developer.android.com/reference/android/media/VolumeShaper.Configuration#INTERPOLATOR_TYPE_CUBIC` - `https://developer.android.com/reference/android/media/VolumeShaper.Configuration#INTERPOLATOR_TYPE_CUBIC_MONOTONIC` |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/media/VolumeShaper.Configuration.Builder` | the same `Builder` instance. This value cannot be `null`. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalArgumentException` | if `interpolatorType` is not valid. |