Enum Class NavigationCommand

java.lang.Object
java.lang.Enum<NavigationCommand>
org.freedesktop.gstreamer.video.NavigationCommand
All Implemented Interfaces:
Serializable, Comparable<NavigationCommand>, Constable, Enumeration
@Generated("org.javagi.JavaGI") public enum NavigationCommand extends Enum<NavigationCommand> implements Enumeration

A set of commands that may be issued to an element providing the GstNavigation interface. The available commands can be queried via the gst_navigation_query_new_commands() query.

For convenience in handling DVD navigation, the MENU commands are aliased as: GST_NAVIGATION_COMMAND_DVD_MENU = GSTNAVIGATIONCOMMANDMENU1 GST_NAVIGATION_COMMAND_DVD_TITLE_MENU = GSTNAVIGATIONCOMMANDMENU2 GST_NAVIGATION_COMMAND_DVD_ROOT_MENU = GSTNAVIGATIONCOMMANDMENU3 GST_NAVIGATION_COMMAND_DVD_SUBPICTURE_MENU = GSTNAVIGATIONCOMMANDMENU4 GST_NAVIGATION_COMMAND_DVD_AUDIO_MENU = GSTNAVIGATIONCOMMANDMENU5 GST_NAVIGATION_COMMAND_DVD_ANGLE_MENU = GSTNAVIGATIONCOMMANDMENU6 GST_NAVIGATION_COMMAND_DVD_CHAPTER_MENU = GSTNAVIGATIONCOMMANDMENU7

  • Nested Class Summary

    Nested classes/interfaces inherited from class Enum

    Enum.EnumDesc<E>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    ACTIVATE
    Activate (click) the currently selected button in a menu, if such a button exists.
    DOWN
    Select the button below the current one in a menu, if such a button exists.
    INVALID
    An invalid command entry
    LEFT
    Select the next button to the left in a menu, if such a button exists.
    MENU1
    Execute navigation menu command 1.
    MENU2
    Execute navigation menu command 2.
    MENU3
    Execute navigation menu command 3.
    MENU4
    Execute navigation menu command 4.
    MENU5
    Execute navigation menu command 5.
    MENU6
    Execute navigation menu command 6.
    MENU7
    Execute navigation menu command 7.
    NEXT_ANGLE
    Switch to the next angle in a multiangle feature.
    PREV_ANGLE
    Switch to the previous angle in a multiangle feature.
    RIGHT
    Select the next button to the right in a menu, if such a button exists.
    UP
    Select the button above the current one in a menu, if such a button exists.

  • Method Summary

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

    Methods inherited from class Enum

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

    Methods inherited from class Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • INVALID

      public static final NavigationCommand INVALID
      An invalid command entry

    • LEFT

      public static final NavigationCommand LEFT
      Select the next button to the left in a menu, if such a button exists.

    • UP

      public static final NavigationCommand UP
      Select the button above the current one in a menu, if such a button exists.

    • DOWN

      public static final NavigationCommand DOWN
      Select the button below the current one in a menu, if such a button exists.

    • ACTIVATE

      public static final NavigationCommand ACTIVATE
      Activate (click) the currently selected button in a menu, if such a button exists.

    • PREV_ANGLE

      public static final NavigationCommand PREV_ANGLE
      Switch to the previous angle in a multiangle feature.

    • NEXT_ANGLE

      public static final NavigationCommand NEXT_ANGLE
      Switch to the next angle in a multiangle feature.

  • Method Details

    • values

      public static NavigationCommand[] 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 NavigationCommand 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 NavigationCommand of(int value)
      Create a new NavigationCommand 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

    • of

      public static NavigationCommand of(MemorySegment address)
      Create a new NavigationCommand for the value in the provided memory address.
      Parameters:
      address - the memory address holding a enum value
      Returns:
      the enum for the value in the provided memory address

    • getType

      public static @Nullable Type getType()
      Get the GType of the NavigationCommand class.
      Returns:
      the GType