HeadphoneFence

Page Summary

• The HeadphoneFence class is used to create fences based on headphone state.

• Fences indicating a changing state are momentarily TRUE for about 5 seconds before reverting to FALSE.

• The during method creates a fence that is TRUE when headphones are in a specified state (plugged in or unplugged).

• The pluggingIn method creates a fence that is momentarily TRUE when headphones are plugged in.

• The unplugging method creates a fence that is momentarily TRUE when headphones are unplugged.

public final class HeadphoneFence extends Object

This class is deprecated.
The Awareness API is deprecated and will be turned down in a future Google Play services release, as early as January 2027. There is no direct replacement.

Use this class to create headphone state fences.

Note: Values that indicate a changing state are momentarily FenceState.TRUE for about 5 seconds, then automatically revert to FenceState.FALSE.

Please be sure to follow the guidelines in the Awareness API Guide .

Public Method Summary

static AwarenessFence	during(int headphoneState) This method is deprecated. The Awareness API is deprecated and will be turned down in a future Google Play services release, as early as January 2027. There is no direct replacement.
static AwarenessFence	pluggingIn() This method is deprecated. The Awareness API is deprecated and will be turned down in a future Google Play services release, as early as January 2027. There is no direct replacement.
static AwarenessFence	unplugging() This method is deprecated. The Awareness API is deprecated and will be turned down in a future Google Play services release, as early as January 2027. There is no direct replacement.

Inherited Method Summary

From class java.lang.Object

Object	clone()
boolean	equals(Object arg0)
void	finalize()
final Class<?>	getClass()
int	hashCode()
final void	notify()
final void	notifyAll()
String	toString()
final void	wait(long arg0, int arg1)
final void	wait(long arg0)
final void	wait()

Public Methods

public static AwarenessFence during (int headphoneState)

This method is deprecated.
The Awareness API is deprecated and will be turned down in a future Google Play services release, as early as January 2027. There is no direct replacement.

This fence is in the FenceState.TRUE state when the headphones are in the specified state.

Parameters

headphoneState	Valid values are HeadphoneState.PLUGGED_IN or HeadphoneState.UNPLUGGED

Returns

• AwarenessFence

public static AwarenessFence pluggingIn ()

This method is deprecated.
The Awareness API is deprecated and will be turned down in a future Google Play services release, as early as January 2027. There is no direct replacement.

This fence is momentarily (about 5 seconds) in the FenceState.TRUE state when headphones are plugged in to the device.

Returns

• AwarenessFence

public static AwarenessFence unplugging ()

This method is deprecated.
The Awareness API is deprecated and will be turned down in a future Google Play services release, as early as January 2027. There is no direct replacement.

This fence is momentarily (about 5 seconds) in the FenceState.TRUE state when headphones are unplugged from the device.

Returns

• AwarenessFence