PipeWire: pw_proxy Class Reference

PipeWire 0.2.3

Public Member Functions
pw_proxy Class Reference

Represents an object on the client side. More...

## Public Member Functions
struct pw_proxy * | pw_proxy_new (struct pw_proxy *factory, uint32_t type, size_t user_data_size)
| Create a proxy object with a given id and type. More...
void | pw_proxy_destroy (struct pw_proxy *proxy)
| Destroy a proxy object. More...

## Detailed Description

Represents an object on the client side.

A pw_proxy acts as a client side proxy to an object existing in a remote pipewire instance. The proxy is responsible for converting interface functions invoked by the client to PipeWire messages. Events will call the handlers set in listener.

See Proxy

## Member Function Documentation

## ◆ pw_proxy_destroy()

void pw_proxy_destroy | ( | struct pw_proxy * | proxy | ) |

Destroy a proxy object.

Parameters

  proxy | Proxy object to destroy

Note
  This is normally called by pw_remote when the server decides to destroy the server side object

References pw_log::pw_log_debug(), and pw_map::pw_map_insert_at().

Referenced by pw_remote_disconnect().

## ◆ pw_proxy_new()

struct pw_proxy * pw_proxy_new | ( | struct pw_proxy * | factory,
|  | uint32_t | type,
|  | size_t | user_data_size
| ) |  |

Create a proxy object with a given id and type.

Parameters

  factory | another proxy object that serves as a factory
  type | Type of the proxy object
  user_data_size | size of user_data

Returns
  A newly allocated proxy object or NULL on failure

This function creates a new proxy object with the supplied id and type. The proxy object will have an id assigned from the client id space.

See also
  pw_remote

References pw_log::pw_log_debug(), pw_map::pw_map_insert_new(), pw_protocol_get_marshal(), and impl::this.

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

- proxy.h
- proxy.c