pulse.proplist

Members

Aliases

pa_update_mode_t

alias pa_update_mode_t = pa_update_mode

Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.

Enums

pa_update_mode

enum pa_update_mode

Update mode enum for pa_proplist_update(). \since 0.9.11

Functions

pa_proplist_clear

void pa_proplist_clear(pa_proplist* p)

Remove all entries from the property list object. \since 0.9.11

pa_proplist_contains

int pa_proplist_contains(const(pa_proplist)* p, const(char)* key)

Returns 1 if an entry for the specified key exists in the * property list. Returns negative on error. \since 0.9.11

pa_proplist_copy

pa_proplist* pa_proplist_copy(const(pa_proplist)* p)

Allocate a new property list and copy over every single entry from * the specified list. \since 0.9.11

pa_proplist_equal

int pa_proplist_equal(const(pa_proplist)* a, const(pa_proplist)* b)

Return non-zero when a and b have the same keys and values. * \since 0.9.16

pa_proplist_free

void pa_proplist_free(pa_proplist* p)

Free the property list. \since 0.9.11

pa_proplist_from_string

pa_proplist* pa_proplist_from_string(const(char)* str)

Allocate a new property list and assign key/value from a human * readable string. \since 0.9.15

pa_proplist_get

int pa_proplist_get(const(pa_proplist)* p, const(char)* key, const(void*)* data, size_t* nbytes)

Store the value for the specified key in \a data. Will store a * NUL-terminated string for string entries. The \a data pointer returned will * point to an internally allocated buffer. The caller should make a * copy of the data before any subsequent modification or destruction * of the property list. * Returns zero on success, negative on error. \since 0.9.11

pa_proplist_gets

const(char)* pa_proplist_gets(const(pa_proplist)* p, const(char)* key)

Return a string entry for the specified key. Will return NULL if * the data is not valid UTF-8. Will return a NUL-terminated string in * an internally allocated buffer. The caller should make a copy of * the data before accessing the property list again. \since 0.9.11

pa_proplist_isempty

int pa_proplist_isempty(const(pa_proplist)* p)

Returns 0 when the proplist is empty, positive otherwise \since 0.9.15

pa_proplist_iterate

const(char)* pa_proplist_iterate(const(pa_proplist)* p, void** state)

Iterate through the property list. The user should allocate a * state variable of type void* and initialize it with NULL. A pointer * to this variable should then be passed to pa_proplist_iterate() * which should be called in a loop until it returns NULL which * signifies EOL. The property list should not be modified during * iteration through the list -- with the exception of deleting the * current entry. On each invocation this function will return the * key string for the next entry. The keys in the property list do not * have any particular order. \since 0.9.11

pa_proplist_key_valid

int pa_proplist_key_valid(const(char)* key)

Returns a non-zero value if the key is valid. \since 3.0

pa_proplist_new

pa_proplist* pa_proplist_new()

Allocate a property list. Free with pa_proplist_free. \since 0.9.11

pa_proplist_set

int pa_proplist_set(pa_proplist* p, const(char)* key, const(void)* data, size_t nbytes)

Append a new arbitrary data entry to the property list, possibly * overwriting an already existing entry with the same key. An * internal copy of the data passed is made. * Returns zero on success. \since 0.9.11

pa_proplist_setf

int pa_proplist_setf(pa_proplist* p, const(char)* key, const(char)* format, ...)

Append a new string entry to the property list, possibly * overwriting an already existing entry with the same key. An * internal copy of the data passed is made. Will accept only valid * UTF-8. The data can be passed as printf()-style format string with * arguments. Returns zero on success. \since 0.9.11

pa_proplist_setp

int pa_proplist_setp(pa_proplist* p, const(char)* pair)

Append a new string entry to the property list, possibly * overwriting an already existing entry with the same key. An * internal copy of the data passed is made. Will accept only valid * UTF-8. The string passed in must contain a '='. Left hand side of * the '=' is used as key name, the right hand side as string * data. Returns zero on success. \since 0.9.16

