Method

PwgStreamset_pipewire_property

since: 0.1

Declaration [src]

_Bool
pwg_stream_set_pipewire_property (
  PwgStream* self,
  const char* key,
  const char* value,
  GError** error
)

Description [src]

Sets an app-specific PipeWire stream property override before the stream is started. This can be used for bindable identity and policy hints such as node.name, node.description, application.name, media.class, media.name, media.category, or media.role.

Stability: Unstable

Available since: 0.1

Parameters

key

Type: const char*

PipeWire stream property key.

The data is owned by the caller of the method.
The value is a NUL terminated UTF-8 string.
value

Type: const char*

PipeWire stream property value, or NULL to remove an override.

The argument can be NULL.
The data is owned by the caller of the method.
The value is a NUL terminated UTF-8 string.
error

Type: GError **

The return location for a recoverable error.

The argument can be NULL.
If the return location is not NULL, then you must initialize it to a NULL GError*.
The argument will be left initialized to NULL by the method if there are no errors.
In case of error, the argument will be set to a newly allocated GError; the caller will take ownership of the data, and be responsible for freeing it.

Return value

Type: _Bool

TRUE when the property override was accepted.