Method

PwgMetadataset

since: 0.1

Declaration [src]

_Bool
pwg_metadata_set (
  PwgMetadata* self,
  unsigned int subject,
  const char* key,
  const char* type,
  const char* value,
  GError** error
)

Description [src]

Sets or clears one metadata key. The named metadata object must be bound.

Stability: Unstable

Available since: 0.1

Parameters

subject

Type: unsigned int

The PipeWire global id associated with the metadata.

key

Type: const char*

A metadata key.

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

Type: const char*

The metadata value type, or NULL.

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

Type: const char*

The metadata value, or NULL to clear key.

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 PipeWire accepted the request.