PipeWire
0.1.4
|
PipeWire client object class. More...
Public Member Functions | |
struct pw_client * | pw_client_new (struct pw_core *core, struct pw_global *parent, struct ucred *ucred, struct pw_properties *properties, size_t user_data_size) |
Make a new client object. More... | |
void | pw_client_destroy (struct pw_client *client) |
Destroy a client object. More... | |
void | pw_client_update_properties (struct pw_client *client, const struct spa_dict *dict) |
Update client properties. More... | |
Data Fields | |
struct pw_core * | core |
core object More... | |
struct spa_list | link |
link in core object client list More... | |
struct pw_global * | global |
global object created for this client More... | |
struct pw_properties * | properties |
Client properties. More... | |
struct pw_client_info | info |
client info More... | |
bool | ucred_valid |
if the ucred member is valid More... | |
struct ucred | ucred |
ucred information More... | |
struct pw_resource * | core_resource |
core resource object More... | |
struct pw_map | objects |
list of resource objects More... | |
uint32_t | n_types |
number of client types More... | |
struct pw_map | types |
map of client types More... | |
struct spa_list | resource_list |
The list of resources of this client. More... | |
bool | busy |
struct spa_hook_list | listener_list |
struct pw_protocol * | protocol |
protocol in use More... | |
struct spa_list | protocol_link |
link in the protocol client_list More... | |
void * | user_data |
extra user data More... | |
PipeWire client object class.
The client object represents a client connection with the PipeWire server.
Each client has its own list of resources it is bound to along with a mapping between the client types and server types.
void pw_client_destroy | ( | struct pw_client * | client | ) |
Destroy a client object.
client | the client to destroy |
References global, link, listener_list, objects, pw_global_destroy(), pw_resource_destroy(), and resource_list.
struct pw_client * pw_client_new | ( | struct pw_core * | core, |
struct pw_global * | parent, | ||
struct ucred * | ucred, | ||
struct pw_properties * | properties, | ||
size_t | user_data_size | ||
) |
Make a new client object.
core | a pw_core object to register the client with |
ucred | a ucred structure or NULL when unknown |
properties | optional client properties, ownership is taken |
References pw_type::client, pw_core::client_list, pw_properties::dict, pw_global::id, link, pw_core_add_global(), PW_VERSION_CLIENT, impl::this, and pw_core::type.
void pw_client_update_properties | ( | struct pw_client * | client, |
const struct spa_dict * | dict | ||
) |
Update client properties.
client | the client |
dict | a spa_dict with properties |
Add all properties in dict to the client properties. Existing properties are overwritten. Items can be removed by setting the value to NULL.
References pw_client_info::change_mask, pw_properties::dict, info, pw_resource::link, listener_list, properties, pw_client_info::props, pw_client_resource_info, pw_properties_new_dict(), pw_properties_set(), and resource_list.
bool pw_client::busy |
Referenced by pw_client_set_busy().
struct pw_core* pw_client::core |
core object
Referenced by pw_client_get_core(), pw_global_get_permissions(), and pw_resource_new().
struct pw_resource* pw_client::core_resource |
core resource object
Referenced by pw_client_get_core_resource(), pw_global::pw_global_bind(), pw_resource_destroy(), and pw_resource_error().
struct pw_global* pw_client::global |
global object created for this client
Referenced by pw_client_destroy(), pw_client_get_global(), and pw_core::pw_core_add_global().
struct pw_client_info pw_client::info |
client info
Referenced by pw_client_get_info(), and pw_client_update_properties().
struct spa_list pw_client::link |
link in core object client list
Referenced by pw_client_destroy(), and pw_client_new().
struct spa_hook_list pw_client::listener_list |
uint32_t pw_client::n_types |
number of client types
struct pw_map pw_client::objects |
list of resource objects
Referenced by pw_client_destroy(), pw_client_get_resource(), pw_resource_destroy(), and pw_resource_new().
struct pw_properties* pw_client::properties |
Client properties.
Referenced by pw_client_get_properties(), and pw_client_update_properties().
struct pw_protocol* pw_client::protocol |
protocol in use
Referenced by pw_resource_get_protocol(), and pw_resource_new().
struct spa_list pw_client::protocol_link |
link in the protocol client_list
struct spa_list pw_client::resource_list |
The list of resources of this client.
Referenced by pw_client_destroy(), and pw_client_update_properties().
struct pw_map pw_client::types |
map of client types
struct ucred pw_client::ucred |
ucred information
Referenced by pw_client_get_ucred().
bool pw_client::ucred_valid |
if the ucred member is valid
Referenced by pw_client_get_ucred().
void* pw_client::user_data |
extra user data
Referenced by pw_client_get_user_data().