AudioFocusRequestCompat.Builder

public Builder(int focusGain)

Constructs a new Builder, and specifies how audio focus will be requested. Valid values for focus requests are AUDIOFOCUS_GAIN, AUDIOFOCUS_GAIN_TRANSIENT, and AUDIOFOCUS_GAIN_TRANSIENT_MAY_DUCK, and AUDIOFOCUS_GAIN_TRANSIENT_EXCLUSIVE. AUDIOFOCUS_GAIN_TRANSIENT_EXCLUSIVE is converted to AUDIOFOCUS_GAIN_TRANSIENT on API levels previous to API 19.

By default there is no focus change listener, delayed focus is not supported, ducking is suitable for the application, and the AudioAttributesCompat have a usage of USAGE_MEDIA.

public Builder(@NonNull AudioFocusRequestCompat requestToCopy)

Constructs a new Builder with all the properties of the AudioFocusRequestCompat passed as parameter. Use this method when you want a new request to differ only by some properties.

public AudioFocusRequestCompat build()

Builds a new AudioFocusRequestCompat instance combining all the information gathered by this Builder's configuration methods.

public @NonNull AudioFocusRequestCompat.Builder setAudioAttributes(@NonNull AudioAttributesCompat attributes)

Sets the AudioAttributesCompat to be associated with the focus request, and which describe the use case for which focus is requested. As the focus requests typically precede audio playback, this information is used on certain platforms to declare the subsequent playback use case. It is therefore good practice to use in this method the same AudioAttributesCompat as used for playback, see for example setAudioAttributes in MediaPlayer or setAudioAttributes in AudioTrack.

public @NonNull AudioFocusRequestCompat.Builder setFocusGain(int focusGain)

Sets the type of focus gain that will be requested. Use this method to replace the focus gain when building a request by modifying an existing AudioFocusRequestCompat instance.

public @NonNull AudioFocusRequestCompat.Builder setOnAudioFocusChangeListener(
    @NonNull AudioManager.OnAudioFocusChangeListener listener
)

Sets the listener called when audio focus changes after being requested with requestAudioFocus, and until being abandoned with abandonAudioFocusRequest. Note that only focus changes (gains and losses) affecting the focus owner are reported, not gains and losses of other focus requesters in the system. Notifications are delivered on the main thread.

public @NonNull AudioFocusRequestCompat.Builder setOnAudioFocusChangeListener(
    @NonNull AudioManager.OnAudioFocusChangeListener listener,
    @NonNull Handler handler
)

Sets the listener called when audio focus changes after being requested with requestAudioFocus, and until being abandoned with abandonAudioFocusRequest. Note that only focus changes (gains and losses) affecting the focus owner are reported, not gains and losses of other focus requesters in the system.

public @NonNull AudioFocusRequestCompat.Builder setWillPauseWhenDucked(boolean pauseOnDuck)

Declare the intended behavior of the application with regards to audio ducking. See more details in the AudioFocusRequest class documentation. Setting pauseOnDuck to true will only have an effect on O and later.