WpProxy

WpProxy

GObject
    ╰──WpProxy
        ╰──WpClient
        ╰──WpDevice
        ╰──WpEndpoint
        ╰──WpEndpointLink
        ╰──WpEndpointStream
        ╰──WpLink
        ╰──WpNode
        ╰──WpPort
        ╰──WpSession

Wp.Proxy.prototype.augment

function Wp.Proxy.prototype.augment(wanted_features: Wp.ProxyFeatures, cancellable: Gio.Cancellable, callback: Gio.AsyncReadyCallback, user_data: Object): {
    // javascript wrapper for 'wp_proxy_augment'
}

Wp.Proxy.prototype.augment_finish

function Wp.Proxy.prototype.augment_finish(res: Gio.AsyncResult): {
    // javascript wrapper for 'wp_proxy_augment_finish'
}

Wp.Proxy.prototype.enum_params

function Wp.Proxy.prototype.enum_params(id: String, filter: Wp.SpaPod, cancellable: Gio.Cancellable, callback: Gio.AsyncReadyCallback, user_data: Object): {
    // javascript wrapper for 'wp_proxy_enum_params'
}

Enumerate object parameters. This will asynchronously return the result, or an error, by calling the given callback. The result is going to be a Wp.Iterator containing Wp.SpaPod objects, which can be retrieved with Wp.Proxy.prototype.enum_params_finish.

Wp.Proxy.prototype.enum_params_finish

function Wp.Proxy.prototype.enum_params_finish(res: Gio.AsyncResult): {
    // javascript wrapper for 'wp_proxy_enum_params_finish'
}

Wp.Proxy.prototype.get_bound_id

function Wp.Proxy.prototype.get_bound_id(): {
    // javascript wrapper for 'wp_proxy_get_bound_id'
}

Returns the bound id, which is the id that this object has on the pipewire registry (a.k.a. the global id). The object must have the Wp.ProxyFeatures.BOUND feature before this method can be called.

Wp.Proxy.prototype.get_core

function Wp.Proxy.prototype.get_core(): {
    // javascript wrapper for 'wp_proxy_get_core'
}

Wp.Proxy.prototype.get_features

function Wp.Proxy.prototype.get_features(): {
    // javascript wrapper for 'wp_proxy_get_features'
}

Wp.Proxy.prototype.get_global_permissions

function Wp.Proxy.prototype.get_global_permissions(): {
    // javascript wrapper for 'wp_proxy_get_global_permissions'
}

Wp.Proxy.prototype.get_global_properties

function Wp.Proxy.prototype.get_global_properties(): {
    // javascript wrapper for 'wp_proxy_get_global_properties'
}

Wp.Proxy.prototype.get_info

function Wp.Proxy.prototype.get_info(): {
    // javascript wrapper for 'wp_proxy_get_info'
}

Requires Wp.ProxyFeatures.INFO

Wp.Proxy.prototype.get_param_info

function Wp.Proxy.prototype.get_param_info(): {
    // javascript wrapper for 'wp_proxy_get_param_info'
}

Returns the available parameters of this proxy. The return value is a variant of type a{ss}, where the key of each map entry is a spa param type id (the same ids that you can pass in Wp.Proxy.prototype.enum_params) and the value is a string that can contain the following letters, each of them representing a flag:

• r: the param is readable (SPA_PARAM_INFO_READ)
• w: the param is writable (SPA_PARAM_INFO_WRITE)
• s: the param was updated (SPA_PARAM_INFO_SERIAL)

For params that are readable, you can query them with Wp.Proxy.prototype.enum_params

Params that are writable can be set with Wp.Proxy.prototype.set_param

Requires Wp.ProxyFeatures.INFO

Wp.Proxy.prototype.get_prop

function Wp.Proxy.prototype.get_prop(prop_name: String): {
    // javascript wrapper for 'wp_proxy_get_prop'
}

Requires Wp.ProxyFeatures.PROPS

Wp.Proxy.prototype.get_properties

function Wp.Proxy.prototype.get_properties(): {
    // javascript wrapper for 'wp_proxy_get_properties'
}

Requires Wp.ProxyFeatures.INFO

Wp.Proxy.prototype.get_property

function Wp.Proxy.prototype.get_property(key: String): {
    // javascript wrapper for 'wp_proxy_get_property'
}

Returns the value of a single pipewire property. This is the same as getting the whole properties structure with Wp.Proxy.prototype.get_properties and accessing a single property with Wp.Properties.prototype.get, but saves one call and having to clean up the Wp.Properties reference count afterwards.

The value is owned by the proxy, but it is guaranteed to stay alive until execution returns back to the event loop.

Requires Wp.ProxyFeatures.INFO

Wp.Proxy.prototype.get_pw_proxy

function Wp.Proxy.prototype.get_pw_proxy(): {
    // javascript wrapper for 'wp_proxy_get_pw_proxy'
}

Wp.Proxy.prototype.iterate_prop_info

