Core¶
-
struct
WpCore
¶ The core is the central object around which everything operates. It is essential to create a WpCore before using any other WirePlumber API.
The core object has the following responsibilities:
it initializes the PipeWire library
it creates a
pw_context
and allows connecting to the PipeWire server, creating a localpw_core
it glues the PipeWire library’s event loop system with GMainLoop
it maintains a list of registered objects, which other classes use to keep objects loaded permanently into memory
it watches the PipeWire registry and keeps track of remote and local objects that appear in the registry, making them accessible through the WpObjectManager API.
The core is also responsible for loading components, which are defined in the main configuration file. Components are loaded when WP_CORE_FEATURE_COMPONENTS is activated.
Configuration
The main configuration file needs to be created and opened before the core is created, using the WpConf API. It is then passed to the core as an argument in the constructor.
If a configuration file is not provided, the core will let the underlying
pw_context
load its own configuration, based on the rules that apply to all pipewire clients (e.g. it respects thePIPEWIRE_CONFIG_NAME
environment variable and loads “client.conf” as a last resort).If a configuration file is provided, the core does not let the underlying
pw_context
load any configuration and instead uses the provided WpConf object.GObject Properties
GObject Signals
- connected
- disconnected
-
enum
wpcore::
WpCoreFeatures
¶ Flags to be used as WpObjectFeatures on WpCore.
Values:
-
WP_CORE_FEATURE_CONNECTED
= (1 << 0)¶ connects to pipewire
-
WP_CORE_FEATURE_COMPONENTS
= (1 << 1)¶ loads components defined in the configuration
-
-
WpCore*
wp_core_new
(GMainContext * context, WpConf * conf, WpProperties * properties)¶ Creates a new core object.
- Return
(transfer full): a new WpCore
- Parameters
context
: (transfer none) (nullable): the GMainContext to use for eventsconf
: (transfer full) (nullable): the main configuration fileproperties
: (transfer full) (nullable): additional properties, which are also passed to pw_context_new() and pw_context_connect()
-
WpCore*
wp_core_clone
(WpCore * self)¶ Clones a core with the same context as self.
- Return
(transfer full): the clone WpCore
- Parameters
self
: the core
-
WpCore*
wp_core_get_export_core
(WpCore * self)¶ Returns the special WpCore that is used to maintain a secondary connection to PipeWire, for exporting objects.
The export core is enabled by loading the built-in “export-core” component.
- Return
(transfer full): the export WpCore
- Parameters
self
: the core
-
WpConf*
wp_core_get_conf
(WpCore * self)¶ Gets the main configuration file of the core.
- Return
(transfer full) (nullable): the main configuration file
- Parameters
self
: the core
-
GMainContext*
wp_core_get_g_main_context
(WpCore * self)¶ Gets the GMainContext of the core.
- Return
(transfer none) (nullable): the GMainContext that is in use by this core for events
- Parameters
self
: the core
-
struct pw_context*
wp_core_get_pw_context
(WpCore * self)¶ Gets the internal PipeWire context of the core.
- Return
(transfer none): the internal pw_context object
- Parameters
self
: the core
-
struct pw_core*
wp_core_get_pw_core
(WpCore * self)¶ Gets the internal PipeWire core of the core.
- Return
(transfer none) (nullable): the internal pw_core object, or NULL if the core is not connected to PipeWire
- Parameters
self
: the core
-
gchar*
wp_core_get_vm_type
(WpCore * self)¶ Gets the virtual machine type of the core.
- Return
(transfer full) (nullable): a comma separated string with all the virtual machine types that this core matches, or NULL if the core is not running in a virtual machine.
- Since
0.4.11
- Parameters
self
: the core
-
gboolean
wp_core_connect
(WpCore * self)¶ Connects this core to the PipeWire server.
When connection succeeds, the WpCore
"connected"
signal is emitted.- Return
TRUE if the core is effectively connected or FALSE if connection failed
- Parameters
self
: the core
-
void
wp_core_disconnect
(WpCore * self)¶ Disconnects this core from the PipeWire server.
This also effectively destroys all WpCore objects that were created through the registry, destroys the pw_core and finally emits the WpCore
"disconnected"
signal.- Parameters
self
: the core
-
gboolean
wp_core_is_connected
(WpCore * self)¶ Checks if the core is connected to PipeWire.
- Return
TRUE if the core is connected to PipeWire, FALSE otherwise
- Parameters
self
: the core
-
guint32
wp_core_get_own_bound_id
(WpCore * self)¶ Gets the bound id of the client object that is created as a result of this core being connected to the PipeWire daemon.
- Since
0.4.16
- Return
the bound id of this client
- Parameters
self
: the core
Gets the cookie of the core’s connected PipeWire instance.
- Return
The cookie of the PipeWire instance that self is connected to. The cookie is a unique random number for identifying an instance of PipeWire
- Parameters
self
: the core
-
const gchar*
wp_core_get_remote_name
(WpCore * self)¶ Gets the name of the core’s connected PipeWire instance.
- Return
The name of the PipeWire instance that self is connected to
- Parameters
self
: the core
-
const gchar*
wp_core_get_remote_user_name
(WpCore * self)¶ Gets the user name of the core’s connected PipeWire instance.
- Return
The name of the user that started the PipeWire instance that self is connected to
- Parameters
self
: the core
-
const gchar*
wp_core_get_remote_host_name
(WpCore * self)¶ Gets the host name of the core’s connected PipeWire instance.
- Return
The name of the host where the PipeWire instance that self is connected to is running on
- Parameters
self
: the core
-
const gchar*
wp_core_get_remote_version
(WpCore * self)¶ Gets the version of the core’s connected PipeWire instance.
- Return
The version of the PipeWire instance that self is connected to
- Parameters
self
: the core
-
WpProperties*
wp_core_get_remote_properties
(WpCore * self)¶ Gets the properties of the core’s connected PipeWire instance.
- Return
(transfer full): the properties of the PipeWire instance that self is connected to
- Parameters
self
: the core
-
WpProperties*
wp_core_get_properties
(WpCore * self)¶ Gets the properties of the core.
- Return
(transfer full): the properties of self
- Parameters
self
: the core
-
void
wp_core_update_properties
(WpCore * self, WpProperties * updates)¶ Updates the properties of self on the connection, making them appear on the client object that represents this connection.
If self is not connected yet, these properties are stored and passed to pw_context_connect() when connecting.
- Parameters
self
: the coreupdates
: (transfer full): updates to apply to the properties of self; this does not need to include properties that have not changed
-
void
wp_core_idle_add
(WpCore * self, GSource ** source, GSourceFunc function, gpointer data, GDestroyNotify destroy)¶ Adds an idle callback to be called in the same GMainContext as the one used by this core.
This is essentially the same as g_idle_add_full(), but it adds the created GSource on the GMainContext used by this core instead of the default context.
- Parameters
self
: the coresource
: (out) (optional): the sourcefunction
: (scope notified): the function to calldata
: (closure): data to pass to functiondestroy
: (nullable): a function to destroy data
-
void
wp_core_idle_add_closure
(WpCore * self, GSource ** source, GClosure * closure)¶ Adds an idle callback to be called in the same GMainContext as the one used by this core.
This is the same as wp_core_idle_add(), but it allows you to specify a GClosure instead of a C callback.
- Parameters
self
: the coresource
: (out) (optional): the sourceclosure
: the closure to invoke
-
void
wp_core_timeout_add
(WpCore * self, GSource ** source, guint timeout_ms, GSourceFunc function, gpointer data, GDestroyNotify destroy)¶ Adds a timeout callback to be called at regular intervals in the same GMainContext as the one used by this core.
The function is called repeatedly until it returns FALSE, at which point the timeout is automatically destroyed and the function will not be called again. The first call to the function will be at the end of the first interval.
This is essentially the same as g_timeout_add_full(), but it adds the created GSource on the GMainContext used by this core instead of the default context.
- Parameters
self
: the coresource
: (out) (optional): the sourcetimeout_ms
: the timeout in millisecondsfunction
: (scope notified): the function to calldata
: (closure): data to pass to functiondestroy
: (nullable): a function to destroy data
-
void
wp_core_timeout_add_closure
(WpCore * self, GSource ** source, guint timeout_ms, GClosure * closure)¶ Adds a timeout callback to be called at regular intervals in the same GMainContext as the one used by this core.
This is the same as wp_core_timeout_add(), but it allows you to specify a GClosure instead of a C callback.
- Parameters
self
: the coresource
: (out) (optional): the sourcetimeout_ms
: the timeout in millisecondsclosure
: the closure to invoke
-
gboolean
wp_core_sync
(WpCore * self, GCancellable * cancellable, GAsyncReadyCallback callback, gpointer user_data)¶ Asks the PipeWire server to call the callback via an event.
Since methods are handled in-order and events are delivered in-order, this can be used as a barrier to ensure all previous methods and the resulting events have been handled.
In both success and error cases, callback is always called. Use wp_core_sync_finish() from within the callback to determine whether the operation completed successfully or if an error occurred.
- Return
TRUE if the sync operation was started, FALSE if an error occurred before returning from this function
- Parameters
self
: the corecancellable
: (nullable): a GCancellable to cancel the operationcallback
: (scope async): a function to call when the operation is doneuser_data
: (closure): data to pass to callback
-
gboolean
wp_core_sync_closure
(WpCore * self, GCancellable * cancellable, GClosure * closure)¶ Asks the PipeWire server to invoke the closure via an event.
Since methods are handled in-order and events are delivered in-order, this can be used as a barrier to ensure all previous methods and the resulting events have been handled.
In both success and error cases, closure is always invoked. Use wp_core_sync_finish() from within the closure to determine whether the operation completed successfully or if an error occurred.
- Since
0.4.6
- Return
TRUE if the sync operation was started, FALSE if an error occurred before returning from this function
- Parameters
self
: the corecancellable
: (nullable): a GCancellable to cancel the operationclosure
: (transfer floating): a closure to invoke when the operation is done
-
gboolean
wp_core_sync_finish
(WpCore * self, GAsyncResult * res, GError ** error)¶ This function is meant to be called from within the callback of wp_core_sync() in order to determine the success or failure of the operation.
- Return
TRUE if the operation succeeded, FALSE otherwise
- Parameters
self
: the coreres
: a GAsyncResulterror
: (out) (optional): the error that occurred, if any
-
void
wp_core_register_object
(WpCore * self, gpointer obj)¶ Registers obj with the core, making it appear on WpObjectManager instances as well.
The core will also maintain a ref to that object until it is removed.
- Parameters
self
: the coreobj
: (transfer full) (type GObject*): the object to register
-
void
wp_core_remove_object
(WpCore * self, gpointer obj)¶ Detaches and unrefs the specified object from this core.
- Parameters
self
: the coreobj
: (transfer none) (type GObject*): a pointer to the object to remove
-
gboolean
wp_core_test_feature
(WpCore * self, const gchar * feature)¶ Test if a global feature is provided.
- Return
TRUE if the feature is provided, FALSE otherwise
- Parameters
self
: the corefeature
: the feature name
-
WP_TYPE_CORE
(wp_core_get_type ())¶ The WpCore GType.