<!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: pa_source_info Struct 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 class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><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="annotated.html"><span>Data Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>pa_source_info Struct Reference</h1><!-- doxytag: class="pa_source_info" -->Stores information about sources.
<a href="#_details">More...</a>
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Data Fields</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structpa__source__info.html#61afc17239989ccac42c9b143c8dafbd">name</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Name of the source. <a href="#61afc17239989ccac42c9b143c8dafbd"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structpa__source__info.html#aea5cb728eff6a6e47fd4b2a57c68800">index</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Index of the source. <a href="#aea5cb728eff6a6e47fd4b2a57c68800"></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="structpa__source__info.html#c67e3147b1560c94fb215e265afdf077">description</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Description of this source. <a href="#c67e3147b1560c94fb215e265afdf077"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structpa__sample__spec.html">pa_sample_spec</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structpa__source__info.html#31aa76b7f145f448472e065b08df238d">sample_spec</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sample spec of this source. <a href="#31aa76b7f145f448472e065b08df238d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structpa__channel__map.html">pa_channel_map</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structpa__source__info.html#a5421702ef8229d3ca4225e6e8d14033">channel_map</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Channel map. <a href="#a5421702ef8229d3ca4225e6e8d14033"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structpa__source__info.html#a0478463eb67bf22f724a25b07e544e3">owner_module</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Owning module index, or PA_INVALID_INDEX. <a href="#a0478463eb67bf22f724a25b07e544e3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structpa__cvolume.html">pa_cvolume</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structpa__source__info.html#14feca3480affae3bb15c5cb3400dce3">volume</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Volume of the source. <a href="#14feca3480affae3bb15c5cb3400dce3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structpa__source__info.html#bcadbb57169622929271f2c106ccb3bf">mute</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Mute switch of the sink. <a href="#bcadbb57169622929271f2c106ccb3bf"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structpa__source__info.html#5e304b796ce71c7fa54e5a88f3333630">monitor_of_sink</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">If this is a monitor source the index of the owning sink, otherwise PA_INVALID_INDEX. <a href="#5e304b796ce71c7fa54e5a88f3333630"></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="structpa__source__info.html#57574e2d67787b7c7a742ea742577880">monitor_of_sink_name</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Name of the owning sink, or PA_INVALID_INDEX. <a href="#57574e2d67787b7c7a742ea742577880"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="sample_8h.html#885df3b973773f0dccbbec6bc6777f89">pa_usec_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structpa__source__info.html#5ed69b0cede6c4f9508ebca50a79c1ba">latency</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Length of filled record buffer of this source. <a href="#5ed69b0cede6c4f9508ebca50a79c1ba"></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="structpa__source__info.html#330b6032ab2411e38c84bfd102677aed">driver</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Driver name. <a href="#330b6032ab2411e38c84bfd102677aed"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="def_8h.html#1177496dc4c63e0cce094ed849a9ef8d">pa_source_flags_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structpa__source__info.html#fe48c018865c45058174e9ba2ef7356f">flags</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Flags. <a href="#fe48c018865c45058174e9ba2ef7356f"></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="structpa__source__info.html#18fd48b4f94232408c5896fa3cb48aa9">proplist</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Property list. <a href="#18fd48b4f94232408c5896fa3cb48aa9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="sample_8h.html#885df3b973773f0dccbbec6bc6777f89">pa_usec_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structpa__source__info.html#9d18ad1b45483014c84055ddce0b5e7d">configured_latency</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The latency this device has been configured to. <a href="#9d18ad1b45483014c84055ddce0b5e7d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="volume_8h.html#6d671c65284ff2e94d3773c7368a0352">pa_volume_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structpa__source__info.html#9a0954875670adbe13c041eda723348b">base_volume</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Some kind of "base" volume that refers to unamplified/unattenuated volume in the context of the input device. <a href="#9a0954875670adbe13c041eda723348b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="def_8h.html#2be5558ab768f960e50c18e252c2f906">pa_source_state_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structpa__source__info.html#4fc4bd5fe3ce3226f04b11270d26ffeb">state</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">State. <a href="#4fc4bd5fe3ce3226f04b11270d26ffeb"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structpa__source__info.html#079323d09fdbce973533b791b792cfcc">n_volume_steps</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Number of volume steps for sources which do not support arbitrary volumes. <a href="#079323d09fdbce973533b791b792cfcc"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structpa__source__info.html#6f7628bf54e546011b6e120a4d4c1183">card</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Card index, or PA_INVALID_INDEX. <a href="#6f7628bf54e546011b6e120a4d4c1183"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Stores information about sources.
<p>
Please note that this structure can be extended as part of evolutionary API updates at any time in any new release. <hr><h2>Field Documentation</h2>
<a class="anchor" name="9a0954875670adbe13c041eda723348b"></a><!-- doxytag: member="pa_source_info::base_volume" ref="9a0954875670adbe13c041eda723348b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="volume_8h.html#6d671c65284ff2e94d3773c7368a0352">pa_volume_t</a> <a class="el" href="structpa__source__info.html#9a0954875670adbe13c041eda723348b">pa_source_info::base_volume</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Some kind of "base" volume that refers to unamplified/unattenuated volume in the context of the input device.
<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd>0.9.15 </dd></dl>
</div>
</div><p>
<a class="anchor" name="6f7628bf54e546011b6e120a4d4c1183"></a><!-- doxytag: member="pa_source_info::card" ref="6f7628bf54e546011b6e120a4d4c1183" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t <a class="el" href="structpa__source__info.html#6f7628bf54e546011b6e120a4d4c1183">pa_source_info::card</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Card index, or PA_INVALID_INDEX.
<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd>0.9.15 </dd></dl>
</div>
</div><p>
<a class="anchor" name="a5421702ef8229d3ca4225e6e8d14033"></a><!-- doxytag: member="pa_source_info::channel_map" ref="a5421702ef8229d3ca4225e6e8d14033" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structpa__channel__map.html">pa_channel_map</a> <a class="el" href="structpa__source__info.html#a5421702ef8229d3ca4225e6e8d14033">pa_source_info::channel_map</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Channel map.
<p>
</div>
</div><p>
<a class="anchor" name="9d18ad1b45483014c84055ddce0b5e7d"></a><!-- doxytag: member="pa_source_info::configured_latency" ref="9d18ad1b45483014c84055ddce0b5e7d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="sample_8h.html#885df3b973773f0dccbbec6bc6777f89">pa_usec_t</a> <a class="el" href="structpa__source__info.html#9d18ad1b45483014c84055ddce0b5e7d">pa_source_info::configured_latency</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The latency this device has been configured to.
<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd>0.9.11 </dd></dl>
</div>
</div><p>
<a class="anchor" name="c67e3147b1560c94fb215e265afdf077"></a><!-- doxytag: member="pa_source_info::description" ref="c67e3147b1560c94fb215e265afdf077" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* <a class="el" href="structpa__source__info.html#c67e3147b1560c94fb215e265afdf077">pa_source_info::description</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Description of this source.
<p>
</div>
</div><p>
<a class="anchor" name="330b6032ab2411e38c84bfd102677aed"></a><!-- doxytag: member="pa_source_info::driver" ref="330b6032ab2411e38c84bfd102677aed" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* <a class="el" href="structpa__source__info.html#330b6032ab2411e38c84bfd102677aed">pa_source_info::driver</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Driver name.
<p>
</div>
</div><p>
<a class="anchor" name="fe48c018865c45058174e9ba2ef7356f"></a><!-- doxytag: member="pa_source_info::flags" ref="fe48c018865c45058174e9ba2ef7356f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="def_8h.html#1177496dc4c63e0cce094ed849a9ef8d">pa_source_flags_t</a> <a class="el" href="structpa__source__info.html#fe48c018865c45058174e9ba2ef7356f">pa_source_info::flags</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Flags.
<p>
</div>
</div><p>
<a class="anchor" name="aea5cb728eff6a6e47fd4b2a57c68800"></a><!-- doxytag: member="pa_source_info::index" ref="aea5cb728eff6a6e47fd4b2a57c68800" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t <a class="el" href="structpa__source__info.html#aea5cb728eff6a6e47fd4b2a57c68800">pa_source_info::index</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Index of the source.
<p>
</div>
</div><p>
<a class="anchor" name="5ed69b0cede6c4f9508ebca50a79c1ba"></a><!-- doxytag: member="pa_source_info::latency" ref="5ed69b0cede6c4f9508ebca50a79c1ba" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="sample_8h.html#885df3b973773f0dccbbec6bc6777f89">pa_usec_t</a> <a class="el" href="structpa__source__info.html#5ed69b0cede6c4f9508ebca50a79c1ba">pa_source_info::latency</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Length of filled record buffer of this source.
<p>
</div>
</div><p>
<a class="anchor" name="5e304b796ce71c7fa54e5a88f3333630"></a><!-- doxytag: member="pa_source_info::monitor_of_sink" ref="5e304b796ce71c7fa54e5a88f3333630" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t <a class="el" href="structpa__source__info.html#5e304b796ce71c7fa54e5a88f3333630">pa_source_info::monitor_of_sink</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
If this is a monitor source the index of the owning sink, otherwise PA_INVALID_INDEX.
<p>
</div>
</div><p>
<a class="anchor" name="57574e2d67787b7c7a742ea742577880"></a><!-- doxytag: member="pa_source_info::monitor_of_sink_name" ref="57574e2d67787b7c7a742ea742577880" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* <a class="el" href="structpa__source__info.html#57574e2d67787b7c7a742ea742577880">pa_source_info::monitor_of_sink_name</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Name of the owning sink, or PA_INVALID_INDEX.
<p>
</div>
</div><p>
<a class="anchor" name="bcadbb57169622929271f2c106ccb3bf"></a><!-- doxytag: member="pa_source_info::mute" ref="bcadbb57169622929271f2c106ccb3bf" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="structpa__source__info.html#bcadbb57169622929271f2c106ccb3bf">pa_source_info::mute</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Mute switch of the sink.
<p>
</div>
</div><p>
<a class="anchor" name="079323d09fdbce973533b791b792cfcc"></a><!-- doxytag: member="pa_source_info::n_volume_steps" ref="079323d09fdbce973533b791b792cfcc" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t <a class="el" href="structpa__source__info.html#079323d09fdbce973533b791b792cfcc">pa_source_info::n_volume_steps</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Number of volume steps for sources which do not support arbitrary volumes.
<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd>0.9.15 </dd></dl>
</div>
</div><p>
<a class="anchor" name="61afc17239989ccac42c9b143c8dafbd"></a><!-- doxytag: member="pa_source_info::name" ref="61afc17239989ccac42c9b143c8dafbd" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* <a class="el" href="structpa__source__info.html#61afc17239989ccac42c9b143c8dafbd">pa_source_info::name</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Name of the source.
<p>
</div>
</div><p>
<a class="anchor" name="a0478463eb67bf22f724a25b07e544e3"></a><!-- doxytag: member="pa_source_info::owner_module" ref="a0478463eb67bf22f724a25b07e544e3" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t <a class="el" href="structpa__source__info.html#a0478463eb67bf22f724a25b07e544e3">pa_source_info::owner_module</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Owning module index, or PA_INVALID_INDEX.
<p>
</div>
</div><p>
<a class="anchor" name="18fd48b4f94232408c5896fa3cb48aa9"></a><!-- doxytag: member="pa_source_info::proplist" ref="18fd48b4f94232408c5896fa3cb48aa9" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="proplist_8h.html#cdf756a6014b6fae3b358b2c934c3426">pa_proplist</a>* <a class="el" href="structpa__source__info.html#18fd48b4f94232408c5896fa3cb48aa9">pa_source_info::proplist</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
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="31aa76b7f145f448472e065b08df238d"></a><!-- doxytag: member="pa_source_info::sample_spec" ref="31aa76b7f145f448472e065b08df238d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structpa__sample__spec.html">pa_sample_spec</a> <a class="el" href="structpa__source__info.html#31aa76b7f145f448472e065b08df238d">pa_source_info::sample_spec</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sample spec of this source.
<p>
</div>
</div><p>
<a class="anchor" name="4fc4bd5fe3ce3226f04b11270d26ffeb"></a><!-- doxytag: member="pa_source_info::state" ref="4fc4bd5fe3ce3226f04b11270d26ffeb" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="def_8h.html#2be5558ab768f960e50c18e252c2f906">pa_source_state_t</a> <a class="el" href="structpa__source__info.html#4fc4bd5fe3ce3226f04b11270d26ffeb">pa_source_info::state</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
State.
<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd>0.9.15 </dd></dl>
</div>
</div><p>
<a class="anchor" name="14feca3480affae3bb15c5cb3400dce3"></a><!-- doxytag: member="pa_source_info::volume" ref="14feca3480affae3bb15c5cb3400dce3" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structpa__cvolume.html">pa_cvolume</a> <a class="el" href="structpa__source__info.html#14feca3480affae3bb15c5cb3400dce3">pa_source_info::volume</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Volume of the source.
<p>
</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="introspect_8h-source.html">introspect.h</a></ul>
</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
>
170
