PipeWire
0.3.61
|
The node object processes data. More...
Files | |
file | impl-node.h |
pipewire/impl-node.h | |
Data Structures | |
struct | pw_impl_node_events |
Node events, listen to them with pw_impl_node_add_listener. More... | |
struct | pw_impl_node |
struct | pw_impl_port |
Macros | |
#define | PW_VERSION_IMPL_NODE_EVENTS 0 |
Functions | |
struct pw_impl_node * | pw_context_create_node (struct pw_context *context, struct pw_properties *properties, size_t user_data_size) |
Create a new node. More... | |
int | pw_impl_node_register (struct pw_impl_node *node, struct pw_properties *properties) |
Complete initialization of the node and register. More... | |
void | pw_impl_node_destroy (struct pw_impl_node *node) |
Destroy a node. More... | |
const struct pw_node_info * | pw_impl_node_get_info (struct pw_impl_node *node) |
Get the node info. More... | |
void * | pw_impl_node_get_user_data (struct pw_impl_node *node) |
Get node user_data. More... | |
struct pw_context * | pw_impl_node_get_context (struct pw_impl_node *node) |
Get the context of this node. More... | |
struct pw_global * | pw_impl_node_get_global (struct pw_impl_node *node) |
Get the global of this node. More... | |
const struct pw_properties * | pw_impl_node_get_properties (struct pw_impl_node *node) |
Get the node properties. More... | |
int | pw_impl_node_update_properties (struct pw_impl_node *node, const struct spa_dict *dict) |
Update the node properties. More... | |
int | pw_impl_node_set_implementation (struct pw_impl_node *node, struct spa_node *spa_node) |
Set the node implementation. More... | |
struct spa_node * | pw_impl_node_get_implementation (struct pw_impl_node *node) |
Get the node implementation. More... | |
void | pw_impl_node_add_listener (struct pw_impl_node *node, struct spa_hook *listener, const struct pw_impl_node_events *events, void *data) |
Add an event listener. More... | |
int | pw_impl_node_for_each_port (struct pw_impl_node *node, enum pw_direction direction, int(*callback)(void *data, struct pw_impl_port *port), void *data) |
Iterate the ports in the given direction. More... | |
int | pw_impl_node_for_each_param (struct pw_impl_node *node, int seq, uint32_t param_id, uint32_t index, uint32_t max, const struct spa_pod *filter, int(*callback)(void *data, int seq, uint32_t id, uint32_t index, uint32_t next, struct spa_pod *param), void *data) |
struct pw_impl_port * | pw_impl_node_find_port (struct pw_impl_node *node, enum pw_direction direction, uint32_t port_id) |
Find the port with direction and port_id or NULL when not found. More... | |
uint32_t | pw_impl_node_get_free_port_id (struct pw_impl_node *node, enum pw_direction direction) |
Get a free unused port_id from the node. More... | |
int | pw_impl_node_initialized (struct pw_impl_node *node) |
int | pw_impl_node_set_active (struct pw_impl_node *node, bool active) |
Set a node active. More... | |
bool | pw_impl_node_is_active (struct pw_impl_node *node) |
Check if a node is active. More... | |
int | pw_impl_node_send_command (struct pw_impl_node *node, const struct spa_command *command) |
Check if a node is active, Since 0.3.39. More... | |
The node object processes data.
The node has a list of input and output ports (Port Impl) on which it will receive and send out buffers respectively.
#define PW_VERSION_IMPL_NODE_EVENTS 0 |
struct pw_impl_node* pw_context_create_node | ( | struct pw_context * | context, |
struct pw_properties * | properties, | ||
size_t | user_data_size | ||
) |
Create a new node.
context | the context |
properties | extra properties |
user_data_size | user data size |
int pw_impl_node_register | ( | struct pw_impl_node * | node, |
struct pw_properties * | properties | ||
) |
Complete initialization of the node and register.
node | node to register |
properties | extra properties |
void pw_impl_node_destroy | ( | struct pw_impl_node * | node | ) |
Destroy a node.
node | a node to destroy |
Remove node. This will stop the transfer on the node and free the resources allocated by node.
const struct pw_node_info* pw_impl_node_get_info | ( | struct pw_impl_node * | node | ) |
Get the node info.
void* pw_impl_node_get_user_data | ( | struct pw_impl_node * | node | ) |
Get node user_data.
The size of the memory was given in pw_context_create_node
struct pw_context* pw_impl_node_get_context | ( | struct pw_impl_node * | node | ) |
Get the context of this node.
struct pw_global* pw_impl_node_get_global | ( | struct pw_impl_node * | node | ) |
Get the global of this node.
const struct pw_properties* pw_impl_node_get_properties | ( | struct pw_impl_node * | node | ) |
Get the node properties.
int pw_impl_node_update_properties | ( | struct pw_impl_node * | node, |
const struct spa_dict * | dict | ||
) |
Update the node properties.
int pw_impl_node_set_implementation | ( | struct pw_impl_node * | node, |
struct spa_node * | spa_node | ||
) |
Set the node implementation.
struct spa_node* pw_impl_node_get_implementation | ( | struct pw_impl_node * | node | ) |
Get the node implementation.
void pw_impl_node_add_listener | ( | struct pw_impl_node * | node, |
struct spa_hook * | listener, | ||
const struct pw_impl_node_events * | events, | ||
void * | data | ||
) |
Add an event listener.
int pw_impl_node_for_each_port | ( | struct pw_impl_node * | node, |
enum pw_direction | direction, | ||
int(*)(void *data, struct pw_impl_port *port) | callback, | ||
void * | data | ||
) |
Iterate the ports in the given direction.
The callback should return 0 to fetch the next item, any other value stops the iteration and returns the value. When all callbacks return 0, this function returns 0 when all items are iterated.
int pw_impl_node_for_each_param | ( | struct pw_impl_node * | node, |
int | seq, | ||
uint32_t | param_id, | ||
uint32_t | index, | ||
uint32_t | max, | ||
const struct spa_pod * | filter, | ||
int(*)(void *data, int seq, uint32_t id, uint32_t index, uint32_t next, struct spa_pod *param) | callback, | ||
void * | data | ||
) |
struct pw_impl_port* pw_impl_node_find_port | ( | struct pw_impl_node * | node, |
enum pw_direction | direction, | ||
uint32_t | port_id | ||
) |
Find the port with direction and port_id or NULL when not found.
Passing PW_ID_ANY for port_id will return any port, preferably an unlinked one.
uint32_t pw_impl_node_get_free_port_id | ( | struct pw_impl_node * | node, |
enum pw_direction | direction | ||
) |
Get a free unused port_id from the node.
int pw_impl_node_initialized | ( | struct pw_impl_node * | node | ) |
int pw_impl_node_set_active | ( | struct pw_impl_node * | node, |
bool | active | ||
) |
Set a node active.
This will start negotiation with all linked active nodes and start data transport
bool pw_impl_node_is_active | ( | struct pw_impl_node * | node | ) |
Check if a node is active.
int pw_impl_node_send_command | ( | struct pw_impl_node * | node, |
const struct spa_command * | command | ||
) |
Check if a node is active, Since 0.3.39.