pa_proplist_sets

int pa_proplist_sets(pa_proplist* p, const(char)* key, const(char)* value)

Append a new string entry to the property list, possibly * overwriting an already existing entry with the same key. An * internal copy of the data passed is made. Will accept only valid * UTF-8. Returns zero on success. \since 0.9.11

pa_proplist_size

uint pa_proplist_size(const(pa_proplist)* p)

Return the number of entries in the property list. \since 0.9.15

pa_proplist_to_string

char* pa_proplist_to_string(const(pa_proplist)* p)

Format the property list nicely as a human readable string. This * works very much like pa_proplist_to_string_sep() and uses a newline * as separator and appends one final one. Call pa_xfree() on the * result. \since 0.9.11

pa_proplist_to_string_sep

char* pa_proplist_to_string_sep(const(pa_proplist)* p, const(char)* sep)

Format the property list nicely as a human readable string and * choose the separator. Call pa_xfree() on the result. \since * 0.9.15

pa_proplist_unset

int pa_proplist_unset(pa_proplist* p, const(char)* key)

Removes a single entry from the property list, identified be the * specified key name. Returns zero on success, negative on error. * \since 0.9.11

pa_proplist_unset_many

int pa_proplist_unset_many(pa_proplist* p, const(char*)* keys)

Similar to pa_proplist_unset() but takes an array of keys to * remove. The array should be terminated by a NULL pointer. Returns -1 * on failure, otherwise the number of entries actually removed (which * might even be 0, if there were no matching entries to * remove). \since 0.9.11

pa_proplist_update

void pa_proplist_update(pa_proplist* p, pa_update_mode_t mode, const(pa_proplist)* other)

Merge property list "other" into "p", adhering the merge mode as * specified in "mode". \since 0.9.11

Manifest constants

PA_PROP_APPLICATION_ICON

enum PA_PROP_APPLICATION_ICON;

For clients/streams: application icon. A binary blob containing PNG image data

PA_PROP_APPLICATION_ICON_NAME

enum PA_PROP_APPLICATION_ICON_NAME;

For clients/streams: an XDG icon name for the application. E.g. "totem"

PA_PROP_APPLICATION_ID

enum PA_PROP_APPLICATION_ID;

For clients/streams: a textual id for identifying an application logically. E.g. "org.gnome.Totem"

PA_PROP_APPLICATION_LANGUAGE

enum PA_PROP_APPLICATION_LANGUAGE;

For clients/streams: application language if applicable, in standard POSIX format. E.g. "de_DE"

PA_PROP_APPLICATION_NAME

enum PA_PROP_APPLICATION_NAME;

For clients/streams: localized human readable application name. E.g. "Totem Music Player"

PA_PROP_APPLICATION_PROCESS_BINARY

enum PA_PROP_APPLICATION_PROCESS_BINARY;

For clients/streams: application process name. E.g. "totem"

PA_PROP_APPLICATION_PROCESS_HOST

enum PA_PROP_APPLICATION_PROCESS_HOST;

For clients/streams: host name the application runs on. E.g. "omega"

PA_PROP_APPLICATION_PROCESS_ID

enum PA_PROP_APPLICATION_PROCESS_ID;

For clients/streams on UNIX: application process PID, an integer formatted as string. E.g. "4711"

PA_PROP_APPLICATION_PROCESS_MACHINE_ID

enum PA_PROP_APPLICATION_PROCESS_MACHINE_ID;

For clients/streams: the D-Bus host id the application runs on. E.g. "543679e7b01393ed3e3e650047d78f6e"

PA_PROP_APPLICATION_PROCESS_SESSION_ID

enum PA_PROP_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"

PA_PROP_APPLICATION_PROCESS_USER

enum PA_PROP_APPLICATION_PROCESS_USER;

For clients/streams: application user name. E.g. "lennart"

PA_PROP_APPLICATION_VERSION

enum PA_PROP_APPLICATION_VERSION;

