Expand description
A collection of keys that are used to add extra information on objects.
use pipewire::properties::properties;
let props = properties! {
*pipewire::keys::REMOTE_NAME => "pipewire-0"
};Statics§
- ACCESS
- how the client access is controlled
- APP_
ICON - aa base64 blob with PNG image data
- APP_
ICON_ NAME - an XDG icon name for the application. Ex: “totem”
- APP_ID
- a textual id for identifying an application logically. Ex: “org.gnome.Totem”
- APP_
LANGUAGE - application language if applicable, in standard POSIX format. Ex: “en_GB”
- APP_
NAME - application name. Ex: “Totem Music Player”
- APP_
PROCESS_ BINARY - binary name
- APP_
PROCESS_ HOST - host name
- APP_
PROCESS_ ID - process id (pid)
- APP_
PROCESS_ MACHINE_ ID - the D-Bus host id the application runs on
- APP_
PROCESS_ SESSION_ ID - login session of the application, on Unix the value of $XDG_SESSION_ID.
- APP_
PROCESS_ USER - user name
- APP_
VERSION - application version. Ex: “1.2.0”
- AUDIO_
CHANNEL - an audio channel. Ex: “FL”
- AUDIO_
CHANNELS - number of audio channels
- AUDIO_
FORMAT - an audio format. Ex: “S16LE”
- CLIENT_
ACCESS - how the client wants to be access controlled Must be obtained from trusted sources by the protocol and placed as read-only properties.
- CLIENT_
API - the client api used to access PipeWire
- CLIENT_
ID - a client id
- CLIENT_
NAME - the client name
- CONFIG_
NAME - a config file name
- CONFIG_
PREFIX - a config prefix directory
- CONTEXT_
PROFILE_ MODULES - a context profile for modules, deprecated
- CORE_
DAEMON - If the core is listening for connections.
- CORE_ID
- the core id
- CORE_
MONITORS - the apis monitored by core.
- CORE_
NAME - The name of the core. Default is
pipewire-<username>-<pid>, overwritten by env(PIPEWIRE_CORE) - CORE_
VERSION - The version of the core.
- CPU_
CORES - number of cores
- CPU_
MAX_ ALIGN - maximum alignment needed to support all CPU optimizations
- DEVICE_
API - API this device is accessed with. Ex. “alsa”, “v4l2”
- DEVICE_
BUS - bus of the device if applicable. One of “isa”, “pci”, “usb”, “firewire”, “bluetooth”
- DEVICE_
BUS_ PATH - bus path to the device in the OS’ format. Ex. “pci-0000:00:14.0-usb-0:3.2:1.0”
- DEVICE_
CACHE_ PARAMS - cache the device spa params
- DEVICE_
CLASS - device class
- DEVICE_
DESCRIPTION - localized human readable device one-line description. Ex. “Foobar USB Headset”
- DEVICE_
FORM_ FACTOR - form factor if applicable. One of “internal”, “speaker”, “handset”, “tv”, “webcam”, “microphone”, “headset”, “headphone”, “hands-free”, “car”, “hifi”, “computer”, “portable”
- DEVICE_
ICON - icon for the device. A base64 blob containing PNG image data
- DEVICE_
ICON_ NAME - an XDG icon name for the device. Ex. “sound-card-speakers-usb”
- DEVICE_
ID - device id
- DEVICE_
INTENDED_ ROLES - intended use. A space separated list of roles (see PW_KEY_MEDIA_ROLE) this device is particularly well suited for, due to latency, quality or form factor.
- DEVICE_
NAME - device name
- DEVICE_
NICK - a short device nickname
- DEVICE_
PLUGGED - when the device was created. As a uint64 in nanoseconds.
- DEVICE_
PRODUCT_ ID - product ID if applicable
- DEVICE_
PRODUCT_ NAME - product name if applicable
- DEVICE_
SERIAL - Serial number if applicable
- DEVICE_
STRING - device string in the underlying layer’s format. Ex. “surround51:0”
- DEVICE_
SUBSYSTEM - device subsystem
- DEVICE_
VENDOR_ ID - vendor ID if applicable
- DEVICE_
VENDOR_ NAME - vendor name if applicable
- FACTORY_
ID - the factory id
- FACTORY_
NAME - the name of the factory
- FACTORY_
TYPE_ NAME - the name of the type created by a factory
- FACTORY_
TYPE_ VERSION - the version of the type created by a factory
- FACTORY_
USAGE - the usage of the factory
- FORMAT_
DSP - a dsp format. Ex: “32 bit float mono audio”
- HOST_
NAME - The host name of the machine
- LIBRARY_
NAME_ DBUS - name of the dbus library to use
- LIBRARY_
NAME_ LOOP - name of the loop library to use
- LIBRARY_
NAME_ SYSTEM - name of the system library to use
- LINK_
FEEDBACK - indicate that a link is a feedback link and the target will receive data in the next cycle
- LINK_ID
- a link id
- LINK_
INPUT_ NODE - input node id of a link
- LINK_
INPUT_ PORT - input port id of a link
- LINK_
OUTPUT_ NODE - output node id of a link
- LINK_
OUTPUT_ PORT - output port id of a link
- LINK_
PASSIVE - indicate that a link is passive and does not cause the graph to be runnable.
- MEDIA_
ARTIST - artist. Ex: “Pink Floyd”
- MEDIA_
CATEGORY - Media Category: Playback, Capture, Duplex, Monitor, Manager
- MEDIA_
CLASS - class Ex: “Video/Source”
- MEDIA_
COMMENT - extra comment
- MEDIA_
COPYRIGHT - copyright string
- MEDIA_
DATE - date of the media
- MEDIA_
FILENAME - filename
- MEDIA_
FORMAT - format of the media
- MEDIA_
ICON - icon for the media, a base64 blob with PNG image data
- MEDIA_
ICON_ NAME - an XDG icon name for the media. Ex: “audio-x-mp3”
- MEDIA_
LANGUAGE - language in POSIX format. Ex: en_GB
- MEDIA_
NAME - media name. Ex: “Pink Floyd: Time”
- MEDIA_
ROLE - Role: Movie, Music, Camera, Screen, Communication, Game, Notification, DSP, Production, Accessibility, Test
- MEDIA_
SOFTWARE - generator software
- MEDIA_
TITLE - title. Ex: “Time”
- MEDIA_
TYPE - Media type, one of Audio, Video, Midi
- MODULE_
AUTHOR - the author’s name
- MODULE_
DESCRIPTION - a human readable one-line description of the module’s purpose.
- MODULE_
ID - the module id
- MODULE_
NAME - the name of the module
- MODULE_
USAGE - a human readable usage description of the module’s arguments.
- MODULE_
VERSION - a version string for the module.
- NODE_
ALWAYS_ PROCESS - process even when unlinked
- NODE_
AUTOCONNECT - node wants to be automatically connected to a compatible node
- NODE_
CACHE_ PARAMS - cache the node params
- NODE_
DESCRIPTION - localized human readable node one-line description. Ex. “Foobar USB Headset”
- NODE_
DONT_ RECONNECT - don’t reconnect this node. The node is initially linked to target.object or the default node. If the target is removed, the node is destroyed
- NODE_
DRIVER - node can drive the graph
- NODE_
EXCLUSIVE - node wants exclusive access to resources
- NODE_
GROUP - the group id this node is part of. Nodes in the same group are always scheduled with the same driver.
- NODE_ID
- node id
- NODE_
LATENCY - the requested latency of the node as a fraction. Ex: 128/48000
- NODE_
MAX_ LATENCY - the maximum supported latency of the node as a fraction. Ex: 1024/48000
- NODE_
NAME - node name
- NODE_
NICK - short node name
- NODE_
PASSIVE - indicate that a node wants passive links on output/input/all ports when the value is “out”/“in”/“true” respectively
- NODE_
PAUSE_ ON_ IDLE - pause the node when idle
- NODE_
PLUGGED - when the node was created. As a uint64 in nanoseconds.
- NODE_
SESSION - the session id this node is part of
- NODE_
STREAM - node is a stream, the server side should add a converter
- NODE_
VIRTUAL - the node is some sort of virtual object
- OBJECT_
ID - a global object id
- OBJECT_
LINGER - the object lives on even after the client that created it has been destroyed
- OBJECT_
PATH - unique path to construct the object
- PORT_
ALIAS - port alias
- PORT_
CACHE_ PARAMS - cache the node port params
- PORT_
CONTROL - if this port is a control port
- PORT_
DIRECTION - the port direction, one of “in” or “out” or “control” and “notify” for control ports
- PORT_
EXTRA - api specific extra port info, API name should be prefixed. “jack:flags:56”
- PORT_ID
- port id
- PORT_
MONITOR - if this port is a monitor port
- PORT_
NAME - port name
- PORT_
PHYSICAL - if this is a physical port
- PORT_
TERMINAL - if this port consumes the data
- PRIORITY_
DRIVER - priority to be a driver
- PRIORITY_
SESSION - priority in session manager
- PROTOCOL
- protocol used for connection
- REMOTE_
INTENTION - The intention of the remote connection, “generic”, “screencast”
- REMOTE_
NAME - The name of the remote to connect to, default pipewire-0, overwritten by env(PIPEWIRE_REMOTE)
- SEC_GID
- client gid, set by protocol
- SEC_
LABEL - client security label, set by protocol
- SEC_PID
- Client pid, set by protocol
- SEC_UID
- Client uid, set by protocol
- STREAM_
CAPTURE_ SINK - Try to capture the sink output instead of source output
- STREAM_
DONT_ REMIX - don’t remix channels
- STREAM_
IS_ LIVE - Indicates that the stream is live.
- STREAM_
LATENCY_ MAX - The maximum latency of the stream
- STREAM_
LATENCY_ MIN - The minimum latency of the stream.
- STREAM_
MONITOR - Indicates that the stream is monitoring and might select a less accurate but faster conversion algorithm.
- USER_
NAME - The user name that runs pipewire
- VIDEO_
FORMAT - a video format
- VIDEO_
RATE - a video framerate
- VIDEO_
SIZE - a video size as “<width>x<height>”
- WINDOW_
X11_ DISPLAY - the X11 display string. Ex. “:0.0”