com.google.android.exoplayer2.audio

Class AudioFocusManager

java.lang.Object

com.google.android.exoplayer2.audio.AudioFocusManager

public final class AudioFocusManager
extends java.lang.Object

Manages requesting and responding to changes in audio focus.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AudioFocusManager.PlayerCommand Player commands.
static interface	AudioFocusManager.PlayerControl Interface to allow AudioFocusManager to give commands to a player.

Field Summary

Fields

Modifier and Type	Field and Description
static int	PLAYER_COMMAND_DO_NOT_PLAY Do not play.
static int	PLAYER_COMMAND_PLAY_WHEN_READY Play freely.
static int	PLAYER_COMMAND_WAIT_FOR_CALLBACK Do not play now.

Constructor Summary

Constructors

Constructor and Description
AudioFocusManager(android.content.Context context, AudioFocusManager.PlayerControl playerControl) Constructs an AudioFocusManager to automatically handle audio focus for a player.

Method Summary

Modifier and Type	Method and Description
float	getVolumeMultiplier() Gets the current player volume multiplier.
int	handlePrepare(boolean playWhenReady) Called by a player as part of ExoPlayer.prepare(MediaSource, boolean, boolean).
int	handleSetPlayWhenReady(boolean playWhenReady, int playerState) Called by the player as part of Player.setPlayWhenReady(boolean).
void	handleStop() Called by the player as part of Player.stop(boolean).
int	setAudioAttributes(AudioAttributes audioAttributes, boolean playWhenReady, int playerState) Sets audio attributes that should be used to manage audio focus.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PLAYER_COMMAND_DO_NOT_PLAY

public static final int PLAYER_COMMAND_DO_NOT_PLAY

Do not play.

See Also:

Constant Field Values

PLAYER_COMMAND_WAIT_FOR_CALLBACK

public static final int PLAYER_COMMAND_WAIT_FOR_CALLBACK

Do not play now. Wait for callback to play.

See Also:

Constant Field Values

PLAYER_COMMAND_PLAY_WHEN_READY

public static final int PLAYER_COMMAND_PLAY_WHEN_READY

Play freely.

See Also:

Constant Field Values

Constructor Detail

AudioFocusManager

public AudioFocusManager(@Nullable
                         android.content.Context context,
                         AudioFocusManager.PlayerControl playerControl)

Constructs an AudioFocusManager to automatically handle audio focus for a player.

Parameters:

context - The current context.

playerControl - A AudioFocusManager.PlayerControl to handle commands from this instance.

Method Detail

getVolumeMultiplier

public float getVolumeMultiplier()

Gets the current player volume multiplier.

setAudioAttributes

@AudioFocusManager.PlayerCommand
public int setAudioAttributes(@Nullable
                                                               AudioAttributes audioAttributes,
                                                               boolean playWhenReady,
                                                               int playerState)

Sets audio attributes that should be used to manage audio focus.

Parameters:

audioAttributes - The audio attributes or null if audio focus should not be managed automatically.

playWhenReady - The current state of Player.getPlayWhenReady().

playerState - The current player state; Player.getPlaybackState().

Returns:

A AudioFocusManager.PlayerCommand to execute on the player.

handlePrepare

@AudioFocusManager.PlayerCommand
public int handlePrepare(boolean playWhenReady)

Called by a player as part of ExoPlayer.prepare(MediaSource, boolean, boolean).

Parameters:

playWhenReady - The current state of Player.getPlayWhenReady().

Returns:

A AudioFocusManager.PlayerCommand to execute on the player.

handleSetPlayWhenReady

@AudioFocusManager.PlayerCommand
public int handleSetPlayWhenReady(boolean playWhenReady,
                                                                   int playerState)

Called by the player as part of Player.setPlayWhenReady(boolean).

Parameters:

playWhenReady - The desired value of playWhenReady.

playerState - The current state of the player.

Returns:

A AudioFocusManager.PlayerCommand to execute on the player.

handleStop

public void handleStop()

Called by the player as part of Player.stop(boolean).