For clients/streams: a version string, e.g.\ "0.6.88"

PA_PROP_BLUETOOTH_CODEC

enum PA_PROP_BLUETOOTH_CODEC;

For a bluez device: the currently selected codec name. \since 15.0

PA_PROP_CONTEXT_FORCE_DISABLE_SHM

enum PA_PROP_CONTEXT_FORCE_DISABLE_SHM;

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. \since 15.0

PA_PROP_DEVICE_ACCESS_MODE

enum PA_PROP_DEVICE_ACCESS_MODE;

For devices: access mode of the device if applicable. One of "mmap", "mmap_rewrite", "serial"

PA_PROP_DEVICE_API

enum PA_PROP_DEVICE_API;

For devices: API this device is access with. E.g. "alsa"

PA_PROP_DEVICE_BUFFERING_BUFFER_SIZE

enum PA_PROP_DEVICE_BUFFERING_BUFFER_SIZE;

For devices: buffer size in bytes, integer formatted as string.

PA_PROP_DEVICE_BUFFERING_FRAGMENT_SIZE

enum PA_PROP_DEVICE_BUFFERING_FRAGMENT_SIZE;

For devices: fragment size in bytes, integer formatted as string.

PA_PROP_DEVICE_BUS

enum PA_PROP_DEVICE_BUS;

For devices: bus of the device if applicable. One of "isa", "pci", "usb", "firewire", "bluetooth"

PA_PROP_DEVICE_BUS_PATH

enum PA_PROP_DEVICE_BUS_PATH;

For devices: bus path to the device in the OS' format. E.g. "/sys/bus/pci/devices/0000:00:1f.2"

PA_PROP_DEVICE_CLASS

enum PA_PROP_DEVICE_CLASS;

For devices: device class. One of "sound", "modem", "monitor", "filter"

PA_PROP_DEVICE_DESCRIPTION

enum PA_PROP_DEVICE_DESCRIPTION;

For devices: localized human readable device one-line description. E.g. "Foobar Industries USB Headset 2000+ Ultra"

PA_PROP_DEVICE_FORM_FACTOR

enum PA_PROP_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"

PA_PROP_DEVICE_ICON

enum PA_PROP_DEVICE_ICON;

For devices: icon for the device. A binary blob containing PNG image data

PA_PROP_DEVICE_ICON_NAME

enum PA_PROP_DEVICE_ICON_NAME;

For devices: an XDG icon name for the device. E.g. "sound-card-speakers-usb"

PA_PROP_DEVICE_INTENDED_ROLES

enum PA_PROP_DEVICE_INTENDED_ROLES;

For devices: intended use. A space separated list of roles (see PA_PROP_MEDIA_ROLE) this device is particularly well suited for, due to latency, quality or form factor. \since 0.9.16

PA_PROP_DEVICE_MASTER_DEVICE

enum PA_PROP_DEVICE_MASTER_DEVICE;

For filter devices: master device id if applicable.

PA_PROP_DEVICE_PRODUCT_ID

enum PA_PROP_DEVICE_PRODUCT_ID;

For devices: product ID if applicable. E.g. 4565

PA_PROP_DEVICE_PRODUCT_NAME

enum PA_PROP_DEVICE_PRODUCT_NAME;

For devices: product name if applicable. E.g. "SuperSpeakers 2000 Pro"

PA_PROP_DEVICE_PROFILE_DESCRIPTION

enum PA_PROP_DEVICE_PROFILE_DESCRIPTION;

For devices: human readable one-line description of the profile this device is in. E.g. "Analog Stereo", ...

PA_PROP_DEVICE_PROFILE_NAME

enum PA_PROP_DEVICE_PROFILE_NAME;

For devices: profile identifier for the profile this devices is in. E.g. "analog-stereo", "analog-surround-40", "iec958-stereo", ...

PA_PROP_DEVICE_SERIAL

enum PA_PROP_DEVICE_SERIAL;

For devices: serial number if applicable. E.g. "4711-0815-1234"

