mirrors/pipewire
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pipewire/pipewire.git synced 2025-11-03 09:01:54 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: copy docs from the _methods struct

Browse source
This commit is contained in:
Wim Taymans 2024-11-26 13:21:04 +01:00
parent 853c4783bc
commit 4d4607e62a
11 changed files with 64 additions and 43 deletions
Download patch file Download diff file Expand all files Collapse all files

18
src/pipewire/client.h
View file

@ -195,24 +195,6 @@ PW_API_CLIENT_IMPL int pw_client_update_permissions(struct pw_client *object, ui
n_permissions, permissions);
}
PW_API_CLIENT_IMPL void *pw_client_get_user_data(struct pw_client *object)
{
return pw_proxy_get_user_data((struct pw_proxy *)object);
}
PW_API_CLIENT_IMPL void pw_client_add_proxy_listener(struct pw_client *object,
struct spa_hook *listener,
const struct pw_proxy_events *events,
void *data)
{
pw_proxy_add_listener((struct pw_proxy *)object, listener, events, data);
}
PW_API_CLIENT_IMPL struct pw_client *pw_registry_bind_client(struct pw_registry *object,
uint32_t id, size_t user_data_size)
{
return (struct pw_client*)pw_registry_bind(object, id, PW_TYPE_INTERFACE_Client,
PW_VERSION_CLIENT, user_data_size);
}
/**
* \}
*/

29
src/pipewire/core.h
View file

