metadata.h

Go to the documentation of this file.

/* PipeWire */
/* SPDX-FileCopyrightText: Copyright © 2019 Wim Taymans */
/* SPDX-License-Identifier: MIT */
 
#ifndef PIPEWIRE_EXT_METADATA_H
#define PIPEWIRE_EXT_METADATA_H
 
#include <spa/utils/defs.h>
#include <spa/utils/hook.h>
 
#include <errno.h>
 
#ifdef __cplusplus
extern "C" {
#endif


#define PW_TYPE_INTERFACE_Metadata              PW_TYPE_INFO_INTERFACE_BASE "Metadata"
 
#define PW_METADATA_PERM_MASK                   PW_PERM_RWX
 
#define PW_VERSION_METADATA                     3
struct pw_metadata;
 
#ifndef PW_API_METADATA_IMPL
#define PW_API_METADATA_IMPL static inline
#endif
 
#define PW_EXTENSION_MODULE_METADATA            PIPEWIRE_MODULE_PREFIX "module-metadata"
 
#define PW_METADATA_EVENT_PROPERTY              0
#define PW_METADATA_EVENT_NUM                   1
 

struct pw_metadata_events {
#define PW_VERSION_METADATA_EVENTS              0
        uint32_t version;
 
        int (*property) (void *data,
                        uint32_t subject,
                        const char *key,
                        const char *type,
                        const char *value);
};
 
#define PW_METADATA_METHOD_ADD_LISTENER         0
#define PW_METADATA_METHOD_SET_PROPERTY         1
#define PW_METADATA_METHOD_CLEAR                2
#define PW_METADATA_METHOD_NUM                  3

struct pw_metadata_methods {
#define PW_VERSION_METADATA_METHODS             0
        uint32_t version;
 
        int (*add_listener) (void *object,
                        struct spa_hook *listener,
                        const struct pw_metadata_events *events,
                        void *data);

         * \param key the key of the metadata, NULL clears all metadata for
         *                the subject.
         * \param type the type of the metadata, this can be blank
         * \param value the metadata value. NULL clears the metadata.
         *
         * This requires X and W permissions on the metadata. It also
         * requires M permissions on the subject global.
         */
        int (*set_property) (void *object,
                        uint32_t subject,
                        const char *key,
                        const char *type,
                        const char *value);

        int (*clear) (void *object);
};

PW_API_METADATA_IMPL int pw_metadata_add_listener(struct pw_metadata *object,
                        struct spa_hook *listener,
                        const struct pw_metadata_events *events,
                        void *data)
{
        return spa_api_method_r(int, -ENOTSUP,
                        pw_metadata, (struct spa_interface*)object, add_listener, 0,
                        listener, events, data);
}
PW_API_METADATA_IMPL int pw_metadata_set_property(struct pw_metadata *object,
                        uint32_t subject,
                        const char *key,
                        const char *type,
                        const char *value)
{
        return spa_api_method_r(int, -ENOTSUP,
                        pw_metadata, (struct spa_interface*)object, set_property, 0,
                        subject, key, type, value);
}
PW_API_METADATA_IMPL int pw_metadata_clear(struct pw_metadata *object)
{
        return spa_api_method_r(int, -ENOTSUP,
                        pw_metadata, (struct spa_interface*)object, clear, 0);
}
 
#define PW_KEY_METADATA_NAME            "metadata.name"
#define PW_KEY_METADATA_VALUES          "metadata.values"

 
#ifdef __cplusplus
}  /* extern "C" */
#endif
 
#endif /* PIPEWIRE_EXT_METADATA_H */