PipeWire
0.2.0
|
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 |
#define | PW_REMOTE_PROP_PROTOCOL "pipewire.protocol" |
Specify the name of the protocol to use, default is using the native protocol. More... | |
#define | PW_REMOTE_PROP_REMOTE_NAME "pipewire.remote.name" |
The name of the remote to connect to, default env(PIPEWIRE_REMOTE) or pipewire-0. More... | |
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_core * | pw_remote_get_core (struct pw_remote *remote) |
Get the core used to construct this remote. More... | |
const struct pw_properties * | pw_remote_get_properties (struct pw_remote *remote) |
Get the remote properties. More... | |
void * | pw_remote_get_user_data (struct pw_remote *remote) |
Get the user_data. 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... | |
int | pw_remote_steal_fd (struct pw_remote *remote) |
Steal the fd of the remote connection or < 0 on error. 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_info * | pw_remote_get_core_info (struct pw_remote *remote) |
Get the remote core info, can only be called when connected. More... | |
struct pw_proxy * | pw_remote_find_proxy (struct pw_remote *remote, uint32_t id) |
Get the proxy with the given id. More... | |
int | 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_proxy * | pw_remote_export (struct pw_remote *remote, struct pw_node *node) |
run a local node in a remote graph More... | |
#define PW_REMOTE_PROP_PROTOCOL "pipewire.protocol" |
Specify the name of the protocol to use, default is using the native protocol.
Referenced by pw_remote_new().
#define PW_REMOTE_PROP_REMOTE_NAME "pipewire.remote.name" |
The name of the remote to connect to, default env(PIPEWIRE_REMOTE) or pipewire-0.
#define PW_VERSION_REMOTE_EVENTS 0 |
enum pw_remote_state |
The state of a pw_remote.
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.
run a local node in a remote graph
Get the proxy with the given id.
References pw_map::pw_map_lookup().
Get the core used to construct this remote.
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.
struct pw_core_proxy* pw_remote_get_core_proxy | ( | struct pw_remote * | remote | ) |
Get the core proxy, can only be called when connected.
const struct pw_properties* pw_remote_get_properties | ( | struct pw_remote * | remote | ) |
Get the remote properties.
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.
void* pw_remote_get_user_data | ( | struct pw_remote * | remote | ) |
Get the user_data.
The size was given in pw_remote_new
int pw_remote_steal_fd | ( | struct pw_remote * | remote | ) |
Steal the fd of the remote connection or < 0 on error.
The remote will be in the unconnected state after this call.
References pw_protocol_client_steal_fd, and pw_remote::pw_remote_disconnect().
int 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_log::pw_log_debug(), and pw_remote::pw_remote_state_as_string().
Referenced by pw_remote_connect(), pw_remote_connect_fd(), and pw_remote_disconnect().