PipeWire  0.2.9
remote.c File Reference
Include dependency graph for remote.c:

Functions

SPA_EXPORT const char * pw_remote_state_as_string (enum pw_remote_state state)
 
SPA_EXPORT struct pw_remotepw_remote_new (struct pw_core *core, struct pw_properties *properties, size_t user_data_size)
 
SPA_EXPORT void pw_remote_destroy (struct pw_remote *remote)
 
SPA_EXPORT struct pw_corepw_remote_get_core (struct pw_remote *remote)
 Get the core used to construct this remote. More...
 
SPA_EXPORT const struct pw_propertiespw_remote_get_properties (struct pw_remote *remote)
 Get the remote properties. More...
 
SPA_EXPORT int pw_remote_update_properties (struct pw_remote *remote, const struct spa_dict *dict)
 Update properties. More...
 
SPA_EXPORT void * pw_remote_get_user_data (struct pw_remote *remote)
 Get the user_data. More...
 
SPA_EXPORT 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...
 
SPA_EXPORT 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...
 
SPA_EXPORT struct pw_core_proxypw_remote_get_core_proxy (struct pw_remote *remote)
 Get the core proxy, can only be called when connected. More...
 
SPA_EXPORT struct pw_client_proxypw_remote_get_client_proxy (struct pw_remote *remote)
 Get the client proxy, can only be called when connected. More...
 
SPA_EXPORT struct pw_proxypw_remote_find_proxy (struct pw_remote *remote, uint32_t id)
 Get the proxy with the given id. More...
 
SPA_EXPORT int pw_remote_connect (struct pw_remote *remote)
 
SPA_EXPORT int pw_remote_connect_fd (struct pw_remote *remote, int fd)
 
SPA_EXPORT int pw_remote_steal_fd (struct pw_remote *remote)
 Steal the fd of the remote connection or < 0 on error. More...
 
SPA_EXPORT int pw_remote_disconnect (struct pw_remote *remote)
 
SPA_EXPORT struct pw_proxypw_remote_export (struct pw_remote *remote, uint32_t type, struct pw_properties *props, void *object, size_t user_data_size)
 run a local node in a remote graph More...
 
SPA_EXPORT int pw_core_register_export_type (struct pw_core *core, struct pw_export_type *type)
 register a type that can be exported on a remote. More...
 
const struct pw_export_typepw_core_find_export_type (struct pw_core *core, uint32_t type)
 

Function Documentation

◆ pw_core_find_export_type()

const struct pw_export_type* pw_core_find_export_type ( struct pw_core core,
uint32_t  type 
)

◆ pw_core_register_export_type()

SPA_EXPORT int pw_core_register_export_type ( struct pw_core core,
struct pw_export_type type 
)

register a type that can be exported on a remote.

This is usually used by extension modules

References pw_log::pw_log_debug, pw_type_info(), and pw_export_type::type.

◆ pw_remote_add_listener()

SPA_EXPORT 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_connect()

SPA_EXPORT int pw_remote_connect ( struct pw_remote remote)

◆ pw_remote_connect_fd()

SPA_EXPORT int pw_remote_connect_fd ( struct pw_remote remote,
int  fd 
)

◆ pw_remote_destroy()

◆ pw_remote_disconnect()

SPA_EXPORT int pw_remote_disconnect ( struct pw_remote remote)

◆ pw_remote_export()

SPA_EXPORT struct pw_proxy* pw_remote_export ( struct pw_remote remote,
uint32_t  type,
struct pw_properties props,
void *  object,
size_t  user_data_size 
)

run a local node in a remote graph

Parameters
remotethe remote
typethe type of object
propsextra properties
objectobject to export
user_data_sizeextra user data

References pw_export_type::func, pw_core_find_export_type(), pw_log::pw_log_error, and pw_export_type::type.

◆ pw_remote_find_proxy()

SPA_EXPORT struct pw_proxy* pw_remote_find_proxy ( struct pw_remote remote,
uint32_t  id 
)

Get the proxy with the given id.

References pw_map::pw_map_lookup().

◆ pw_remote_get_client_proxy()

SPA_EXPORT struct pw_client_proxy* pw_remote_get_client_proxy ( struct pw_remote remote)

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

◆ pw_remote_get_core()

SPA_EXPORT struct pw_core* pw_remote_get_core ( struct pw_remote remote)

Get the core used to construct this remote.

◆ pw_remote_get_core_proxy()

SPA_EXPORT 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_properties()

SPA_EXPORT const struct pw_properties* pw_remote_get_properties ( struct pw_remote remote)

Get the remote properties.

Referenced by pw_stream_new().

Here is the caller graph for this function:

◆ pw_remote_get_state()

SPA_EXPORT 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_get_user_data()

SPA_EXPORT void* pw_remote_get_user_data ( struct pw_remote remote)

Get the user_data.

The size was given in pw_remote_new

◆ pw_remote_new()

◆ pw_remote_state_as_string()

SPA_EXPORT const char* pw_remote_state_as_string ( enum pw_remote_state  state)

◆ pw_remote_steal_fd()

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

◆ pw_remote_update_properties()

SPA_EXPORT int pw_remote_update_properties ( struct pw_remote remote,
const struct spa_dict *  dict 
)