PipeWire Endpoint Link
WpEndpointLink
GObject ╰──WpObject ╰──WpProxy ╰──WpGlobalProxy ╰──WpEndpointLink ╰──WpImplEndpointLink
The WpEndpointLink class allows accessing the properties and methods of a
PipeWire endpoint link object (struct pw_endpoint_link
from the
session-manager extension).
A WpEndpointLink is constructed internally when a new endpoint link appears on the PipeWire registry and it is made available through the WpObjectManager API.
Members
parent_instance
(WpGlobalProxy)
–
Class structure
Methods
wp_endpoint_link_get_linked_object_ids
wp_endpoint_link_get_linked_object_ids (WpEndpointLink * self, guint32* output_endpoint, guint32* input_endpoint)
Retrieves the ids of the objects that are linked by this endpoint link
Note: Using this method requires WP_PIPEWIRE_OBJECT_FEATURE_INFO
Parameters:
self
–
the endpoint link
output_endpoint
(
[out][optional])
–
the bound id of the output (source) endpoint
input_endpoint
(
[out][optional])
–
the bound id of the input (sink) endpoint
wp_endpoint_link_get_state
WpEndpointLinkState wp_endpoint_link_get_state (WpEndpointLink * self, const gchar** error)
Retrieves the current state of the link
Note: Using this method requires WP_PIPEWIRE_OBJECT_FEATURE_INFO
Parameters:
self
–
the endpoint link
error
(
[out][optional][transfer: none])
–
the error string if the state is WP_ENDPOINT_LINK_STATE_ERROR
the current state of the link
wp_endpoint_link_request_state
wp_endpoint_link_request_state (WpEndpointLink * self, WpEndpointLinkState target)
Requests a state change on the link
Note: Using this method requires WP_PROXY_FEATURE_BOUND
Parameters:
self
–
the endpoint link
target
–
the desired target state of the link
Signals
state-changed
state_changed_callback (WpEndpointLink * self, WpEndpointLinkState * old_state, WpEndpointLinkState * new_state, gchar* error, gpointer user_data)
Emitted when an endpoint link changes state
Parameters:
self
–
the endpoint link
old_state
–
the old state of the link
new_state
–
the new state of the link
error
(
[nullable])
–
the error string if the new state is WP_ENDPOINT_LINK_STATE_ERROR
user_data
–
Flags: Run Last
WpImplEndpointLink
GObject ╰──WpObject ╰──WpProxy ╰──WpGlobalProxy ╰──WpEndpointLink ╰──WpImplEndpointLink
Class structure
Constructors
wp_impl_endpoint_link_new
WpImplEndpointLink * wp_impl_endpoint_link_new (WpCore * core, WpSiLink * item)
Parameters:
core
–
item
–
Properties
Enumerations
WpEndpointLinkState
Members
WP_ENDPOINT_LINK_STATE_ERROR
(-1)
–
WP_ENDPOINT_LINK_STATE_PREPARING
(0)
–
WP_ENDPOINT_LINK_STATE_INACTIVE
(1)
–
WP_ENDPOINT_LINK_STATE_ACTIVE
(2)
–
Constants
WP_TYPE_ENDPOINT_LINK
#define WP_TYPE_ENDPOINT_LINK (wp_endpoint_link_get_type ())
The WpEndpointLink GType
WP_TYPE_IMPL_ENDPOINT_LINK
#define WP_TYPE_IMPL_ENDPOINT_LINK (wp_impl_endpoint_link_get_type ())
The WpImplEndpointLink GType
The results of the search are