Package org.freedesktop.gstreamer.video

Enum Class NavigationEventType

java.lang.Object

java.lang.Enum<NavigationEventType>

org.freedesktop.gstreamer.video.NavigationEventType

All Implemented Interfaces:

Enumeration, Serializable, Comparable<NavigationEventType>, Constable

@Generated("io.github.jwharm.JavaGI")
public enum NavigationEventType
extends Enum<NavigationEventType>
implements Enumeration

Enum values for the various events that an element implementing the GstNavigation interface might send up the pipeline. Touch events have been inspired by the libinput API, and have the same meaning here.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
COMMAND	A navigation command event.
INVALID	Returned from gst_navigation_event_get_type() when the passed event is not a navigation event.
KEY_PRESS	A key press event.
KEY_RELEASE	A key release event.
MOUSE_BUTTON_PRESS	A mouse button press event.
MOUSE_BUTTON_RELEASE	A mouse button release event.
MOUSE_MOVE	A mouse movement event.
MOUSE_SCROLL	A mouse scroll event.
TOUCH_CANCEL	An event cancelling all currently active touch points.
TOUCH_DOWN	An event describing a new touch point, which will be assigned an identifier that is unique to it for the duration of its movement on the screen.
TOUCH_FRAME	An event signaling the end of a sequence of simultaneous touch events.
TOUCH_MOTION	An event describing the movement of an active touch point across the screen.
TOUCH_UP	An event describing a removed touch point.

Method Summary

Modifier and Type	Method	Description
static Type	getType()	Get the GType of the NavigationEventType class
int	getValue()	Get the numeric value of this enum
static NavigationEventType	of(int value)	Create a new NavigationEventType for the provided value
static NavigationEventType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static NavigationEventType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

INVALID

public static final NavigationEventType INVALID

Returned from gst_navigation_event_get_type() when the passed event is not a navigation event.

KEY_PRESS

public static final NavigationEventType KEY_PRESS

A key press event. Use gst_navigation_event_parse_key_event() to extract the details from the event.

KEY_RELEASE

public static final NavigationEventType KEY_RELEASE

A key release event. Use gst_navigation_event_parse_key_event() to extract the details from the event.

MOUSE_BUTTON_PRESS

public static final NavigationEventType MOUSE_BUTTON_PRESS

A mouse button press event. Use gst_navigation_event_parse_mouse_button_event() to extract the details from the event.

MOUSE_BUTTON_RELEASE

public static final NavigationEventType MOUSE_BUTTON_RELEASE

A mouse button release event. Use gst_navigation_event_parse_mouse_button_event() to extract the details from the event.

MOUSE_MOVE

public static final NavigationEventType MOUSE_MOVE

A mouse movement event. Use gst_navigation_event_parse_mouse_move_event() to extract the details from the event.

COMMAND

public static final NavigationEventType COMMAND

A navigation command event. Use gst_navigation_event_parse_command() to extract the details from the event.

MOUSE_SCROLL

public static final NavigationEventType MOUSE_SCROLL

A mouse scroll event. Use gst_navigation_event_parse_mouse_scroll_event() to extract the details from the event.

TOUCH_DOWN

public static final NavigationEventType TOUCH_DOWN

An event describing a new touch point, which will be assigned an identifier that is unique to it for the duration of its movement on the screen. Use gst_navigation_event_parse_touch_event() to extract the details from the event.

TOUCH_MOTION

public static final NavigationEventType TOUCH_MOTION

An event describing the movement of an active touch point across the screen. Use gst_navigation_event_parse_touch_event() to extract the details from the event.

TOUCH_UP

public static final NavigationEventType TOUCH_UP

An event describing a removed touch point. After this event, its identifier may be reused for any new touch points. Use gst_navigation_event_parse_touch_up_event() to extract the details from the event.

TOUCH_FRAME

public static final NavigationEventType TOUCH_FRAME

An event signaling the end of a sequence of simultaneous touch events.

TOUCH_CANCEL

public static final NavigationEventType TOUCH_CANCEL

An event cancelling all currently active touch points.

Method Details

values

public static NavigationEventType[] values()

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

Returns:

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

valueOf

public static NavigationEventType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

of

public static NavigationEventType of(int value)

Create a new NavigationEventType for the provided value

Parameters:

value - the enum value

Returns:

the enum for the provided value

getValue

public int getValue()

Get the numeric value of this enum

Specified by:

getValue in interface Enumeration

Returns:

the enum value

getType

public static Type getType()

Get the GType of the NavigationEventType class

Returns:

the GType