Added in [API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Nested Classes](https://developer.android.com/reference/android/media/VolumeShaper#nestedclasses) \| [Methods](https://developer.android.com/reference/android/media/VolumeShaper#pubmethods) \| [Protected Methods](https://developer.android.com/reference/android/media/VolumeShaper#promethods) \| [Inherited Methods](https://developer.android.com/reference/android/media/VolumeShaper#inhmethods)

# VolumeShaper

*** ** * ** ***


`
public

final

class
VolumeShaper
`


`

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


`

`


implements

https://developer.android.com/reference/java/lang/AutoCloseable


`

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

<br />

*** ** * ** ***

The `VolumeShaper` class is used to automatically control audio volume during media
playback, allowing simple implementation of transition effects and ducking.
It is created from implementations of `VolumeAutomation`,
such as `MediaPlayer` and `AudioTrack` (referred to as "players" below),
by `https://developer.android.com/reference/android/media/MediaPlayer#createVolumeShaper(android.media.VolumeShaper.Configuration)` or `https://developer.android.com/reference/android/media/AudioTrack#createVolumeShaper(android.media.VolumeShaper.Configuration)`.

A `VolumeShaper` is intended for short volume changes.
If the audio output sink changes during
a `VolumeShaper` transition, the precise curve position may be lost, and the
`VolumeShaper` may advance to the end of the curve for the new audio output sink.

The `VolumeShaper` appears as an additional scaling on the audio output,
and adjusts independently of track or stream volume controls.

## Summary

| ### Nested classes ||
|---|---|
| ` class` | `https://developer.android.com/reference/android/media/VolumeShaper.Configuration` The `VolumeShaper.Configuration` class contains curve and duration information. |
| ` class` | `https://developer.android.com/reference/android/media/VolumeShaper.Operation` The `VolumeShaper.Operation` class is used to specify operations to the `VolumeShaper` that affect the volume change. |

| ### Public methods ||
|---|---|
| ` void` | ` https://developer.android.com/reference/android/media/VolumeShaper#apply(android.media.VolumeShaper.Operation)(https://developer.android.com/reference/android/media/VolumeShaper.Operation operation) ` Applies the `https://developer.android.com/reference/android/media/VolumeShaper.Operation` to the `VolumeShaper`. |
| ` void` | ` https://developer.android.com/reference/android/media/VolumeShaper#close()() ` Releases the `VolumeShaper` object; any volume scale due to the `VolumeShaper` is removed after closing. |
| ` float` | ` https://developer.android.com/reference/android/media/VolumeShaper#getVolume()() ` Returns the current volume scale attributable to the `VolumeShaper`. |
| ` void` | ` https://developer.android.com/reference/android/media/VolumeShaper#replace(android.media.VolumeShaper.Configuration,%20android.media.VolumeShaper.Operation,%20boolean)(https://developer.android.com/reference/android/media/VolumeShaper.Configuration configuration, https://developer.android.com/reference/android/media/VolumeShaper.Operation operation, boolean join) ` Replaces the current `VolumeShaper` `configuration` with a new `configuration`. |

| ### Protected methods ||
|---|---|
| ` void` | ` https://developer.android.com/reference/android/media/VolumeShaper#finalize()() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. |

| ### 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*. | ||
| From interface ` https://developer.android.com/reference/java/lang/AutoCloseable ` |---|---| | ` abstract void` | ` https://developer.android.com/reference/java/lang/AutoCloseable#close()() ` Closes this resource, relinquishing any underlying resources. | ||

## Public methods

### apply

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

```
public void apply (VolumeShaper.Operation operation)
```

Applies the `https://developer.android.com/reference/android/media/VolumeShaper.Operation` to the `VolumeShaper`.

Applying `https://developer.android.com/reference/android/media/VolumeShaper.Operation#PLAY` after `PLAY`
or `https://developer.android.com/reference/android/media/VolumeShaper.Operation#REVERSE` after
`REVERSE` has no effect.

Applying `https://developer.android.com/reference/android/media/VolumeShaper.Operation#PLAY` when the player
hasn't started will synchronously start the `VolumeShaper` when
playback begins.

<br />

| Parameters ||
|---|---|
| `operation` | `VolumeShaper.Operation`: the `operation` to apply. This value cannot be `null`. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalStateException` | if the player is uninitialized or if there is a critical failure. In that case, the `VolumeShaper` should be recreated. |

### close

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

```
public void close ()
```

Releases the `VolumeShaper` object; any volume scale due to the
`VolumeShaper` is removed after closing.

If the volume does not reach 1.f when the `VolumeShaper` is closed
(or finalized), there may be an abrupt change of volume.

`close()` may be safely called after a prior `close()`.
This class implements the Java `AutoClosable` interface and
may be used with try-with-resources.

<br />

### getVolume

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

```
public float getVolume ()
```

Returns the current volume scale attributable to the `VolumeShaper`.

This is the last volume from the `VolumeShaper` used for the player,
or the initial volume if the `VolumeShaper` hasn't been started with
`https://developer.android.com/reference/android/media/VolumeShaper.Operation#PLAY`.

<br />

| Returns ||
|---|---|
| `float` | the volume, linearly represented as a value between 0.f and 1.f. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalStateException` | if the player is uninitialized or if there is a critical failure. In that case, the `VolumeShaper` should be recreated. |

### replace

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

```
public void replace (VolumeShaper.Configuration configuration, 
                VolumeShaper.Operation operation, 
                boolean join)
```

Replaces the current `VolumeShaper`
`configuration` with a new `configuration`.

This allows the user to change the volume shape
while the existing `VolumeShaper` is in effect.

The effect of `replace()` is similar to an atomic close of
the existing `VolumeShaper` and creation of a new `VolumeShaper`.

If the `operation` is `https://developer.android.com/reference/android/media/VolumeShaper.Operation#PLAY` then the
new curve starts immediately.

If the `operation` is
`https://developer.android.com/reference/android/media/VolumeShaper.Operation#REVERSE`, then the new curve will
be delayed until `PLAY` is applied.

<br />

| Parameters ||
|---|---|
| `configuration` | `VolumeShaper.Configuration`: the new `configuration` to use. This value cannot be `null`. <br /> |
| `operation` | `VolumeShaper.Operation`: the `operation` to apply to the `VolumeShaper` This value cannot be `null`. <br /> |
| `join` | `boolean`: if true, match the start volume of the new `configuration` to the current volume of the existing `VolumeShaper`, to avoid discontinuity. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalStateException` | if the player is uninitialized or if there is a critical failure. In that case, the `VolumeShaper` should be recreated. |

## Protected methods

### finalize

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

```
protected void finalize ()
```

Called by the garbage collector on an object when garbage collection
determines that there are no more references to the object.
A subclass overrides the `finalize` method to dispose of
system resources or to perform other cleanup.


The general contract of `finalize` is that it is invoked
if and when the Java virtual
machine has determined that there is no longer any
means by which this object can be accessed by any thread that has
not yet died, except as a result of an action taken by the
finalization of some other object or class which is ready to be
finalized. The `finalize` method may take any action, including
making this object available again to other threads; the usual purpose
of `finalize`, however, is to perform cleanup actions before
the object is irrevocably discarded. For example, the finalize method
for an object that represents an input/output connection might perform
explicit I/O transactions to break the connection before the object is
permanently discarded.


The `finalize` method of class `Object` performs no
special action; it simply returns normally. Subclasses of
`Object` may override this definition.


The Java programming language does not guarantee which thread will
invoke the `finalize` method for any given object. It is
guaranteed, however, that the thread that invokes finalize will not
be holding any user-visible synchronization locks when finalize is
invoked. If an uncaught exception is thrown by the finalize method,
the exception is ignored and finalization of that object terminates.


After the `finalize` method has been invoked for an object, no
further action is taken until the Java virtual machine has again
determined that there is no longer any means by which this object can
be accessed by any thread that has not yet died, including possible
actions by other objects or classes which are ready to be finalized,
at which point the object may be discarded.


The `finalize` method is never invoked more than once by a Java
virtual machine for any given object.


Any exception thrown by the `finalize` method causes
the finalization of this object to be halted, but is otherwise
ignored.

<br />