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.

WpEndpoint

GObject
    ╰──WpProxy
        ╰──WpEndpoint

Members

parent_instance (WpProxy) –

No description available

Class structure

WpEndpointClass

Fields

parent_class (WpProxyClass) –

No description available

Wp.EndpointClass

Attributes

parent_class (Wp.ProxyClass) –

No description available

Wp.EndpointClass

Attributes

parent_class (Wp.ProxyClass) –

No description available

WpEndpoint

GObject
    ╰──WpProxy
        ╰──WpEndpoint

Members

parent_instance (WpProxy) –

No description available

WpEndpoint

GObject
    ╰──WpProxy
        ╰──WpEndpoint

Members

parent_instance (WpProxy) –

No description available

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.output.stream: the bound id of the endpoint stream 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
endpoint-link.input.stream: the bound id of the endpoint stream that is in the WP_DIRECTION_INPUT direction

If either stream id are not specified (or set to -1), then the first available stream of this endpoint is used for the link.

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.create_link

def Wp.Endpoint.create_link (self, props):
    #python wrapper for 'wp_endpoint_create_link'

Creates a Wp.EndpointLink 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.output.stream: the bound id of the endpoint stream 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
endpoint-link.input.stream: the bound id of the endpoint stream that is in the Wp.Direction.INPUT direction

If either stream id are not specified (or set to -1), then the first available stream of this endpoint is used for the link.

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 ( Wp.Endpoint ) –

the endpoint

props ( Wp.Properties ) –

the link properties

Wp.Endpoint.prototype.create_link

function Wp.Endpoint.prototype.create_link(props: Wp.Properties): {
    // javascript wrapper for 'wp_endpoint_create_link'
}

Creates a Wp.EndpointLink 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.output.stream: the bound id of the endpoint stream 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
endpoint-link.input.stream: the bound id of the endpoint stream that is in the Wp.Direction.INPUT direction

If either stream id are not specified (or set to -1), then the first available stream of this endpoint is used for the link.

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 ( Wp.Endpoint ) –

the endpoint

props ( Wp.Properties ) –

the link properties

wp_endpoint_get_direction

WpDirection
wp_endpoint_get_direction (WpEndpoint * self)

Parameters:

self –

the endpoint

Returns –

the direction of this endpoint

Wp.Endpoint.get_direction

def Wp.Endpoint.get_direction (self):
    #python wrapper for 'wp_endpoint_get_direction'

Parameters:

self ( Wp.Endpoint ) –

the endpoint

Returns ( Wp.Direction ) –

the direction of this endpoint

Wp.Endpoint.prototype.get_direction

function Wp.Endpoint.prototype.get_direction(): {
    // javascript wrapper for 'wp_endpoint_get_direction'
}

Parameters:

self ( Wp.Endpoint ) –

the endpoint

Returns ( Wp.Direction ) –

the direction of this endpoint

wp_endpoint_get_media_class

const gchar *
wp_endpoint_get_media_class (WpEndpoint * self)

Parameters:

self –

the endpoint

Returns –

the media class of the endpoint (ex. "Audio/Sink")

Wp.Endpoint.get_media_class

def Wp.Endpoint.get_media_class (self):
    #python wrapper for 'wp_endpoint_get_media_class'

Parameters:

self ( Wp.Endpoint ) –

the endpoint

Returns ( str ) –

the media class of the endpoint (ex. "Audio/Sink")

Wp.Endpoint.prototype.get_media_class

function Wp.Endpoint.prototype.get_media_class(): {
    // javascript wrapper for 'wp_endpoint_get_media_class'
}

Parameters:

self ( Wp.Endpoint ) –

the endpoint

Returns ( String ) –

the media class of the endpoint (ex. "Audio/Sink")

wp_endpoint_get_n_streams

guint
wp_endpoint_get_n_streams (WpEndpoint * self)

Requires WP_ENDPOINT_FEATURE_STREAMS

Parameters:

self –

the endpoint

Returns –

the number of streams of this endpoint

Wp.Endpoint.get_n_streams

def Wp.Endpoint.get_n_streams (self):
    #python wrapper for 'wp_endpoint_get_n_streams'

Requires Wp.EndpointFeatures.STREAMS

Parameters:

self ( Wp.Endpoint ) –

the endpoint

Returns ( int ) –

the number of streams of this endpoint

Wp.Endpoint.prototype.get_n_streams

function Wp.Endpoint.prototype.get_n_streams(): {
    // javascript wrapper for 'wp_endpoint_get_n_streams'
}

Requires Wp.EndpointFeatures.STREAMS

Parameters:

self ( Wp.Endpoint ) –

the endpoint

Returns ( Number ) –

the number of streams of this endpoint

wp_endpoint_get_name

