<!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_sink_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_sink_info Struct Reference</h1><!-- doxytag: class="pa_sink_info" -->Stores information about sinks.
<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__sink__info.html#66f0e7dd799c8c7cf800c481a2866276">name</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Name of the sink. <a href="#66f0e7dd799c8c7cf800c481a2866276"></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__sink__info.html#18fd50e556478fdec857fead7d2ded04">index</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Index of the sink. <a href="#18fd50e556478fdec857fead7d2ded04"></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__sink__info.html#c2bb6605579c4962511eed3c113962ee">description</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Description of this sink. <a href="#c2bb6605579c4962511eed3c113962ee"></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__sink__info.html#178d2358c2ed17a6ae6088f9cd79cc7a">sample_spec</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sample spec of this sink. <a href="#178d2358c2ed17a6ae6088f9cd79cc7a"></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__sink__info.html#63d52fb9c811644ab6179a49dbcdc330">channel_map</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Channel map. <a href="#63d52fb9c811644ab6179a49dbcdc330"></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__sink__info.html#95aaf34a3dcc08486df1e31947d87617">owner_module</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Index of the owning module of this sink, or PA_INVALID_INDEX. <a href="#95aaf34a3dcc08486df1e31947d87617"></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__sink__info.html#e319476958f091f92f1a97a983363767">volume</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Volume of the sink. <a href="#e319476958f091f92f1a97a983363767"></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__sink__info.html#b73ed639790cce4fc11ea4991c651691">mute</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Mute switch of the sink. <a href="#b73ed639790cce4fc11ea4991c651691"></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__sink__info.html#d9946f956c2c67a47b4446f8034c3f2d">monitor_source</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Index of the monitor source connected to this sink. <a href="#d9946f956c2c67a47b4446f8034c3f2d"></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__sink__info.html#59dc10c527bb0b837b4d937a901cdd4f">monitor_source_name</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The name of the monitor source. <a href="#59dc10c527bb0b837b4d937a901cdd4f"></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__sink__info.html#872cc1f311330e161f9b7990200b8b21">latency</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Length of queued audio in the output buffer. <a href="#872cc1f311330e161f9b7990200b8b21"></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__sink__info.html#b3a090937bf1389a7ffb7583065a136b">driver</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Driver name. <a href="#b3a090937bf1389a7ffb7583065a136b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="def_8h.html#33360cff8c751ad1b8a557e074463a99">pa_sink_flags_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structpa__sink__info.html#3c9f43295084e6dddb4d3e12cdb69220">flags</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Flags. <a href="#3c9f43295084e6dddb4d3e12cdb69220"></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__sink__info.html#ca4c6228ebbcae6c05e5288945867cda">proplist</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Property list. <a href="#ca4c6228ebbcae6c05e5288945867cda"></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__sink__info.html#5043ee6996ea976e51a26a2c2b13120e">configured_latency</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The latency this device has been configured to. <a href="#5043ee6996ea976e51a26a2c2b13120e"></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__sink__info.html#2332e2ca20f797f65162fe725cc6e0fd">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 output device. <a href="#2332e2ca20f797f65162fe725cc6e0fd"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="def_8h.html#f1ba5b1cd9a58a5a914231862779a88f">pa_sink_state_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structpa__sink__info.html#e10dc516faa471cdcba1ef03c75c209e">state</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">State. <a href="#e10dc516faa471cdcba1ef03c75c209e"></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__sink__info.html#18b1010e061aada3d2d8cab1874c75ce">n_volume_steps</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Number of volume steps for sinks which do not support arbitrary volumes. <a href="#18b1010e061aada3d2d8cab1874c75ce"></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__sink__info.html#18371dac55a1163c3f616d1f92d58706">card</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Card index, or PA_INVALID_INDEX. <a href="#18371dac55a1163c3f616d1f92d58706"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Stores information about sinks.
<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="2332e2ca20f797f65162fe725cc6e0fd"></a><!-- doxytag: member="pa_sink_info::base_volume" ref="2332e2ca20f797f65162fe725cc6e0fd" 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__sink__info.html#2332e2ca20f797f65162fe725cc6e0fd">pa_sink_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 output device.
<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd>0.9.15 </dd></dl>
</div>
</div><p>
<a class="anchor" name="18371dac55a1163c3f616d1f92d58706"></a><!-- doxytag: member="pa_sink_info::card" ref="18371dac55a1163c3f616d1f92d58706" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t <a class="el" href="structpa__sink__info.html#18371dac55a1163c3f616d1f92d58706">pa_sink_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="63d52fb9c811644ab6179a49dbcdc330"></a><!-- doxytag: member="pa_sink_info::channel_map" ref="63d52fb9c811644ab6179a49dbcdc330" 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__sink__info.html#63d52fb9c811644ab6179a49dbcdc330">pa_sink_info::channel_map</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Channel map.
<p>
</div>
</div><p>
<a class="anchor" name="5043ee6996ea976e51a26a2c2b13120e"></a><!-- doxytag: member="pa_sink_info::configured_latency" ref="5043ee6996ea976e51a26a2c2b13120e" 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__sink__info.html#5043ee6996ea976e51a26a2c2b13120e">pa_sink_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="c2bb6605579c4962511eed3c113962ee"></a><!-- doxytag: member="pa_sink_info::description" ref="c2bb6605579c4962511eed3c113962ee" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* <a class="el" href="structpa__sink__info.html#c2bb6605579c4962511eed3c113962ee">pa_sink_info::description</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Description of this sink.
<p>
</div>
</div><p>
<a class="anchor" name="b3a090937bf1389a7ffb7583065a136b"></a><!-- doxytag: member="pa_sink_info::driver" ref="b3a090937bf1389a7ffb7583065a136b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* <a class="el" href="structpa__sink__info.html#b3a090937bf1389a7ffb7583065a136b">pa_sink_info::driver</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Driver name.
<p>
</div>
</div><p>
<a class="anchor" name="3c9f43295084e6dddb4d3e12cdb69220"></a><!-- doxytag: member="pa_sink_info::flags" ref="3c9f43295084e6dddb4d3e12cdb69220" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="def_8h.html#33360cff8c751ad1b8a557e074463a99">pa_sink_flags_t</a> <a class="el" href="structpa__sink__info.html#3c9f43295084e6dddb4d3e12cdb69220">pa_sink_info::flags</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Flags.
<p>
</div>
</div><p>
<a class="anchor" name="18fd50e556478fdec857fead7d2ded04"></a><!-- doxytag: member="pa_sink_info::index" ref="18fd50e556478fdec857fead7d2ded04" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t <a class="el" href="structpa__sink__info.html#18fd50e556478fdec857fead7d2ded04">pa_sink_info::index</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Index of the sink.
<p>
</div>
</div><p>
<a class="anchor" name="872cc1f311330e161f9b7990200b8b21"></a><!-- doxytag: member="pa_sink_info::latency" ref="872cc1f311330e161f9b7990200b8b21" 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__sink__info.html#872cc1f311330e161f9b7990200b8b21">pa_sink_info::latency</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Length of queued audio in the output buffer.
<p>
</div>
</div><p>
<a class="anchor" name="d9946f956c2c67a47b4446f8034c3f2d"></a><!-- doxytag: member="pa_sink_info::monitor_source" ref="d9946f956c2c67a47b4446f8034c3f2d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t <a class="el" href="structpa__sink__info.html#d9946f956c2c67a47b4446f8034c3f2d">pa_sink_info::monitor_source</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Index of the monitor source connected to this sink.
<p>
</div>
</div><p>
<a class="anchor" name="59dc10c527bb0b837b4d937a901cdd4f"></a><!-- doxytag: member="pa_sink_info::monitor_source_name" ref="59dc10c527bb0b837b4d937a901cdd4f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* <a class="el" href="structpa__sink__info.html#59dc10c527bb0b837b4d937a901cdd4f">pa_sink_info::monitor_source_name</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The name of the monitor source.
<p>
</div>
</div><p>
<a class="anchor" name="b73ed639790cce4fc11ea4991c651691"></a><!-- doxytag: member="pa_sink_info::mute" ref="b73ed639790cce4fc11ea4991c651691" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="structpa__sink__info.html#b73ed639790cce4fc11ea4991c651691">pa_sink_info::mute</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Mute switch of the sink.
<p>
</div>
</div><p>
<a class="anchor" name="18b1010e061aada3d2d8cab1874c75ce"></a><!-- doxytag: member="pa_sink_info::n_volume_steps" ref="18b1010e061aada3d2d8cab1874c75ce" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t <a class="el" href="structpa__sink__info.html#18b1010e061aada3d2d8cab1874c75ce">pa_sink_info::n_volume_steps</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Number of volume steps for sinks 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="66f0e7dd799c8c7cf800c481a2866276"></a><!-- doxytag: member="pa_sink_info::name" ref="66f0e7dd799c8c7cf800c481a2866276" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* <a class="el" href="structpa__sink__info.html#66f0e7dd799c8c7cf800c481a2866276">pa_sink_info::name</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Name of the sink.
<p>
</div>
</div><p>
<a class="anchor" name="95aaf34a3dcc08486df1e31947d87617"></a><!-- doxytag: member="pa_sink_info::owner_module" ref="95aaf34a3dcc08486df1e31947d87617" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t <a class="el" href="structpa__sink__info.html#95aaf34a3dcc08486df1e31947d87617">pa_sink_info::owner_module</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Index of the owning module of this sink, or PA_INVALID_INDEX.
<p>
</div>
</div><p>
<a class="anchor" name="ca4c6228ebbcae6c05e5288945867cda"></a><!-- doxytag: member="pa_sink_info::proplist" ref="ca4c6228ebbcae6c05e5288945867cda" 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__sink__info.html#ca4c6228ebbcae6c05e5288945867cda">pa_sink_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="178d2358c2ed17a6ae6088f9cd79cc7a"></a><!-- doxytag: member="pa_sink_info::sample_spec" ref="178d2358c2ed17a6ae6088f9cd79cc7a" 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__sink__info.html#178d2358c2ed17a6ae6088f9cd79cc7a">pa_sink_info::sample_spec</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sample spec of this sink.
<p>
</div>
</div><p>
<a class="anchor" name="e10dc516faa471cdcba1ef03c75c209e"></a><!-- doxytag: member="pa_sink_info::state" ref="e10dc516faa471cdcba1ef03c75c209e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="def_8h.html#f1ba5b1cd9a58a5a914231862779a88f">pa_sink_state_t</a> <a class="el" href="structpa__sink__info.html#e10dc516faa471cdcba1ef03c75c209e">pa_sink_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="e319476958f091f92f1a97a983363767"></a><!-- doxytag: member="pa_sink_info::volume" ref="e319476958f091f92f1a97a983363767" 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__sink__info.html#e319476958f091f92f1a97a983363767">pa_sink_info::volume</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Volume of the sink.
<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
>
168
