Expand description
Common properties.
Constants§
- APPLICATION_
ICON - For clients/streams: application icon. A binary blob containing PNG image data.
- APPLICATION_
ICON_ NAME - For clients/streams: an XDG icon name for the application. E.g. “totem”.
- APPLICATION_
ID - For clients/streams: a textual id for identifying an application logically. E.g. “org.gnome.Totem”.
- APPLICATION_
LANGUAGE - For clients/streams: application language if applicable, in standard POSIX format. E.g. “de_DE”.
- APPLICATION_
NAME - For clients/streams: localized human readable application name. E.g. “Totem Music Player”.
- APPLICATION_
PROCESS_ BINARY - For clients/streams: application process name. E.g. “totem”.
- APPLICATION_
PROCESS_ HOST - For clients/streams: host name the application runs on. E.g. “omega”.
- APPLICATION_
PROCESS_ ID - For clients/streams on UNIX: application process PID, an integer formatted as string. E.g. “4711”.
- APPLICATION_
PROCESS_ MACHINE_ ID - For clients/streams: the D-Bus host id the application runs on. E.g. “543679e7b01393ed3e3e650047d78f6e”.
- APPLICATION_
PROCESS_ SESSION_ ID - For clients/streams: an id for the login session the application runs in. On Unix the value of $XDG_SESSION_ID. E.g. “5”.
- APPLICATION_
PROCESS_ USER - For clients/streams: application user name. E.g. “lennart”.
- APPLICATION_
VERSION - For clients/streams: a version string, e.g. “0.6.88”.
- BLUETOOTH_
CODEC pa_v15 - For a bluez device: the currently selected codec name.
- CONTEXT_
FORCE_ DISABLE_ SHM pa_v15 - For context: whether to forcefully disable data transfer via POSIX or memfd shared memory. This property overrides any other client configuration which would otherwise enable SHM communication channels.
- DEVICE_
ACCESS_ MODE - For devices: access mode of the device if applicable. One of “mmap”, “mmap_rewrite”, “serial”.
- DEVICE_
API - For devices: API this device is accessed with. E.g. “alsa”.
- DEVICE_
BUFFERING_ BUFFER_ SIZE - For devices: buffer size in bytes, integer formatted as string.
- DEVICE_
BUFFERING_ FRAGMENT_ SIZE - For devices: fragment size in bytes, integer formatted as string.
- DEVICE_
BUS - For devices: bus of the device if applicable. One of “isa”, “pci”, “usb”, “firewire”, “bluetooth”.
- DEVICE_
BUS_ PATH - For devices: bus path to the device in the OS’ format. E.g. “/sys/bus/pci/devices/0000:00:1f.2”.
- DEVICE_
CLASS - For devices: device class. One of “sound”, “modem”, “monitor”, “filter”.
- DEVICE_
DESCRIPTION - For devices: localized human readable device one-line description. E.g. “Foobar Industries USB Headset 2000+ Ultra”.
- DEVICE_
FORM_ FACTOR - For devices: form factor if applicable. One of “internal”, “speaker”, “handset”, “tv”, “webcam”, “microphone”, “headset”, “headphone”, “hands-free”, “car”, “hifi”, “computer”, “portable”.
- DEVICE_
ICON - For devices: icon for the device. A binary blob containing PNG image data.
- DEVICE_
ICON_ NAME - For devices: an XDG icon name for the device. E.g. “sound-card-speakers-usb”.
- DEVICE_
INTENDED_ ROLES - For devices: intended use. A space separated list of roles (see
MEDIA_ROLE) this device is particularly well suited for, due to latency, quality or form factor. - DEVICE_
MASTER_ DEVICE - For filter devices: master device id if applicable.
- DEVICE_
PRODUCT_ ID - For devices: product ID if applicable. E.g. 4565.
- DEVICE_
PRODUCT_ NAME - For devices: product name if applicable. E.g. “SuperSpeakers 2000 Pro”.
- DEVICE_
PROFILE_ DESCRIPTION - For devices: human readable one-line description of the profile this device is in. E.g. “Analog Stereo”, …
- DEVICE_
PROFILE_ NAME - For devices: profile identifier for the profile this devices is in. E.g. “analog-stereo”, “analog-surround-40”, “iec958-stereo”, …
- DEVICE_
SERIAL - For devices: serial number if applicable. E.g. “4711-0815-1234”.
- DEVICE_
STRING - For devices: device string in the underlying audio layer’s format. E.g. “surround51:0”.
- DEVICE_
VENDOR_ ID - For devices: vendor ID if applicable. E.g. 1274.
- DEVICE_
VENDOR_ NAME - For devices: vendor name if applicable. E.g. “Foocorp Heavy Industries”.
- EVENT_
DESCRIPTION - For event sound streams: localized human readable one-line description of the event, formatted as UTF-8. E.g. “Email from lennart@example.com received.”
- EVENT_
ID - For event sound streams: XDG event sound name. e.g. “message-new-email” (Event sound streams are those with media.role set to “event”).
- EVENT_
MOUSE_ BUTTON - For event sound streams: mouse button that triggered the event if applicable, integer formatted as string with 0=left, 1=middle, 2=right. E.g. “0”.
- EVENT_
MOUSE_ HPOS - For event sound streams: relative horizontal mouse position on the screen if the event sound was triggered by a mouse click, float formatted as text string, ranging from 0.0 (left side of the screen) to 1.0 (right side of the screen). E.g. “0.65”.
- EVENT_
MOUSE_ VPOS - For event sound streams: relative vertical mouse position on the screen if the event sound was triggered by a mouse click, float formatted as text string, ranging from 0.0 (top of the screen) to 1.0 (bottom of the screen). E.g. “0.43”.
- EVENT_
MOUSE_ X - For event sound streams: absolute horizontal mouse position on the screen if the event sound was triggered by a mouse click, integer formatted as text string. E.g. “865”.
- EVENT_
MOUSE_ Y - For event sound streams: absolute vertical mouse position on the screen if the event sound was triggered by a mouse click, integer formatted as text string. E.g. “432”.
- FILTER_
APPLY - For streams: the name of a filter that is desired, e.g. “echo-cancel” or “equalizer-sink”.
Differs from
FILTER_WANTin that it forces PulseAudio to apply the filter, regardless of whether PulseAudio thinks it makes sense to do so or not. If this is set,FILTER_WANTis ignored. In other words, you almost certainly do not want to use this. - FILTER_
SUPPRESS - For streams: the name of a filter that should specifically be suppressed (i.e. overrides
FILTER_WANT). Useful for the times thatFILTER_WANTis automatically added (e.g. echo-cancellation for phone streams when $VOIP_APP does its own, internal AEC). - FILTER_
WANT - For streams: the name of a filter that is desired, e.g. “echo-cancel” or “equalizer-sink”. PulseAudio may choose to not apply the filter if it does not make sense (for example, applying echo-cancellation on a Bluetooth headset probably does not make sense.
- FORMAT_
CHANNELS - For all formats: the number of channels (unsigned integer).
- FORMAT_
CHANNEL_ MAP - For PCM formats: the channel map of the stream as returned by
Map::print(). - FORMAT_
RATE - For all formats: the sample rate (unsigned integer).
- FORMAT_
SAMPLE_ FORMAT - For PCM formats: the sample format used as returned by
Format::to_string(). - MEDIA_
ARTIST - For streams: localized media artist if applicable, formatted as UTF-8. E.g. “Guns’N’Roses”.
- MEDIA_
COPYRIGHT - For streams: localized media copyright string if applicable, formatted as UTF-8. E.g. “Evil Record Corp.”.
- MEDIA_
FILENAME - For streams: source filename if applicable, in URI format or local path. E.g. “/home/lennart/music/foobar.ogg”.
- MEDIA_
ICON - For streams: icon for the media. A binary blob containing PNG image data.
- MEDIA_
ICON_ NAME - For streams: an XDG icon name for the media. E.g. “audio-x-mp3”.
- MEDIA_
LANGUAGE - For streams: media language if applicable, in standard POSIX format. E.g. “de_DE”.
- MEDIA_
NAME - For streams: localized media name, formatted as UTF-8. E.g. “Guns’N’Roses: Civil War”.
- MEDIA_
ROLE - For streams: logic role of this media. One of the strings “video”, “music”, “game”, “event”, “phone”, “animation”, “production”, “a11y”, “test”.
- MEDIA_
SOFTWARE - For streams: localized media generator software string if applicable, formatted as UTF-8. E.g. “Foocrop AudioFrobnicator”.
- MEDIA_
TITLE - For streams: localized media title if applicable, formatted as UTF-8. E.g. “Civil War”.
- MODULE_
AUTHOR - For modules: the author’s name, formatted as UTF-8 string. E.g. “Lennart Poettering”.
- MODULE_
DESCRIPTION - For modules: a human readable one-line description of the module’s purpose formatted as UTF-8. E.g. “Frobnicate sounds with a flux compensator”.
- MODULE_
USAGE - For modules: a human readable usage description of the module’s arguments formatted as UTF-8.
- MODULE_
VERSION - For modules: a version string for the module. E.g. “0.9.15”.
- WINDOW_
DESKTOP - For streams that belong to a window on the screen: if the windowing system supports multiple desktops, a comma separated list of indexes of the desktops this window is visible on. If this property is an empty string, it is visible on all desktops (i.e. ‘sticky’). The first desktop is zero. E.g. “0,2,3”.
- WINDOW_
HEIGHT - For streams that belong to a window on the screen: window height on the screen, integer formatted as text string. E.g. “643”.
- WINDOW_
HPOS - For streams that belong to a window on the screen: relative position of the window center on the screen, float formatted as text string, ranging from 0.0 (left side of the screen) to 1.0 (right side of the screen). E.g. “0.65”.
- WINDOW_
ICON - For streams that belong to a window on the screen: window icon. A binary blob containing PNG image data.
- WINDOW_
ICON_ NAME - For streams that belong to a window on the screen: an XDG icon name for the window. E.g. “totem”.
- WINDOW_
ID - For streams that belong to a window on the screen: a textual id for identifying a window logically. E.g. “org.gnome.Totem.MainWindow”.
- WINDOW_
NAME - For streams that belong to a window on the screen: localized window title. E.g. “Totem Music Player”.
- WINDOW_
VPOS - For streams that belong to a window on the screen: relative position of the window center on the screen, float formatted as text string, ranging from 0.0 (top of the screen) to 1.0 (bottom of the screen). E.g. “0.43”.
- WINDOW_
WIDTH - For streams that belong to a window on the screen: window width on the screen, integer formatted as text string. e.g. “365”.
- WINDOW_
X - For streams that belong to a window on the screen: absolute horizontal window position on the screen, integer formatted as text string. E.g. “865”.
- WINDOW_
X11_ DISPLAY - For streams that belong to an X11 window on the screen: the X11 display string. E.g. “:0.0”.
- WINDOW_
X11_ MONITOR - For streams that belong to an X11 window on the screen: the X11 monitor the window is on, an integer formatted as string. E.g. “0”.
- WINDOW_
X11_ SCREEN - For streams that belong to an X11 window on the screen: the X11 screen the window is on, an integer formatted as string. E.g. “0”.
- WINDOW_
X11_ XID - For streams that belong to an X11 window on the screen: the window XID, an integer formatted as string. E.g. “25632”.
- WINDOW_
Y - For streams that belong to a window on the screen: absolute vertical window position on the screen, integer formatted as text string. E.g. “343”.