PA_PROP_DEVICE_STRING

enum PA_PROP_DEVICE_STRING;

For devices: device string in the underlying audio layer's format. E.g. "surround51:0"

PA_PROP_DEVICE_VENDOR_ID

enum PA_PROP_DEVICE_VENDOR_ID;

For devices: vendor ID if applicable. E.g. 1274

PA_PROP_DEVICE_VENDOR_NAME

enum PA_PROP_DEVICE_VENDOR_NAME;

For devices: vendor name if applicable. E.g. "Foocorp Heavy Industries"

PA_PROP_EVENT_DESCRIPTION

enum PA_PROP_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."

PA_PROP_EVENT_ID

enum PA_PROP_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")

PA_PROP_EVENT_MOUSE_BUTTON

enum PA_PROP_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"

PA_PROP_EVENT_MOUSE_HPOS

enum PA_PROP_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"

PA_PROP_EVENT_MOUSE_VPOS

enum PA_PROP_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"

PA_PROP_EVENT_MOUSE_X

enum PA_PROP_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"

PA_PROP_EVENT_MOUSE_Y

enum PA_PROP_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"

PA_PROP_FILTER_APPLY

enum PA_PROP_FILTER_APPLY;

For streams: the name of a filter that is desired, e.g.\ "echo-cancel" or "equalizer-sink". Differs from PA_PROP_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, PA_PROP_FILTER_WANT is ignored. In other words, you almost certainly do not want to use this. \since 1.0

PA_PROP_FILTER_SUPPRESS

enum PA_PROP_FILTER_SUPPRESS;

For streams: the name of a filter that should specifically suppressed (i.e.\ overrides PA_PROP_FILTER_WANT). Useful for the times that PA_PROP_FILTER_WANT is automatically added (e.g. echo-cancellation for phone streams when $VOIP_APP does its own, internal AEC) \since 1.0

PA_PROP_FILTER_WANT

enum PA_PROP_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. \since 1.0

PA_PROP_FORMAT_CHANNELS

enum PA_PROP_FORMAT_CHANNELS;

For all formats: the number of channels (unsigned integer) \since 1.0

PA_PROP_FORMAT_CHANNEL_MAP

enum PA_PROP_FORMAT_CHANNEL_MAP;

For PCM formats: the channel map of the stream as returned by pa_channel_map_snprint() \since 1.0

PA_PROP_FORMAT_RATE

enum PA_PROP_FORMAT_RATE;

For all formats: the sample rate (unsigned integer) \since 1.0

PA_PROP_FORMAT_SAMPLE_FORMAT

enum PA_PROP_FORMAT_SAMPLE_FORMAT;

For PCM formats: the sample format used as returned by pa_sample_format_to_string() \since 1.0

PA_PROP_MEDIA_ARTIST

enum PA_PROP_MEDIA_ARTIST;

For streams: localized media artist if applicable, formatted as UTF-8. E.g. "Guns'N'Roses"

PA_PROP_MEDIA_COPYRIGHT

enum PA_PROP_MEDIA_COPYRIGHT;

For streams: localized media copyright string if applicable, formatted as UTF-8. E.g. "Evil Record Corp."

PA_PROP_MEDIA_FILENAME

enum PA_PROP_MEDIA_FILENAME;

For streams: source filename if applicable, in URI format or local path. E.g. "/home/lennart/music/foobar.ogg"

PA_PROP_MEDIA_ICON

enum PA_PROP_MEDIA_ICON;

For streams: icon for the media. A binary blob containing PNG image data

PA_PROP_MEDIA_ICON_NAME

enum PA_PROP_MEDIA_ICON_NAME;

For streams: an XDG icon name for the media. E.g. "audio-x-mp3"

PA_PROP_MEDIA_LANGUAGE

enum PA_PROP_MEDIA_LANGUAGE;

For streams: media language if applicable, in standard POSIX format. E.g. "de_DE"

PA_PROP_MEDIA_NAME

