| Current File : //proc/self/root/kunden/usr/share/doc/pulseaudio-libs-devel/html/structpa__sink__port__info.html |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>PulseAudio: pa_sink_port_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="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">PulseAudio
 <span id="projectnumber">15.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></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">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('structpa__sink__port__info.html',''); initResizable(); });
/* @license-end */
</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_port_info Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Stores information about a specific port of a sink.
<a href="structpa__sink__port__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:a58a6dd04307c2ee5577ed39d744df680"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structpa__sink__port__info.html#a58a6dd04307c2ee5577ed39d744df680">name</a></td></tr>
<tr class="memdesc:a58a6dd04307c2ee5577ed39d744df680"><td class="mdescLeft"> </td><td class="mdescRight">Name of this port. <a href="structpa__sink__port__info.html#a58a6dd04307c2ee5577ed39d744df680">More...</a><br /></td></tr>
<tr class="separator:a58a6dd04307c2ee5577ed39d744df680"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aebd20222053b72fd4fd7a996724c91ff"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structpa__sink__port__info.html#aebd20222053b72fd4fd7a996724c91ff">description</a></td></tr>
<tr class="memdesc:aebd20222053b72fd4fd7a996724c91ff"><td class="mdescLeft"> </td><td class="mdescRight">Description of this port. <a href="structpa__sink__port__info.html#aebd20222053b72fd4fd7a996724c91ff">More...</a><br /></td></tr>
<tr class="separator:aebd20222053b72fd4fd7a996724c91ff"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a49120ec9b0a5aaf75eb83c8cedd7af1d"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structpa__sink__port__info.html#a49120ec9b0a5aaf75eb83c8cedd7af1d">priority</a></td></tr>
<tr class="memdesc:a49120ec9b0a5aaf75eb83c8cedd7af1d"><td class="mdescLeft"> </td><td class="mdescRight">The higher this value is, the more useful this port is as a default. <a href="structpa__sink__port__info.html#a49120ec9b0a5aaf75eb83c8cedd7af1d">More...</a><br /></td></tr>
<tr class="separator:a49120ec9b0a5aaf75eb83c8cedd7af1d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8d3c1b5d08840ea7835e1064ffda58a4"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structpa__sink__port__info.html#a8d3c1b5d08840ea7835e1064ffda58a4">available</a></td></tr>
<tr class="memdesc:a8d3c1b5d08840ea7835e1064ffda58a4"><td class="mdescLeft"> </td><td class="mdescRight">A flags (see <a class="el" href="def_8h.html#a72f790c31bf10c1d244aa078c4cdb345" title="Port availability / jack detection status.">pa_port_available</a>), indicating availability status of this port. <a href="structpa__sink__port__info.html#a8d3c1b5d08840ea7835e1064ffda58a4">More...</a><br /></td></tr>
<tr class="separator:a8d3c1b5d08840ea7835e1064ffda58a4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a131d1f069b4d60f9bb00dec17d8269c8"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structpa__sink__port__info.html#a131d1f069b4d60f9bb00dec17d8269c8">availability_group</a></td></tr>
<tr class="memdesc:a131d1f069b4d60f9bb00dec17d8269c8"><td class="mdescLeft"> </td><td class="mdescRight">An indentifier for the group of ports that share their availability status with each other. <a href="structpa__sink__port__info.html#a131d1f069b4d60f9bb00dec17d8269c8">More...</a><br /></td></tr>
<tr class="separator:a131d1f069b4d60f9bb00dec17d8269c8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa17f3e340845799d7b2638b852206d8c"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structpa__sink__port__info.html#aa17f3e340845799d7b2638b852206d8c">type</a></td></tr>
<tr class="memdesc:aa17f3e340845799d7b2638b852206d8c"><td class="mdescLeft"> </td><td class="mdescRight">Port type, see <a class="el" href="def_8h.html#a6b86472b4fa68a20d1412a95a8ba83e6" title="Port type.">pa_device_port_type</a>. <a href="structpa__sink__port__info.html#aa17f3e340845799d7b2638b852206d8c">More...</a><br /></td></tr>
<tr class="separator:aa17f3e340845799d7b2638b852206d8c"><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 a specific port of a sink. </p>
<p>Please note that this structure can be extended as part of evolutionary API updates at any time in any new release. </p><dl class="section since"><dt>Since</dt><dd>0.9.16 </dd></dl>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="a131d1f069b4d60f9bb00dec17d8269c8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a131d1f069b4d60f9bb00dec17d8269c8">◆ </a></span>availability_group</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* pa_sink_port_info::availability_group</td>
</tr>
</table>
</div><div class="memdoc">
<p>An indentifier for the group of ports that share their availability status with each other. </p>
<p>This is meant especially for handling cases where one 3.5 mm connector is used for headphones, headsets and microphones, and the hardware can only tell that something was plugged in but not what exactly. In this situation the ports for all those devices share their availability status, and PulseAudio can't tell which one is actually plugged in, and some application may ask the user what was plugged in. Such applications should get a list of all card ports and compare their <code>availability_group</code> fields. Ports that have the same group are those that need input from the user to determine which device was plugged in. The application should then activate the user-chosen port.</p>
<p>May be NULL, in which case the port is not part of any availability group.</p>
<p>The group identifier must be treated as an opaque identifier. The string may look like an ALSA control name, but applications must not assume any such relationship. The group naming scheme can change without a warning.</p>
<p>Since one group can include both input and output ports, the grouping should be done using <a class="el" href="structpa__card__port__info.html" title="Stores information about a specific port of a card.">pa_card_port_info</a> instead of <a class="el" href="structpa__sink__port__info.html" title="Stores information about a specific port of a sink.">pa_sink_port_info</a>, but this field is duplicated also in <a class="el" href="structpa__sink__port__info.html" title="Stores information about a specific port of a sink.">pa_sink_port_info</a> (and <a class="el" href="structpa__source__port__info.html" title="Stores information about a specific port of a source.">pa_source_port_info</a>) in case someone finds that convenient.</p>
<dl class="section since"><dt>Since</dt><dd>14.0 </dd></dl>
</div>
</div>
<a id="a8d3c1b5d08840ea7835e1064ffda58a4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8d3c1b5d08840ea7835e1064ffda58a4">◆ </a></span>available</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int pa_sink_port_info::available</td>
</tr>
</table>
</div><div class="memdoc">
<p>A flags (see <a class="el" href="def_8h.html#a72f790c31bf10c1d244aa078c4cdb345" title="Port availability / jack detection status.">pa_port_available</a>), indicating availability status of this port. </p>
<dl class="section since"><dt>Since</dt><dd>2.0 </dd></dl>
</div>
</div>
<a id="aebd20222053b72fd4fd7a996724c91ff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aebd20222053b72fd4fd7a996724c91ff">◆ </a></span>description</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* pa_sink_port_info::description</td>
</tr>
</table>
</div><div class="memdoc">
<p>Description of this port. </p>
</div>
</div>
<a id="a58a6dd04307c2ee5577ed39d744df680"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a58a6dd04307c2ee5577ed39d744df680">◆ </a></span>name</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* pa_sink_port_info::name</td>
</tr>
</table>
</div><div class="memdoc">
<p>Name of this port. </p>
</div>
</div>
<a id="a49120ec9b0a5aaf75eb83c8cedd7af1d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a49120ec9b0a5aaf75eb83c8cedd7af1d">◆ </a></span>priority</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t pa_sink_port_info::priority</td>
</tr>
</table>
</div><div class="memdoc">
<p>The higher this value is, the more useful this port is as a default. </p>
</div>
</div>
<a id="aa17f3e340845799d7b2638b852206d8c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa17f3e340845799d7b2638b852206d8c">◆ </a></span>type</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t pa_sink_port_info::type</td>
</tr>
</table>
</div><div class="memdoc">
<p>Port type, see <a class="el" href="def_8h.html#a6b86472b4fa68a20d1412a95a8ba83e6" title="Port type.">pa_device_port_type</a>. </p>
<dl class="section since"><dt>Since</dt><dd>14.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__port__info.html">pa_sink_port_info</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>
</html>