proplist.h

Go to the documentation of this file.

#ifndef foopulseproplisthfoo
#define foopulseproplisthfoo
 
/***
  This file is part of PulseAudio.
 
  Copyright 2007 Lennart Poettering
 
  PulseAudio is free software; you can redistribute it and/or modify
  it under the terms of the GNU Lesser General Public License as
  published by the Free Software Foundation; either version 2.1 of the
  License, or (at your option) any later version.
 
  PulseAudio is distributed in the hope that it will be useful, but
  WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  Lesser General Public License for more details.
 
  You should have received a copy of the GNU Lesser General Public
  License along with PulseAudio; if not, see <http://www.gnu.org/licenses/>.
***/
 
#include <sys/types.h>
 
#include <pulse/cdecl.h>
#include <pulse/gccmacro.h>
#include <pulse/version.h>
 
PA_C_DECL_BEGIN
 
#define PA_PROP_MEDIA_NAME                     "media.name"
 
#define PA_PROP_MEDIA_TITLE                    "media.title"
 
#define PA_PROP_MEDIA_ARTIST                   "media.artist"
 
#define PA_PROP_MEDIA_COPYRIGHT                "media.copyright"
 
#define PA_PROP_MEDIA_SOFTWARE                 "media.software"
 
#define PA_PROP_MEDIA_LANGUAGE                 "media.language"
 
#define PA_PROP_MEDIA_FILENAME                 "media.filename"
 
#define PA_PROP_MEDIA_ICON                     "media.icon"
#define PA_PROP_MEDIA_ICON_NAME                "media.icon_name"
 
#define PA_PROP_MEDIA_ROLE                     "media.role"
 
#define PA_PROP_FILTER_WANT                    "filter.want"
 
#define PA_PROP_FILTER_APPLY                   "filter.apply"
 
#define PA_PROP_FILTER_SUPPRESS                "filter.suppress"
 
#define PA_PROP_EVENT_ID                       "event.id"
 
#define PA_PROP_EVENT_DESCRIPTION              "event.description"
 
#define PA_PROP_EVENT_MOUSE_X                  "event.mouse.x"
 
#define PA_PROP_EVENT_MOUSE_Y                  "event.mouse.y"
 
#define PA_PROP_EVENT_MOUSE_HPOS               "event.mouse.hpos"
 
#define PA_PROP_EVENT_MOUSE_VPOS               "event.mouse.vpos"
 
#define PA_PROP_EVENT_MOUSE_BUTTON             "event.mouse.button"
 
#define PA_PROP_WINDOW_NAME                    "window.name"
 
#define PA_PROP_WINDOW_ID                      "window.id"
 
#define PA_PROP_WINDOW_ICON                    "window.icon"
#define PA_PROP_WINDOW_ICON_NAME               "window.icon_name"
 
#define PA_PROP_WINDOW_X                       "window.x"
 
#define PA_PROP_WINDOW_Y                       "window.y"
 
#define PA_PROP_WINDOW_WIDTH                   "window.width"
 
#define PA_PROP_WINDOW_HEIGHT                  "window.height"
 
#define PA_PROP_WINDOW_HPOS                    "window.hpos"
 
#define PA_PROP_WINDOW_VPOS                    "window.vpos"
 
#define PA_PROP_WINDOW_DESKTOP                 "window.desktop"
 
#define PA_PROP_WINDOW_X11_DISPLAY             "window.x11.display"
 
#define PA_PROP_WINDOW_X11_SCREEN              "window.x11.screen"
 
#define PA_PROP_WINDOW_X11_MONITOR             "window.x11.monitor"
 
#define PA_PROP_WINDOW_X11_XID                 "window.x11.xid"
 
#define PA_PROP_APPLICATION_NAME               "application.name"
 
#define PA_PROP_APPLICATION_ID                 "application.id"
 
#define PA_PROP_APPLICATION_VERSION            "application.version"
 
#define PA_PROP_APPLICATION_ICON               "application.icon"
#define PA_PROP_APPLICATION_ICON_NAME          "application.icon_name"
 
#define PA_PROP_APPLICATION_LANGUAGE           "application.language"
 
#define PA_PROP_APPLICATION_PROCESS_ID         "application.process.id"
 
#define PA_PROP_APPLICATION_PROCESS_BINARY     "application.process.binary"
 
#define PA_PROP_APPLICATION_PROCESS_USER       "application.process.user"
 
#define PA_PROP_APPLICATION_PROCESS_HOST       "application.process.host"
 
#define PA_PROP_APPLICATION_PROCESS_MACHINE_ID "application.process.machine_id"
 
#define PA_PROP_APPLICATION_PROCESS_SESSION_ID "application.process.session_id"
 
#define PA_PROP_DEVICE_STRING                  "device.string"
 
#define PA_PROP_DEVICE_API                     "device.api"
 
