# AudioFocusRequestCompat

Artifact: [androidx.media:media](https://developer.android.com/jetpack/androidx/releases/media) [View Source](https://cs.android.com/search?q=file:androidx/media/AudioFocusRequestCompat.java+class:androidx.media.AudioFocusRequestCompat) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/media#1.1.0) Deprecated in [1.8.0](https://developer.android.com/jetpack/androidx/releases/media#1.8.0)

*** ** * ** ***


```
public class AudioFocusRequestCompat
```

<br />

*** ** * ** ***

> [!CAUTION]
> **This class is deprecated.**   
>
> androidx.media is deprecated. Please migrate to [androidx.media3](https://developer.android.com/media/media3).

Compatibility version of an `https://developer.android.com/reference/android/media/AudioFocusRequest.html`.

## Summary

| ### Nested types |
|---|
| `public final class https://developer.android.com/reference/androidx/media/AudioFocusRequestCompat.Builder` **This class is deprecated.** androidx.media is deprecated. <br /> |

| ### Public methods |
|---|---|
| `boolean` | `[equals](https://developer.android.com/reference/androidx/media/AudioFocusRequestCompat#equals(java.lang.Object))(https://developer.android.com/reference/java/lang/Object.html o)` **This method is deprecated.** Deprecated in Java |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/media/AudioAttributesCompat` | `[getAudioAttributesCompat](https://developer.android.com/reference/androidx/media/AudioFocusRequestCompat#getAudioAttributesCompat())()` **This method is deprecated.** Deprecated in Java |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/os/Handler.html` | `[getFocusChangeHandler](https://developer.android.com/reference/androidx/media/AudioFocusRequestCompat#getFocusChangeHandler())()` **This method is deprecated.** Deprecated in Java |
| `int` | `[getFocusGain](https://developer.android.com/reference/androidx/media/AudioFocusRequestCompat#getFocusGain())()` **This method is deprecated.** Deprecated in Java |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/media/AudioManager.OnAudioFocusChangeListener.html` | `[getOnAudioFocusChangeListener](https://developer.android.com/reference/androidx/media/AudioFocusRequestCompat#getOnAudioFocusChangeListener())()` **This method is deprecated.** Deprecated in Java |
| `int` | `[hashCode](https://developer.android.com/reference/androidx/media/AudioFocusRequestCompat#hashCode())()` **This method is deprecated.** Deprecated in Java |
| `boolean` | `[willPauseWhenDucked](https://developer.android.com/reference/androidx/media/AudioFocusRequestCompat#willPauseWhenDucked())()` **This method is deprecated.** Deprecated in Java |

## Public methods

### equals

```
public boolean [equals](https://developer.android.com/reference/androidx/media/AudioFocusRequestCompat#equals(java.lang.Object))(Object o)
```

> [!CAUTION]
> **This method is deprecated.**   
> Deprecated in Java

### getAudioAttributesCompat

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/media#1.1.0) Deprecated in [1.8.0](https://developer.android.com/jetpack/androidx/releases/media#1.8.0)

```
public @NonNull AudioAttributesCompat [getAudioAttributesCompat](https://developer.android.com/reference/androidx/media/AudioFocusRequestCompat#getAudioAttributesCompat())()
```

> [!CAUTION]
> **This method is deprecated.**   
> Deprecated in Java

Gets the `https://developer.android.com/reference/androidx/media/AudioAttributesCompat` set for this `AudioFocusRequestCompat`, or the default attributes if none were set.

| Returns |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/media/AudioAttributesCompat` | non-null `https://developer.android.com/reference/androidx/media/AudioAttributesCompat`. |

### getFocusChangeHandler

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/media#1.1.0) Deprecated in [1.8.0](https://developer.android.com/jetpack/androidx/releases/media#1.8.0)

```
public @NonNull Handler [getFocusChangeHandler](https://developer.android.com/reference/androidx/media/AudioFocusRequestCompat#getFocusChangeHandler())()
```

> [!CAUTION]
> **This method is deprecated.**   
> Deprecated in Java

Gets the `https://developer.android.com/reference/android/os/Handler.html` to be used for the focus change listener.

| Returns |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/os/Handler.html` | the same `Handler` set in. `https://developer.android.com/reference/androidx/media/AudioFocusRequestCompat.Builder#setOnAudioFocusChangeListener(android.media.AudioManager.OnAudioFocusChangeListener,android.os.Handler)`. |

### getFocusGain

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/media#1.1.0) Deprecated in [1.8.0](https://developer.android.com/jetpack/androidx/releases/media#1.8.0)

```
public int [getFocusGain](https://developer.android.com/reference/androidx/media/AudioFocusRequestCompat#getFocusGain())()
```

> [!CAUTION]
> **This method is deprecated.**   
> Deprecated in Java

Gets the type of audio focus request configured for this `AudioFocusRequestCompat`.

Value is one of the following:

- `AudioManagerCompat.AUDIOFOCUS_GAIN`
- `AudioManagerCompat.AUDIOFOCUS_GAIN_TRANSIENT`
- `AudioManagerCompat.AUDIOFOCUS_GAIN_TRANSIENT_MAY_DUCK`
- `AudioManagerCompat.AUDIOFOCUS_GAIN_TRANSIENT_EXCLUSIVE`

<br />

| Returns |
|---|---|
| `int` | one of `https://developer.android.com/reference/androidx/media/AudioManagerCompat#AUDIOFOCUS_GAIN()`, `https://developer.android.com/reference/androidx/media/AudioManagerCompat#AUDIOFOCUS_GAIN_TRANSIENT()`, `https://developer.android.com/reference/androidx/media/AudioManagerCompat#AUDIOFOCUS_GAIN_TRANSIENT_MAY_DUCK()`, and `https://developer.android.com/reference/androidx/media/AudioManagerCompat#AUDIOFOCUS_GAIN_TRANSIENT_EXCLUSIVE()`. |

### getOnAudioFocusChangeListener

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/media#1.1.0) Deprecated in [1.8.0](https://developer.android.com/jetpack/androidx/releases/media#1.8.0)

```
public @NonNull AudioManager.OnAudioFocusChangeListener [getOnAudioFocusChangeListener](https://developer.android.com/reference/androidx/media/AudioFocusRequestCompat#getOnAudioFocusChangeListener())()
```

> [!CAUTION]
> **This method is deprecated.**   
> Deprecated in Java

Gets the focus change listener set for this `AudioFocusRequestCompat`.

| Returns |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/android/media/AudioManager.OnAudioFocusChangeListener.html` | The `https://developer.android.com/reference/android/media/AudioManager.OnAudioFocusChangeListener.html` that was set. |

### hashCode

```
public int [hashCode](https://developer.android.com/reference/androidx/media/AudioFocusRequestCompat#hashCode())()
```

> [!CAUTION]
> **This method is deprecated.**   
> Deprecated in Java

### willPauseWhenDucked

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/media#1.1.0) Deprecated in [1.8.0](https://developer.android.com/jetpack/androidx/releases/media#1.8.0)

```
public boolean [willPauseWhenDucked](https://developer.android.com/reference/androidx/media/AudioFocusRequestCompat#willPauseWhenDucked())()
```

> [!CAUTION]
> **This method is deprecated.**   
> Deprecated in Java

Gets whether the application that would use this `AudioFocusRequestCompat` would pause when it is requested to duck. This value is only applicable on `https://developer.android.com/reference/android/os/Build.VERSION_CODES.html#O` and later.

| Returns |
|---|---|
| `boolean` | the duck/pause behavior. |