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§
- how the client access is controlled
- aa base64 blob with PNG image data
- an XDG icon name for the application. Ex: “totem”
- a textual id for identifying an application logically. Ex: “org.gnome.Totem”
- application language if applicable, in standard POSIX format. Ex: “en_GB”
- application name. Ex: “Totem Music Player”
- binary name
- host name
- process id (pid)
- the D-Bus host id the application runs on
- login session of the application, on Unix the value of $XDG_SESSION_ID.
- user name
- application version. Ex: “1.2.0”
- an audio channel. Ex: “FL”
- number of audio channels
- an audio format. Ex: “S16LE”
- how the client wants to be access controlled Must be obtained from trusted sources by the protocol and placed as read-only properties.
- the client api used to access PipeWire
- a client id
- the client name
- a config file name
- a config prefix directory
- a context profile for modules, deprecated
- If the core is listening for connections.
- the core id
- the apis monitored by core.
- The name of the core. Default is
pipewire-<username>-<pid>, overwritten by env(PIPEWIRE_CORE) - The version of the core.
- number of cores
- maximum alignment needed to support all CPU optimizations
- API this device is accessed with. Ex. “alsa”, “v4l2”
- bus of the device if applicable. One of “isa”, “pci”, “usb”, “firewire”, “bluetooth”
- bus path to the device in the OS’ format. Ex. “pci-0000:00:14.0-usb-0:3.2:1.0”
- cache the device spa params
- device class
- localized human readable device one-line description. Ex. “Foobar USB Headset”
- form factor if applicable. One of “internal”, “speaker”, “handset”, “tv”, “webcam”, “microphone”, “headset”, “headphone”, “hands-free”, “car”, “hifi”, “computer”, “portable”
- icon for the device. A base64 blob containing PNG image data
- an XDG icon name for the device. Ex. “sound-card-speakers-usb”
- device id
- 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
- a short device nickname
- when the device was created. As a uint64 in nanoseconds.
- product ID if applicable
- product name if applicable
- Serial number if applicable
- device string in the underlying layer’s format. Ex. “surround51:0”
- device subsystem
- vendor ID if applicable
- vendor name if applicable
- the factory id
- the name of the factory
- the name of the type created by a factory
- the version of the type created by a factory
- the usage of the factory
- a dsp format. Ex: “32 bit float mono audio”
- The host name of the machine
- name of the dbus library to use
- name of the loop library to use
- name of the system library to use
- indicate that a link is a feedback link and the target will receive data in the next cycle
- a link id
- input node id of a link
- input port id of a link
- output node id of a link
- output port id of a link
- indicate that a link is passive and does not cause the graph to be runnable.
- artist. Ex: “Pink Floyd”
- Media Category: Playback, Capture, Duplex, Monitor, Manager
- class Ex: “Video/Source”
- extra comment
- copyright string
- date of the media
- filename
- format of the media
- icon for the media, a base64 blob with PNG image data
- an XDG icon name for the media. Ex: “audio-x-mp3”
- language in POSIX format. Ex: en_GB
- media name. Ex: “Pink Floyd: Time”
- Role: Movie, Music, Camera, Screen, Communication, Game, Notification, DSP, Production, Accessibility, Test
- generator software
- title. Ex: “Time”
- Media type, one of Audio, Video, Midi
- the author’s name
- a human readable one-line description of the module’s purpose.
- the module id
- the name of the module
- a human readable usage description of the module’s arguments.
- a version string for the module.
- process even when unlinked
- node wants to be automatically connected to a compatible node
- cache the node params
- localized human readable node one-line description. Ex. “Foobar USB Headset”
- 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 can drive the graph
- node wants exclusive access to resources
- the group id this node is part of. Nodes in the same group are always scheduled with the same driver.
- node id
- the requested latency of the node as a fraction. Ex: 128/48000
- the maximum supported latency of the node as a fraction. Ex: 1024/48000
- node name
- short node name
- indicate that a node wants passive links on output/input/all ports when the value is “out”/“in”/“true” respectively
- pause the node when idle
- when the node was created. As a uint64 in nanoseconds.
- the session id this node is part of
- node is a stream, the server side should add a converter
- the node is some sort of virtual object
- a global object id
- the object lives on even after the client that created it has been destroyed
- unique path to construct the object
- port alias
- cache the node port params
- if this port is a control port
- the port direction, one of “in” or “out” or “control” and “notify” for control ports
- api specific extra port info, API name should be prefixed. “jack:flags:56”
- port id
- if this port is a monitor port
- port name
- if this is a physical port
- if this port consumes the data
- priority to be a driver
- priority in session manager
- protocol used for connection
- The intention of the remote connection, “generic”, “screencast”
- The name of the remote to connect to, default pipewire-0, overwritten by env(PIPEWIRE_REMOTE)
- client gid, set by protocol
- client security label, set by protocol
- Client pid, set by protocol
- Client uid, set by protocol
- Try to capture the sink output instead of source output
- don’t remix channels
- Indicates that the stream is live.
- The maximum latency of the stream
- The minimum latency of the stream.
- Indicates that the stream is monitoring and might select a less accurate but faster conversion algorithm.
- The user name that runs pipewire
- a video format
- a video framerate
- a video size as “<width>x<height>”
- the X11 display string. Ex. “:0.0”