WpEndpointLink

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.

WpEndpointLink

GObject
    ╰──WpProxy
        ╰──WpEndpointLink

Members

parent_instance (WpProxy) –

No description available

Class structure

WpEndpointLinkClass

Fields

parent_class (WpProxyClass) –

No description available

Wp.EndpointLinkClass

Attributes

parent_class (Wp.ProxyClass) –

No description available

Wp.EndpointLinkClass

Attributes

parent_class (Wp.ProxyClass) –

No description available

WpEndpointLink

GObject
    ╰──WpProxy
        ╰──WpEndpointLink

Members

parent_instance (WpProxy) –

No description available

WpEndpointLink

GObject
    ╰──WpProxy
        ╰──WpEndpointLink

Members

parent_instance (WpProxy) –

No description available

Methods

wp_endpoint_link_get_linked_object_ids

wp_endpoint_link_get_linked_object_ids (WpEndpointLink * self,
                                        guint32 * output_endpoint,
                                        guint32 * output_stream,
                                        guint32 * input_endpoint,
                                        guint32 * input_stream)

Retrieves the ids of the objects that are linked by this endpoint link

Note: Using this method requires WP_PROXY_FEATURE_INFO

Parameters:

self –

the endpoint link

output_endpoint ( [out] [optional] ) –

the bound id of the output (source) endpoint

output_stream ( [out] [optional] ) –

the bound id of the output (source) endpoint's stream

input_endpoint ( [out] [optional] ) –

the bound id of the input (sink) endpoint

input_stream ( [out] [optional] ) –

the bound id of the input (sink) endpoint's stream

Wp.EndpointLink.get_linked_object_ids

def Wp.EndpointLink.get_linked_object_ids (self):
    #python wrapper for 'wp_endpoint_link_get_linked_object_ids'

Retrieves the ids of the objects that are linked by this endpoint link

Note: Using this method requires Wp.ProxyFeatures.INFO

Parameters:

self ( Wp.EndpointLink ) –

the endpoint link

Wp.EndpointLink.prototype.get_linked_object_ids

function Wp.EndpointLink.prototype.get_linked_object_ids(): {
    // javascript wrapper for 'wp_endpoint_link_get_linked_object_ids'
}

Retrieves the ids of the objects that are linked by this endpoint link

Note: Using this method requires Wp.ProxyFeatures.INFO

Parameters:

self ( Wp.EndpointLink ) –

the endpoint link

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_PROXY_FEATURE_INFO

Parameters:

self –

the endpoint link

error ( [out] [optional] [transfer: none] ) –

the error string if the state is WP_ENDPOINT_LINK_STATE_ERROR

Returns –

the current state of the link

Wp.EndpointLink.get_state

def Wp.EndpointLink.get_state (self):
    #python wrapper for 'wp_endpoint_link_get_state'

Retrieves the current state of the link

Note: Using this method requires Wp.ProxyFeatures.INFO

Parameters:

self ( Wp.EndpointLink ) –

the endpoint link

Returns a tuple made of:

( Wp.EndpointLinkState ) –

the current state of the link

error ( str ) –

the current state of the link

Wp.EndpointLink.prototype.get_state

function Wp.EndpointLink.prototype.get_state(): {
    // javascript wrapper for 'wp_endpoint_link_get_state'
}

Retrieves the current state of the link

Note: Using this method requires Wp.ProxyFeatures.INFO

Parameters:

self ( Wp.EndpointLink ) –

the endpoint link

Returns a tuple made of:

( Wp.EndpointLinkState ) –

the current state of the link

error ( String ) –

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_PW_PROXY

Parameters:

self –

the endpoint link

target –

the desired target state of the link

Wp.EndpointLink.request_state

def Wp.EndpointLink.request_state (self, target):
    #python wrapper for 'wp_endpoint_link_request_state'

Requests a state change on the link

Note: Using this method requires Wp.ProxyFeatures.PW_PROXY

Parameters:

self ( Wp.EndpointLink ) –

the endpoint link

target ( Wp.EndpointLinkState ) –

the desired target state of the link

Wp.EndpointLink.prototype.request_state

function Wp.EndpointLink.prototype.request_state(target: Wp.EndpointLinkState): {
    // javascript wrapper for 'wp_endpoint_link_request_state'
}

Requests a state change on the link

Note: Using this method requires Wp.ProxyFeatures.PW_PROXY

Parameters:

self ( Wp.EndpointLink ) –

the endpoint link

target ( Wp.EndpointLinkState ) –

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 –

No description available

Flags: Run Last

state-changed

def state_changed_callback (self, old_state, new_state, error, *user_data):
    #python callback for the 'state-changed' signal

Emitted when an endpoint link changes state

Parameters:

self ( Wp.EndpointLink ) –

the endpoint link

old_state ( Wp.EndpointLinkState ) –

the old state of the link

new_state ( Wp.EndpointLinkState ) –

the new state of the link

error ( str ) –

the error string if the new state is Wp.EndpointLinkState.ERROR

user_data ( variadic ) –

No description available

Flags: Run Last

state-changed

function state_changed_callback(self: Wp.EndpointLink, old_state: Wp.EndpointLinkState, new_state: Wp.EndpointLinkState, error: String, user_data: Object): {
    // javascript callback for the 'state-changed' signal
}

Emitted when an endpoint link changes state

Parameters:

self ( Wp.EndpointLink ) –

the endpoint link

old_state ( Wp.EndpointLinkState ) –

the old state of the link

new_state ( Wp.EndpointLinkState ) –

the new state of the link

error ( String ) –

the error string if the new state is Wp.EndpointLinkState.ERROR

user_data ( Object ) –

No description available

Flags: Run Last

Enumerations

WpEndpointLinkState

Members

WP_ENDPOINT_LINK_STATE_ERROR (-1) –

No description available

WP_ENDPOINT_LINK_STATE_PREPARING (0) –

No description available

WP_ENDPOINT_LINK_STATE_INACTIVE (1) –

No description available

WP_ENDPOINT_LINK_STATE_ACTIVE (2) –

No description available

Wp.EndpointLinkState

Members

Wp.EndpointLinkState.ERROR (-1) –

No description available

Wp.EndpointLinkState.PREPARING (0) –

No description available

Wp.EndpointLinkState.INACTIVE (1) –

No description available

Wp.EndpointLinkState.ACTIVE (2) –

No description available

Wp.EndpointLinkState

Members

Wp.EndpointLinkState.ERROR (-1) –

No description available

Wp.EndpointLinkState.PREPARING (0) –

No description available

Wp.EndpointLinkState.INACTIVE (1) –

No description available

Wp.EndpointLinkState.ACTIVE (2) –

No description available

Constants

WP_TYPE_ENDPOINT_LINK

#define WP_TYPE_ENDPOINT_LINK (wp_endpoint_link_get_type ())

The WpEndpointLink GType

The results of the search are