|
| #define | PW_KEY_PROTOCOL "pipewire.protocol" |
| | protocol used for connection
|
| |
| #define | PW_KEY_ACCESS "pipewire.access" |
| | how the client access is controlled
|
| |
| #define | PW_KEY_CLIENT_ACCESS "pipewire.client.access |
| | how the client wants to be access controlled
|
| |
| #define | PW_KEY_SEC_PID "pipewire.sec.pid" |
| | Various keys related to the identity of a client process and its security.
|
| |
| #define | PW_KEY_SEC_UID "pipewire.sec.uid" |
| | Client uid, set by protocol.
|
| |
| #define | PW_KEY_SEC_GID "pipewire.sec.gid" |
| | client gid, set by protocol
|
| |
| #define | PW_KEY_SEC_LABEL "pipewire.sec.label" |
| | client security label, set by protocol
|
| |
| #define | PW_KEY_SEC_SOCKET "pipewire.sec.socket" |
| | client socket name, set by protocol
|
| |
| #define | PW_KEY_SEC_ENGINE "pipewire.sec.engine" |
| | client secure context engine, set by protocol.
|
| |
| #define | PW_KEY_SEC_APP_ID "pipewire.sec.app-id" |
| | client secure application id
|
| |
| #define | PW_KEY_SEC_INSTANCE_ID "pipewire.sec.instance-id" |
| | client secure instance id
|
| |
| #define | PW_KEY_LIBRARY_NAME_SYSTEM "library.name.system" |
| | name of the system library to use
|
| |
| #define | PW_KEY_LIBRARY_NAME_LOOP "library.name.loop" |
| | name of the loop library to use
|
| |
| #define | PW_KEY_LIBRARY_NAME_DBUS "library.name.dbus" |
| | name of the dbus library to use
|
| |
| #define | PW_KEY_OBJECT_PATH "object.path" |
| | object properties
|
| |
| #define | PW_KEY_OBJECT_ID "object.id" |
| | a global object id
|
| |
| #define | PW_KEY_OBJECT_SERIAL "object.serial" |
| | a 64 bit object serial number.
|
| |
| #define | PW_KEY_OBJECT_LINGER "object.linger" |
| | the object lives on even after the client that created it has been destroyed
|
| |
| #define | PW_KEY_OBJECT_REGISTER "object.register" |
| | If the object should be registered.
|
| |
| #define | PW_KEY_OBJECT_EXPORT "object.export" |
| | If the object should be exported, since 0.3.72.
|
| |
| #define | PW_KEY_CONFIG_PREFIX "config.prefix" |
| | a config prefix directory
|
| |
| #define | PW_KEY_CONFIG_NAME "config.name" |
| | a config file name
|
| |
| #define | PW_KEY_CONFIG_OVERRIDE_PREFIX "config.override.prefix" |
| | a config override prefix directory
|
| |
| #define | PW_KEY_CONFIG_OVERRIDE_NAME "config.override.name" |
| | a config override file name
|
| |
| #define | PW_KEY_LOOP_NAME "loop.name" |
| | the name of a loop
|
| |
| #define | PW_KEY_LOOP_CLASS "loop.class" |
| | the classes this loop handles, array of strings
|
| |
| #define | PW_KEY_LOOP_RT_PRIO "loop.rt-prio" |
| | realtime priority of the loop
|
| |
| #define | PW_KEY_LOOP_CANCEL "loop.cancel" |
| | if the loop can be canceled
|
| |
| #define | PW_KEY_CONTEXT_PROFILE_MODULES "context.profile.modules" |
| | a context profile for modules, deprecated
|
| |
| #define | PW_KEY_USER_NAME "context.user-name" |
| | The user name that runs pipewire.
|
| |
| #define | PW_KEY_HOST_NAME "context.host-name" |
| | The host name of the machine.
|
| |
| #define | PW_KEY_CORE_NAME "core.name" |
| | The name of the core.
|
| |
| #define | PW_KEY_CORE_VERSION "core.version" |
| | The version of the core.
|
| |
| #define | PW_KEY_CORE_DAEMON "core.daemon" |
| | If the core is listening for connections.
|
| |
| #define | PW_KEY_CORE_ID "core.id" |
| | the core id
|
| |
| #define | PW_KEY_CORE_MONITORS "core.monitors" |
| | the apis monitored by core.
|
| |
| #define | PW_KEY_CPU_MAX_ALIGN "cpu.max-align" |
| | maximum alignment needed to support all CPU optimizations
|
| |
| #define | PW_KEY_CPU_CORES "cpu.cores" |
| | number of cores
|
| |
| #define | PW_KEY_PRIORITY_SESSION "priority.session" |
| | priority in session manager
|
| |
| #define | PW_KEY_PRIORITY_DRIVER "priority.driver" |
| | priority to be a driver
|
| |
| #define | PW_KEY_REMOTE_NAME "remote.name" |
| | The name of the remote to connect to, default pipewire-0, overwritten by env(PIPEWIRE_REMOTE).
|
| |
| #define | PW_KEY_REMOTE_INTENTION "remote.intention" |
| | The intention of the remote connection, "generic", "screencast", "manager".
|
| |
| #define | PW_KEY_APP_NAME "application.name" |
| | application keys
|
| |
| #define | PW_KEY_APP_ID "application.id" |
| | a textual id for identifying an application logically.
|
| |
| #define | PW_KEY_APP_VERSION "application.version" |
| | application version.
|
| |
| #define | PW_KEY_APP_ICON "application.icon" |
| | aa base64 blob with PNG image data
|
| |
| #define | PW_KEY_APP_ICON_NAME "application.icon-name" |
| | an XDG icon name for the application.
|
| |
| #define | PW_KEY_APP_LANGUAGE "application.language" |
| | application language if applicable, in standard POSIX format.
|
| |
| #define | PW_KEY_APP_PROCESS_ID "application.process.id" |
| | process id (pid)
|
| |
| #define | PW_KEY_APP_PROCESS_BINARY "application.process.binary" |
| | binary name
|
| |
| #define | PW_KEY_APP_PROCESS_USER "application.process.user" |
| | user name
|
| |
| #define | PW_KEY_APP_PROCESS_HOST "application.process.host" |
| | host name
|
| |
| #define | PW_KEY_APP_PROCESS_MACHINE_ID "application.process.machine-id" |
| | the D-Bus host id the application runs on
|
| |
| #define | PW_KEY_APP_PROCESS_SESSION_ID "application.process.session-id" |
| | login session of the application, on Unix the value of $XDG_SESSION_ID.
|
| |
| #define | PW_KEY_WINDOW_X11_DISPLAY "window.x11.display" |
| | window system
|
| |
| #define | PW_KEY_CLIENT_ID "client.id" |
| | Client properties.
|
| |
| #define | PW_KEY_CLIENT_NAME "client.name" |
| | the client name
|
| |
| #define | PW_KEY_CLIENT_API "client.api" |
| | the client api used to access PipeWire
|
| |
| #define | PW_KEY_NODE_ID "node.id" |
| | Node keys.
|
| |
| #define | PW_KEY_NODE_NAME "node.name" |
| | node name
|
| |
| #define | PW_KEY_NODE_NICK "node.nick" |
| | short node name
|
| |
| #define | PW_KEY_NODE_DESCRIPTION "node.description" |
| | localized human readable node one-line description.
|
| |
| #define | PW_KEY_NODE_PLUGGED "node.plugged" |
| | when the node was created.
|
| |
| #define | PW_KEY_NODE_SESSION "node.session" |
| | the session id this node is part of
|
| |
| #define | PW_KEY_NODE_GROUP "node.group" |
| | the group id this node is part of.
|
| |
| #define | PW_KEY_NODE_SYNC_GROUP "node.sync-group" |
| | the sync group this node is part of.
|
| |
| #define | PW_KEY_NODE_SYNC "node.sync" |
| | if the sync-group is active or not
|
| |
| #define | PW_KEY_NODE_TRANSPORT "node.transport" |
| | if the transport is active or not
|
| |
| #define | PW_KEY_NODE_EXCLUSIVE "node.exclusive" |
| | node wants exclusive access to resources
|
| |
| #define | PW_KEY_NODE_AUTOCONNECT "node.autoconnect" |
| | node wants to be automatically connected to a compatible node
|
| |
| #define | PW_KEY_NODE_LATENCY "node.latency" |
| | the requested latency of the node as a fraction.
|
| |
| #define | PW_KEY_NODE_MAX_LATENCY "node.max-latency" |
| | the maximum supported latency of the node as a fraction.
|
| |
| #define | PW_KEY_NODE_LOCK_QUANTUM "node.lock-quantum" |
| | don't change quantum when this node is active
|
| |
| #define | PW_KEY_NODE_FORCE_QUANTUM "node.force-quantum" |
| | force a quantum while the node is active
|
| |
| #define | PW_KEY_NODE_RATE "node.rate" |
| | the requested rate of the graph as a fraction.
|
| |
| #define | PW_KEY_NODE_LOCK_RATE "node.lock-rate" |
| | don't change rate when this node is active
|
| |
| #define | PW_KEY_NODE_FORCE_RATE "node.force-rate" |
| | force a rate while the node is active.
|
| |
| #define | PW_KEY_NODE_DONT_RECONNECT "node.dont-reconnect" |
| | don't reconnect this node.
|
| |
| #define | PW_KEY_NODE_ALWAYS_PROCESS "node.always-process" |
| | process even when unlinked
|
| |
| #define | PW_KEY_NODE_WANT_DRIVER "node.want-driver" |
| | the node wants to be grouped with a driver node in order to schedule the graph.
|
| |
| #define | PW_KEY_NODE_PAUSE_ON_IDLE "node.pause-on-idle" |
| | pause the node when idle
|
| |
| #define | PW_KEY_NODE_SUSPEND_ON_IDLE "node.suspend-on-idle" |
| | suspend the node when idle
|
| |
| #define | PW_KEY_NODE_CACHE_PARAMS "node.cache-params" |
| | cache the node params
|
| |
| #define | PW_KEY_NODE_TRANSPORT_SYNC "node.transport.sync" |
| | the node handles transport sync
|
| |
| #define | PW_KEY_NODE_DRIVER "node.driver" |
| | node can drive the graph.
|
| |
| #define | PW_KEY_NODE_SUPPORTS_LAZY "node.supports-lazy" |
| | the node can be a lazy driver.
|
| |
| #define | PW_KEY_NODE_SUPPORTS_REQUEST "node.supports-request" |
| | The node supports emiting RequestProcess events when it wants the graph to be scheduled.
|
| |
| #define | PW_KEY_NODE_DRIVER_ID "node.driver-id" |
| | the node id of the node assigned as driver for this node
|
| |
| #define | PW_KEY_NODE_ASYNC "node.async" |
| | the node wants async scheduling
|
| |
| #define | PW_KEY_NODE_LOOP_NAME "node.loop.name" |
| | the loop name fnmatch pattern to run in
|
| |
| #define | PW_KEY_NODE_LOOP_CLASS "node.loop.class" |
| | the loop class fnmatch pattern to run in
|
| |
| #define | PW_KEY_NODE_STREAM "node.stream" |
| | node is a stream, the server side should add a converter
|
| |
| #define | PW_KEY_NODE_VIRTUAL "node.virtual" |
| | the node is some sort of virtual object
|
| |
| #define | PW_KEY_NODE_PASSIVE "node.passive" |
| | indicate that a node wants passive links on output/input/all ports when the value is "out"/"in"/"true" respectively
|
| |
| #define | PW_KEY_NODE_LINK_GROUP "node.link-group" |
| | the node is internally linked to nodes with the same link-group.
|
| |
| #define | PW_KEY_NODE_NETWORK "node.network" |
| | the node is on a network
|
| |
| #define | PW_KEY_NODE_TRIGGER "node.trigger" |
| | the node is not scheduled automatically based on the dependencies in the graph but it will be triggered explicitly.
|
| |
| #define | PW_KEY_NODE_CHANNELNAMES "node.channel-names" |
| | names of node's channels (unrelated to positions)
|
| |
| #define | PW_KEY_NODE_DEVICE_PORT_NAME_PREFIX "node.device-port-name-prefix" |
| | override port name prefix for device ports, like capture and playback or disable the prefix completely if an empty string is provided
|
| |
| #define | PW_KEY_PORT_ID "port.id" |
| | Port keys.
|
| |
| #define | PW_KEY_PORT_NAME "port.name" |
| | port name
|
| |
| #define | PW_KEY_PORT_DIRECTION "port.direction" |
| | the port direction, one of "in" or "out" or "control" and "notify" for control ports
|
| |
| #define | PW_KEY_PORT_ALIAS "port.alias" |
| | port alias
|
| |
| #define | PW_KEY_PORT_PHYSICAL "port.physical" |
| | if this is a physical port
|
| |
| #define | PW_KEY_PORT_TERMINAL "port.terminal" |
| | if this port consumes the data
|
| |
| #define | PW_KEY_PORT_CONTROL "port.control" |
| | if this port is a control port
|
| |
| #define | PW_KEY_PORT_MONITOR "port.monitor" |
| | if this port is a monitor port
|
| |
| #define | PW_KEY_PORT_CACHE_PARAMS "port.cache-params" |
| | cache the node port params
|
| |
| #define | PW_KEY_PORT_EXTRA "port.extra" |
| | api specific extra port info, API name should be prefixed.
|
| |
| #define | PW_KEY_PORT_PASSIVE "port.passive" |