@ -344,6 +344,8 @@ struct pw_core_methods {
};
/** \copydoc pw_core_methods.add_listener
* \sa pw_core_methods.add_listener */
PW_API_CORE_IMPL int pw_core_add_listener(struct pw_core *object,
struct spa_hook *listener,
const struct pw_core_events *events,
@ -353,24 +355,32 @@ PW_API_CORE_IMPL int pw_core_add_listener(struct pw_core *object,
pw_core, (struct spa_interface*)object, add_listener, 0,
listener, events, data);
}
/** \copydoc pw_core_methods.hello
* \sa pw_core_methods.hello */
PW_API_CORE_IMPL int pw_core_hello(struct pw_core *object, uint32_t version)
{
return spa_api_method_r(int, -ENOTSUP,
pw_core, (struct spa_interface*)object, hello, 0,
version);
}
/** \copydoc pw_core_methods.sync
* \sa pw_core_methods.sync */
PW_API_CORE_IMPL int pw_core_sync(struct pw_core *object, uint32_t id, int seq)
{
return spa_api_method_r(int, -ENOTSUP,
pw_core, (struct spa_interface*)object, sync, 0,
id, seq);
}
/** \copydoc pw_core_methods.pong
* \sa pw_core_methods.pong */
PW_API_CORE_IMPL int pw_core_pong(struct pw_core *object, uint32_t id, int seq)
{
return spa_api_method_r(int, -ENOTSUP,
pw_core, (struct spa_interface*)object, pong, 0,
id, seq);
}
/** \copydoc pw_core_methods.error
* \sa pw_core_methods.error */
PW_API_CORE_IMPL int pw_core_error(struct pw_core *object, uint32_t id, int seq, int res, const char *message)
{
return spa_api_method_r(int, -ENOTSUP,
@ -401,6 +411,8 @@ pw_core_errorf(struct pw_core *core, uint32_t id, int seq,
return r;
}
/** \copydoc pw_core_methods.get_registry
* \sa pw_core_methods.get_registry */
PW_API_CORE_IMPL struct pw_registry *
pw_core_get_registry(struct pw_core *core, uint32_t version, size_t user_data_size)
{
@ -408,6 +420,8 @@ pw_core_get_registry(struct pw_core *core, uint32_t version, size_t user_data_si
pw_core, (struct spa_interface*)core, get_registry, 0,
version, user_data_size);
}
/** \copydoc pw_core_methods.create_object
* \sa pw_core_methods.create_object */
PW_API_CORE_IMPL void *
pw_core_create_object(struct pw_core *core,
const char *factory_name,
@ -420,6 +434,8 @@ pw_core_create_object(struct pw_core *core,
pw_core, (struct spa_interface*)core, create_object, 0,
factory_name, type, version, props, user_data_size);
}
/** \copydoc pw_core_methods.destroy
* \sa pw_core_methods.destroy */
PW_API_CORE_IMPL void
pw_core_destroy(struct pw_core *core, void *proxy)
{
@ -545,6 +561,8 @@ struct pw_registry_methods {
/** Registry */
/** \copydoc pw_registry_methods.add_listener
* \sa pw_registry_methods.add_listener */
PW_API_REGISTRY_IMPL int pw_registry_add_listener(struct pw_registry *registry,
struct spa_hook *listener,
const struct pw_registry_events *events,
@ -554,6 +572,8 @@ PW_API_REGISTRY_IMPL int pw_registry_add_listener(struct pw_registry *registry,
pw_registry, (struct spa_interface*)registry, add_listener, 0,
listener, events, data);
}
/** \copydoc pw_registry_methods.bind
* \sa pw_registry_methods.bind */
PW_API_REGISTRY_IMPL void *
pw_registry_bind(struct pw_registry *registry,
uint32_t id, const char *type, uint32_t version,
@ -563,6 +583,8 @@ pw_registry_bind(struct pw_registry *registry,
pw_registry, (struct spa_interface*)registry, bind, 0,
id, type, version, user_data_size);
}
/** \copydoc pw_registry_methods.destroy
* \sa pw_registry_methods.destroy */
PW_API_REGISTRY_IMPL int
pw_registry_destroy(struct pw_registry *registry, uint32_t id)
{
@ -570,13 +592,6 @@ pw_registry_destroy(struct pw_registry *registry, uint32_t id)
pw_registry, (struct spa_interface*)registry, destroy, 0, id);
}
PW_API_REGISTRY_IMPL struct pw_core *pw_registry_bind_core(struct pw_registry *object,
uint32_t id, size_t user_data_size)
{
return (struct pw_core*)pw_registry_bind(object, id, PW_TYPE_INTERFACE_Core,
PW_VERSION_CORE, user_data_size);
}
/**
* \}
*/

26
src/pipewire/device.h
View file

@ -145,6 +145,8 @@ struct pw_device_methods {
const struct spa_pod *param);
};
/** \copydoc pw_device_methods.add_listener
* \sa pw_device_methods.add_listener */
PW_API_DEVICE_IMPL int pw_device_add_listener(struct pw_device *object,
struct spa_hook *listener,
const struct pw_device_events *events,
@ -154,12 +156,16 @@ PW_API_DEVICE_IMPL int pw_device_add_listener(struct pw_device *object,
pw_device, (struct spa_interface*)object, add_listener, 0,
listener, events, data);
}
/** \copydoc pw_device_methods.subscribe_params
* \sa pw_device_methods.subscribe_params */
PW_API_DEVICE_IMPL int pw_device_subscribe_params(struct pw_device *object, uint32_t *ids, uint32_t n_ids)
{
return spa_api_method_r(int, -ENOTSUP,
pw_device, (struct spa_interface*)object, subscribe_params, 0,
ids, n_ids);
}
/** \copydoc pw_device_methods.enum_params
* \sa pw_device_methods.enum_params */
PW_API_DEVICE_IMPL int pw_device_enum_params(struct pw_device *object,
int seq, uint32_t id, uint32_t start, uint32_t num,
const struct spa_pod *filter)
@ -168,6 +174,8 @@ PW_API_DEVICE_IMPL int pw_device_enum_params(struct pw_device *object,
pw_device, (struct spa_interface*)object, enum_params, 0,
seq, id, start, num, filter);
}
/** \copydoc pw_device_methods.set_param
* \sa pw_device_methods.set_param */
PW_API_DEVICE_IMPL int pw_device_set_param(struct pw_device *object, uint32_t id, uint32_t flags,
const struct spa_pod *param)
{
@ -176,24 +184,6 @@ PW_API_DEVICE_IMPL int pw_device_set_param(struct pw_device *object, uint32_t id
id, flags, param);
}
PW_API_DEVICE_IMPL void *pw_device_get_user_data(struct pw_device *object)
{
return pw_proxy_get_user_data((struct pw_proxy *)object);
}
PW_API_DEVICE_IMPL void pw_device_add_proxy_listener(struct pw_device *object,
struct spa_hook *listener,
const struct pw_proxy_events *events,
void *data)
{
pw_proxy_add_listener((struct pw_proxy *)object, listener, events, data);
}
PW_API_DEVICE_IMPL struct pw_device *pw_registry_bind_device(struct pw_registry *object,
uint32_t id, size_t user_data_size)
{
return (struct pw_device*)pw_registry_bind(object, id, PW_TYPE_INTERFACE_Device,
PW_VERSION_DEVICE, user_data_size);
}
/**
* \}
*/

6
src/pipewire/extensions/metadata.h
View file

@ -93,6 +93,8 @@ struct pw_metadata_methods {
int (*clear) (void *object);
};
/** \copydoc pw_metadata_methods.add_listener
* \sa pw_metadata_methods.add_listener */
PW_API_METADATA_IMPL int pw_metadata_add_listener(struct pw_metadata *object,
struct spa_hook *listener,
const struct pw_metadata_events *events,
@ -102,6 +104,8 @@ PW_API_METADATA_IMPL int pw_metadata_add_listener(struct pw_metadata *object,
pw_metadata, (struct spa_interface*)object, add_listener, 0,
listener, events, data);
}
/** \copydoc pw_metadata_methods.set_property
* \sa pw_metadata_methods.set_property */
PW_API_METADATA_IMPL int pw_metadata_set_property(struct pw_metadata *object,
uint32_t subject,
const char *key,
@ -112,6 +116,8 @@ PW_API_METADATA_IMPL int pw_metadata_set_property(struct pw_metadata *object,
pw_metadata, (struct spa_interface*)object, set_property, 0,
subject, key, type, value);
}
/** \copydoc pw_metadata_methods.clear
* \sa pw_metadata_methods.clear */
PW_API_METADATA_IMPL int pw_metadata_clear(struct pw_metadata *object)
{
return spa_api_method_r(int, -ENOTSUP,

2
src/pipewire/extensions/profiler.h
View file

@ -57,6 +57,8 @@ struct pw_profiler_methods {
void *data);
};
/** \copydoc pw_profiler_methods.add_listener
* \sa pw_profiler_methods.add_listener */
PW_API_PROFILER int pw_profiler_add_listener(struct pw_profiler *object,
struct spa_hook *listener,
const struct pw_profiler_events *events,

4
src/pipewire/extensions/security-context.h
View file

@ -98,6 +98,8 @@ struct pw_security_context_methods {
const struct spa_dict *props);
};
/** \copydoc pw_security_context_methods.add_listener
* \sa pw_security_context_methods.add_listener */
PW_API_SECURITY_CONTEXT int pw_security_context_add_listener(struct pw_security_context *object,
struct spa_hook *listener,
const struct pw_security_context_events *events,
@ -108,6 +110,8 @@ PW_API_SECURITY_CONTEXT int pw_security_context_add_listener(struct pw_security_
listener, events, data);
}
/** \copydoc pw_security_context_methods.create
* \sa pw_security_context_methods.create */
PW_API_SECURITY_CONTEXT int pw_security_context_create(struct pw_security_context *object,
int listen_fd, int close_fd, const struct spa_dict *props)
{

2
src/pipewire/factory.h
View file

@ -87,6 +87,8 @@ struct pw_factory_methods {
void *data);
};
/** \copydoc pw_factory_methods.add_listener
* \sa pw_factory_methods.add_listener */
PW_API_FACTORY_IMPL int pw_factory_add_listener(struct pw_factory *object,
struct spa_hook *listener,
const struct pw_factory_events *events,

2
src/pipewire/link.h
View file

@ -113,6 +113,8 @@ struct pw_link_methods {
void *data);
};
/** \copydoc pw_link_methods.add_listener
* \sa pw_link_methods.add_listener */
PW_API_LINK_IMPL int pw_link_add_listener(struct pw_link *object,
struct spa_hook *listener,
const struct pw_link_events *events,

2
src/pipewire/module.h
View file

@ -85,6 +85,8 @@ struct pw_module_methods {
void *data);
};
/** \copydoc pw_module_methods.add_listener
* \sa pw_module_methods.add_listener */
PW_API_MODULE_IMPL int pw_module_add_listener(struct pw_module *object,
struct spa_hook *listener,
const struct pw_module_events *events,

10
src/pipewire/node.h
View file

@ -184,6 +184,8 @@ struct pw_node_methods {
};
/** \copydoc pw_node_methods.add_listener
* \sa pw_node_methods.add_listener */
PW_API_NODE_IMPL int pw_node_add_listener(struct pw_node *object,
struct spa_hook *listener,
const struct pw_node_events *events,
@ -193,12 +195,16 @@ PW_API_NODE_IMPL int pw_node_add_listener(struct pw_node *object,
pw_node, (struct spa_interface*)object, add_listener, 0,
listener, events, data);
}
/** \copydoc pw_node_methods.subscribe_params
* \sa pw_node_methods.subscribe_params */
PW_API_NODE_IMPL int pw_node_subscribe_params(struct pw_node *object, uint32_t *ids, uint32_t n_ids)
{
return spa_api_method_r(int, -ENOTSUP,
pw_node, (struct spa_interface*)object, subscribe_params, 0,
ids, n_ids);
}
/** \copydoc pw_node_methods.enum_params
* \sa pw_node_methods.enum_params */
PW_API_NODE_IMPL int pw_node_enum_params(struct pw_node *object,
int seq, uint32_t id, uint32_t start, uint32_t num,
const struct spa_pod *filter)
@ -207,6 +213,8 @@ PW_API_NODE_IMPL int pw_node_enum_params(struct pw_node *object,
pw_node, (struct spa_interface*)object, enum_params, 0,
seq, id, start, num, filter);
}
/** \copydoc pw_node_methods.set_param
* \sa pw_node_methods.set_param */
PW_API_NODE_IMPL int pw_node_set_param(struct pw_node *object, uint32_t id, uint32_t flags,
const struct spa_pod *param)
{
@ -214,6 +222,8 @@ PW_API_NODE_IMPL int pw_node_set_param(struct pw_node *object, uint32_t id, uint
pw_node, (struct spa_interface*)object, set_param, 0,
id, flags, param);
}
/** \copydoc pw_node_methods.send_command
* \sa pw_node_methods.send_command */
PW_API_NODE_IMPL int pw_node_send_command(struct pw_node *object, const struct spa_command *command)
{
return spa_api_method_r(int, -ENOTSUP,

6
src/pipewire/port.h
View file

@ -145,6 +145,8 @@ struct pw_port_methods {
const struct spa_pod *filter);
};
/** \copydoc pw_port_methods.add_listener
* \sa pw_port_methods.add_listener */
PW_API_PORT_IMPL int pw_port_add_listener(struct pw_port *object,
struct spa_hook *listener,
const struct pw_port_events *events,
@ -154,12 +156,16 @@ PW_API_PORT_IMPL int pw_port_add_listener(struct pw_port *object,
pw_port, (struct spa_interface*)object, add_listener, 0,
listener, events, data);
}
/** \copydoc pw_port_methods.subscribe_params
* \sa pw_port_methods.subscribe_params */
PW_API_PORT_IMPL int pw_port_subscribe_params(struct pw_port *object, uint32_t *ids, uint32_t n_ids)
{
return spa_api_method_r(int, -ENOTSUP,
pw_port, (struct spa_interface*)object, subscribe_params, 0,
ids, n_ids);
}
/** \copydoc pw_port_methods.enum_params
* \sa pw_port_methods.enum_params */
PW_API_PORT_IMPL int pw_port_enum_params(struct pw_port *object,
int seq, uint32_t id, uint32_t start, uint32_t num,
const struct spa_pod *filter)