const gchar *
wp_endpoint_get_name (WpEndpoint * self)

Parameters:

self –

the endpoint

Returns –

the name of the endpoint

Wp.Endpoint.get_name

def Wp.Endpoint.get_name (self):
    #python wrapper for 'wp_endpoint_get_name'

Parameters:

self ( Wp.Endpoint ) –

the endpoint

Returns ( str ) –

the name of the endpoint

Wp.Endpoint.prototype.get_name

function Wp.Endpoint.prototype.get_name(): {
    // javascript wrapper for 'wp_endpoint_get_name'
}

Parameters:

self ( Wp.Endpoint ) –

the endpoint

Returns ( String ) –

the name of the endpoint

wp_endpoint_iterate_streams

WpIterator *
wp_endpoint_iterate_streams (WpEndpoint * self)

Requires WP_ENDPOINT_FEATURE_STREAMS

Parameters:

self –

the endpoint

Returns ( [transfer: full] ) –

a WpIterator that iterates over all the endpoint streams that belong to this endpoint

Wp.Endpoint.iterate_streams

def Wp.Endpoint.iterate_streams (self):
    #python wrapper for 'wp_endpoint_iterate_streams'

Requires Wp.EndpointFeatures.STREAMS

Parameters:

self ( Wp.Endpoint ) –

the endpoint

Returns ( Wp.Iterator ) –

a Wp.Iterator that iterates over all the endpoint streams that belong to this endpoint

Wp.Endpoint.prototype.iterate_streams

function Wp.Endpoint.prototype.iterate_streams(): {
    // javascript wrapper for 'wp_endpoint_iterate_streams'
}

Requires Wp.EndpointFeatures.STREAMS

Parameters:

self ( Wp.Endpoint ) –

the endpoint

Returns ( Wp.Iterator ) –

a Wp.Iterator that iterates over all the endpoint streams that belong to this endpoint

wp_endpoint_iterate_streams_filtered

WpIterator *
wp_endpoint_iterate_streams_filtered (WpEndpoint * self,
                                      ... ...)

Requires WP_ENDPOINT_FEATURE_STREAMS

The constraints specified in the variable arguments must follow the rules documented in wp_object_interest_new.

Parameters:

self –

the endpoint

... –

a list of constraints, terminated by NULL

Returns ( [transfer: full] ) –

a WpIterator that iterates over all the streams that belong to this endpoint and match the constraints

wp_endpoint_iterate_streams_filtered_full

WpIterator *
wp_endpoint_iterate_streams_filtered_full (WpEndpoint * self,
                                           WpObjectInterest * interest)

Requires WP_ENDPOINT_FEATURE_STREAMS

Parameters:

self –

the endpoint

interest ( [transfer: full] ) –

the interest

Returns ( [transfer: full] ) –

a WpIterator that iterates over all the streams that belong to this endpoint and match the interest

Wp.Endpoint.iterate_streams_filtered_full

def Wp.Endpoint.iterate_streams_filtered_full (self, interest):
    #python wrapper for 'wp_endpoint_iterate_streams_filtered_full'

Requires Wp.EndpointFeatures.STREAMS

Parameters:

self ( Wp.Endpoint ) –

the endpoint

interest ( Wp.ObjectInterest ) –

the interest

Returns ( Wp.Iterator ) –

a Wp.Iterator that iterates over all the streams that belong to this endpoint and match the interest

Wp.Endpoint.prototype.iterate_streams_filtered_full

function Wp.Endpoint.prototype.iterate_streams_filtered_full(interest: Wp.ObjectInterest): {
    // javascript wrapper for 'wp_endpoint_iterate_streams_filtered_full'
}

Requires Wp.EndpointFeatures.STREAMS

Parameters:

self ( Wp.Endpoint ) –

the endpoint

interest ( Wp.ObjectInterest ) –

the interest

Returns ( Wp.Iterator ) –

a Wp.Iterator that iterates over all the streams that belong to this endpoint and match the interest

wp_endpoint_lookup_stream

WpEndpointStream *
wp_endpoint_lookup_stream (WpEndpoint * self,
                           ... ...)

Requires WP_ENDPOINT_FEATURE_STREAMS

The constraints specified in the variable arguments must follow the rules documented in wp_object_interest_new.

Parameters:

self –

the endpoint

... –

a list of constraints, terminated by NULL

Returns ( [transfer: full] [nullable] ) –

the first stream that matches the constraints, or NULL if there is no such stream

wp_endpoint_lookup_stream_full

WpEndpointStream *
wp_endpoint_lookup_stream_full (WpEndpoint * self,
                                WpObjectInterest * interest)

Requires WP_ENDPOINT_FEATURE_STREAMS

Parameters:

self –

the endpoint

interest ( [transfer: full] ) –

