Class

PwgDevice

since: 0.1

Description [src]

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

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

Device objects bind a discovered device 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.

Device route parameters can be inspected and observed with this class, but route policy and default-device decisions remain the responsibility of the host session manager.

Stability: Unstable

Available since: 0.1

Ancestors

Constructors

pwg_device_new

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

since: 0.1

Instance methods

pwg_device_enum_all_params

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

since: 0.1

pwg_device_enum_params

Requests read-only enumeration of device parameters for id. Results are appended to pwg_device_get_params() and emitted through the PwgDevice::param signal.

since: 0.1

pwg_device_get_bound

Gets whether the device proxy is currently bound.

since: 0.1

pwg_device_get_core

Gets the core used by this device wrapper.

since: 0.1

pwg_device_get_global

Gets the global descriptor used to bind this device.

since: 0.1

pwg_device_get_param_infos

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

since: 0.1

pwg_device_get_params

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

since: 0.1

pwg_device_get_running

Gets whether the device wrapper is running.

since: 0.1

pwg_device_set_param

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

since: 0.1

pwg_device_start

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

since: 0.1

pwg_device_stop

Stops the device proxy and clears copied parameter state.

since: 0.1

pwg_device_subscribe_params

Replaces the device’s active parameter subscription set with the ids in ids. PipeWire emits copied PwgParam values through PwgDevice::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.Device:bound

Whether the device proxy is currently bound.

since: 0.1

Pwg.Device:core

PipeWire core used by this device wrapper.

since: 0.1

Pwg.Device:global

PipeWire device global used by this device wrapper.

since: 0.1

Pwg.Device:param-infos

A GListModel of PwgParamInfo objects.

since: 0.1

Pwg.Device:params

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

since: 0.1

Pwg.Device:running

Whether the device wrapper is running.

since: 0.1

Signals

Pwg.Device::param

Emitted from the object’s construction thread-default main context when a device 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 PwgDeviceClass {
  GObjectClass parent_class;
  
}

No description available.

Class members
parent_class: GObjectClass

No description available.