#define PA_PROP_DEVICE_DESCRIPTION             "device.description"
 
#define PA_PROP_DEVICE_BUS_PATH                "device.bus_path"
 
#define PA_PROP_DEVICE_SERIAL                  "device.serial"
 
#define PA_PROP_DEVICE_VENDOR_ID               "device.vendor.id"
 
#define PA_PROP_DEVICE_VENDOR_NAME             "device.vendor.name"
 
#define PA_PROP_DEVICE_PRODUCT_ID              "device.product.id"
 
#define PA_PROP_DEVICE_PRODUCT_NAME            "device.product.name"
 
#define PA_PROP_DEVICE_CLASS                   "device.class"
 
#define PA_PROP_DEVICE_FORM_FACTOR             "device.form_factor"
 
#define PA_PROP_DEVICE_BUS                     "device.bus"
 
#define PA_PROP_DEVICE_ICON                    "device.icon"
#define PA_PROP_DEVICE_ICON_NAME               "device.icon_name"
 
#define PA_PROP_DEVICE_ACCESS_MODE             "device.access_mode"
 
#define PA_PROP_DEVICE_MASTER_DEVICE           "device.master_device"
 
#define PA_PROP_DEVICE_BUFFERING_BUFFER_SIZE   "device.buffering.buffer_size"
 
#define PA_PROP_DEVICE_BUFFERING_FRAGMENT_SIZE "device.buffering.fragment_size"
 
#define PA_PROP_DEVICE_PROFILE_NAME            "device.profile.name"
 
#define PA_PROP_DEVICE_INTENDED_ROLES          "device.intended_roles"
 
#define PA_PROP_DEVICE_PROFILE_DESCRIPTION     "device.profile.description"
 
#define PA_PROP_MODULE_AUTHOR                  "module.author"
 
#define PA_PROP_MODULE_DESCRIPTION             "module.description"
 
#define PA_PROP_MODULE_USAGE                   "module.usage"
 
#define PA_PROP_MODULE_VERSION                 "module.version"
 
#define PA_PROP_FORMAT_SAMPLE_FORMAT           "format.sample_format"
 
#define PA_PROP_FORMAT_RATE                    "format.rate"
 
#define PA_PROP_FORMAT_CHANNELS                "format.channels"
 
#define PA_PROP_FORMAT_CHANNEL_MAP             "format.channel_map"
 
#define PA_PROP_CONTEXT_FORCE_DISABLE_SHM      "context.force.disable.shm"
 
#define PA_PROP_BLUETOOTH_CODEC                "bluetooth.codec"
 
typedef struct pa_proplist pa_proplist;
 
pa_proplist* pa_proplist_new(void);
 
void pa_proplist_free(pa_proplist* p);
 
int pa_proplist_key_valid(const char *key);
 
int pa_proplist_sets(pa_proplist *p, const char *key, const char *value);
 
int pa_proplist_setp(pa_proplist *p, const char *pair);
 
int pa_proplist_setf(pa_proplist *p, const char *key, const char *format, ...) PA_GCC_PRINTF_ATTR(3,4);
 
int pa_proplist_set(pa_proplist *p, const char *key, const void *data, size_t nbytes);
 
const char *pa_proplist_gets(const pa_proplist *p, const char *key);
 
int pa_proplist_get(const pa_proplist *p, const char *key, const void **data, size_t *nbytes);
 
typedef enum pa_update_mode {
    PA_UPDATE_SET,
 
    PA_UPDATE_MERGE,
 
    PA_UPDATE_REPLACE
} pa_update_mode_t;
 
#define PA_UPDATE_SET PA_UPDATE_SET
#define PA_UPDATE_MERGE PA_UPDATE_MERGE
#define PA_UPDATE_REPLACE PA_UPDATE_REPLACE
void pa_proplist_update(pa_proplist *p, pa_update_mode_t mode, const pa_proplist *other);
 
int pa_proplist_unset(pa_proplist *p, const char *key);
 
int pa_proplist_unset_many(pa_proplist *p, const char * const keys[]);
 
const char *pa_proplist_iterate(const pa_proplist *p, void **state);
 
char *pa_proplist_to_string(const pa_proplist *p);
 
char *pa_proplist_to_string_sep(const pa_proplist *p, const char *sep);
 
pa_proplist *pa_proplist_from_string(const char *str);
 
int pa_proplist_contains(const pa_proplist *p, const char *key);
 
void pa_proplist_clear(pa_proplist *p);
 
pa_proplist* pa_proplist_copy(const pa_proplist *p);
 
unsigned pa_proplist_size(const pa_proplist *p);
 
int pa_proplist_isempty(const pa_proplist *p);
 
int pa_proplist_equal(const pa_proplist *a, const pa_proplist *b);
 
PA_C_DECL_END
 
#endif