Class

PwgRouteInfo

since: 0.1

Description [src]

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

Immutable typed view of a copied PipeWire ParamRoute parameter.

Route information is copied from PwgParam, so it is safe to inspect from language bindings without exposing raw SPA POD ownership.

This class describes route data published by PipeWire. It does not select routes or implement session-manager policy.

Stability: Unstable

Available since: 0.1

Ancestors

Constructors

pwg_route_info_new_from_param

Creates a typed route view from a copied EnumRoute or Route parameter.

since: 0.1

Instance methods

pwg_route_info_dup_availability

Copies the route availability nick, such as yes, no, or unknown.

since: 0.1

pwg_route_info_dup_description

Copies the route description.

since: 0.1

pwg_route_info_dup_direction

Copies the route direction nick, such as input or output.

since: 0.1

pwg_route_info_dup_name

Copies the route name.

since: 0.1

pwg_route_info_get_device

Gets the route’s profile-device index.

since: 0.1

pwg_route_info_get_direction_id

Gets the route direction SPA id.

since: 0.1

pwg_route_info_get_index

Gets the PipeWire route index.

since: 0.1

pwg_route_info_get_info

Copies the route info dictionary.

since: 0.1

pwg_route_info_get_priority

Gets the route priority.

since: 0.1

pwg_route_info_get_profile

Gets the route’s profile index.

since: 0.1

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Properties

Pwg.RouteInfo:availability

Route availability nick, such as yes, no, or unknown, or NULL.

since: 0.1

Pwg.RouteInfo:description

Route description, or NULL.

since: 0.1

Pwg.RouteInfo:device

Route profile-device index, or -1 if absent.

since: 0.1

Pwg.RouteInfo:direction

Route direction nick, such as input or output, or NULL.

since: 0.1

Pwg.RouteInfo:direction-id

Route direction SPA id, or SPA_ID_INVALID if absent.

since: 0.1

Pwg.RouteInfo:index

PipeWire route index, or -1 if absent.

since: 0.1

Pwg.RouteInfo:info

Route info dictionary as an a{ss} variant.

since: 0.1

Pwg.RouteInfo:name

Route name, or NULL.

since: 0.1

Pwg.RouteInfo:priority

Route priority, or -1 if absent.

since: 0.1

Pwg.RouteInfo:profile

Associated active profile index, or -1 if absent.

since: 0.1

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

No description available.

Class members
parent_class: GObjectClass

No description available.