Class

PwgNode

since: 0.1

Description [src]

final class Pwg.Node : GObject.Object
{
  /* No available fields */
}

Live PipeWire node proxy for parameter inspection and limited parameter updates.

Node objects bind a discovered node global and expose copied parameter info and enumeration results. They can queue copied parameter updates built by this library, but they do not expose raw PipeWire proxy ownership to language bindings.

Stability: Unstable

Available since: 0.1

Ancestors

Constructors

pwg_node_new

Creates a live node proxy wrapper for parameter inspection and limited copied parameter updates.

since: 0.1

Instance methods

pwg_node_enum_all_params

Requests read-only enumeration of all available node parameter ids.

since: 0.1

pwg_node_enum_params

Requests read-only enumeration of node parameters for id. Results are appended to pwg_node_get_params() and emitted through the PwgNode::param signal.

since: 0.1

pwg_node_get_bound

Gets whether the node proxy is currently bound.

since: 0.1

pwg_node_get_core

Gets the core used by this node wrapper.

since: 0.1

pwg_node_get_global

Gets the global descriptor used to bind this node.

since: 0.1

pwg_node_get_param_infos

Gets the live model of PwgParamInfo descriptors advertised by node info events.

since: 0.1

pwg_node_get_params

Gets the live model of PwgParam values from the most recent enumeration request.

since: 0.1

pwg_node_get_running

Gets whether the node wrapper is running.

since: 0.1

pwg_node_set_param

Queues a parameter update on the bound node. A successful return means PipeWire accepted the request for dispatch; it does not confirm that the target applied the new value. Observe later node state or parameter events when application logic needs confirmation.

since: 0.1

pwg_node_start

Binds the node proxy. If the core is not connected, this method connects it first.

since: 0.1

pwg_node_stop

Stops the node proxy and clears copied parameter state.

since: 0.1

pwg_node_subscribe_params

Replaces the node’s active parameter subscription set with the ids in ids. PipeWire emits copied PwgParam values through PwgNode::param for current subscribed values and later updates. Passing an empty au variant clears the subscription.

since: 0.1

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Properties

Pwg.Node:bound

Whether the node proxy is currently bound.

since: 0.1

Pwg.Node:core

PipeWire core used by this node wrapper.

since: 0.1

Pwg.Node:global

PipeWire node global used by this node wrapper.

since: 0.1

Pwg.Node:param-infos

A GListModel of PwgParamInfo objects.

since: 0.1

Pwg.Node:params

A GListModel of PwgParam objects from the most recent enumeration request.

since: 0.1

Pwg.Node:running

Whether the node wrapper is running.

since: 0.1

Signals

Pwg.Node::param

Emitted from the object’s construction thread-default main context when a node parameter enumeration result or subscribed update arrives.

since: 0.1

Signals inherited from GObject (1)
GObject::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

Class structure

struct PwgNodeClass {
  GObjectClass parent_class;
  
}

No description available.

Class members
parent_class: GObjectClass

No description available.