Package com.castlabs.android.player.audiofocus

Enum AudioFocusMode

java.lang.Object

java.lang.Enum<AudioFocusMode>

com.castlabs.android.player.audiofocus.AudioFocusMode

All Implemented Interfaces:

Serializable, Comparable<AudioFocusMode>

public enum AudioFocusMode
extends Enum<AudioFocusMode>

Defines how PlayerConfig.audioAttributes participate in Android audio-focus management. Audio attributes are always applied to audio output, regardless of the selected mode.

The deprecated SdkConsts.AUDIO_ATTRIBUTES_FOCUS_DISABLED takes precedence over this mode: when it is used as the audio attributes, audio focus is not managed even if MANAGED is selected.

Enum Constant Summary

Enum Constants

Enum Constant	Description
DISABLED	The audio attributes affect output only; the SDK does not request audio focus.
MANAGED	The SDK uses the audio attributes to request focus and apply focus changes to playback.

Method Summary

Modifier and Type	Method	Description
static AudioFocusMode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static AudioFocusMode[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

MANAGED

public static final AudioFocusMode MANAGED

The SDK uses the audio attributes to request focus and apply focus changes to playback.

Focus is only managed for the audio usages that Android supports for automatic handling, namely AudioAttributes.USAGE_MEDIA, AudioAttributes.USAGE_GAME and AudioAttributes.USAGE_UNKNOWN. Other usages are rejected when the configuration is built.

DISABLED

public static final AudioFocusMode DISABLED

The audio attributes affect output only; the SDK does not request audio focus.

Method Details

values

public static AudioFocusMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static AudioFocusMode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null