function Wp.Proxy.prototype.iterate_prop_info(): {
    // javascript wrapper for 'wp_proxy_iterate_prop_info'
}

Requires Wp.ProxyFeatures.PROPS

Wp.Proxy.prototype.request_destroy

function Wp.Proxy.prototype.request_destroy(): {
    // javascript wrapper for 'wp_proxy_request_destroy'
}

Requests the PipeWire server to destroy the object represented by this proxy. If the server allows it, the object will be destroyed and the WpProxy::pw-proxy-destroyed signal will be emitted. If the server does not allow it, nothing will happen.

This is mostly useful for destroying Wp.Link and Wp.EndpointLink objects.

Wp.Proxy.prototype.set_param

function Wp.Proxy.prototype.set_param(id: String, param: Wp.SpaPod): {
    // javascript wrapper for 'wp_proxy_set_param'
}

Sets a parameter on the object.

Wp.Proxy.prototype.set_prop

function Wp.Proxy.prototype.set_prop(prop_name: String, value: Wp.SpaPod): {
    // javascript wrapper for 'wp_proxy_set_prop'
}

Sets a single property in the SPA_PARAM_Props param of this object.

bound

function bound_callback(self: Wp.Proxy, object: Number, user_data: Object): {
    // javascript callback for the 'bound' signal
}

Flags: Run First

prop-changed

function prop_changed_callback(self: Wp.Proxy, object: String, user_data: Object): {
    // javascript callback for the 'prop-changed' signal
}

Flags: Run Last

pw-proxy-created

function pw_proxy_created_callback(self: Wp.Proxy, object: Object, user_data: Object): {
    // javascript callback for the 'pw-proxy-created' signal
}

Flags: Run First

pw-proxy-destroyed

function pw_proxy_destroyed_callback(self: Wp.Proxy, user_data: Object): {
    // javascript callback for the 'pw-proxy-destroyed' signal
}

Flags: Run First

bound-id

“bound-id” Number

Flags : Read

core

“core” Wp.Core

Flags : Read / Write / Construct Only

features

“features” Wp.ProxyFeatures

Flags : Read

global-permissions

“global-permissions” Number

Flags : Read

global-properties

“global-properties” Wp.Properties

Flags : Read

info

“info” Object

Flags : Read

param-info

“param-info” GLib.Variant

Flags : Read

properties

“properties” Wp.Properties

Flags : Read

pw-proxy

“pw-proxy” Object

Flags : Read / Write / Construct Only

vfunc_augment

function vfunc_augment(self: Wp.Proxy, features: Wp.ProxyFeatures): {
    // javascript implementation of the 'augment' virtual method
}

vfunc_bound

function vfunc_bound(self: Wp.Proxy, id: Number): {
    // javascript implementation of the 'bound' virtual method
}

vfunc_enum_params

function vfunc_enum_params(self: Wp.Proxy, id: Number, start: Number, num: Number, filter: Wp.SpaPod): {
    // javascript implementation of the 'enum_params' virtual method
}

vfunc_get_info

function vfunc_get_info(self: Wp.Proxy): {
    // javascript implementation of the 'get_info' virtual method
}

vfunc_get_param_info

function vfunc_get_param_info(self: Wp.Proxy, n_params: Number): {
    // javascript implementation of the 'get_param_info' virtual method
}

vfunc_get_properties

function vfunc_get_properties(self: Wp.Proxy): {
    // javascript implementation of the 'get_properties' virtual method
}

vfunc_prop_changed

function vfunc_prop_changed(self: Wp.Proxy, prop_name: String): {
    // javascript implementation of the 'prop_changed' virtual method
}

vfunc_pw_proxy_created

function vfunc_pw_proxy_created(self: Wp.Proxy, proxy: Object): {
    // javascript implementation of the 'pw_proxy_created' virtual method
}

vfunc_pw_proxy_destroyed

function vfunc_pw_proxy_destroyed(self: Wp.Proxy): {
    // javascript implementation of the 'pw_proxy_destroyed' virtual method
}

vfunc_set_param

function vfunc_set_param(self: Wp.Proxy, id: Number, flags: Number, param: Wp.SpaPod): {
    // javascript implementation of the 'set_param' virtual method
}

vfunc_subscribe_params

function vfunc_subscribe_params(self: Wp.Proxy, ids: Number, n_ids: Number): {
    // javascript implementation of the 'subscribe_params' virtual method
}

Wp.ProxyFeatures

Flags that specify functionality that is available on this class. Use Wp.Proxy.prototype.augment to enable more features and Wp.Proxy.prototype.get_features to find out which features are already enabled.

Subclasses may also specify additional features that can be ORed with these ones and they can also be enabled with Wp.Proxy.prototype.augment.

Wp.PROXY_FEATURES_STANDARD

A constant set of features that contains the standard features that are available in the Wp.Proxy class. The standard features are usually all enabled at once, even if not requested explicitly. It is a good practice, though, to enable only the features that you actually need. This leaves room for optimizations in the Wp.Proxy class.