pipewire/html/src_2pipewire_2keys_8h_source.html

/* PipeWire */

/* SPDX-FileCopyrightText: Copyright © 2019 Wim Taymans */

/* SPDX-License-Identifier: MIT */


#ifndef PIPEWIRE_KEYS_H

#define PIPEWIRE_KEYS_H


#include <pipewire/utils.h>


#ifdef __cplusplus

extern "C" {

#endif


#define PW_KEY_PROTOCOL                 "pipewire.protocol"

#define PW_KEY_ACCESS                   "pipewire.access"

#define PW_KEY_CLIENT_ACCESS            "pipewire.client.access"


#define PW_KEY_SEC_PID                  "pipewire.sec.pid"

#define PW_KEY_SEC_UID                  "pipewire.sec.uid"

#define PW_KEY_SEC_GID                  "pipewire.sec.gid"

#define PW_KEY_SEC_LABEL                "pipewire.sec.label"


#define PW_KEY_SEC_SOCKET               "pipewire.sec.socket"


#define PW_KEY_SEC_ENGINE               "pipewire.sec.engine"

#define PW_KEY_SEC_APP_ID               "pipewire.sec.app-id"

#define PW_KEY_SEC_INSTANCE_ID          "pipewire.sec.instance-id"


#define PW_KEY_LIBRARY_NAME_SYSTEM      "library.name.system"

#define PW_KEY_LIBRARY_NAME_LOOP        "library.name.loop"

#define PW_KEY_LIBRARY_NAME_DBUS        "library.name.dbus"


#define PW_KEY_OBJECT_PATH              "object.path"

#define PW_KEY_OBJECT_ID                "object.id"

#define PW_KEY_OBJECT_SERIAL            "object.serial"

#define PW_KEY_OBJECT_LINGER            "object.linger"

#define PW_KEY_OBJECT_REGISTER          "object.register"

#define PW_KEY_OBJECT_EXPORT            "object.export"


/* config */

#define PW_KEY_CONFIG_PREFIX            "config.prefix"

#define PW_KEY_CONFIG_NAME              "config.name"

#define PW_KEY_CONFIG_OVERRIDE_PREFIX   "config.override.prefix"

#define PW_KEY_CONFIG_OVERRIDE_NAME     "config.override.name"


/* loop */

#define PW_KEY_LOOP_NAME                "loop.name"

#define PW_KEY_LOOP_CLASS               "loop.class"

#define PW_KEY_LOOP_RT_PRIO             "loop.rt-prio"

#define PW_KEY_LOOP_CANCEL              "loop.cancel"


/* context */

#define PW_KEY_CONTEXT_PROFILE_MODULES  "context.profile.modules"

#define PW_KEY_USER_NAME                "context.user-name"

#define PW_KEY_HOST_NAME                "context.host-name"


/* core */

#define PW_KEY_CORE_NAME                "core.name"

#define PW_KEY_CORE_VERSION             "core.version"

#define PW_KEY_CORE_DAEMON              "core.daemon"


#define PW_KEY_CORE_ID                  "core.id"

#define PW_KEY_CORE_MONITORS            "core.monitors"


/* cpu */

#define PW_KEY_CPU_MAX_ALIGN            "cpu.max-align"

#define PW_KEY_CPU_CORES                "cpu.cores"


/* priorities */

#define PW_KEY_PRIORITY_SESSION         "priority.session"

#define PW_KEY_PRIORITY_DRIVER          "priority.driver"


/* remote keys */

#define PW_KEY_REMOTE_NAME              "remote.name"

#define PW_KEY_REMOTE_INTENTION         "remote.intention"


#define PW_KEY_APP_NAME                 "application.name"

#define PW_KEY_APP_ID                   "application.id"

#define PW_KEY_APP_VERSION              "application.version"

#define PW_KEY_APP_ICON                 "application.icon"

#define PW_KEY_APP_ICON_NAME            "application.icon-name"

#define PW_KEY_APP_LANGUAGE             "application.language"


#define PW_KEY_APP_PROCESS_ID           "application.process.id"

#define PW_KEY_APP_PROCESS_BINARY       "application.process.binary"

#define PW_KEY_APP_PROCESS_USER         "application.process.user"

#define PW_KEY_APP_PROCESS_HOST         "application.process.host"

#define PW_KEY_APP_PROCESS_MACHINE_ID   "application.process.machine-id"

#define PW_KEY_APP_PROCESS_SESSION_ID   "application.process.session-id"

#define PW_KEY_WINDOW_X11_DISPLAY       "window.x11.display"


#define PW_KEY_CLIENT_ID                "client.id"

#define PW_KEY_CLIENT_NAME              "client.name"

#define PW_KEY_CLIENT_API               "client.api"


#define PW_KEY_NODE_ID                  "node.id"

#define PW_KEY_NODE_NAME                "node.name"

#define PW_KEY_NODE_NICK                "node.nick"

#define PW_KEY_NODE_DESCRIPTION         "node.description"

#define PW_KEY_NODE_PLUGGED             "node.plugged"


#define PW_KEY_NODE_SESSION             "node.session"

#define PW_KEY_NODE_GROUP               "node.group"

#define PW_KEY_NODE_SYNC_GROUP          "node.sync-group"

#define PW_KEY_NODE_SYNC                "node.sync"

#define PW_KEY_NODE_TRANSPORT           "node.transport"

#define PW_KEY_NODE_EXCLUSIVE           "node.exclusive"

#define PW_KEY_NODE_AUTOCONNECT         "node.autoconnect"

#define PW_KEY_NODE_LATENCY             "node.latency"

#define PW_KEY_NODE_MAX_LATENCY         "node.max-latency"

#define PW_KEY_NODE_LOCK_QUANTUM        "node.lock-quantum"

#define PW_KEY_NODE_FORCE_QUANTUM       "node.force-quantum"

#define PW_KEY_NODE_RATE                "node.rate"

#define PW_KEY_NODE_LOCK_RATE           "node.lock-rate"

#define PW_KEY_NODE_FORCE_RATE          "node.force-rate"


#define PW_KEY_NODE_DONT_RECONNECT      "node.dont-reconnect"

#define PW_KEY_NODE_ALWAYS_PROCESS      "node.always-process"

#define PW_KEY_NODE_WANT_DRIVER         "node.want-driver"

#define PW_KEY_NODE_PAUSE_ON_IDLE       "node.pause-on-idle"

#define PW_KEY_NODE_SUSPEND_ON_IDLE     "node.suspend-on-idle"

#define PW_KEY_NODE_CACHE_PARAMS        "node.cache-params"

#define PW_KEY_NODE_TRANSPORT_SYNC      "node.transport.sync"

#define PW_KEY_NODE_DRIVER              "node.driver"

#define PW_KEY_NODE_SUPPORTS_LAZY       "node.supports-lazy"

#define PW_KEY_NODE_SUPPORTS_REQUEST    "node.supports-request"

#define PW_KEY_NODE_DRIVER_ID           "node.driver-id"

#define PW_KEY_NODE_ASYNC               "node.async"

#define PW_KEY_NODE_LOOP_NAME           "node.loop.name"

#define PW_KEY_NODE_LOOP_CLASS          "node.loop.class"

#define PW_KEY_NODE_STREAM              "node.stream"

#define PW_KEY_NODE_VIRTUAL             "node.virtual"

#define PW_KEY_NODE_PASSIVE             "node.passive"

#define PW_KEY_NODE_LINK_GROUP          "node.link-group"

#define PW_KEY_NODE_NETWORK             "node.network"

#define PW_KEY_NODE_TRIGGER             "node.trigger"

#define PW_KEY_NODE_CHANNELNAMES        "node.channel-names"

#define PW_KEY_NODE_DEVICE_PORT_NAME_PREFIX     \

                                        "node.device-port-name-prefix"

#define PW_KEY_NODE_PHYSICAL            "node.physical"

#define PW_KEY_NODE_TERMINAL            "node.terminal"


#define PW_KEY_NODE_RELIABLE            "node.reliable"


#define PW_KEY_PORT_ID                  "port.id"

#define PW_KEY_PORT_NAME                "port.name"

#define PW_KEY_PORT_DIRECTION           "port.direction"

#define PW_KEY_PORT_ALIAS               "port.alias"

#define PW_KEY_PORT_PHYSICAL            "port.physical"

#define PW_KEY_PORT_TERMINAL            "port.terminal"

#define PW_KEY_PORT_CONTROL             "port.control"

#define PW_KEY_PORT_MONITOR             "port.monitor"

#define PW_KEY_PORT_CACHE_PARAMS        "port.cache-params"

#define PW_KEY_PORT_EXTRA               "port.extra"

#define PW_KEY_PORT_PASSIVE             "port.passive"

#define PW_KEY_PORT_IGNORE_LATENCY      "port.ignore-latency"

#define PW_KEY_PORT_GROUP               "port.group"

#define PW_KEY_PORT_EXCLUSIVE           "port.exclusive"

#define PW_KEY_PORT_RELIABLE            "port.reliable"


#define PW_KEY_LINK_ID                  "link.id"

#define PW_KEY_LINK_INPUT_NODE          "link.input.node"

#define PW_KEY_LINK_INPUT_PORT          "link.input.port"

#define PW_KEY_LINK_OUTPUT_NODE         "link.output.node"

#define PW_KEY_LINK_OUTPUT_PORT         "link.output.port"

#define PW_KEY_LINK_PASSIVE             "link.passive"

#define PW_KEY_LINK_FEEDBACK            "link.feedback"

#define PW_KEY_LINK_ASYNC               "link.async"


#define PW_KEY_DEVICE_ID                "device.id"

#define PW_KEY_DEVICE_NAME              "device.name"

#define PW_KEY_DEVICE_PLUGGED           "device.plugged"

#define PW_KEY_DEVICE_NICK              "device.nick"

#define PW_KEY_DEVICE_STRING            "device.string"

#define PW_KEY_DEVICE_API               "device.api"

#define PW_KEY_DEVICE_DESCRIPTION       "device.description"

#define PW_KEY_DEVICE_BUS_PATH          "device.bus-path"

#define PW_KEY_DEVICE_SERIAL            "device.serial"

#define PW_KEY_DEVICE_VENDOR_ID         "device.vendor.id"

#define PW_KEY_DEVICE_VENDOR_NAME       "device.vendor.name"

#define PW_KEY_DEVICE_PRODUCT_ID        "device.product.id"

#define PW_KEY_DEVICE_PRODUCT_NAME      "device.product.name"

#define PW_KEY_DEVICE_CLASS             "device.class"

#define PW_KEY_DEVICE_FORM_FACTOR       "device.form-factor"

#define PW_KEY_DEVICE_BUS               "device.bus"

#define PW_KEY_DEVICE_SUBSYSTEM         "device.subsystem"

#define PW_KEY_DEVICE_SYSFS_PATH        "device.sysfs.path"

#define PW_KEY_DEVICE_ICON              "device.icon"

#define PW_KEY_DEVICE_ICON_NAME         "device.icon-name"

#define PW_KEY_DEVICE_INTENDED_ROLES    "device.intended-roles"

#define PW_KEY_DEVICE_CACHE_PARAMS      "device.cache-params"


#define PW_KEY_MODULE_ID                "module.id"

#define PW_KEY_MODULE_NAME              "module.name"

#define PW_KEY_MODULE_AUTHOR            "module.author"

#define PW_KEY_MODULE_DESCRIPTION       "module.description"

#define PW_KEY_MODULE_USAGE             "module.usage"

#define PW_KEY_MODULE_VERSION           "module.version"

#define PW_KEY_MODULE_DEPRECATED        "module.deprecated"


#define PW_KEY_FACTORY_ID               "factory.id"

#define PW_KEY_FACTORY_NAME             "factory.name"

#define PW_KEY_FACTORY_USAGE            "factory.usage"

#define PW_KEY_FACTORY_TYPE_NAME        "factory.type.name"

#define PW_KEY_FACTORY_TYPE_VERSION     "factory.type.version"


/** Stream properties */

#define PW_KEY_STREAM_IS_LIVE           "stream.is-live"


#define PW_KEY_STREAM_LATENCY_MIN       "stream.latency.min"

#define PW_KEY_STREAM_LATENCY_MAX       "stream.latency.max"

#define PW_KEY_STREAM_MONITOR           "stream.monitor"

#define PW_KEY_STREAM_DONT_REMIX        "stream.dont-remix"

#define PW_KEY_STREAM_CAPTURE_SINK      "stream.capture.sink"


#define PW_KEY_MEDIA_TYPE               "media.type"

#define PW_KEY_MEDIA_CATEGORY           "media.category"

#define PW_KEY_MEDIA_ROLE               "media.role"

#define PW_KEY_MEDIA_CLASS              "media.class"

#define PW_KEY_MEDIA_NAME               "media.name"

#define PW_KEY_MEDIA_TITLE              "media.title"

#define PW_KEY_MEDIA_ARTIST             "media.artist"

#define PW_KEY_MEDIA_ALBUM              "media.album"

#define PW_KEY_MEDIA_COPYRIGHT          "media.copyright"

#define PW_KEY_MEDIA_SOFTWARE           "media.software"

#define PW_KEY_MEDIA_LANGUAGE           "media.language"

#define PW_KEY_MEDIA_FILENAME           "media.filename"

#define PW_KEY_MEDIA_ICON               "media.icon"

#define PW_KEY_MEDIA_ICON_NAME          "media.icon-name"

#define PW_KEY_MEDIA_COMMENT            "media.comment"

#define PW_KEY_MEDIA_DATE               "media.date"

#define PW_KEY_MEDIA_FORMAT             "media.format"


#define PW_KEY_FORMAT_DSP               "format.dsp"

#define PW_KEY_AUDIO_CHANNEL            "audio.channel"

#define PW_KEY_AUDIO_RATE               "audio.rate"

#define PW_KEY_AUDIO_CHANNELS           "audio.channels"

#define PW_KEY_AUDIO_FORMAT             "audio.format"

#define PW_KEY_AUDIO_ALLOWED_RATES      "audio.allowed-rates"


#define PW_KEY_VIDEO_RATE               "video.framerate"

#define PW_KEY_VIDEO_FORMAT             "video.format"

#define PW_KEY_VIDEO_SIZE               "video.size"


#define PW_KEY_TARGET_OBJECT            "target.object"


#ifndef PW_REMOVE_DEPRECATED

# ifdef PW_ENABLE_DEPRECATED

#  define PW_KEY_PRIORITY_MASTER        "priority.master"

#  define PW_KEY_NODE_TARGET            "node.target"

#  define PW_KEY_LOOP_RETRY_TIMEOUT     "loop.retry-timeout"

# else

#  define PW_KEY_PRIORITY_MASTER        PW_DEPRECATED("priority.master")

#  define PW_KEY_NODE_TARGET            PW_DEPRECATED("node.target")

#  define PW_KEY_LOOP_RETRY_TIMEOUT     PW_DEPRECATED("loop.retry-timeout")

# endif /* PW_ENABLE_DEPRECATED */

#endif /* PW_REMOVE_DEPRECATED */


#ifdef __cplusplus

}

#endif


#endif /* PIPEWIRE_KEYS_H */

utils.h