Enum Class InstallPluginsReturn

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

Result codes returned by gst_install_plugins_async() and gst_install_plugins_sync(), and also the result code passed to the GstInstallPluginsResultFunc specified with gst_install_plugins_async().

These codes indicate success or failure of starting an external installer program and to what extent the requested plugins could be installed.

  • Enum Constant Details

    • SUCCESS

      public static final InstallPluginsReturn SUCCESS
      all of the requested plugins could be installed

    • NOT_FOUND

      public static final InstallPluginsReturn NOT_FOUND
      no appropriate installation candidate for any of the requested plugins could be found. Only return this if nothing has been installed. Return GST_INSTALL_PLUGINS_PARTIAL_SUCCESS if some (but not all) of the requested plugins could be installed.

    • ERROR

      public static final InstallPluginsReturn ERROR
      an error occurred during the installation. If this happens, the user has already seen an error message and another one should not be displayed

    • PARTIAL_SUCCESS

      public static final InstallPluginsReturn PARTIAL_SUCCESS
      some of the requested plugins could be installed, but not all

    • USER_ABORT

      public static final InstallPluginsReturn USER_ABORT
      the user has aborted the installation

    • CRASHED

      public static final InstallPluginsReturn CRASHED
      the installer had an unclean exit code (ie. death by signal)

    • INVALID

      public static final InstallPluginsReturn INVALID
      the helper returned an invalid status code

    • STARTED_OK

      public static final InstallPluginsReturn STARTED_OK
      returned by gst_install_plugins_async() to indicate that everything went fine so far and the provided callback will be called with the result of the installation later

    • INTERNAL_FAILURE

      public static final InstallPluginsReturn INTERNAL_FAILURE
      some internal failure has occurred when trying to start the installer

    • HELPER_MISSING

      public static final InstallPluginsReturn HELPER_MISSING
      the helper script to call the actual installer is not installed

    • INSTALL_IN_PROGRESS

      public static final InstallPluginsReturn INSTALL_IN_PROGRESS
      a previously-started plugin installation is still in progress, try again later

  • Method Details

    • values

      public static InstallPluginsReturn[] 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 InstallPluginsReturn 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 InstallPluginsReturn of(int value)
      Create a new InstallPluginsReturn 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 InstallPluginsReturn of(MemorySegment address)
      Create a new InstallPluginsReturn 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 InstallPluginsReturn class.
      Returns:
      the GType

    • getName

      public String getName()
      Convenience function to return the descriptive string associated with a status code. This function returns English strings and should not be used for user messages. It is here only to assist in debugging.
      Returns:
      a descriptive string for the status code in this InstallPluginsReturn