PipeWire  0.1.4
pw_remote Class Reference

Represents a connection with the PipeWire server. More...

Collaboration diagram for pw_remote:

Public Member Functions

const char * pw_remote_state_as_string (enum pw_remote_state state)
 Convert a pw_remote_state to a readable string. More...
 
struct pw_remotepw_remote_new (struct pw_core *core, struct pw_properties *properties)
 Create a new unconnected remote. More...
 
void pw_remote_destroy (struct pw_remote *remote)
 Destroy a remote. More...
 
int pw_remote_connect (struct pw_remote *remote)
 Connect to a remote PipeWire. More...
 
int pw_remote_connect_fd (struct pw_remote *remote, int fd)
 Connect to a remote PipeWire on the given socket. More...
 
void pw_remote_disconnect (struct pw_remote *remote)
 Disconnect from the remote PipeWire. More...
 

Data Fields

struct pw_corecore
 core More...
 
struct spa_list link
 link in core remote_list More...
 
struct pw_propertiesproperties
 extra properties More...
 
struct pw_core_proxy * core_proxy
 proxy for the core object More...
 
struct pw_map objects
 map of client side proxy objects indexed with the client id More...
 
struct pw_core_infoinfo
 info about the remote core More...
 
uint32_t n_types
 number of client types More...
 
struct pw_map types
 client types More...
 
struct spa_list proxy_list
 list of pw_proxy objects More...
 
struct spa_list stream_list
 list of pw_stream objects More...
 
struct spa_list remote_node_list
 list of pw_remote_node objects More...
 
struct pw_protocol_clientconn
 the protocol client connection More...
 
enum pw_remote_state state
 
char * error
 
struct spa_hook_list listener_list
 

Detailed Description

Represents a connection with the PipeWire server.

a pw_remote is created and used to connect to the server. A pw_proxy for the core object will automatically be created when connecting.

See also page_client_api

Member Function Documentation

◆ pw_remote_connect()

int pw_remote_connect ( struct pw_remote remote)

Connect to a remote PipeWire.

Returns
true on success.

◆ pw_remote_connect_fd()

int pw_remote_connect_fd ( struct pw_remote remote,
int  fd 
)

Connect to a remote PipeWire on the given socket.

Parameters
fdthe connected socket to use
Returns
true on success.

◆ pw_remote_destroy()

void pw_remote_destroy ( struct pw_remote remote)

Destroy a remote.

◆ pw_remote_disconnect()

void pw_remote_disconnect ( struct pw_remote remote)

Disconnect from the remote PipeWire.

◆ pw_remote_new()

struct pw_remote * pw_remote_new ( struct pw_core core,
struct pw_properties properties 
)

Create a new unconnected remote.

Returns
a new unconnected remote
Parameters
corea pw_core
propertiesoptional properties, ownership of the properties is taken.

◆ pw_remote_state_as_string()

const char * pw_remote_state_as_string ( enum pw_remote_state  state)

Convert a pw_remote_state to a readable string.

Field Documentation

◆ conn

◆ core

struct pw_core* pw_remote::core

core

Referenced by pw_remote_get_core(), and pw_stream_new().

◆ core_proxy

struct pw_core_proxy* pw_remote::core_proxy

proxy for the core object

Referenced by pw_remote_disconnect(), and pw_remote_get_core_proxy().

◆ error

char* pw_remote::error

◆ info

struct pw_core_info* pw_remote::info

info about the remote core

Referenced by pw_remote_disconnect(), and pw_remote_get_core_info().

◆ link

struct spa_list pw_remote::link

link in core remote_list

Referenced by pw_remote_destroy().

◆ listener_list

struct spa_hook_list pw_remote::listener_list

◆ n_types

uint32_t pw_remote::n_types

number of client types

Referenced by pw_remote_disconnect().

◆ objects

struct pw_map pw_remote::objects

map of client side proxy objects indexed with the client id

Referenced by pw_proxy::pw_proxy_destroy(), pw_proxy::pw_proxy_new(), pw_remote_disconnect(), and pw_remote_get_proxy().

◆ properties

struct pw_properties* pw_remote::properties

extra properties

Referenced by pw_remote_destroy().

◆ proxy_list

struct spa_list pw_remote::proxy_list

list of pw_proxy objects

Referenced by pw_proxy::pw_proxy_new(), and pw_remote_disconnect().

◆ remote_node_list

struct spa_list pw_remote::remote_node_list

list of pw_remote_node objects

◆ state

◆ stream_list

struct spa_list pw_remote::stream_list

◆ types

struct pw_map pw_remote::types

client types

Referenced by pw_remote_disconnect().


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