PipeWire 1.6.8

Loading...
Searching...
No Matches
impl-metadata.h
Go to the documentation of this file.
1/* PipeWire */
2/* SPDX-FileCopyrightText: Copyright © 2021 Wim Taymans */
3/* SPDX-License-Identifier: MIT */
4
5#ifndef PIPEWIRE_IMPL_METADATA_H
6#define PIPEWIRE_IMPL_METADATA_H
7
8#ifdef __cplusplus
9 extern "C" {
10#endif
11
16
21 struct pw_impl_metadata;
22
23#include <pipewire/context.h>
24#include <pipewire/impl-client.h>
25#include <pipewire/global.h>
26#include <pipewire/properties.h>
27#include <pipewire/resource.h>
28
29#include "pipewire/extensions/metadata.h"
30
32 struct pw_impl_metadata_events {
33#define PW_VERSION_IMPL_METADATA_EVENTS 0
34 uint32_t version;
35
37 void (*destroy) (void *data);
39 void (*free) (void *data);
40
42 int (*property) (void *data,
43 uint32_t subject,
44 const char *key,
45 const char *type,
46 const char *value);
47};
48
49 struct pw_impl_metadata *pw_context_create_metadata(struct pw_context *context,
50 const char *name, struct pw_properties *properties,
51 size_t user_data_size);
52
54 const struct pw_properties *pw_impl_metadata_get_properties(struct pw_impl_metadata *metadata);
55
56 int pw_impl_metadata_register(struct pw_impl_metadata *metadata,
57 struct pw_properties *properties);
58
59 void pw_impl_metadata_destroy(struct pw_impl_metadata *metadata);
60
61 void *pw_impl_metadata_get_user_data(struct pw_impl_metadata *metadata);
62
63 int pw_impl_metadata_set_implementation(struct pw_impl_metadata *metadata,
64 struct pw_metadata *impl);
65
66 struct pw_metadata *pw_impl_metadata_get_implementation(struct pw_impl_metadata *metadata);
67
69 struct pw_global *pw_impl_metadata_get_global(struct pw_impl_metadata *metadata);
70
72 void pw_impl_metadata_add_listener(struct pw_impl_metadata *metadata,
73 struct spa_hook *listener,
74 const struct pw_impl_metadata_events *events,
75 void *data);
76
78 int pw_impl_metadata_set_property(struct pw_impl_metadata *metadata,
79 uint32_t subject, const char *key, const char *type,
80 const char *value);
81
82 int pw_impl_metadata_set_propertyf(struct pw_impl_metadata *metadata,
83 uint32_t subject, const char *key, const char *type,
84 const char *fmt, ...) SPA_PRINTF_FUNC(5,6);
85
89
90#ifdef __cplusplus
91}
92#endif
93
94#endif /* PIPEWIRE_IMPL_METADATA_H */
global.h
pipewire/global.h
pw_impl_metadata_get_user_data
void * pw_impl_metadata_get_user_data(struct pw_impl_metadata *metadata)
Definition impl-metadata.c:567
pw_impl_metadata_register
int pw_impl_metadata_register(struct pw_impl_metadata *metadata, struct pw_properties *properties)
Definition impl-metadata.c:522
pw_impl_metadata_set_implementation
int pw_impl_metadata_set_implementation(struct pw_impl_metadata *metadata, struct pw_metadata *impl)
Definition impl-metadata.c:317
pw_impl_metadata_add_listener
void pw_impl_metadata_add_listener(struct pw_impl_metadata *metadata, struct spa_hook *listener, const struct pw_impl_metadata_events *events, void *data)
Add an event listener.
Definition impl-metadata.c:579
pw_impl_metadata_get_implementation
struct pw_metadata * pw_impl_metadata_get_implementation(struct pw_impl_metadata *metadata)
Definition impl-metadata.c:337
pw_impl_metadata_get_global
struct pw_global * pw_impl_metadata_get_global(struct pw_impl_metadata *metadata)
Get the global of this metadata.
Definition impl-metadata.c:573
pw_impl_metadata_get_properties
const struct pw_properties * pw_impl_metadata_get_properties(struct pw_impl_metadata *metadata)
Get the metadata properties.
Definition impl-metadata.c:311
pw_impl_metadata_set_property
int pw_impl_metadata_set_property(struct pw_impl_metadata *metadata, uint32_t subject, const char *key, const char *type, const char *value)
Set a property.
Definition impl-metadata.c:588
pw_context_create_metadata
struct pw_impl_metadata * pw_context_create_metadata(struct pw_context *context, const char *name, struct pw_properties *properties, size_t user_data_size)
Definition impl-metadata.c:267
pw_impl_metadata_set_propertyf
int pw_impl_metadata_set_propertyf(struct pw_impl_metadata *metadata, uint32_t subject, const char *key, const char *type, const char *fmt,...)
Definition impl-metadata.c:596
pw_impl_metadata_destroy
void pw_impl_metadata_destroy(struct pw_impl_metadata *metadata)
Definition impl-metadata.c:343
SPA_PRINTF_FUNC
#define SPA_PRINTF_FUNC(fmt, arg1)
Definition defs.h:297
impl-client.h
pipewire/impl-client.h
metadata.h
pipewire/extensions/metadata.h
properties.h
pipewire/properties.h
resource.h
pipewire/resource.h
context.h
pipewire/context.h
pw_context
pw_global
pw_impl_metadata_events
Metadata events, listen to them with pw_impl_metadata_add_listener.
Definition impl-metadata.h:37
pw_impl_metadata_events::destroy
void(* destroy)(void *data)
the metadata is destroyed
Definition impl-metadata.h:43
pw_impl_metadata_events::property
int(* property)(void *data, uint32_t subject, const char *key, const char *type, const char *value)
a property changed
Definition impl-metadata.h:48
pw_impl_metadata_events::version
uint32_t version
Definition impl-metadata.h:40
pw_impl_metadata
pw_metadata
pw_properties
Definition properties.h:39
spa_hook
A hook, contains the structure with functions and the data passed to the functions.
Definition hook.h:427