PipeWire Endpoint¶
digraph inheritance { rankdir=LR; GObject -> WpObject; WpObject -> WpProxy; WpProxy -> WpGlobalProxy; WpGlobalProxy -> WpEndpoint; GInterface -> WpPipewireObject; WpPipewireObject -> WpEndpoint; WpEndpoint -> WpImplEndpoint; }-
struct
WpEndpoint
¶ The WpEndpoint class allows accessing the properties and methods of a PipeWire endpoint object (
struct pw_endpoint
from the session-manager extension).A WpEndpoint is constructed internally when a new endpoint appears on the PipeWire registry and it is made available through the WpObjectManager API.
GObject Properties
- name
-
The name of the endpoint
- media-class
-
The media class of the endpoint (ex. “Audio/Sink”)
- direction
-
The direction of the endpoint
-
struct
WpImplEndpoint
¶ GObject Properties
- item
-
The session item that implements this endpoint
-
const gchar *
wp_endpoint_get_name
(WpEndpoint *self)¶ Gets the name of the endpoint.
- Remark
Requires WP_PIPEWIRE_OBJECT_FEATURE_INFO
- Return
the name of the endpoint
- Parameters
self
: the endpoint
-
const gchar *
wp_endpoint_get_media_class
(WpEndpoint *self)¶ Gets the media class of the endpoint (ex. “Audio/Sink”)
- Remark
Requires WP_PIPEWIRE_OBJECT_FEATURE_INFO
- Return
the media class of the endpoint
- Parameters
self
: the endpoint
-
WpDirection
wp_endpoint_get_direction
(WpEndpoint *self)¶ Gets the direction of the endpoint.
- Remark
Requires WP_PIPEWIRE_OBJECT_FEATURE_INFO
- Return
the direction of this endpoint
- Parameters
self
: the endpoint
-
WpImplEndpoint *
wp_impl_endpoint_new
(WpCore *core, WpSiEndpoint *item)¶ Creates a new endpoint implementation.
- Return
(transfer full): a new WpImplEndpoint
- Parameters
core
: the coreitem
: the session item that implements the endpoint
-
WP_TYPE_ENDPOINT
(wp_endpoint_get_type ())¶ The WpEndpoint GType.
-
WP_TYPE_IMPL_ENDPOINT
(wp_impl_endpoint_get_type ())¶ The WpImplEndpoint GType.