PipeWire  0.1.4.1
remote.h File Reference
Include dependency graph for remote.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  pw_remote_events
 Events for the remote. More...
 

Macros

#define PW_VERSION_REMOTE_EVENTS   0
 

Enumerations

enum  pw_remote_state {
  PW_REMOTE_STATE_ERROR = -1,
  PW_REMOTE_STATE_UNCONNECTED = 0,
  PW_REMOTE_STATE_CONNECTING = 1,
  PW_REMOTE_STATE_CONNECTED = 2
}
 The state of a pw_remote. More...
 

Functions

struct pw_corepw_remote_get_core (struct pw_remote *remote)
 Get the core used to construct this remote. More...
 
enum pw_remote_state pw_remote_get_state (struct pw_remote *remote, const char **error)
 Get the current state, error is set when state is PW_REMOTE_STATE_ERROR. More...
 
void pw_remote_add_listener (struct pw_remote *remote, struct spa_hook *listener, const struct pw_remote_events *events, void *data)
 Add listener for events. More...
 
struct pw_core_proxy * pw_remote_get_core_proxy (struct pw_remote *remote)
 Get the core proxy, can only be called when connected. More...
 
const struct pw_core_infopw_remote_get_core_info (struct pw_remote *remote)
 Get the remote core info, can only be called when connected. More...
 
struct pw_proxypw_remote_get_proxy (struct pw_remote *remote, uint32_t id)
 Get the proxy with the given id. More...
 
void pw_remote_update_state (struct pw_remote *remote, enum pw_remote_state state, const char *fmt,...)
 Update the state of the remote, mostly used by protocols. More...
 
struct pw_proxypw_remote_export (struct pw_remote *remote, struct pw_node *node)
 run a local node in a remote graph More...
 

Macro Definition Documentation

◆ PW_VERSION_REMOTE_EVENTS

#define PW_VERSION_REMOTE_EVENTS   0

Enumeration Type Documentation

◆ pw_remote_state

The state of a pw_remote.

Enumerator
PW_REMOTE_STATE_ERROR 

remote is in error

PW_REMOTE_STATE_UNCONNECTED 

not connected

PW_REMOTE_STATE_CONNECTING 

connecting to remote PipeWire

PW_REMOTE_STATE_CONNECTED 

remote is connected and ready

Function Documentation

◆ pw_remote_add_listener()

void pw_remote_add_listener ( struct pw_remote remote,
struct spa_hook *  listener,
const struct pw_remote_events events,
void *  data 
)

Add listener for events.

◆ pw_remote_export()

struct pw_proxy* pw_remote_export ( struct pw_remote remote,
struct pw_node node 
)

run a local node in a remote graph

◆ pw_remote_get_core()

struct pw_core* pw_remote_get_core ( struct pw_remote remote)

Get the core used to construct this remote.

◆ pw_remote_get_core_info()

const struct pw_core_info* pw_remote_get_core_info ( struct pw_remote remote)

Get the remote core info, can only be called when connected.

◆ pw_remote_get_core_proxy()

struct pw_core_proxy* pw_remote_get_core_proxy ( struct pw_remote remote)

Get the core proxy, can only be called when connected.

◆ pw_remote_get_proxy()

struct pw_proxy* pw_remote_get_proxy ( struct pw_remote remote,
uint32_t  id 
)

Get the proxy with the given id.

◆ pw_remote_get_state()

enum pw_remote_state pw_remote_get_state ( struct pw_remote remote,
const char **  error 
)

Get the current state, error is set when state is PW_REMOTE_STATE_ERROR.

◆ pw_remote_update_state()

void pw_remote_update_state ( struct pw_remote remote,
enum pw_remote_state  state,
const char *  fmt,
  ... 
)

Update the state of the remote, mostly used by protocols.

References pw_remote_state_as_string().

Referenced by pw_remote_connect(), pw_remote_connect_fd(), and pw_remote_disconnect().