PipeWire  0.1.4
pw_global Class Reference

A global object visible to all clients. More...

Collaboration diagram for pw_global:

Public Member Functions

int pw_global_bind (struct pw_global *global, struct pw_client *client, uint32_t permissions, uint32_t version, uint32_t id)
 Bind to a global. More...
 
void pw_global_destroy (struct pw_global *global)
 Destroy a global. More...
 

Data Fields

struct pw_corecore
 the core More...
 
struct pw_clientowner
 the owner of this object, NULL when the PipeWire server is the owner More...
 
struct spa_list link
 link in core list of globals More...
 
uint32_t id
 server id of the object More...
 
struct pw_globalparent
 parent global More...
 
uint32_t type
 type of interface More...
 
uint32_t version
 version of interface More...
 
pw_bind_func_t bind
 function to bind to the interface More...
 
void * object
 object associated with the interface More...
 

Detailed Description

A global object visible to all clients.

A global object is visible to all clients and represents a resource that can be used or inspected.

See Server API

Member Function Documentation

◆ pw_global_bind()

int pw_global_bind ( struct pw_global global,
struct pw_client client,
uint32_t  permissions,
uint32_t  version,
uint32_t  id 
)

Bind to a global.

Parameters
globalthe global to bind to
clientthe client that binds
versionthe version
idthe id

Let client bind to global with the given version and id. After binding, the client and the global object will be able to exchange messages.

References bind, pw_client::core_resource, pw_resource::id, pw_core_resource_error, and version.

◆ pw_global_destroy()

Field Documentation

◆ bind

pw_bind_func_t pw_global::bind

function to bind to the interface

Referenced by pw_global_bind().

◆ core

struct pw_core* pw_global::core

the core

Referenced by pw_global_destroy(), and pw_global_get_core().

◆ id

◆ link

struct spa_list pw_global::link

link in core list of globals

Referenced by pw_core::pw_core_add_global(), pw_core_for_each_global(), and pw_global_destroy().

◆ object

void* pw_global::object

object associated with the interface

Referenced by pw_global_get_object().

◆ owner

struct pw_client* pw_global::owner

the owner of this object, NULL when the PipeWire server is the owner

Referenced by pw_global_get_owner().

◆ parent

struct pw_global* pw_global::parent

parent global

Referenced by pw_global_get_parent().

◆ type

uint32_t pw_global::type

type of interface

Referenced by pw_core::pw_core_add_global(), and pw_global_get_type().

◆ version

uint32_t pw_global::version

version of interface

Referenced by pw_core::pw_core_add_global(), pw_global_bind(), and pw_global_get_version().


The documentation for this class was generated from the following files: