PipeWire  0.3.53
pw_session_methods Struct Reference

Data Fields

uint32_t version
 version of this structure More...
 
int(* add_listener )(void *object, struct spa_hook *listener, const struct pw_session_events *events, void *data)
 
int(* subscribe_params )(void *object, uint32_t *ids, uint32_t n_ids)
 Subscribe to parameter changes. More...
 
int(* enum_params )(void *object, int seq, uint32_t id, uint32_t start, uint32_t num, const struct spa_pod *filter)
 Enumerate session parameters. More...
 
int(* set_param )(void *object, uint32_t id, uint32_t flags, const struct spa_pod *param)
 Set a parameter on the session. More...
 

Field Documentation

◆ version

uint32_t pw_session_methods::version

version of this structure

◆ add_listener

int(* pw_session_methods::add_listener) (void *object, struct spa_hook *listener, const struct pw_session_events *events, void *data)

◆ subscribe_params

int(* pw_session_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
idsan array of param ids
n_idsthe number of ids in ids

◆ enum_params

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

Enumerate session parameters.

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

Parameters
seqa sequence number returned in the reply
idthe parameter id to enumerate
startthe start index or 0 for the first param
numthe maximum number of params to retrieve
filtera param filter or NULL

◆ set_param

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

Set a parameter on the session.

Parameters
idthe parameter id to set
flagsextra parameter flags
paramthe parameter to set

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