<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.3"/> <title>PulseAudio: pa_sink_input_info Struct Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="navtree.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="resize.js"></script> <script type="text/javascript" src="navtree.js"></script> <script type="text/javascript"> $(document).ready(initResizable); $(window).load(resizeHeight); </script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">PulseAudio  <span id="projectnumber">2.1</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.3 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.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 id="navrow2" class="tabs2"> <ul class="tablist"> <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><!-- top --> <div id="side-nav" class="ui-resizable side-nav-resizable"> <div id="nav-tree"> <div id="nav-tree-contents"> <div id="nav-sync" class="sync"></div> </div> </div> <div id="splitbar" style="-moz-user-select:none;" class="ui-resizable-handle"> </div> </div> <script type="text/javascript"> $(document).ready(function(){initNavTree('structpa__sink__input__info.html','');}); </script> <div id="doc-content"> <div class="header"> <div class="summary"> <a href="#pub-attribs">Data Fields</a> </div> <div class="headertitle"> <div class="title">pa_sink_input_info Struct Reference</div> </div> </div><!--header--> <div class="contents"> <p>Stores information about sink inputs. <a href="structpa__sink__input__info.html#details">More...</a></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> Data Fields</h2></td></tr> <tr class="memitem:acd5d1487d5070bfef2fc0c8d49e9a4b7"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structpa__sink__input__info.html#acd5d1487d5070bfef2fc0c8d49e9a4b7">index</a></td></tr> <tr class="memdesc:acd5d1487d5070bfef2fc0c8d49e9a4b7"><td class="mdescLeft"> </td><td class="mdescRight">Index of the sink input. <a href="#acd5d1487d5070bfef2fc0c8d49e9a4b7"></a><br/></td></tr> <tr class="separator:acd5d1487d5070bfef2fc0c8d49e9a4b7"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:abb409bffd3e2fe178ceccf8cc7e50ae1"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structpa__sink__input__info.html#abb409bffd3e2fe178ceccf8cc7e50ae1">name</a></td></tr> <tr class="memdesc:abb409bffd3e2fe178ceccf8cc7e50ae1"><td class="mdescLeft"> </td><td class="mdescRight">Name of the sink input. <a href="#abb409bffd3e2fe178ceccf8cc7e50ae1"></a><br/></td></tr> <tr class="separator:abb409bffd3e2fe178ceccf8cc7e50ae1"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a113643047c5494375c949e5389c21639"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structpa__sink__input__info.html#a113643047c5494375c949e5389c21639">owner_module</a></td></tr> <tr class="memdesc:a113643047c5494375c949e5389c21639"><td class="mdescLeft"> </td><td class="mdescRight">Index of the module this sink input belongs to, or PA_INVALID_INDEX when it does not belong to any module. <a href="#a113643047c5494375c949e5389c21639"></a><br/></td></tr> <tr class="separator:a113643047c5494375c949e5389c21639"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af728f258ad97e60dd6b9683069d193be"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structpa__sink__input__info.html#af728f258ad97e60dd6b9683069d193be">client</a></td></tr> <tr class="memdesc:af728f258ad97e60dd6b9683069d193be"><td class="mdescLeft"> </td><td class="mdescRight">Index of the client this sink input belongs to, or PA_INVALID_INDEX when it does not belong to any client. <a href="#af728f258ad97e60dd6b9683069d193be"></a><br/></td></tr> <tr class="separator:af728f258ad97e60dd6b9683069d193be"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:adb7c559f8a0e0d54b3ca67ab86f04362"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structpa__sink__input__info.html#adb7c559f8a0e0d54b3ca67ab86f04362">sink</a></td></tr> <tr class="memdesc:adb7c559f8a0e0d54b3ca67ab86f04362"><td class="mdescLeft"> </td><td class="mdescRight">Index of the connected sink. <a href="#adb7c559f8a0e0d54b3ca67ab86f04362"></a><br/></td></tr> <tr class="separator:adb7c559f8a0e0d54b3ca67ab86f04362"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a18f20925b3f720b7baaa89769d4b9311"><td class="memItemLeft" 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__input__info.html#a18f20925b3f720b7baaa89769d4b9311">sample_spec</a></td></tr> <tr class="memdesc:a18f20925b3f720b7baaa89769d4b9311"><td class="mdescLeft"> </td><td class="mdescRight">The sample specification of the sink input. <a href="#a18f20925b3f720b7baaa89769d4b9311"></a><br/></td></tr> <tr class="separator:a18f20925b3f720b7baaa89769d4b9311"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af421fe617ada495512b3506c982ffa1f"><td class="memItemLeft" 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__input__info.html#af421fe617ada495512b3506c982ffa1f">channel_map</a></td></tr> <tr class="memdesc:af421fe617ada495512b3506c982ffa1f"><td class="mdescLeft"> </td><td class="mdescRight">Channel map. <a href="#af421fe617ada495512b3506c982ffa1f"></a><br/></td></tr> <tr class="separator:af421fe617ada495512b3506c982ffa1f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a1e2b2dc874e475839336a9140b2af9f0"><td class="memItemLeft" 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__input__info.html#a1e2b2dc874e475839336a9140b2af9f0">volume</a></td></tr> <tr class="memdesc:a1e2b2dc874e475839336a9140b2af9f0"><td class="mdescLeft"> </td><td class="mdescRight">The volume of this sink input. <a href="#a1e2b2dc874e475839336a9140b2af9f0"></a><br/></td></tr> <tr class="separator:a1e2b2dc874e475839336a9140b2af9f0"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af487869061e436ffc539647e8b66fb89"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sample_8h.html#a885df3b973773f0dccbbec6bc6777f89">pa_usec_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structpa__sink__input__info.html#af487869061e436ffc539647e8b66fb89">buffer_usec</a></td></tr> <tr class="memdesc:af487869061e436ffc539647e8b66fb89"><td class="mdescLeft"> </td><td class="mdescRight">Latency due to buffering in sink input, see pa_latency_info for details. <a href="#af487869061e436ffc539647e8b66fb89"></a><br/></td></tr> <tr class="separator:af487869061e436ffc539647e8b66fb89"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aa37d5ef5d2c37dcd0e0238eb22a7db41"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sample_8h.html#a885df3b973773f0dccbbec6bc6777f89">pa_usec_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structpa__sink__input__info.html#aa37d5ef5d2c37dcd0e0238eb22a7db41">sink_usec</a></td></tr> <tr class="memdesc:aa37d5ef5d2c37dcd0e0238eb22a7db41"><td class="mdescLeft"> </td><td class="mdescRight">Latency of the sink device, see pa_latency_info for details. <a href="#aa37d5ef5d2c37dcd0e0238eb22a7db41"></a><br/></td></tr> <tr class="separator:aa37d5ef5d2c37dcd0e0238eb22a7db41"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aed5eff15179aed0dca02d4c639a1ac58"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structpa__sink__input__info.html#aed5eff15179aed0dca02d4c639a1ac58">resample_method</a></td></tr> <tr class="memdesc:aed5eff15179aed0dca02d4c639a1ac58"><td class="mdescLeft"> </td><td class="mdescRight">The resampling method used by this sink input. <a href="#aed5eff15179aed0dca02d4c639a1ac58"></a><br/></td></tr> <tr class="separator:aed5eff15179aed0dca02d4c639a1ac58"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aea9cddf3c579d90a28cb5958ab964720"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structpa__sink__input__info.html#aea9cddf3c579d90a28cb5958ab964720">driver</a></td></tr> <tr class="memdesc:aea9cddf3c579d90a28cb5958ab964720"><td class="mdescLeft"> </td><td class="mdescRight">Driver name. <a href="#aea9cddf3c579d90a28cb5958ab964720"></a><br/></td></tr> <tr class="separator:aea9cddf3c579d90a28cb5958ab964720"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a85b6207f4579f580adf7b63695f6e0fd"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structpa__sink__input__info.html#a85b6207f4579f580adf7b63695f6e0fd">mute</a></td></tr> <tr class="memdesc:a85b6207f4579f580adf7b63695f6e0fd"><td class="mdescLeft"> </td><td class="mdescRight">Stream muted. <a href="#a85b6207f4579f580adf7b63695f6e0fd"></a><br/></td></tr> <tr class="separator:a85b6207f4579f580adf7b63695f6e0fd"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a4247791d532b700e048509c5643301a1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="proplist_8h.html#acdf756a6014b6fae3b358b2c934c3426">pa_proplist</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structpa__sink__input__info.html#a4247791d532b700e048509c5643301a1">proplist</a></td></tr> <tr class="memdesc:a4247791d532b700e048509c5643301a1"><td class="mdescLeft"> </td><td class="mdescRight">Property list. <a href="#a4247791d532b700e048509c5643301a1"></a><br/></td></tr> <tr class="separator:a4247791d532b700e048509c5643301a1"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aa6059e830f24f40ee1c5eba5959c27ef"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structpa__sink__input__info.html#aa6059e830f24f40ee1c5eba5959c27ef">corked</a></td></tr> <tr class="memdesc:aa6059e830f24f40ee1c5eba5959c27ef"><td class="mdescLeft"> </td><td class="mdescRight">Stream corked. <a href="#aa6059e830f24f40ee1c5eba5959c27ef"></a><br/></td></tr> <tr class="separator:aa6059e830f24f40ee1c5eba5959c27ef"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af7ee7a8459e2b322ef63e2707da6b08a"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structpa__sink__input__info.html#af7ee7a8459e2b322ef63e2707da6b08a">has_volume</a></td></tr> <tr class="memdesc:af7ee7a8459e2b322ef63e2707da6b08a"><td class="mdescLeft"> </td><td class="mdescRight">Stream has volume. <a href="#af7ee7a8459e2b322ef63e2707da6b08a"></a><br/></td></tr> <tr class="separator:af7ee7a8459e2b322ef63e2707da6b08a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a6c68a62ae96fab5b31b18377171c8673"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structpa__sink__input__info.html#a6c68a62ae96fab5b31b18377171c8673">volume_writable</a></td></tr> <tr class="memdesc:a6c68a62ae96fab5b31b18377171c8673"><td class="mdescLeft"> </td><td class="mdescRight">The volume can be set. <a href="#a6c68a62ae96fab5b31b18377171c8673"></a><br/></td></tr> <tr class="separator:a6c68a62ae96fab5b31b18377171c8673"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aa41638ed414c2132a8425fd16b910bd7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structpa__format__info.html">pa_format_info</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structpa__sink__input__info.html#aa41638ed414c2132a8425fd16b910bd7">format</a></td></tr> <tr class="memdesc:aa41638ed414c2132a8425fd16b910bd7"><td class="mdescLeft"> </td><td class="mdescRight">Stream format information. <a href="#aa41638ed414c2132a8425fd16b910bd7"></a><br/></td></tr> <tr class="separator:aa41638ed414c2132a8425fd16b910bd7"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>Stores information about sink inputs. </p> <p>Please note that this structure can be extended as part of evolutionary API updates at any time in any new release. </p> </div><h2 class="groupheader">Field Documentation</h2> <a class="anchor" id="af487869061e436ffc539647e8b66fb89"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="sample_8h.html#a885df3b973773f0dccbbec6bc6777f89">pa_usec_t</a> pa_sink_input_info::buffer_usec</td> </tr> </table> </div><div class="memdoc"> <p>Latency due to buffering in sink input, see pa_latency_info for details. </p> </div> </div> <a class="anchor" id="af421fe617ada495512b3506c982ffa1f"></a> <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> pa_sink_input_info::channel_map</td> </tr> </table> </div><div class="memdoc"> <p>Channel map. </p> </div> </div> <a class="anchor" id="af728f258ad97e60dd6b9683069d193be"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">uint32_t pa_sink_input_info::client</td> </tr> </table> </div><div class="memdoc"> <p>Index of the client this sink input belongs to, or PA_INVALID_INDEX when it does not belong to any client. </p> </div> </div> <a class="anchor" id="aa6059e830f24f40ee1c5eba5959c27ef"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int pa_sink_input_info::corked</td> </tr> </table> </div><div class="memdoc"> <p>Stream corked. </p> <dl class="section since"><dt>Since</dt><dd>1.0 </dd></dl> </div> </div> <a class="anchor" id="aea9cddf3c579d90a28cb5958ab964720"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char* pa_sink_input_info::driver</td> </tr> </table> </div><div class="memdoc"> <p>Driver name. </p> </div> </div> <a class="anchor" id="aa41638ed414c2132a8425fd16b910bd7"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="structpa__format__info.html">pa_format_info</a>* pa_sink_input_info::format</td> </tr> </table> </div><div class="memdoc"> <p>Stream format information. </p> <dl class="section since"><dt>Since</dt><dd>1.0 </dd></dl> </div> </div> <a class="anchor" id="af7ee7a8459e2b322ef63e2707da6b08a"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int pa_sink_input_info::has_volume</td> </tr> </table> </div><div class="memdoc"> <p>Stream has volume. </p> <p>If not set, then the meaning of this struct's volume member is unspecified.</p> <dl class="section since"><dt>Since</dt><dd>1.0 </dd></dl> </div> </div> <a class="anchor" id="acd5d1487d5070bfef2fc0c8d49e9a4b7"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">uint32_t pa_sink_input_info::index</td> </tr> </table> </div><div class="memdoc"> <p>Index of the sink input. </p> </div> </div> <a class="anchor" id="a85b6207f4579f580adf7b63695f6e0fd"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int pa_sink_input_info::mute</td> </tr> </table> </div><div class="memdoc"> <p>Stream muted. </p> <dl class="section since"><dt>Since</dt><dd>0.9.7 </dd></dl> </div> </div> <a class="anchor" id="abb409bffd3e2fe178ceccf8cc7e50ae1"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char* pa_sink_input_info::name</td> </tr> </table> </div><div class="memdoc"> <p>Name of the sink input. </p> </div> </div> <a class="anchor" id="a113643047c5494375c949e5389c21639"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">uint32_t pa_sink_input_info::owner_module</td> </tr> </table> </div><div class="memdoc"> <p>Index of the module this sink input belongs to, or PA_INVALID_INDEX when it does not belong to any module. </p> </div> </div> <a class="anchor" id="a4247791d532b700e048509c5643301a1"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="proplist_8h.html#acdf756a6014b6fae3b358b2c934c3426">pa_proplist</a>* pa_sink_input_info::proplist</td> </tr> </table> </div><div class="memdoc"> <p>Property list. </p> <dl class="section since"><dt>Since</dt><dd>0.9.11 </dd></dl> </div> </div> <a class="anchor" id="aed5eff15179aed0dca02d4c639a1ac58"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char* pa_sink_input_info::resample_method</td> </tr> </table> </div><div class="memdoc"> <p>The resampling method used by this sink input. </p> </div> </div> <a class="anchor" id="a18f20925b3f720b7baaa89769d4b9311"></a> <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> pa_sink_input_info::sample_spec</td> </tr> </table> </div><div class="memdoc"> <p>The sample specification of the sink input. </p> </div> </div> <a class="anchor" id="adb7c559f8a0e0d54b3ca67ab86f04362"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">uint32_t pa_sink_input_info::sink</td> </tr> </table> </div><div class="memdoc"> <p>Index of the connected sink. </p> </div> </div> <a class="anchor" id="aa37d5ef5d2c37dcd0e0238eb22a7db41"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="sample_8h.html#a885df3b973773f0dccbbec6bc6777f89">pa_usec_t</a> pa_sink_input_info::sink_usec</td> </tr> </table> </div><div class="memdoc"> <p>Latency of the sink device, see pa_latency_info for details. </p> </div> </div> <a class="anchor" id="a1e2b2dc874e475839336a9140b2af9f0"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="structpa__cvolume.html">pa_cvolume</a> pa_sink_input_info::volume</td> </tr> </table> </div><div class="memdoc"> <p>The volume of this sink input. </p> </div> </div> <a class="anchor" id="a6c68a62ae96fab5b31b18377171c8673"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int pa_sink_input_info::volume_writable</td> </tr> </table> </div><div class="memdoc"> <p>The volume can be set. </p> <p>If not set, the volume can still change even though clients can't control the volume.</p> <dl class="section since"><dt>Since</dt><dd>1.0 </dd></dl> </div> </div> <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></li> </ul> </div><!-- contents --> </div><!-- doc-content --> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="navelem"><a class="el" href="structpa__sink__input__info.html">pa_sink_input_info</a></li> <li class="footer">Generated by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.3 </li> </ul> </div> </body> </html>