the interest

Returns ( [transfer: full] [nullable] ) –

the first stream that matches the interest, or NULL if there is no such stream

Wp.Endpoint.lookup_stream_full

def Wp.Endpoint.lookup_stream_full (self, interest):
    #python wrapper for 'wp_endpoint_lookup_stream_full'

Requires Wp.EndpointFeatures.STREAMS

Parameters:

self ( Wp.Endpoint ) –

the endpoint

interest ( Wp.ObjectInterest ) –

the interest

Returns ( Wp.EndpointStream ) –

the first stream that matches the interest, or None if there is no such stream

Wp.Endpoint.prototype.lookup_stream_full

function Wp.Endpoint.prototype.lookup_stream_full(interest: Wp.ObjectInterest): {
    // javascript wrapper for 'wp_endpoint_lookup_stream_full'
}

Requires Wp.EndpointFeatures.STREAMS

Parameters:

self ( Wp.Endpoint ) –

the endpoint

interest ( Wp.ObjectInterest ) –

the interest

Returns ( Wp.EndpointStream ) –

the first stream that matches the interest, or null if there is no such stream

Signals

streams-changed

streams_changed_callback (WpEndpoint * self,
                          gpointer user_data)

Emitted when the endpoints's streams change. This is only emitted when WP_ENDPOINT_FEATURE_STREAMS is enabled.

Parameters:

self –

the endpoint

user_data –

No description available

Flags: Run Last

streams-changed

def streams_changed_callback (self, *user_data):
    #python callback for the 'streams-changed' signal

Emitted when the endpoints's streams change. This is only emitted when Wp.EndpointFeatures.STREAMS is enabled.

Parameters:

self ( Wp.Endpoint ) –

the endpoint

user_data ( variadic ) –

No description available

Flags: Run Last

streams-changed

function streams_changed_callback(self: Wp.Endpoint, user_data: Object): {
    // javascript callback for the 'streams-changed' signal
}

Emitted when the endpoints's streams change. This is only emitted when Wp.EndpointFeatures.STREAMS is enabled.

Parameters:

self ( Wp.Endpoint ) –

the endpoint

user_data ( Object ) –

No description available

Flags: Run Last

Properties

direction

“direction” WpDirection *

The direction of the endpoint

Flags : Read

direction

“self.props.direction” Wp.Direction

The direction of the endpoint

Flags : Read

direction

“direction” Wp.Direction

The direction of the endpoint

Flags : Read

media-class

“media-class” gchar *

The media class of the endpoint (ex. "Audio/Sink")

Flags : Read

media_class

“self.props.media_class” str

The media class of the endpoint (ex. "Audio/Sink")

Flags : Read

media-class

“media-class” String

The media class of the endpoint (ex. "Audio/Sink")

Flags : Read

name

“name” gchar *

The name of the endpoint

Flags : Read

name

“self.props.name” str

The name of the endpoint

Flags : Read

name

“name” String

The name of the endpoint

Flags : Read

Enumerations

WpEndpointFeatures

An extension of WpProxyFeatures

Members

WP_ENDPOINT_FEATURE_STREAMS (65536) –

caches information about streams, enabling the use of wp_endpoint_get_n_streams, wp_endpoint_lookup_stream, wp_endpoint_iterate_streams and related methods

Wp.EndpointFeatures

An extension of Wp.ProxyFeatures

Members

Wp.EndpointFeatures.STREAMS (65536) –

caches information about streams, enabling the use of Wp.Endpoint.get_n_streams, wp_endpoint_lookup_stream (not introspectable), Wp.Endpoint.iterate_streams and related methods

Wp.EndpointFeatures

An extension of Wp.ProxyFeatures

Members

Wp.EndpointFeatures.STREAMS (65536) –

caches information about streams, enabling the use of Wp.Endpoint.prototype.get_n_streams, wp_endpoint_lookup_stream (not introspectable), Wp.Endpoint.prototype.iterate_streams and related methods

Constants

WP_ENDPOINT_FEATURES_STANDARD

#define WP_ENDPOINT_FEATURES_STANDARD \
    (WP_PROXY_FEATURES_STANDARD | \
     WP_PROXY_FEATURE_PROPS | \
     WP_ENDPOINT_FEATURE_STREAMS)

A constant set of features that contains the standard features that are available in the WpEndpoint class.

Wp.ENDPOINT_FEATURES_STANDARD

A constant set of features that contains the standard features that are available in the Wp.Endpoint class.

Wp.ENDPOINT_FEATURES_STANDARD

A constant set of features that contains the standard features that are available in the Wp.Endpoint class.

WP_TYPE_ENDPOINT

#define WP_TYPE_ENDPOINT (wp_endpoint_get_type ())

The WpEndpoint GType

The results of the search are