Class

PwgParam

since: 0.1

Description [src]

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

Immutable copied PipeWire parameter returned by node parameter enumeration or built by library constructors.

Parameter objects own copied POD bytes and do not expose PipeWire or SPA memory ownership to language bindings.

Constructors are intentionally limited to typed helpers for common app-facing updates. Applications can inspect copied raw bytes when needed, but arbitrary SPA POD construction is not exposed as a stable binding API.

Stability: Unstable

Available since: 0.1

Ancestors

GObject

Constructors

pwg_param_new_props_controls

Builds a copied SPA Props parameter containing named float controls in the params property. This is useful for PipeWire modules that expose controls by name, such as filter-chain biquad coefficients.

since: 0.1

pwg_param_new_props_mute

Builds a copied SPA Props parameter containing a mute property.

since: 0.1

pwg_param_new_props_volume

Builds a copied SPA Props parameter containing a volume property.

since: 0.1

Instance methods

pwg_param_dup_audio_format

Parses this parameter as a raw audio SPA Format object.

since: 0.1

pwg_param_dup_format_media_subtype_name

Copies the short SPA media subtype name when this parameter contains a SPA Format object.

since: 0.1

pwg_param_dup_format_media_type_name

Copies the short SPA media type name when this parameter contains a SPA Format object.

since: 0.1

pwg_param_dup_name

Copies the short SPA parameter name when known.

since: 0.1

pwg_param_dup_object_id_name

Copies the short object id name when the copied POD is a SPA object.

since: 0.1

pwg_param_dup_object_type_name

Copies the short object type name when the copied POD is a SPA object.

since: 0.1

pwg_param_dup_pod_type_name

Copies the short top-level SPA POD type name when known.

since: 0.1

pwg_param_dup_summary

Copies a short diagnostic summary of the copied parameter.

since: 0.1

pwg_param_get_bytes

Gets a new reference to the copied SPA POD bytes.

since: 0.1

pwg_param_get_format_media_subtype

Gets the SPA media subtype id when this parameter contains a SPA Format object.

since: 0.1

pwg_param_get_format_media_type

Gets the SPA media type id when this parameter contains a SPA Format object.

since: 0.1

pwg_param_get_id

Gets the SPA parameter id.

since: 0.1

pwg_param_get_index

Gets the enumeration index for this parameter.

since: 0.1

pwg_param_get_next

Gets PipeWire’s next enumeration index for this parameter.

since: 0.1

pwg_param_get_object_id

Gets the object id when the copied POD is a SPA object.

since: 0.1

pwg_param_get_object_type

Gets the object type id when the copied POD is a SPA object.

since: 0.1

pwg_param_get_pod_type

Gets the top-level SPA POD type id.

since: 0.1

pwg_param_get_seq

Gets the sequence number of the enumeration request that produced this parameter.

since: 0.1

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Signals

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 PwgParamClass {
  GObjectClass parent_class;
  
}

No description available.

Class members

parent_class: GObjectClass: No description available.

Description [src]

Ancestors

Constructors

Instance methods

Methods inherited from GObject (43)

Properties

Signals

Signals inherited from GObject (1)

Class structure

Class members