AudioFocusRequestCompat.Builder

Builder(@AudioManagerCompat.AudioFocusGain focusGain: Int)

Constructs a new Builder, and specifies how audio focus will be requested.

By default there is no focus change listener, delayed focus is not supported, ducking is suitable for the application, and the AudioAttributes are set to DEFAULT.

fun build(): AudioFocusRequestCompat!

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

@CanIgnoreReturnValue
fun setAudioAttributes(attributes: AudioAttributes!): AudioFocusRequestCompat.Builder!

Sets the AudioAttributes 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 AudioAttributes as used for playback, see for example ExoPlayer.Builder.setAudioAttributes().

@CanIgnoreReturnValue
fun setFocusGain(@AudioManagerCompat.AudioFocusGain focusGain: Int): AudioFocusRequestCompat.Builder!

Sets the type of AudioManagerCompat.AudioFocusGain that will be requested.

@CanIgnoreReturnValue
fun setOnAudioFocusChangeListener(
    listener: AudioManager.OnAudioFocusChangeListener!
): AudioFocusRequestCompat.Builder!

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.

@CanIgnoreReturnValue
fun setOnAudioFocusChangeListener(
    listener: AudioManager.OnAudioFocusChangeListener!,
    handler: Handler!
): AudioFocusRequestCompat.Builder!

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.

@CanIgnoreReturnValue
fun setWillPauseWhenDucked(pauseOnDuck: Boolean): AudioFocusRequestCompat.Builder!

Declares 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.