Interface PluginInitFunc

All Superinterfaces:
FunctionPointer
Functional Interface:
This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
@FunctionalInterface @Generated("org.javagi.JavaGI") public interface PluginInitFunc extends FunctionPointer

Functional interface declaration of the PluginInitFunc callback.

See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    run(Plugin plugin)
    A plugin should provide a pointer to a function of this type in the plugin_desc struct.
    default MemorySegment
    toCallback(Arena arena)
    Creates a native function pointer to the upcall(MemorySegment) method.
    default int
    upcall(MemorySegment plugin)
    The upcall method is called from native code.

  • Method Details

    • run

      boolean run(Plugin plugin)
      A plugin should provide a pointer to a function of this type in the plugin_desc struct. This function will be called by the loader at startup. One would then register each GstPluginFeature.
      Parameters:
      plugin - The plugin object
      Returns:
      true if plugin initialised successfully

    • upcall

      default int upcall(MemorySegment plugin)
      The upcall method is called from native code. The parameters are marshaled and run(Plugin) is executed.

    • toCallback

      default MemorySegment toCallback(Arena arena)
      Creates a native function pointer to the upcall(MemorySegment) method.
      Specified by:
      toCallback in interface FunctionPointer
      Parameters:
      arena - the arena in which the function pointer is allocated
      Returns:
      the native function pointer