<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>PulseAudio: proplist.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.8 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>proplist.h File Reference</h1>
<p>
<a href="proplist_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#c416e31ede2459f40ec7eb62f80db580">PA_PROP_MEDIA_NAME</a> "media.name"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">For streams: localized media name, formatted as UTF-8. <a href="#c416e31ede2459f40ec7eb62f80db580"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#6aa1ad2d42304ca4bd159935bce2070b">PA_PROP_MEDIA_TITLE</a> "media.title"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">For streams: localized media title if applicable, formatted as UTF-8. <a href="#6aa1ad2d42304ca4bd159935bce2070b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#24c327adc989a0800d594cc939c34cbe">PA_PROP_MEDIA_ARTIST</a> "media.artist"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">For streams: localized media artist if applicable, formatted as UTF-8. <a href="#24c327adc989a0800d594cc939c34cbe"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#dfb00db4b8417864d5b1ad475da7a3f6">PA_PROP_MEDIA_LANGUAGE</a> "media.language"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">For streams: media language if applicable, in standard POSIX format. <a href="#dfb00db4b8417864d5b1ad475da7a3f6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#266ee48bfe8c6e9fdaf2e543927559db">PA_PROP_MEDIA_FILENAME</a> "media.filename"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">For streams: source filename if applicable, in URI format or local path. <a href="#266ee48bfe8c6e9fdaf2e543927559db"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#dcd76df0647befdb7343fda49b91f6a6">PA_PROP_MEDIA_ICON_NAME</a> "media.icon_name"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">For streams: an XDG icon name for the media. <a href="#dcd76df0647befdb7343fda49b91f6a6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#06b7c7a5bfc7a20974b7785031169596">PA_PROP_MEDIA_ROLE</a> "media.role"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">For streams: logic role of this media. <a href="#06b7c7a5bfc7a20974b7785031169596"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#eb3700d6ea024ddf6ec10c01426a4fec">PA_PROP_EVENT_ID</a> "event.id"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">For event sound streams: XDG event sound name. <a href="#eb3700d6ea024ddf6ec10c01426a4fec"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#bf89c26784f717f69f65609685c3cd10">PA_PROP_EVENT_DESCRIPTION</a> "event.description"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">For event sound streams: localized human readable one-line description of the event, formatted as UTF-8. <a href="#bf89c26784f717f69f65609685c3cd10"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#7c2e7c02e167943db734a624283ddd57">PA_PROP_EVENT_MOUSE_X</a> "event.mouse.x"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">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. <a href="#7c2e7c02e167943db734a624283ddd57"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#3c9f668cb526a34e9d3fdd3f1ea29568">PA_PROP_EVENT_MOUSE_Y</a> "event.mouse.y"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">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. <a href="#3c9f668cb526a34e9d3fdd3f1ea29568"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#24a0330c50b352ca13d47db9bcc16d75">PA_PROP_EVENT_MOUSE_HPOS</a> "event.mouse.hpos"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">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). <a href="#24a0330c50b352ca13d47db9bcc16d75"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#455ca0352b84fe49987399741e3f345d">PA_PROP_EVENT_MOUSE_VPOS</a> "event.mouse.vpos"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">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). <a href="#455ca0352b84fe49987399741e3f345d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#750440ad31b8e47b370a1d7e69a85f09">PA_PROP_EVENT_MOUSE_BUTTON</a> "event.mouse.button"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">For event sound streams: mouse button that triggered the event if applicable, integer formatted as string with 0=left, 1=middle, 2=right. <a href="#750440ad31b8e47b370a1d7e69a85f09"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#4ed7fb55d38eb5a3226a0797f00a99fa">PA_PROP_WINDOW_NAME</a> "window.name"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">For streams that belong to a window on the screen: localized window title. <a href="#4ed7fb55d38eb5a3226a0797f00a99fa"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#9fdf6146c8c9f1a5bf2bae0f5ac15c80">PA_PROP_WINDOW_ID</a> "window.id"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">For streams that belong to a window on the screen: a textual id for identifying a window logically. <a href="#9fdf6146c8c9f1a5bf2bae0f5ac15c80"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#ada02bbccf6d429a5e1c0f12bf6943c5">PA_PROP_WINDOW_ICON_NAME</a> "window.icon_name"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">For streams that belong to a window on the screen: an XDG icon name for the window. <a href="#ada02bbccf6d429a5e1c0f12bf6943c5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#feec29bb46c625c5002f4ee377859c82">PA_PROP_WINDOW_X11_DISPLAY</a> "window.x11.display"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">For streams that belong to an X11 window on the screen: the X11 display string. <a href="#feec29bb46c625c5002f4ee377859c82"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#a3f8852528712b34af4d64d5d968be98">PA_PROP_WINDOW_X11_SCREEN</a> "window.x11.screen"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">For streams that belong to an X11 window on the screen: the X11 screen the window is on, an integer formatted as string. <a href="#a3f8852528712b34af4d64d5d968be98"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#0178c33ccad89d11f18826518cf6ee18">PA_PROP_WINDOW_X11_MONITOR</a> "window.x11.monitor"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">For streams that belong to an X11 window on the screen: the X11 monitor the window is on, an integer formatted as string. <a href="#0178c33ccad89d11f18826518cf6ee18"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#cffcfbc6e950bd892da9e93ceac66ac0">PA_PROP_WINDOW_X11_XID</a> "window.x11.xid"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">For streams that belong to an X11 window on the screen: the window XID, an integer formatted as string. <a href="#cffcfbc6e950bd892da9e93ceac66ac0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#b94d533153744b934780ce627ef3e74c">PA_PROP_APPLICATION_NAME</a> "application.name"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">For clients/streams: localized human readable application name. <a href="#b94d533153744b934780ce627ef3e74c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#75405097deaf2bcf967e7a8f3df09674">PA_PROP_APPLICATION_ID</a> "application.id"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">For clients/streams: a textual id for identifying an application logically. <a href="#75405097deaf2bcf967e7a8f3df09674"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#a44674bfd5200c2376809fecd6dfa195">PA_PROP_APPLICATION_VERSION</a> "application.version"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">For clients/streams: a version string e.g. <a href="#a44674bfd5200c2376809fecd6dfa195"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#ee165f0d3f2808271ee4e43e880bd7ed">PA_PROP_APPLICATION_ICON_NAME</a> "application.icon_name"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">For clients/streams: an XDG icon name for the application. <a href="#ee165f0d3f2808271ee4e43e880bd7ed"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#df6aef2cc0bbc50101750b49b3f6e711">PA_PROP_APPLICATION_LANGUAGE</a> "application.language"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">For clients/streams: application language if applicable, in standard POSIX format. <a href="#df6aef2cc0bbc50101750b49b3f6e711"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#57c2f00f66288d89b55cc9752ff460e8">PA_PROP_APPLICATION_PROCESS_ID</a> "application.process.id"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">For clients/streams on UNIX: application process PID, an integer formatted as string. <a href="#57c2f00f66288d89b55cc9752ff460e8"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#d54f38ddc3061d473acf2223b1eb5e32">PA_PROP_APPLICATION_PROCESS_BINARY</a> "application.process.binary"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">For clients/streams: application process name. <a href="#d54f38ddc3061d473acf2223b1eb5e32"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#b3e75fdd60a288107fac7495941cbe59">PA_PROP_APPLICATION_PROCESS_USER</a> "application.process.user"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">For clients/streams: application user name. <a href="#b3e75fdd60a288107fac7495941cbe59"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#fad23e199f7e3d2c493fa1002a3bae44">PA_PROP_APPLICATION_PROCESS_HOST</a> "application.process.host"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">For clients/streams: host name the application runs on. <a href="#fad23e199f7e3d2c493fa1002a3bae44"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#8f7ed035493e70716a8d2f52106937b2">PA_PROP_APPLICATION_PROCESS_MACHINE_ID</a> "application.process.machine_id"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">For clients/streams: the D-Bus host id the application runs on. <a href="#8f7ed035493e70716a8d2f52106937b2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#518722daf6434d9f355a1cb3b6b3f955">PA_PROP_APPLICATION_PROCESS_SESSION_ID</a> "application.process.session_id"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">For clients/streams: an id for the login session the application runs in. <a href="#518722daf6434d9f355a1cb3b6b3f955"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#32cd5705427249174d44ab7635cff827">PA_PROP_DEVICE_STRING</a> "device.string"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">For devices: device string in the underlying audio layer's format. <a href="#32cd5705427249174d44ab7635cff827"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#32c48832bbc8ca1197ba3d781c062bf0">PA_PROP_DEVICE_API</a> "device.api"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">For devices: API this device is access with. <a href="#32c48832bbc8ca1197ba3d781c062bf0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#fe29e06d1d2e253753651bbb5d7bd78a">PA_PROP_DEVICE_DESCRIPTION</a> "device.description"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">For devices: localized human readable device one-line description, e.g. <a href="#fe29e06d1d2e253753651bbb5d7bd78a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#7fd06059407c3e967621422788cade3f">PA_PROP_DEVICE_BUS_PATH</a> "device.bus_path"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">For devices: bus path to the device in the OS' format. <a href="#7fd06059407c3e967621422788cade3f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#df297c24512cbb1b9ad628bfe7424da3">PA_PROP_DEVICE_SERIAL</a> "device.serial"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">For devices: serial number if applicable. <a href="#df297c24512cbb1b9ad628bfe7424da3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#2769c225eef6595e9b04e828a0e82c52">PA_PROP_DEVICE_VENDOR_ID</a> "device.vendor.id"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">For devices: vendor ID if applicable. <a href="#2769c225eef6595e9b04e828a0e82c52"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#82e638aabdd34730e3d561a0c47ff410">PA_PROP_DEVICE_VENDOR_NAME</a> "device.vendor.name"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">For devices: vendor name if applicable. <a href="#82e638aabdd34730e3d561a0c47ff410"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#19e0a8ed4ecb38441827c548ac53e22c">PA_PROP_DEVICE_PRODUCT_ID</a> "device.product.id"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">For devices: product ID if applicable. <a href="#19e0a8ed4ecb38441827c548ac53e22c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#425d32187f43dcf5410be5c77e8840af">PA_PROP_DEVICE_PRODUCT_NAME</a> "device.product.name"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">For devices: product name if applicable. <a href="#425d32187f43dcf5410be5c77e8840af"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#e89f0a9be328322377f04bb5ba041524">PA_PROP_DEVICE_CLASS</a> "device.class"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">For devices: device class. <a href="#e89f0a9be328322377f04bb5ba041524"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#77c49f81eb8426259c13fc53619b9670">PA_PROP_DEVICE_FORM_FACTOR</a> "device.form_factor"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">For devices: form factor if applicable. <a href="#77c49f81eb8426259c13fc53619b9670"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#842f7ea2529281f740ed5dc8ebe6418f">PA_PROP_DEVICE_BUS</a> "device.bus"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">For devices: bus of the device if applicable. <a href="#842f7ea2529281f740ed5dc8ebe6418f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#d2eee8a3a9bbad4ed65eb7eb094a7518">PA_PROP_DEVICE_ICON_NAME</a> "device.icon_name"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">For devices: an XDG icon name for the device. <a href="#d2eee8a3a9bbad4ed65eb7eb094a7518"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#e67f8b18e3e813951e237af01cc63996">PA_PROP_DEVICE_ACCESS_MODE</a> "device.access_mode"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">For devices: access mode of the device if applicable. <a href="#e67f8b18e3e813951e237af01cc63996"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#77be50b56f559fc0e5290c3193cf98f5">PA_PROP_DEVICE_MASTER_DEVICE</a> "device.master_device"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">For filter devices: master device id if applicable. <a href="#77be50b56f559fc0e5290c3193cf98f5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#98373af36e11cff98e143c323d0f606d">PA_PROP_DEVICE_BUFFERING_BUFFER_SIZE</a> "device.buffering.buffer_size"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">For devices: buffer size in bytes, integer formatted as string. <a href="#98373af36e11cff98e143c323d0f606d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#07334c11be900bae5d7cdcc200c906e9">PA_PROP_DEVICE_BUFFERING_FRAGMENT_SIZE</a> "device.buffering.fragment_size"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">For devices: fragment size in bytes, integer formatted as string. <a href="#07334c11be900bae5d7cdcc200c906e9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#c8be39205a2f0da46385706b1d4a8a37">PA_PROP_DEVICE_PROFILE_NAME</a> "device.profile.name"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">For devices: profile identifier for the profile this devices is in. <a href="#c8be39205a2f0da46385706b1d4a8a37"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#7e999bcf81e40ac1c78670c05919c806">PA_PROP_DEVICE_PROFILE_DESCRIPTION</a> "device.profile.description"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">For devices: human readable one-line description of the profile this device is in. <a href="#7e999bcf81e40ac1c78670c05919c806"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#91154e3b32f45ce447ac717da6683ee3">PA_PROP_MODULE_AUTHOR</a> "module.author"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">For modules: the author's name, formatted as UTF-8 string. <a href="#91154e3b32f45ce447ac717da6683ee3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#acc58d79f68e2339c1d2cbedd6fb7328">PA_PROP_MODULE_DESCRIPTION</a> "module.description"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">For modules: a human readable one-line description of the module's purpose formatted as UTF-8. <a href="#acc58d79f68e2339c1d2cbedd6fb7328"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#f3c39bab465092442c2552db1f140650">PA_PROP_MODULE_USAGE</a> "module.usage"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">For modules: a human readable usage description of the module's arguments formatted as UTF-8. <a href="#f3c39bab465092442c2552db1f140650"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#6159a27a95f0230c7ed3c512313eae0a">PA_PROP_MODULE_VERSION</a> "module.version"</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">For modules: a version string for the module. <a href="#6159a27a95f0230c7ed3c512313eae0a"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef struct <a class="el" href="proplist_8h.html#cdf756a6014b6fae3b358b2c934c3426">pa_proplist</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#cdf756a6014b6fae3b358b2c934c3426">pa_proplist</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A property list object. <a href="#cdf756a6014b6fae3b358b2c934c3426"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef enum <a class="el" href="proplist_8h.html#6f2fa31b75070136ad852b04a6da46b3">pa_update_mode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#4b73cd513add16a26378a7941a9f1fd9">pa_update_mode_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Update mode enum for <a class="el" href="proplist_8h.html#cef0478be6f832e35ccc988f922c2d1e" title="Merge property list "other" into "p", adhering the merge mode...">pa_proplist_update()</a>. <a href="#4b73cd513add16a26378a7941a9f1fd9"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Enumerations</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#6f2fa31b75070136ad852b04a6da46b3">pa_update_mode</a> { <br>
<a class="el" href="proplist_8h.html#6f2fa31b75070136ad852b04a6da46b3dfa2ae49fe2db261b262cb76df37418a">PA_UPDATE_SET</a>,
<br>
<a class="el" href="proplist_8h.html#6f2fa31b75070136ad852b04a6da46b3c321fcb6f9bcca06b0c2f5da2ecf4d27">PA_UPDATE_MERGE</a>,
<br>
<a class="el" href="proplist_8h.html#6f2fa31b75070136ad852b04a6da46b31ee9602fda76148e89e7bf9ddc7bb7e6">PA_UPDATE_REPLACE</a>
<br>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Update mode enum for <a class="el" href="proplist_8h.html#cef0478be6f832e35ccc988f922c2d1e" title="Merge property list "other" into "p", adhering the merge mode...">pa_proplist_update()</a>. <a href="proplist_8h.html#6f2fa31b75070136ad852b04a6da46b3">More...</a><br></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="proplist_8h.html#cdf756a6014b6fae3b358b2c934c3426">pa_proplist</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#0296f1e719b2d78955c96162017dbbcf">pa_proplist_new</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Allocate a property list. <a href="#0296f1e719b2d78955c96162017dbbcf"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#5be3a346bf26b4b8f0043859da53f447">pa_proplist_free</a> (<a class="el" href="proplist_8h.html#cdf756a6014b6fae3b358b2c934c3426">pa_proplist</a> *p)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Free the property list. <a href="#5be3a346bf26b4b8f0043859da53f447"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#768c59b205d817aa47c8b261bab1bfb1">pa_proplist_sets</a> (<a class="el" href="proplist_8h.html#cdf756a6014b6fae3b358b2c934c3426">pa_proplist</a> *p, const char *key, const char *value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Append a new string entry to the property list, possibly overwriting an already existing entry with the same key. <a href="#768c59b205d817aa47c8b261bab1bfb1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#70a0a95a7075cc30ae5864a28f05ddcf">pa_proplist_setf</a> (<a class="el" href="proplist_8h.html#cdf756a6014b6fae3b358b2c934c3426">pa_proplist</a> *p, const char *key, const char *format,...) PA_GCC_PRINTF_ATTR(3</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Append a new string entry to the property list, possibly overwriting an already existing entry with the same key. <a href="#70a0a95a7075cc30ae5864a28f05ddcf"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int int </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#82706443b9be01d9fcbc182a3d5f149c">pa_proplist_set</a> (<a class="el" href="proplist_8h.html#cdf756a6014b6fae3b358b2c934c3426">pa_proplist</a> *p, const char *key, const void *data, size_t nbytes)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Append a new arbitrary data entry to the property list, possibly overwriting an already existing entry with the same key. <a href="#82706443b9be01d9fcbc182a3d5f149c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#fd7db43261e9c8ad64a989e2cd2140ca">pa_proplist_gets</a> (<a class="el" href="proplist_8h.html#cdf756a6014b6fae3b358b2c934c3426">pa_proplist</a> *p, const char *key)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a string entry for the specified key. <a href="#fd7db43261e9c8ad64a989e2cd2140ca"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#247192ed12c22d7033faa787ff9a8361">pa_proplist_get</a> (<a class="el" href="proplist_8h.html#cdf756a6014b6fae3b358b2c934c3426">pa_proplist</a> *p, const char *key, const void **data, size_t *nbytes)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the the value for the specified key. <a href="#247192ed12c22d7033faa787ff9a8361"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#cef0478be6f832e35ccc988f922c2d1e">pa_proplist_update</a> (<a class="el" href="proplist_8h.html#cdf756a6014b6fae3b358b2c934c3426">pa_proplist</a> *p, <a class="el" href="proplist_8h.html#4b73cd513add16a26378a7941a9f1fd9">pa_update_mode_t</a> mode, <a class="el" href="proplist_8h.html#cdf756a6014b6fae3b358b2c934c3426">pa_proplist</a> *other)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Merge property list "other" into "p", adhering the merge mode as specified in "mode". <a href="#cef0478be6f832e35ccc988f922c2d1e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#bf1074347ce78d873b76c3e1f1d2b082">pa_proplist_unset</a> (<a class="el" href="proplist_8h.html#cdf756a6014b6fae3b358b2c934c3426">pa_proplist</a> *p, const char *key)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Removes a single entry from the property list, identified be the specified key name. <a href="#bf1074347ce78d873b76c3e1f1d2b082"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#a9fa007fc79ac30b371fb0d35e5ceaa1">pa_proplist_unset_many</a> (<a class="el" href="proplist_8h.html#cdf756a6014b6fae3b358b2c934c3426">pa_proplist</a> *p, const char *const keys[])</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Similar to pa_proplist_remove() but takes an array of keys to remove. <a href="#a9fa007fc79ac30b371fb0d35e5ceaa1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#ccd1dd7cfa262f9c3759b0bde4e35c8e">pa_proplist_iterate</a> (<a class="el" href="proplist_8h.html#cdf756a6014b6fae3b358b2c934c3426">pa_proplist</a> *p, void **state)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Iterate through the property list. <a href="#ccd1dd7cfa262f9c3759b0bde4e35c8e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#ef78250696f299917872cd5681375938">pa_proplist_to_string</a> (<a class="el" href="proplist_8h.html#cdf756a6014b6fae3b358b2c934c3426">pa_proplist</a> *p)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Format the property list nicely as a human readable string. <a href="#ef78250696f299917872cd5681375938"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#f78042ee0665530a50a6f314b348a9a1">pa_proplist_to_string_sep</a> (<a class="el" href="proplist_8h.html#cdf756a6014b6fae3b358b2c934c3426">pa_proplist</a> *p, const char *sep)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Format the property list nicely as a human readable string and choose the seperator. <a href="#f78042ee0665530a50a6f314b348a9a1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="proplist_8h.html#cdf756a6014b6fae3b358b2c934c3426">pa_proplist</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#e952dba084738a3274899a6dcbc2daa2">pa_proplist_from_string</a> (const char *str)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Allocate a new property list and assign key/value from a human readable string. <a href="#e952dba084738a3274899a6dcbc2daa2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#c8b92b2ac0988d07d630f254bd136668">pa_proplist_contains</a> (<a class="el" href="proplist_8h.html#cdf756a6014b6fae3b358b2c934c3426">pa_proplist</a> *p, const char *key)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns 1 if an entry for the specified key is existant in the property list. <a href="#c8b92b2ac0988d07d630f254bd136668"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#51704063deafbd329a42e89d1420e73c">pa_proplist_clear</a> (<a class="el" href="proplist_8h.html#cdf756a6014b6fae3b358b2c934c3426">pa_proplist</a> *p)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove all entries from the property list object. <a href="#51704063deafbd329a42e89d1420e73c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="proplist_8h.html#cdf756a6014b6fae3b358b2c934c3426">pa_proplist</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#73414f89ad83c4ee2e8758429a13016c">pa_proplist_copy</a> (<a class="el" href="proplist_8h.html#cdf756a6014b6fae3b358b2c934c3426">pa_proplist</a> *t)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Allocate a new property list and copy over every single entry from the specific list. <a href="#73414f89ad83c4ee2e8758429a13016c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#2bd491a92c091df4835178f6ea7637fb">pa_proplist_size</a> (<a class="el" href="proplist_8h.html#cdf756a6014b6fae3b358b2c934c3426">pa_proplist</a> *t)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the number of entries on the property list. <a href="#2bd491a92c091df4835178f6ea7637fb"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="proplist_8h.html#fbf13178a912abdff6314a11522eced9">pa_proplist_isempty</a> (<a class="el" href="proplist_8h.html#cdf756a6014b6fae3b358b2c934c3426">pa_proplist</a> *t)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns 0 when the proplist is empty, positive otherwise. <a href="#fbf13178a912abdff6314a11522eced9"></a><br></td></tr>
</table>
<hr><h2>Define Documentation</h2>
<a class="anchor" name="ee165f0d3f2808271ee4e43e880bd7ed"></a><!-- doxytag: member="proplist.h::PA_PROP_APPLICATION_ICON_NAME" ref="ee165f0d3f2808271ee4e43e880bd7ed" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_PROP_APPLICATION_ICON_NAME "application.icon_name" </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
For clients/streams: an XDG icon name for the application.
<p>
e.g. "totem"
</div>
</div><p>
<a class="anchor" name="75405097deaf2bcf967e7a8f3df09674"></a><!-- doxytag: member="proplist.h::PA_PROP_APPLICATION_ID" ref="75405097deaf2bcf967e7a8f3df09674" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_PROP_APPLICATION_ID "application.id" </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
For clients/streams: a textual id for identifying an application logically.
<p>
e.g. "org.gnome.Totem"
</div>
</div><p>
<a class="anchor" name="df6aef2cc0bbc50101750b49b3f6e711"></a><!-- doxytag: member="proplist.h::PA_PROP_APPLICATION_LANGUAGE" ref="df6aef2cc0bbc50101750b49b3f6e711" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_PROP_APPLICATION_LANGUAGE "application.language" </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
For clients/streams: application language if applicable, in standard POSIX format.
<p>
e.g. "de_DE"
</div>
</div><p>
<a class="anchor" name="b94d533153744b934780ce627ef3e74c"></a><!-- doxytag: member="proplist.h::PA_PROP_APPLICATION_NAME" ref="b94d533153744b934780ce627ef3e74c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_PROP_APPLICATION_NAME "application.name" </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
For clients/streams: localized human readable application name.
<p>
e.g. "Totem Music Player"
</div>
</div><p>
<a class="anchor" name="d54f38ddc3061d473acf2223b1eb5e32"></a><!-- doxytag: member="proplist.h::PA_PROP_APPLICATION_PROCESS_BINARY" ref="d54f38ddc3061d473acf2223b1eb5e32" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_PROP_APPLICATION_PROCESS_BINARY "application.process.binary" </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
For clients/streams: application process name.
<p>
e.g. "totem"
</div>
</div><p>
<a class="anchor" name="fad23e199f7e3d2c493fa1002a3bae44"></a><!-- doxytag: member="proplist.h::PA_PROP_APPLICATION_PROCESS_HOST" ref="fad23e199f7e3d2c493fa1002a3bae44" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_PROP_APPLICATION_PROCESS_HOST "application.process.host" </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
For clients/streams: host name the application runs on.
<p>
e.g. "omega"
</div>
</div><p>
<a class="anchor" name="57c2f00f66288d89b55cc9752ff460e8"></a><!-- doxytag: member="proplist.h::PA_PROP_APPLICATION_PROCESS_ID" ref="57c2f00f66288d89b55cc9752ff460e8" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_PROP_APPLICATION_PROCESS_ID "application.process.id" </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
For clients/streams on UNIX: application process PID, an integer formatted as string.
<p>
e.g. "4711"
</div>
</div><p>
<a class="anchor" name="8f7ed035493e70716a8d2f52106937b2"></a><!-- doxytag: member="proplist.h::PA_PROP_APPLICATION_PROCESS_MACHINE_ID" ref="8f7ed035493e70716a8d2f52106937b2" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_PROP_APPLICATION_PROCESS_MACHINE_ID "application.process.machine_id" </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
For clients/streams: the D-Bus host id the application runs on.
<p>
e.g. "543679e7b01393ed3e3e650047d78f6e"
</div>
</div><p>
<a class="anchor" name="518722daf6434d9f355a1cb3b6b3f955"></a><!-- doxytag: member="proplist.h::PA_PROP_APPLICATION_PROCESS_SESSION_ID" ref="518722daf6434d9f355a1cb3b6b3f955" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_PROP_APPLICATION_PROCESS_SESSION_ID "application.process.session_id" </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
For clients/streams: an id for the login session the application runs in.
<p>
On Unix the value of $XDG_SESSION_COOKIE. e.g. "543679e7b01393ed3e3e650047d78f6e-1235159798.76193-190367717"
</div>
</div><p>
<a class="anchor" name="b3e75fdd60a288107fac7495941cbe59"></a><!-- doxytag: member="proplist.h::PA_PROP_APPLICATION_PROCESS_USER" ref="b3e75fdd60a288107fac7495941cbe59" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_PROP_APPLICATION_PROCESS_USER "application.process.user" </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
For clients/streams: application user name.
<p>
e.g. "lennart"
</div>
</div><p>
<a class="anchor" name="a44674bfd5200c2376809fecd6dfa195"></a><!-- doxytag: member="proplist.h::PA_PROP_APPLICATION_VERSION" ref="a44674bfd5200c2376809fecd6dfa195" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_PROP_APPLICATION_VERSION "application.version" </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
For clients/streams: a version string e.g.
<p>
"0.6.88"
</div>
</div><p>
<a class="anchor" name="e67f8b18e3e813951e237af01cc63996"></a><!-- doxytag: member="proplist.h::PA_PROP_DEVICE_ACCESS_MODE" ref="e67f8b18e3e813951e237af01cc63996" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_PROP_DEVICE_ACCESS_MODE "device.access_mode" </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
For devices: access mode of the device if applicable.
<p>
One of "mmap", "mmap_rewrite", "serial"
</div>
</div><p>
<a class="anchor" name="32c48832bbc8ca1197ba3d781c062bf0"></a><!-- doxytag: member="proplist.h::PA_PROP_DEVICE_API" ref="32c48832bbc8ca1197ba3d781c062bf0" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_PROP_DEVICE_API "device.api" </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
For devices: API this device is access with.
<p>
e.g. "alsa"
</div>
</div><p>
<a class="anchor" name="98373af36e11cff98e143c323d0f606d"></a><!-- doxytag: member="proplist.h::PA_PROP_DEVICE_BUFFERING_BUFFER_SIZE" ref="98373af36e11cff98e143c323d0f606d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_PROP_DEVICE_BUFFERING_BUFFER_SIZE "device.buffering.buffer_size" </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
For devices: buffer size in bytes, integer formatted as string.
<p>
</div>
</div><p>
<a class="anchor" name="07334c11be900bae5d7cdcc200c906e9"></a><!-- doxytag: member="proplist.h::PA_PROP_DEVICE_BUFFERING_FRAGMENT_SIZE" ref="07334c11be900bae5d7cdcc200c906e9" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_PROP_DEVICE_BUFFERING_FRAGMENT_SIZE "device.buffering.fragment_size" </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
For devices: fragment size in bytes, integer formatted as string.
<p>
</div>
</div><p>
<a class="anchor" name="842f7ea2529281f740ed5dc8ebe6418f"></a><!-- doxytag: member="proplist.h::PA_PROP_DEVICE_BUS" ref="842f7ea2529281f740ed5dc8ebe6418f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_PROP_DEVICE_BUS "device.bus" </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
For devices: bus of the device if applicable.
<p>
One of "isa", "pci", "usb", "firewire", "bluetooth"
</div>
</div><p>
<a class="anchor" name="7fd06059407c3e967621422788cade3f"></a><!-- doxytag: member="proplist.h::PA_PROP_DEVICE_BUS_PATH" ref="7fd06059407c3e967621422788cade3f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_PROP_DEVICE_BUS_PATH "device.bus_path" </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
For devices: bus path to the device in the OS' format.
<p>
e.g. "/sys/bus/pci/devices/0000:00:1f.2"
</div>
</div><p>
<a class="anchor" name="e89f0a9be328322377f04bb5ba041524"></a><!-- doxytag: member="proplist.h::PA_PROP_DEVICE_CLASS" ref="e89f0a9be328322377f04bb5ba041524" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_PROP_DEVICE_CLASS "device.class" </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
For devices: device class.
<p>
One of "sound", "modem", "monitor", "filter"
</div>
</div><p>
<a class="anchor" name="fe29e06d1d2e253753651bbb5d7bd78a"></a><!-- doxytag: member="proplist.h::PA_PROP_DEVICE_DESCRIPTION" ref="fe29e06d1d2e253753651bbb5d7bd78a" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_PROP_DEVICE_DESCRIPTION "device.description" </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
For devices: localized human readable device one-line description, e.g.
<p>
"Foobar Industries USB Headset 2000+ Ultra"
</div>
</div><p>
<a class="anchor" name="77c49f81eb8426259c13fc53619b9670"></a><!-- doxytag: member="proplist.h::PA_PROP_DEVICE_FORM_FACTOR" ref="77c49f81eb8426259c13fc53619b9670" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_PROP_DEVICE_FORM_FACTOR "device.form_factor" </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
For devices: form factor if applicable.
<p>
One of "internal", "speaker", "handset", "tv", "webcam", "microphone", "headset", "headphone", "hands-free", "car", "hifi", "computer", "portable"
</div>
</div><p>
<a class="anchor" name="d2eee8a3a9bbad4ed65eb7eb094a7518"></a><!-- doxytag: member="proplist.h::PA_PROP_DEVICE_ICON_NAME" ref="d2eee8a3a9bbad4ed65eb7eb094a7518" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_PROP_DEVICE_ICON_NAME "device.icon_name" </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
For devices: an XDG icon name for the device.
<p>
e.g. "sound-card-speakers-usb"
</div>
</div><p>
<a class="anchor" name="77be50b56f559fc0e5290c3193cf98f5"></a><!-- doxytag: member="proplist.h::PA_PROP_DEVICE_MASTER_DEVICE" ref="77be50b56f559fc0e5290c3193cf98f5" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_PROP_DEVICE_MASTER_DEVICE "device.master_device" </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
For filter devices: master device id if applicable.
<p>
</div>
</div><p>
<a class="anchor" name="19e0a8ed4ecb38441827c548ac53e22c"></a><!-- doxytag: member="proplist.h::PA_PROP_DEVICE_PRODUCT_ID" ref="19e0a8ed4ecb38441827c548ac53e22c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_PROP_DEVICE_PRODUCT_ID "device.product.id" </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
For devices: product ID if applicable.
<p>
e.g. 4565
</div>
</div><p>
<a class="anchor" name="425d32187f43dcf5410be5c77e8840af"></a><!-- doxytag: member="proplist.h::PA_PROP_DEVICE_PRODUCT_NAME" ref="425d32187f43dcf5410be5c77e8840af" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_PROP_DEVICE_PRODUCT_NAME "device.product.name" </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
For devices: product name if applicable.
<p>
e.g. "SuperSpeakers 2000 Pro"
</div>
</div><p>
<a class="anchor" name="7e999bcf81e40ac1c78670c05919c806"></a><!-- doxytag: member="proplist.h::PA_PROP_DEVICE_PROFILE_DESCRIPTION" ref="7e999bcf81e40ac1c78670c05919c806" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_PROP_DEVICE_PROFILE_DESCRIPTION "device.profile.description" </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
For devices: human readable one-line description of the profile this device is in.
<p>
e.g. "Analog Stereo", ...
</div>
</div><p>
<a class="anchor" name="c8be39205a2f0da46385706b1d4a8a37"></a><!-- doxytag: member="proplist.h::PA_PROP_DEVICE_PROFILE_NAME" ref="c8be39205a2f0da46385706b1d4a8a37" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_PROP_DEVICE_PROFILE_NAME "device.profile.name" </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
For devices: profile identifier for the profile this devices is in.
<p>
e.g. "analog-stereo", "analog-surround-40", "iec958-stereo", ...
</div>
</div><p>
<a class="anchor" name="df297c24512cbb1b9ad628bfe7424da3"></a><!-- doxytag: member="proplist.h::PA_PROP_DEVICE_SERIAL" ref="df297c24512cbb1b9ad628bfe7424da3" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_PROP_DEVICE_SERIAL "device.serial" </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
For devices: serial number if applicable.
<p>
e.g. "4711-0815-1234"
</div>
</div><p>
<a class="anchor" name="32cd5705427249174d44ab7635cff827"></a><!-- doxytag: member="proplist.h::PA_PROP_DEVICE_STRING" ref="32cd5705427249174d44ab7635cff827" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_PROP_DEVICE_STRING "device.string" </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
For devices: device string in the underlying audio layer's format.
<p>
e.g. "surround51:0"
</div>
</div><p>
<a class="anchor" name="2769c225eef6595e9b04e828a0e82c52"></a><!-- doxytag: member="proplist.h::PA_PROP_DEVICE_VENDOR_ID" ref="2769c225eef6595e9b04e828a0e82c52" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_PROP_DEVICE_VENDOR_ID "device.vendor.id" </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
For devices: vendor ID if applicable.
<p>
e.g. 1274
</div>
</div><p>
<a class="anchor" name="82e638aabdd34730e3d561a0c47ff410"></a><!-- doxytag: member="proplist.h::PA_PROP_DEVICE_VENDOR_NAME" ref="82e638aabdd34730e3d561a0c47ff410" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_PROP_DEVICE_VENDOR_NAME "device.vendor.name" </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
For devices: vendor name if applicable.
<p>
e.g. "Foocorp Heavy Industries"
</div>
</div><p>
<a class="anchor" name="bf89c26784f717f69f65609685c3cd10"></a><!-- doxytag: member="proplist.h::PA_PROP_EVENT_DESCRIPTION" ref="bf89c26784f717f69f65609685c3cd10" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_PROP_EVENT_DESCRIPTION "event.description" </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
For event sound streams: localized human readable one-line description of the event, formatted as UTF-8.
<p>
e.g. "Email from lennart@example.com received."
</div>
</div><p>
<a class="anchor" name="eb3700d6ea024ddf6ec10c01426a4fec"></a><!-- doxytag: member="proplist.h::PA_PROP_EVENT_ID" ref="eb3700d6ea024ddf6ec10c01426a4fec" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_PROP_EVENT_ID "event.id" </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
For event sound streams: XDG event sound name.
<p>
e.g. "message-new-email" (Event sound streams are those with media.role set to "event")
</div>
</div><p>
<a class="anchor" name="750440ad31b8e47b370a1d7e69a85f09"></a><!-- doxytag: member="proplist.h::PA_PROP_EVENT_MOUSE_BUTTON" ref="750440ad31b8e47b370a1d7e69a85f09" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_PROP_EVENT_MOUSE_BUTTON "event.mouse.button" </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
For event sound streams: mouse button that triggered the event if applicable, integer formatted as string with 0=left, 1=middle, 2=right.
<p>
e.g. "0"
</div>
</div><p>
<a class="anchor" name="24a0330c50b352ca13d47db9bcc16d75"></a><!-- doxytag: member="proplist.h::PA_PROP_EVENT_MOUSE_HPOS" ref="24a0330c50b352ca13d47db9bcc16d75" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_PROP_EVENT_MOUSE_HPOS "event.mouse.hpos" </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
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).
<p>
e.g. "0.65"
</div>
</div><p>
<a class="anchor" name="455ca0352b84fe49987399741e3f345d"></a><!-- doxytag: member="proplist.h::PA_PROP_EVENT_MOUSE_VPOS" ref="455ca0352b84fe49987399741e3f345d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_PROP_EVENT_MOUSE_VPOS "event.mouse.vpos" </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
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).
<p>
e.g. "0.43"
</div>
</div><p>
<a class="anchor" name="7c2e7c02e167943db734a624283ddd57"></a><!-- doxytag: member="proplist.h::PA_PROP_EVENT_MOUSE_X" ref="7c2e7c02e167943db734a624283ddd57" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_PROP_EVENT_MOUSE_X "event.mouse.x" </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
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.
<p>
e.g. "865"
</div>
</div><p>
<a class="anchor" name="3c9f668cb526a34e9d3fdd3f1ea29568"></a><!-- doxytag: member="proplist.h::PA_PROP_EVENT_MOUSE_Y" ref="3c9f668cb526a34e9d3fdd3f1ea29568" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_PROP_EVENT_MOUSE_Y "event.mouse.y" </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
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.
<p>
e.g. "432"
</div>
</div><p>
<a class="anchor" name="24c327adc989a0800d594cc939c34cbe"></a><!-- doxytag: member="proplist.h::PA_PROP_MEDIA_ARTIST" ref="24c327adc989a0800d594cc939c34cbe" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_PROP_MEDIA_ARTIST "media.artist" </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
For streams: localized media artist if applicable, formatted as UTF-8.
<p>
e.g. "Guns'N'Roses"
</div>
</div><p>
<a class="anchor" name="266ee48bfe8c6e9fdaf2e543927559db"></a><!-- doxytag: member="proplist.h::PA_PROP_MEDIA_FILENAME" ref="266ee48bfe8c6e9fdaf2e543927559db" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_PROP_MEDIA_FILENAME "media.filename" </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
For streams: source filename if applicable, in URI format or local path.
<p>
e.g. "/home/lennart/music/foobar.ogg"
</div>
</div><p>
<a class="anchor" name="dcd76df0647befdb7343fda49b91f6a6"></a><!-- doxytag: member="proplist.h::PA_PROP_MEDIA_ICON_NAME" ref="dcd76df0647befdb7343fda49b91f6a6" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_PROP_MEDIA_ICON_NAME "media.icon_name" </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
For streams: an XDG icon name for the media.
<p>
e.g. "audio-x-mp3"
</div>
</div><p>
<a class="anchor" name="dfb00db4b8417864d5b1ad475da7a3f6"></a><!-- doxytag: member="proplist.h::PA_PROP_MEDIA_LANGUAGE" ref="dfb00db4b8417864d5b1ad475da7a3f6" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_PROP_MEDIA_LANGUAGE "media.language" </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
For streams: media language if applicable, in standard POSIX format.
<p>
e.g. "de_DE"
</div>
</div><p>
<a class="anchor" name="c416e31ede2459f40ec7eb62f80db580"></a><!-- doxytag: member="proplist.h::PA_PROP_MEDIA_NAME" ref="c416e31ede2459f40ec7eb62f80db580" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_PROP_MEDIA_NAME "media.name" </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
For streams: localized media name, formatted as UTF-8.
<p>
e.g. "Guns'N'Roses: Civil War".
</div>
</div><p>
<a class="anchor" name="06b7c7a5bfc7a20974b7785031169596"></a><!-- doxytag: member="proplist.h::PA_PROP_MEDIA_ROLE" ref="06b7c7a5bfc7a20974b7785031169596" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_PROP_MEDIA_ROLE "media.role" </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
For streams: logic role of this media.
<p>
One of the strings "video", "music", "game", "event", "phone", "animation", "production", "a11y"
</div>
</div><p>
<a class="anchor" name="6aa1ad2d42304ca4bd159935bce2070b"></a><!-- doxytag: member="proplist.h::PA_PROP_MEDIA_TITLE" ref="6aa1ad2d42304ca4bd159935bce2070b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_PROP_MEDIA_TITLE "media.title" </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
For streams: localized media title if applicable, formatted as UTF-8.
<p>
e.g. "Civil War"
</div>
</div><p>
<a class="anchor" name="91154e3b32f45ce447ac717da6683ee3"></a><!-- doxytag: member="proplist.h::PA_PROP_MODULE_AUTHOR" ref="91154e3b32f45ce447ac717da6683ee3" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_PROP_MODULE_AUTHOR "module.author" </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
For modules: the author's name, formatted as UTF-8 string.
<p>
e.g. "Lennart Poettering"
</div>
</div><p>
<a class="anchor" name="acc58d79f68e2339c1d2cbedd6fb7328"></a><!-- doxytag: member="proplist.h::PA_PROP_MODULE_DESCRIPTION" ref="acc58d79f68e2339c1d2cbedd6fb7328" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_PROP_MODULE_DESCRIPTION "module.description" </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
For modules: a human readable one-line description of the module's purpose formatted as UTF-8.
<p>
e.g. "Frobnicate sounds with a flux compensator"
</div>
</div><p>
<a class="anchor" name="f3c39bab465092442c2552db1f140650"></a><!-- doxytag: member="proplist.h::PA_PROP_MODULE_USAGE" ref="f3c39bab465092442c2552db1f140650" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_PROP_MODULE_USAGE "module.usage" </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
For modules: a human readable usage description of the module's arguments formatted as UTF-8.
<p>
</div>
</div><p>
<a class="anchor" name="6159a27a95f0230c7ed3c512313eae0a"></a><!-- doxytag: member="proplist.h::PA_PROP_MODULE_VERSION" ref="6159a27a95f0230c7ed3c512313eae0a" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_PROP_MODULE_VERSION "module.version" </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
For modules: a version string for the module.
<p>
e.g. "0.9.15"
</div>
</div><p>
<a class="anchor" name="ada02bbccf6d429a5e1c0f12bf6943c5"></a><!-- doxytag: member="proplist.h::PA_PROP_WINDOW_ICON_NAME" ref="ada02bbccf6d429a5e1c0f12bf6943c5" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_PROP_WINDOW_ICON_NAME "window.icon_name" </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
For streams that belong to a window on the screen: an XDG icon name for the window.
<p>
e.g. "totem"
</div>
</div><p>
<a class="anchor" name="9fdf6146c8c9f1a5bf2bae0f5ac15c80"></a><!-- doxytag: member="proplist.h::PA_PROP_WINDOW_ID" ref="9fdf6146c8c9f1a5bf2bae0f5ac15c80" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_PROP_WINDOW_ID "window.id" </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
For streams that belong to a window on the screen: a textual id for identifying a window logically.
<p>
e.g. "org.gnome.Totem.MainWindow"
</div>
</div><p>
<a class="anchor" name="4ed7fb55d38eb5a3226a0797f00a99fa"></a><!-- doxytag: member="proplist.h::PA_PROP_WINDOW_NAME" ref="4ed7fb55d38eb5a3226a0797f00a99fa" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_PROP_WINDOW_NAME "window.name" </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
For streams that belong to a window on the screen: localized window title.
<p>
e.g. "Totem Music Player"
</div>
</div><p>
<a class="anchor" name="feec29bb46c625c5002f4ee377859c82"></a><!-- doxytag: member="proplist.h::PA_PROP_WINDOW_X11_DISPLAY" ref="feec29bb46c625c5002f4ee377859c82" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_PROP_WINDOW_X11_DISPLAY "window.x11.display" </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
For streams that belong to an X11 window on the screen: the X11 display string.
<p>
e.g. ":0.0"
</div>
</div><p>
<a class="anchor" name="0178c33ccad89d11f18826518cf6ee18"></a><!-- doxytag: member="proplist.h::PA_PROP_WINDOW_X11_MONITOR" ref="0178c33ccad89d11f18826518cf6ee18" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_PROP_WINDOW_X11_MONITOR "window.x11.monitor" </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
For streams that belong to an X11 window on the screen: the X11 monitor the window is on, an integer formatted as string.
<p>
e.g. "0"
</div>
</div><p>
<a class="anchor" name="a3f8852528712b34af4d64d5d968be98"></a><!-- doxytag: member="proplist.h::PA_PROP_WINDOW_X11_SCREEN" ref="a3f8852528712b34af4d64d5d968be98" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_PROP_WINDOW_X11_SCREEN "window.x11.screen" </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
For streams that belong to an X11 window on the screen: the X11 screen the window is on, an integer formatted as string.
<p>
e.g. "0"
</div>
</div><p>
<a class="anchor" name="cffcfbc6e950bd892da9e93ceac66ac0"></a><!-- doxytag: member="proplist.h::PA_PROP_WINDOW_X11_XID" ref="cffcfbc6e950bd892da9e93ceac66ac0" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_PROP_WINDOW_X11_XID "window.x11.xid" </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
For streams that belong to an X11 window on the screen: the window XID, an integer formatted as string.
<p>
e.g. "25632"
</div>
</div><p>
<hr><h2>Typedef Documentation</h2>
<a class="anchor" name="cdf756a6014b6fae3b358b2c934c3426"></a><!-- doxytag: member="proplist.h::pa_proplist" ref="cdf756a6014b6fae3b358b2c934c3426" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="proplist_8h.html#cdf756a6014b6fae3b358b2c934c3426">pa_proplist</a> <a class="el" href="proplist_8h.html#cdf756a6014b6fae3b358b2c934c3426">pa_proplist</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
A property list object.
<p>
Basically a dictionary with ASCII strings as keys and arbitrary data as values. <dl class="since" compact><dt><b>Since:</b></dt><dd>0.9.11 </dd></dl>
<dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="pacat_8c-example.html#a45">pacat.c</a>.</dl>
</div>
</div><p>
<a class="anchor" name="4b73cd513add16a26378a7941a9f1fd9"></a><!-- doxytag: member="proplist.h::pa_update_mode_t" ref="4b73cd513add16a26378a7941a9f1fd9" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef enum <a class="el" href="proplist_8h.html#6f2fa31b75070136ad852b04a6da46b3">pa_update_mode</a> <a class="el" href="proplist_8h.html#4b73cd513add16a26378a7941a9f1fd9">pa_update_mode_t</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Update mode enum for <a class="el" href="proplist_8h.html#cef0478be6f832e35ccc988f922c2d1e" title="Merge property list "other" into "p", adhering the merge mode...">pa_proplist_update()</a>.
<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd>0.9.11 </dd></dl>
</div>
</div><p>
<hr><h2>Enumeration Type Documentation</h2>
<a class="anchor" name="6f2fa31b75070136ad852b04a6da46b3"></a><!-- doxytag: member="proplist.h::pa_update_mode" ref="6f2fa31b75070136ad852b04a6da46b3" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="proplist_8h.html#6f2fa31b75070136ad852b04a6da46b3">pa_update_mode</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Update mode enum for <a class="el" href="proplist_8h.html#cef0478be6f832e35ccc988f922c2d1e" title="Merge property list "other" into "p", adhering the merge mode...">pa_proplist_update()</a>.
<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd>0.9.11 </dd></dl>
<dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="6f2fa31b75070136ad852b04a6da46b3dfa2ae49fe2db261b262cb76df37418a"></a><!-- doxytag: member="PA_UPDATE_SET" ref="6f2fa31b75070136ad852b04a6da46b3dfa2ae49fe2db261b262cb76df37418a" args="" -->PA_UPDATE_SET</em> </td><td>
Replace the entire property list with the new one.
<p>
Don't keep any of the old data around </td></tr>
<tr><td valign="top"><em><a class="anchor" name="6f2fa31b75070136ad852b04a6da46b3c321fcb6f9bcca06b0c2f5da2ecf4d27"></a><!-- doxytag: member="PA_UPDATE_MERGE" ref="6f2fa31b75070136ad852b04a6da46b3c321fcb6f9bcca06b0c2f5da2ecf4d27" args="" -->PA_UPDATE_MERGE</em> </td><td>
Merge new property list into the existing one, not replacing any old entries if they share a common key with the new property list.
<p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="6f2fa31b75070136ad852b04a6da46b31ee9602fda76148e89e7bf9ddc7bb7e6"></a><!-- doxytag: member="PA_UPDATE_REPLACE" ref="6f2fa31b75070136ad852b04a6da46b31ee9602fda76148e89e7bf9ddc7bb7e6" args="" -->PA_UPDATE_REPLACE</em> </td><td>
Merge new property list into the existing one, replacing all old entries that share a common key with the new property list.
<p>
</td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="51704063deafbd329a42e89d1420e73c"></a><!-- doxytag: member="proplist.h::pa_proplist_clear" ref="51704063deafbd329a42e89d1420e73c" args="(pa_proplist *p)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void pa_proplist_clear </td>
<td>(</td>
<td class="paramtype"><a class="el" href="proplist_8h.html#cdf756a6014b6fae3b358b2c934c3426">pa_proplist</a> * </td>
<td class="paramname"> <em>p</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Remove all entries from the property list object.
<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd>0.9.11 </dd></dl>
</div>
</div><p>
<a class="anchor" name="c8b92b2ac0988d07d630f254bd136668"></a><!-- doxytag: member="proplist.h::pa_proplist_contains" ref="c8b92b2ac0988d07d630f254bd136668" args="(pa_proplist *p, const char *key)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int pa_proplist_contains </td>
<td>(</td>
<td class="paramtype"><a class="el" href="proplist_8h.html#cdf756a6014b6fae3b358b2c934c3426">pa_proplist</a> * </td>
<td class="paramname"> <em>p</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>key</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns 1 if an entry for the specified key is existant in the property list.
<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd>0.9.11 </dd></dl>
</div>
</div><p>
<a class="anchor" name="73414f89ad83c4ee2e8758429a13016c"></a><!-- doxytag: member="proplist.h::pa_proplist_copy" ref="73414f89ad83c4ee2e8758429a13016c" args="(pa_proplist *t)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="proplist_8h.html#cdf756a6014b6fae3b358b2c934c3426">pa_proplist</a>* pa_proplist_copy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="proplist_8h.html#cdf756a6014b6fae3b358b2c934c3426">pa_proplist</a> * </td>
<td class="paramname"> <em>t</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Allocate a new property list and copy over every single entry from the specific list.
<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd>0.9.11 </dd></dl>
</div>
</div><p>
<a class="anchor" name="5be3a346bf26b4b8f0043859da53f447"></a><!-- doxytag: member="proplist.h::pa_proplist_free" ref="5be3a346bf26b4b8f0043859da53f447" args="(pa_proplist *p)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void pa_proplist_free </td>
<td>(</td>
<td class="paramtype"><a class="el" href="proplist_8h.html#cdf756a6014b6fae3b358b2c934c3426">pa_proplist</a> * </td>
<td class="paramname"> <em>p</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Free the property list.
<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd>0.9.11 </dd></dl>
</div>
</div><p>
<a class="anchor" name="e952dba084738a3274899a6dcbc2daa2"></a><!-- doxytag: member="proplist.h::pa_proplist_from_string" ref="e952dba084738a3274899a6dcbc2daa2" args="(const char *str)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="proplist_8h.html#cdf756a6014b6fae3b358b2c934c3426">pa_proplist</a>* pa_proplist_from_string </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>str</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Allocate a new property list and assign key/value from a human readable string.
<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd>0.9.15 </dd></dl>
</div>
</div><p>
<a class="anchor" name="247192ed12c22d7033faa787ff9a8361"></a><!-- doxytag: member="proplist.h::pa_proplist_get" ref="247192ed12c22d7033faa787ff9a8361" args="(pa_proplist *p, const char *key, const void **data, size_t *nbytes)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int pa_proplist_get </td>
<td>(</td>
<td class="paramtype"><a class="el" href="proplist_8h.html#cdf756a6014b6fae3b358b2c934c3426">pa_proplist</a> * </td>
<td class="paramname"> <em>p</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void ** </td>
<td class="paramname"> <em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t * </td>
<td class="paramname"> <em>nbytes</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the the value for the specified key.
<p>
Will return a NUL-terminated string for string entries. The pointer returned will point to an internally allocated buffer. The caller should make a copy of the data before the property list is accessed again. <dl class="since" compact><dt><b>Since:</b></dt><dd>0.9.11 </dd></dl>
</div>
</div><p>
<a class="anchor" name="fd7db43261e9c8ad64a989e2cd2140ca"></a><!-- doxytag: member="proplist.h::pa_proplist_gets" ref="fd7db43261e9c8ad64a989e2cd2140ca" args="(pa_proplist *p, const char *key)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* pa_proplist_gets </td>
<td>(</td>
<td class="paramtype"><a class="el" href="proplist_8h.html#cdf756a6014b6fae3b358b2c934c3426">pa_proplist</a> * </td>
<td class="paramname"> <em>p</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>key</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return a string entry for the specified key.
<p>
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. <dl class="since" compact><dt><b>Since:</b></dt><dd>0.9.11 </dd></dl>
</div>
</div><p>
<a class="anchor" name="fbf13178a912abdff6314a11522eced9"></a><!-- doxytag: member="proplist.h::pa_proplist_isempty" ref="fbf13178a912abdff6314a11522eced9" args="(pa_proplist *t)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int pa_proplist_isempty </td>
<td>(</td>
<td class="paramtype"><a class="el" href="proplist_8h.html#cdf756a6014b6fae3b358b2c934c3426">pa_proplist</a> * </td>
<td class="paramname"> <em>t</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns 0 when the proplist is empty, positive otherwise.
<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd>0.9.15 </dd></dl>
</div>
</div><p>
<a class="anchor" name="ccd1dd7cfa262f9c3759b0bde4e35c8e"></a><!-- doxytag: member="proplist.h::pa_proplist_iterate" ref="ccd1dd7cfa262f9c3759b0bde4e35c8e" args="(pa_proplist *p, void **state)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* pa_proplist_iterate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="proplist_8h.html#cdf756a6014b6fae3b358b2c934c3426">pa_proplist</a> * </td>
<td class="paramname"> <em>p</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void ** </td>
<td class="paramname"> <em>state</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Iterate through the property list.
<p>
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 <a class="el" href="proplist_8h.html#ccd1dd7cfa262f9c3759b0bde4e35c8e" title="Iterate through the property list.">pa_proplist_iterate()</a> 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 -- except for deleting the current looked at entry. On each invication this function will return the key string for the next entry. The keys in the property list do not have any particular order. <dl class="since" compact><dt><b>Since:</b></dt><dd>0.9.11 </dd></dl>
</div>
</div><p>
<a class="anchor" name="0296f1e719b2d78955c96162017dbbcf"></a><!-- doxytag: member="proplist.h::pa_proplist_new" ref="0296f1e719b2d78955c96162017dbbcf" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="proplist_8h.html#cdf756a6014b6fae3b358b2c934c3426">pa_proplist</a>* pa_proplist_new </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Allocate a property list.
<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd>0.9.11 </dd></dl>
</div>
</div><p>
<a class="anchor" name="82706443b9be01d9fcbc182a3d5f149c"></a><!-- doxytag: member="proplist.h::pa_proplist_set" ref="82706443b9be01d9fcbc182a3d5f149c" args="(pa_proplist *p, const char *key, const void *data, size_t nbytes)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int int pa_proplist_set </td>
<td>(</td>
<td class="paramtype"><a class="el" href="proplist_8h.html#cdf756a6014b6fae3b358b2c934c3426">pa_proplist</a> * </td>
<td class="paramname"> <em>p</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void * </td>
<td class="paramname"> <em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>nbytes</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Append a new arbitrary data entry to the property list, possibly overwriting an already existing entry with the same key.
<p>
An internal copy of the data passed is made. <dl class="since" compact><dt><b>Since:</b></dt><dd>0.9.11 </dd></dl>
</div>
</div><p>
<a class="anchor" name="70a0a95a7075cc30ae5864a28f05ddcf"></a><!-- doxytag: member="proplist.h::pa_proplist_setf" ref="70a0a95a7075cc30ae5864a28f05ddcf" args="(pa_proplist *p, const char *key, const char *format,...) PA_GCC_PRINTF_ATTR(3" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int pa_proplist_setf </td>
<td>(</td>
<td class="paramtype"><a class="el" href="proplist_8h.html#cdf756a6014b6fae3b358b2c934c3426">pa_proplist</a> * </td>
<td class="paramname"> <em>p</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>format</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"> <em>...</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Append a new string entry to the property list, possibly overwriting an already existing entry with the same key.
<p>
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. <dl class="since" compact><dt><b>Since:</b></dt><dd>0.9.11 </dd></dl>
</div>
</div><p>
<a class="anchor" name="768c59b205d817aa47c8b261bab1bfb1"></a><!-- doxytag: member="proplist.h::pa_proplist_sets" ref="768c59b205d817aa47c8b261bab1bfb1" args="(pa_proplist *p, const char *key, const char *value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int pa_proplist_sets </td>
<td>(</td>
<td class="paramtype"><a class="el" href="proplist_8h.html#cdf756a6014b6fae3b358b2c934c3426">pa_proplist</a> * </td>
<td class="paramname"> <em>p</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>value</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Append a new string entry to the property list, possibly overwriting an already existing entry with the same key.
<p>
An internal copy of the data passed is made. Will accept only valid UTF-8. <dl class="since" compact><dt><b>Since:</b></dt><dd>0.9.11 </dd></dl>
</div>
</div><p>
<a class="anchor" name="2bd491a92c091df4835178f6ea7637fb"></a><!-- doxytag: member="proplist.h::pa_proplist_size" ref="2bd491a92c091df4835178f6ea7637fb" args="(pa_proplist *t)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned pa_proplist_size </td>
<td>(</td>
<td class="paramtype"><a class="el" href="proplist_8h.html#cdf756a6014b6fae3b358b2c934c3426">pa_proplist</a> * </td>
<td class="paramname"> <em>t</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the number of entries on the property list.
<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd>0.9.15 </dd></dl>
</div>
</div><p>
<a class="anchor" name="ef78250696f299917872cd5681375938"></a><!-- doxytag: member="proplist.h::pa_proplist_to_string" ref="ef78250696f299917872cd5681375938" args="(pa_proplist *p)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* pa_proplist_to_string </td>
<td>(</td>
<td class="paramtype"><a class="el" href="proplist_8h.html#cdf756a6014b6fae3b358b2c934c3426">pa_proplist</a> * </td>
<td class="paramname"> <em>p</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Format the property list nicely as a human readable string.
<p>
This works very much like <a class="el" href="proplist_8h.html#f78042ee0665530a50a6f314b348a9a1" title="Format the property list nicely as a human readable string and choose the seperator...">pa_proplist_to_string_sep()</a> and uses a newline as seperator and appends one final one. Call <a class="el" href="xmalloc_8h.html#975c3f1d400a40ede0d5e79bb8876008" title="Free allocated memory.">pa_xfree()</a> on the result. <dl class="since" compact><dt><b>Since:</b></dt><dd>0.9.11 </dd></dl>
</div>
</div><p>
<a class="anchor" name="f78042ee0665530a50a6f314b348a9a1"></a><!-- doxytag: member="proplist.h::pa_proplist_to_string_sep" ref="f78042ee0665530a50a6f314b348a9a1" args="(pa_proplist *p, const char *sep)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* pa_proplist_to_string_sep </td>
<td>(</td>
<td class="paramtype"><a class="el" href="proplist_8h.html#cdf756a6014b6fae3b358b2c934c3426">pa_proplist</a> * </td>
<td class="paramname"> <em>p</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>sep</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Format the property list nicely as a human readable string and choose the seperator.
<p>
Call <a class="el" href="xmalloc_8h.html#975c3f1d400a40ede0d5e79bb8876008" title="Free allocated memory.">pa_xfree()</a> on the result. <dl class="since" compact><dt><b>Since:</b></dt><dd>0.9.15 </dd></dl>
<dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="pacat_8c-example.html#a46">pacat.c</a>.</dl>
</div>
</div><p>
<a class="anchor" name="bf1074347ce78d873b76c3e1f1d2b082"></a><!-- doxytag: member="proplist.h::pa_proplist_unset" ref="bf1074347ce78d873b76c3e1f1d2b082" args="(pa_proplist *p, const char *key)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int pa_proplist_unset </td>
<td>(</td>
<td class="paramtype"><a class="el" href="proplist_8h.html#cdf756a6014b6fae3b358b2c934c3426">pa_proplist</a> * </td>
<td class="paramname"> <em>p</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>key</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Removes a single entry from the property list, identified be the specified key name.
<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd>0.9.11 </dd></dl>
</div>
</div><p>
<a class="anchor" name="a9fa007fc79ac30b371fb0d35e5ceaa1"></a><!-- doxytag: member="proplist.h::pa_proplist_unset_many" ref="a9fa007fc79ac30b371fb0d35e5ceaa1" args="(pa_proplist *p, const char *const keys[])" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int pa_proplist_unset_many </td>
<td>(</td>
<td class="paramtype"><a class="el" href="proplist_8h.html#cdf756a6014b6fae3b358b2c934c3426">pa_proplist</a> * </td>
<td class="paramname"> <em>p</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *const </td>
<td class="paramname"> <em>keys</em>[]</td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Similar to pa_proplist_remove() but takes an array of keys to remove.
<p>
The array should be terminated by a NULL pointer. Return -1 on failure, otherwise the number of entries actually removed (which might even be 0, if there where no matching entries to remove). <dl class="since" compact><dt><b>Since:</b></dt><dd>0.9.11 </dd></dl>
</div>
</div><p>
<a class="anchor" name="cef0478be6f832e35ccc988f922c2d1e"></a><!-- doxytag: member="proplist.h::pa_proplist_update" ref="cef0478be6f832e35ccc988f922c2d1e" args="(pa_proplist *p, pa_update_mode_t mode, pa_proplist *other)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void pa_proplist_update </td>
<td>(</td>
<td class="paramtype"><a class="el" href="proplist_8h.html#cdf756a6014b6fae3b358b2c934c3426">pa_proplist</a> * </td>
<td class="paramname"> <em>p</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="proplist_8h.html#4b73cd513add16a26378a7941a9f1fd9">pa_update_mode_t</a> </td>
<td class="paramname"> <em>mode</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="proplist_8h.html#cdf756a6014b6fae3b358b2c934c3426">pa_proplist</a> * </td>
<td class="paramname"> <em>other</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Merge property list "other" into "p", adhering the merge mode as specified in "mode".
<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd>0.9.11 </dd></dl>
</div>
</div><p>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Sep 2 04:18:20 2009 for PulseAudio by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2009.1
>
x86_64
>
media
>
main-testing
>
by-pkgid
>
187676b5433787923dfa2cdd6900c6cd
>
files
>
140
