Class InstallPluginsContext

java.lang.Object
org.javagi.base.ProxyInstance
org.freedesktop.gstreamer.pbutils.InstallPluginsContext
All Implemented Interfaces:
Proxy

@Generated("org.javagi.JavaGI") public class InstallPluginsContext extends ProxyInstance
Opaque context structure for the plugin installation. Use the provided API to set details on it.
  • Constructor Details

    • InstallPluginsContext

      public InstallPluginsContext(MemorySegment address)
      Create a InstallPluginsContext proxy instance for the provided memory address.
      Parameters:
      address - the memory address of the native object
    • InstallPluginsContext

      public InstallPluginsContext()
      Creates a new GstInstallPluginsContext.
  • Method Details

    • getType

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

      public static MemoryLayout getMemoryLayout()
      The memory layout of the native struct.
      Returns:
      the memory layout
    • copy

      public InstallPluginsContext copy()
      Copies a GstInstallPluginsContext.
      Returns:
      A copy of this InstallPluginsContext
      Since:
      1.12.1
    • free

      public void free()
      Frees a GstInstallPluginsContext.
    • setConfirmSearch

      public void setConfirmSearch(boolean confirmSearch)

      This function is used to tell the external installer process whether it should ask for confirmation or not before searching for missing plugins.

      If set, this option will be passed to the installer via a --interaction=[show-confirm-search|hide-confirm-search] command line option.

      Parameters:
      confirmSearch - whether to ask for confirmation before searching for plugins
      Since:
      1.6
    • setDesktopId

      public void setDesktopId(String desktopId)

      This function is used to pass the calling application's desktop file ID to the external installer process.

      A desktop file ID is the basename of the desktop file, including the .desktop extension.

      If set, the desktop file ID will be passed to the installer via a --desktop-id= command line option.

      Parameters:
      desktopId - the desktop file ID of the calling application
      Since:
      1.6
    • setStartupNotificationId

      public void setStartupNotificationId(String startupId)

      Sets the startup notification ID for the launched process.

      This is typically used to to pass the current X11 event timestamp to the external installer process.

      Startup notification IDs are defined in the FreeDesktop.Org Startup Notifications standard.

      If set, the ID will be passed to the installer via a --startup-notification-id= command line option.

      GTK+/GNOME applications should be able to create a startup notification ID like this:

        timestamp = gtk_get_current_event_time ();
        startup_id = g_strdup_printf ("_TIME%u", timestamp);
      ...
      
      Parameters:
      startupId - the startup notification ID
      Since:
      1.6
    • setXid

      public void setXid(int xid)

      This function is for X11-based applications (such as most Gtk/Qt applications on linux/unix) only. You can use it to tell the external installer the XID of your main application window. That way the installer can make its own window transient to your application window during the installation.

      If set, the XID will be passed to the installer via a --transient-for=XID command line option.

      Gtk+/Gnome application should be able to obtain the XID of the top-level window like this:

      ##include <gtk/gtk.h>
      ##ifdef GDK_WINDOWING_X11
      ##include <gdk/gdkx.h>
      ##endif
      ...
      ##ifdef GDK_WINDOWING_X11
        xid = GDK_WINDOW_XWINDOW (GTK_WIDGET (application_window)->window);
      ##endif
      ...
      
      Parameters:
      xid - the XWindow ID (XID) of the top-level application