enum PA_PROP_MEDIA_NAME;

For streams: localized media name, formatted as UTF-8. E.g. "Guns'N'Roses: Civil War".

PA_PROP_MEDIA_ROLE

enum PA_PROP_MEDIA_ROLE;

For streams: logic role of this media. One of the strings "video", "music", "game", "event", "phone", "animation", "production", "a11y", "test"

PA_PROP_MEDIA_SOFTWARE

enum PA_PROP_MEDIA_SOFTWARE;

For streams: localized media generator software string if applicable, formatted as UTF-8. E.g. "Foocrop AudioFrobnicator"

PA_PROP_MEDIA_TITLE

enum PA_PROP_MEDIA_TITLE;

For streams: localized media title if applicable, formatted as UTF-8. E.g. "Civil War"

PA_PROP_MODULE_AUTHOR

enum PA_PROP_MODULE_AUTHOR;

For modules: the author's name, formatted as UTF-8 string. E.g. "Lennart Poettering"

PA_PROP_MODULE_DESCRIPTION

enum PA_PROP_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"

PA_PROP_MODULE_USAGE

enum PA_PROP_MODULE_USAGE;

For modules: a human readable usage description of the module's arguments formatted as UTF-8.

PA_PROP_MODULE_VERSION

enum PA_PROP_MODULE_VERSION;

For modules: a version string for the module. E.g. "0.9.15"

PA_PROP_WINDOW_DESKTOP

enum PA_PROP_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 0. E.g. "0,2,3" \since 0.9.18

PA_PROP_WINDOW_HEIGHT

enum PA_PROP_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". \since 0.9.17

PA_PROP_WINDOW_HPOS

enum PA_PROP_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". \since 0.9.17

PA_PROP_WINDOW_ICON

enum PA_PROP_WINDOW_ICON;

For streams that belong to a window on the screen: window icon. A binary blob containing PNG image data

PA_PROP_WINDOW_ICON_NAME

enum PA_PROP_WINDOW_ICON_NAME;

For streams that belong to a window on the screen: an XDG icon name for the window. E.g. "totem"

PA_PROP_WINDOW_ID

enum PA_PROP_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"

PA_PROP_WINDOW_NAME

enum PA_PROP_WINDOW_NAME;

For streams that belong to a window on the screen: localized window title. E.g. "Totem Music Player"

PA_PROP_WINDOW_VPOS

enum PA_PROP_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". \since 0.9.17

PA_PROP_WINDOW_WIDTH

enum PA_PROP_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". \since 0.9.17

PA_PROP_WINDOW_X

enum PA_PROP_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". \since 0.9.17

PA_PROP_WINDOW_X11_DISPLAY

enum PA_PROP_WINDOW_X11_DISPLAY;

For streams that belong to an X11 window on the screen: the X11 display string. E.g. ":0.0"

PA_PROP_WINDOW_X11_MONITOR

enum PA_PROP_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"

PA_PROP_WINDOW_X11_SCREEN

enum PA_PROP_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"

PA_PROP_WINDOW_X11_XID

enum PA_PROP_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"

PA_PROP_WINDOW_Y

enum PA_PROP_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". \since 0.9.17

PA_UPDATE_MERGE

enum PA_UPDATE_MERGE;

Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.

PA_UPDATE_REPLACE

enum PA_UPDATE_REPLACE;

Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.

PA_UPDATE_SET

enum PA_UPDATE_SET;

\cond fulldocs

Structs

pa_proplist

struct pa_proplist

A property list object. Basically a dictionary with ASCII strings * as keys and arbitrary data as values. \since 0.9.11

• channelmap
• context
• def
• error
• extdevicemanager
• extdevicerestore
• extstreamrestore
• format
• introspect
• mainloop
• mainloopapi
• mainloopsignal
• operation
• proplist
• rtclock
• sample
• scache
• simple
• stream
• subscribe
• threadmainloop
• timeval
• utf8
• util
• versiondef
• volume
• xmalloc