Wp.Client

g GObject.GInterface GObject.GInterface Wp.PipewireObject Wp.PipewireObject GObject.GInterface->Wp.PipewireObject GObject.Object GObject.Object Wp.Object Wp.Object GObject.Object->Wp.Object Wp.Client Wp.Client Wp.GlobalProxy Wp.GlobalProxy Wp.GlobalProxy->Wp.Client Wp.Proxy Wp.Proxy Wp.Object->Wp.Proxy Wp.PipewireObject->Wp.Client Wp.Proxy->Wp.GlobalProxy

Subclasses:

None

Methods

Inherited:

Wp.GlobalProxy (4), Wp.Proxy (4), Wp.Object (12), GObject.Object (37), Wp.PipewireObject (9)

Structs:

GObject.ObjectClass (5)

send_error (id, res, message)

update_properties (updates)

Virtual Methods

Inherited:

Wp.Proxy (4), Wp.Object (4), GObject.Object (7), Wp.PipewireObject (7)

Properties

Inherited:

Wp.GlobalProxy (3), Wp.Proxy (2), Wp.Object (4), Wp.PipewireObject (3)

Signals

Inherited:

Wp.Proxy (4), GObject.Object (1), Wp.PipewireObject (1)

Fields

Inherited:

Wp.Proxy (4), GObject.Object (1), Wp.PipewireObject (1)

Class Details

class Wp.Client(**kwargs)
Bases:

Wp.GlobalProxy, Wp.PipewireObject

Abstract:

No

Structure:

Wp.ClientClass

The Wp.Client class allows accessing the properties and methods of a PipeWire client object (struct pw_client). A Wp.Client is constructed internally when a new client connects to PipeWire and it is made available through the Wp.ObjectManager API.

send_error(id, res, message)
Parameters:
  • id (int) – the global id to report the error on

  • res (int) – an errno style error code

  • message (str) – the error message string

Send an error to the client.

update_properties(updates)
Parameters:

updates (Wp.Properties) – updates to apply to the properties of self; this does not need to include properties that have not changed

Updates the properties of self.

This requires W and X permissions on the client.