PipeWire  0.3.45
pw_client_endpoint_events Struct Reference

Data Fields

uint32_t version
 version of this structure More...
 
int(* set_session_id )(void *object, uint32_t session_id)
 Sets the session id of the endpoint. More...
 
int(* set_param )(void *object, uint32_t id, uint32_t flags, const struct spa_pod *param)
 Set the configurable parameter in endpoint. More...
 
int(* stream_set_param )(void *object, uint32_t stream_id, uint32_t id, uint32_t flags, const struct spa_pod *param)
 Set a parameter on stream_id of endpoint. More...
 
int(* create_link )(void *object, const struct spa_dict *props)
 

Field Documentation

◆ version

uint32_t pw_client_endpoint_events::version

version of this structure

◆ set_session_id

int(* pw_client_endpoint_events::set_session_id) (void *object, uint32_t session_id)

Sets the session id of the endpoint.

On endpoints that are not session masters, this method notifies the implementation that it has been associated with a session. The implementation is obliged to set this id in the #struct pw_endpoint_info session_id field.

Parameters
endpointa pw_endpoint
idthe session id associated with this endpoint
Returns
0 on success -EINVAL when the session id has already been set -ENOTSUP when the endpoint is a session master

◆ set_param

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

Set the configurable parameter in endpoint.

Usually, param will be obtained from enum_params and then modified but it is also possible to set another spa_pod as long as its keys and types match a supported object.

Objects with property keys that are not known are ignored.

This function must be called from the main thread.

Parameters
endpointa #struct pw_endpoint
idthe parameter id to configure
flagsadditional flags
paramthe parameter to configure
Returns
0 on success -EINVAL when endpoint is NULL -ENOTSUP when there are no parameters implemented on endpoint -ENOENT the parameter is unknown

◆ stream_set_param

int(* pw_client_endpoint_events::stream_set_param) (void *object, uint32_t stream_id, uint32_t id, uint32_t flags, const struct spa_pod *param)

Set a parameter on stream_id of endpoint.

When param is NULL, the parameter will be unset.

This function must be called from the main thread.

Parameters
endpointa #struct pw_endpoint
stream_idthe stream to configure
idthe parameter id to set
flagsoptional flags
parama #struct spa_pod with the parameter to set
Returns
0 on success 1 on success, the value of param might have been changed depending on flags and the final value can be found by doing stream_enum_params. -EINVAL when endpoint is NULL or invalid arguments are given -ESRCH when the type or size of a property is not correct. -ENOENT when the param id is not found

◆ create_link

int(* pw_client_endpoint_events::create_link) (void *object, const struct spa_dict *props)

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