pw_node_methods Struct Reference

Node methods. More...

#include <pipewire/node.h>

Data Fields
uint32_t	version
int(*	add_listener )(void *object, struct spa_hook *listener, const struct pw_node_events *events, void *data)
int(*	subscribe_params )(void *object, uint32_t *ids, uint32_t n_ids)
	Subscribe to parameter changes.
int(*	enum_params )(void *object, int seq, uint32_t id, uint32_t start, uint32_t num, const struct spa_pod *filter)
	Enumerate node parameters.
int(*	set_param )(void *object, uint32_t id, uint32_t flags, const struct spa_pod *param)
	Set a parameter on the node.
int(*	send_command )(void *object, const struct spa_command *command)
	Send a command to the node.

Detailed Description

Node methods.

Field Documentation

version

uint32_t pw_node_methods::version

add_listener

int(* pw_node_methods::add_listener) (void *object, struct spa_hook *listener, const struct pw_node_events *events, void *data)

subscribe_params

int(* pw_node_methods::subscribe_params) (void *object, uint32_t *ids, uint32_t n_ids)

Subscribe to parameter changes.

Automatically emit param events for the given ids when they are changed.

Parameters

ids	an array of param ids
n_ids	the number of ids in ids

This requires X permissions on the node.

enum_params

int(* pw_node_methods::enum_params) (void *object, int seq, uint32_t id, uint32_t start, uint32_t num, const struct spa_pod *filter)

Enumerate node parameters.

Start enumeration of node parameters. For each param, a param event will be emitted.

Parameters

seq	a sequence number to place in the reply
id	the parameter id to enum or PW_ID_ANY for all
start	the start index or 0 for the first param
num	the maximum number of params to retrieve
filter	a param filter or NULL

This requires X permissions on the node.

set_param

int(* pw_node_methods::set_param) (void *object, uint32_t id, uint32_t flags, const struct spa_pod *param)

Set a parameter on the node.

Parameters

id	the parameter id to set
flags	extra parameter flags
param	the parameter to set

This requires X and W permissions on the node.

send_command

int(* pw_node_methods::send_command) (void *object, const struct spa_command *command)

Send a command to the node.

Parameters

command

the command to send

This requires X and W permissions on the node.

---

The documentation for this struct was generated from the following file:

• pipewire/node.h