PipeWire  0.1.4.1
pw_remote Class Reference

Represents a connection with a remote PipeWire instance. More...

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...
 

Detailed Description

Represents a connection with a remote PipeWire instance.

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

See also Core 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.


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