PipeWire: pw_impl_node Class Reference

PipeWire 0.3.20

Public Member Functions
pw_impl_node Class Reference

PipeWire node class. More...

## Public Member 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...
SPA_EXPORT void | pw_impl_node_destroy (struct pw_impl_node *node)
| Destroy a node. More...
SPA_EXPORT int | pw_impl_node_set_state (struct pw_impl_node *node, enum pw_node_state state)
| Set the node state. More...

## Detailed Description

PipeWire node class.

## Member Function Documentation

## ◆ pw_context_create_node()

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.

Parameters

  context | the context
  properties | extra properties
  user_data_size | user data size

References NAME, impl::param_list, impl::pending_list, pw_log::pw_log_debug, pw_properties::pw_properties_new(), res, and impl::this.

## ◆ pw_impl_node_destroy()

SPA_EXPORT void pw_impl_node_destroy | ( | struct pw_impl_node * | node | ) |

Destroy a node.

Parameters

  node | a node to destroy

Remove node. This will stop the transfer on the node and free the resources allocated by node.

References NAME, pw_log::pw_log_debug, and pw_log::pw_log_info.

Referenced by pw_stream::pw_stream_disconnect().

## ◆ pw_impl_node_set_state()

SPA_EXPORT int pw_impl_node_set_state | ( | struct pw_impl_node * | node,
|  | enum pw_node_state | state
| ) |  |

Set the node state.

Parameters

  node | a pw_impl_node
  state | a pw_node_state

Returns
  0 on success < 0 on error

Set the state of node to state.

References NAME, pw_log::pw_log_debug, pw_node_state_as_string(), PW_NODE_STATE_CREATING, PW_NODE_STATE_SUSPENDED, and res.

The documentation for this class was generated from the following files:

- impl-node.h
- impl-node.c