SoundEffectConstants

public class SoundEffectConstants
extends Object

java.lang.Object
   ↳ android.view.SoundEffectConstants


Constants to be used to play sound effects via View#playSoundEffect(int)

Summary

Constants

int CLICK

int NAVIGATION_DOWN

Effect id for a navigation down

int NAVIGATION_LEFT

Effect id for a navigation left

int NAVIGATION_REPEAT_DOWN

Effect id for a repeatedly triggered navigation down, e.g. due to long pressing a button

int NAVIGATION_REPEAT_LEFT

Effect id for a repeatedly triggered navigation left, e.g. due to long pressing a button

int NAVIGATION_REPEAT_RIGHT

Effect id for a repeatedly triggered navigation right, e.g. due to long pressing a button

int NAVIGATION_REPEAT_UP

Effect id for a repeatedly triggered navigation up, e.g. due to long pressing a button

int NAVIGATION_RIGHT

Effect id for a navigation right

int NAVIGATION_UP

Effect id for a navigation up

Public methods

static int getConstantForFocusDirection(int direction, boolean repeating)

Get the sonification constant for the focus directions

static int getContantForFocusDirection(int direction)

Get the sonification constant for the focus directions.

Inherited methods

Constants

CLICK

Added in API level 1
public static final int CLICK

Constant Value: 0 (0x00000000)

Added in API level 1
public static final int NAVIGATION_DOWN

Effect id for a navigation down

Constant Value: 4 (0x00000004)

Added in API level 1
public static final int NAVIGATION_LEFT

Effect id for a navigation left

Constant Value: 1 (0x00000001)

Added in API level 31
public static final int NAVIGATION_REPEAT_DOWN

Effect id for a repeatedly triggered navigation down, e.g. due to long pressing a button

Constant Value: 8 (0x00000008)

Added in API level 31
public static final int NAVIGATION_REPEAT_LEFT

Effect id for a repeatedly triggered navigation left, e.g. due to long pressing a button

Constant Value: 5 (0x00000005)

Added in API level 31
public static final int NAVIGATION_REPEAT_RIGHT

Effect id for a repeatedly triggered navigation right, e.g. due to long pressing a button

Constant Value: 7 (0x00000007)

Added in API level 31
public static final int NAVIGATION_REPEAT_UP

Effect id for a repeatedly triggered navigation up, e.g. due to long pressing a button

Constant Value: 6 (0x00000006)

Added in API level 1
public static final int NAVIGATION_RIGHT

Effect id for a navigation right

Constant Value: 3 (0x00000003)

Added in API level 1
public static final int NAVIGATION_UP

Effect id for a navigation up

Constant Value: 2 (0x00000002)

Public methods

getConstantForFocusDirection

Added in API level 31
public static int getConstantForFocusDirection (int direction, 
                boolean repeating)

Get the sonification constant for the focus directions

Parameters
direction int: The direction of the focus. Value is View.FOCUS_BACKWARD, View.FOCUS_FORWARD, View.FOCUS_LEFT, View.FOCUS_UP, View.FOCUS_RIGHT, or View.FOCUS_DOWN

repeating boolean: True if the user long-presses a direction

Returns
int The appropriate sonification constant Value is NAVIGATION_LEFT, NAVIGATION_UP, NAVIGATION_RIGHT, NAVIGATION_DOWN, NAVIGATION_REPEAT_LEFT, NAVIGATION_REPEAT_UP, NAVIGATION_REPEAT_RIGHT, or NAVIGATION_REPEAT_DOWN

Throws
IllegalArgumentException when the passed direction is not one of the documented values.

getContantForFocusDirection

Added in API level 1
public static int getContantForFocusDirection (int direction)

Get the sonification constant for the focus directions.

Parameters
direction int: The direction of the focus. Value is View.FOCUS_BACKWARD, View.FOCUS_FORWARD, View.FOCUS_LEFT, View.FOCUS_UP, View.FOCUS_RIGHT, or View.FOCUS_DOWN

Returns
int The appropriate sonification constant.

Throws
java.lang.IllegalArgumentException IllegalArgumentException} when the passed direction is not one of the documented values.