PIpeWire Endpoint
WpEndpoint
GObject ╰──WpObject ╰──WpProxy ╰──WpGlobalProxy ╰──WpEndpoint ╰──WpImplEndpoint
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.
Members
parent_instance
(WpGlobalProxy)
–
Class structure
Methods
wp_endpoint_create_link
wp_endpoint_create_link (WpEndpoint * self, WpProperties * props)
Creates a WpEndpointLink between self and another endpoint, which must be specified in props. props may contain:
-
endpoint-link.output.endpoint
: the bound id of the endpoint that is in the WP_DIRECTION_OUTPUT direction -
endpoint-link.input.endpoint
: the bound id of the endpoint that is in the WP_DIRECTION_INPUT direction
The id of self is not necessary to be specified, so only one of
endpoint-link.output.endpoint
, endpoint-link.input.endpoint
is actually required.
Parameters:
self
–
the endpoint
props
–
the link properties
wp_endpoint_get_direction
WpDirection wp_endpoint_get_direction (WpEndpoint * self)
Requires WP_PIPEWIRE_OBJECT_FEATURE_INFO
Parameters:
self
–
the endpoint
the direction of this endpoint
wp_endpoint_get_media_class
const gchar* wp_endpoint_get_media_class (WpEndpoint * self)
Requires WP_PIPEWIRE_OBJECT_FEATURE_INFO
Parameters:
self
–
the endpoint
the media class of the endpoint (ex. "Audio/Sink")
wp_endpoint_get_name
const gchar* wp_endpoint_get_name (WpEndpoint * self)
Requires WP_PIPEWIRE_OBJECT_FEATURE_INFO
Parameters:
self
–
the endpoint
the name of the endpoint
Properties
media-class
“media-class” gchar*
The media class of the endpoint (ex. "Audio/Sink")
Flags : Read
name
“name” gchar*
The name of the endpoint
Flags : Read
WpImplEndpoint
GObject ╰──WpObject ╰──WpProxy ╰──WpGlobalProxy ╰──WpEndpoint ╰──WpImplEndpoint
Class structure
Constructors
wp_impl_endpoint_new
WpImplEndpoint * wp_impl_endpoint_new (WpCore * core, WpSiEndpoint * item)
Parameters:
core
–
item
–
Properties
Constants
WP_TYPE_IMPL_ENDPOINT
#define WP_TYPE_IMPL_ENDPOINT (wp_impl_endpoint_get_type ())
The WpImplEndpoint GType
The results of the search are