Module libpulse_binding::proplist::properties

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".
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_WANT in 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_WANT is 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 that FILTER_WANT is 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 channelmap::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 sample::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_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_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_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".