<!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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>PulseAudio: sample.h File 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>
<script type="text/javascript">
$(document).ready(initResizable);
</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">10.0.0-1.1.mga6</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',false,false,'search.php','Search');
});
</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">
$(document).ready(function(){initNavTree('sample_8h.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#define-members">Macros</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">sample.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Constants and routines for sample type handling.
<a href="#details">More...</a></p>
<p><a href="sample_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structpa__sample__spec.html">pa_sample_spec</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A sample format and attribute specification. <a href="structpa__sample__spec.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a4c6778fd8a093f9984ce0448f81d9dcf"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="sample_8h.html#a4c6778fd8a093f9984ce0448f81d9dcf">PA_CHANNELS_MAX</a>   32U</td></tr>
<tr class="memdesc:a4c6778fd8a093f9984ce0448f81d9dcf"><td class="mdescLeft"> </td><td class="mdescRight">Maximum number of allowed channels. <a href="#a4c6778fd8a093f9984ce0448f81d9dcf">More...</a><br /></td></tr>
<tr class="separator:a4c6778fd8a093f9984ce0448f81d9dcf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3a7f31e73acc7e833fe0d49290adf839"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="sample_8h.html#a3a7f31e73acc7e833fe0d49290adf839">PA_RATE_MAX</a>   (48000U*8U)</td></tr>
<tr class="memdesc:a3a7f31e73acc7e833fe0d49290adf839"><td class="mdescLeft"> </td><td class="mdescRight">Maximum allowed sample rate. <a href="#a3a7f31e73acc7e833fe0d49290adf839">More...</a><br /></td></tr>
<tr class="separator:a3a7f31e73acc7e833fe0d49290adf839"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a292c1d8ebd4ca0de1d5d5379ee7be38a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="sample_8h.html#a292c1d8ebd4ca0de1d5d5379ee7be38a">PA_SAMPLE_S16NE</a>   <a class="el" href="sample_8h.html#a3c622fc51f4fc6ebfdcc7b454ac9c05fa50e4a2b43c258e559fa9d252275131ce">PA_SAMPLE_S16LE</a></td></tr>
<tr class="memdesc:a292c1d8ebd4ca0de1d5d5379ee7be38a"><td class="mdescLeft"> </td><td class="mdescRight">Signed 16 Bit PCM, native endian. <a href="#a292c1d8ebd4ca0de1d5d5379ee7be38a">More...</a><br /></td></tr>
<tr class="separator:a292c1d8ebd4ca0de1d5d5379ee7be38a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a25befbdbf9fdc57012ce00dcc1756eac"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="sample_8h.html#a25befbdbf9fdc57012ce00dcc1756eac">PA_SAMPLE_FLOAT32NE</a>   <a class="el" href="sample_8h.html#a3c622fc51f4fc6ebfdcc7b454ac9c05fad2f6c96c4f0cd2a841fbe4840488b548">PA_SAMPLE_FLOAT32LE</a></td></tr>
<tr class="memdesc:a25befbdbf9fdc57012ce00dcc1756eac"><td class="mdescLeft"> </td><td class="mdescRight">32 Bit IEEE floating point, native endian <a href="#a25befbdbf9fdc57012ce00dcc1756eac">More...</a><br /></td></tr>
<tr class="separator:a25befbdbf9fdc57012ce00dcc1756eac"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af5b3efe108944c746a07128d9f24c889"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="sample_8h.html#af5b3efe108944c746a07128d9f24c889">PA_SAMPLE_S32NE</a>   <a class="el" href="sample_8h.html#a3c622fc51f4fc6ebfdcc7b454ac9c05fa3eb5213ed7a0887b5dcd28cfc97e3457">PA_SAMPLE_S32LE</a></td></tr>
<tr class="memdesc:af5b3efe108944c746a07128d9f24c889"><td class="mdescLeft"> </td><td class="mdescRight">Signed 32 Bit PCM, native endian. <a href="#af5b3efe108944c746a07128d9f24c889">More...</a><br /></td></tr>
<tr class="separator:af5b3efe108944c746a07128d9f24c889"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a095cd643a682ad1e55205283c42f9aa9"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="sample_8h.html#a095cd643a682ad1e55205283c42f9aa9">PA_SAMPLE_S24NE</a>   <a class="el" href="sample_8h.html#a3c622fc51f4fc6ebfdcc7b454ac9c05faab50478dbb74cceddcb254928646a0c7">PA_SAMPLE_S24LE</a></td></tr>
<tr class="memdesc:a095cd643a682ad1e55205283c42f9aa9"><td class="mdescLeft"> </td><td class="mdescRight">Signed 24 Bit PCM packed, native endian. <a href="#a095cd643a682ad1e55205283c42f9aa9">More...</a><br /></td></tr>
<tr class="separator:a095cd643a682ad1e55205283c42f9aa9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afaf7880f4fa75428bad1d458316e030e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="sample_8h.html#afaf7880f4fa75428bad1d458316e030e">PA_SAMPLE_S24_32NE</a>   <a class="el" href="sample_8h.html#a3c622fc51f4fc6ebfdcc7b454ac9c05fa6d91d680c240fde8ae3cdafa9900c055">PA_SAMPLE_S24_32LE</a></td></tr>
<tr class="memdesc:afaf7880f4fa75428bad1d458316e030e"><td class="mdescLeft"> </td><td class="mdescRight">Signed 24 Bit PCM in LSB of 32 Bit words, native endian. <a href="#afaf7880f4fa75428bad1d458316e030e">More...</a><br /></td></tr>
<tr class="separator:afaf7880f4fa75428bad1d458316e030e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a688b20beba239784f7d92b79a626267a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="sample_8h.html#a688b20beba239784f7d92b79a626267a">PA_SAMPLE_S16RE</a>   <a class="el" href="sample_8h.html#a3c622fc51f4fc6ebfdcc7b454ac9c05fa783cb88f5021ff01fa7ba6d1c2bee84c">PA_SAMPLE_S16BE</a></td></tr>
<tr class="memdesc:a688b20beba239784f7d92b79a626267a"><td class="mdescLeft"> </td><td class="mdescRight">Signed 16 Bit PCM, reverse endian. <a href="#a688b20beba239784f7d92b79a626267a">More...</a><br /></td></tr>
<tr class="separator:a688b20beba239784f7d92b79a626267a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa07717de5712b215af265b35d9daee78"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="sample_8h.html#aa07717de5712b215af265b35d9daee78">PA_SAMPLE_FLOAT32RE</a>   <a class="el" href="sample_8h.html#a3c622fc51f4fc6ebfdcc7b454ac9c05fa3550123d5ef697b349edea2ddf61d6b4">PA_SAMPLE_FLOAT32BE</a></td></tr>
<tr class="memdesc:aa07717de5712b215af265b35d9daee78"><td class="mdescLeft"> </td><td class="mdescRight">32 Bit IEEE floating point, reverse endian <a href="#aa07717de5712b215af265b35d9daee78">More...</a><br /></td></tr>
<tr class="separator:aa07717de5712b215af265b35d9daee78"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac9bfd0ece22174acad5eb021ff159a61"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="sample_8h.html#ac9bfd0ece22174acad5eb021ff159a61">PA_SAMPLE_S32RE</a>   <a class="el" href="sample_8h.html#a3c622fc51f4fc6ebfdcc7b454ac9c05faf81ba0a2b599c490228f619e2a8d3b0e">PA_SAMPLE_S32BE</a></td></tr>
<tr class="memdesc:ac9bfd0ece22174acad5eb021ff159a61"><td class="mdescLeft"> </td><td class="mdescRight">Signed 32 Bit PCM, reverse endian. <a href="#ac9bfd0ece22174acad5eb021ff159a61">More...</a><br /></td></tr>
<tr class="separator:ac9bfd0ece22174acad5eb021ff159a61"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adcdf168f62fd7a27705de50058c6bd5c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="sample_8h.html#adcdf168f62fd7a27705de50058c6bd5c">PA_SAMPLE_S24RE</a>   <a class="el" href="sample_8h.html#a3c622fc51f4fc6ebfdcc7b454ac9c05faadff0a924aee5c95c7fdd923c56621b6">PA_SAMPLE_S24BE</a></td></tr>
<tr class="memdesc:adcdf168f62fd7a27705de50058c6bd5c"><td class="mdescLeft"> </td><td class="mdescRight">Signed 24 Bit PCM, packed reverse endian. <a href="#adcdf168f62fd7a27705de50058c6bd5c">More...</a><br /></td></tr>
<tr class="separator:adcdf168f62fd7a27705de50058c6bd5c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:addb0fe697d3b6a8ce8c13fb711253630"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="sample_8h.html#addb0fe697d3b6a8ce8c13fb711253630">PA_SAMPLE_S24_32RE</a>   <a class="el" href="sample_8h.html#a3c622fc51f4fc6ebfdcc7b454ac9c05facd9ce7bf2cc5d2c4f72a59b9ae0bef89">PA_SAMPLE_S24_32BE</a></td></tr>
<tr class="memdesc:addb0fe697d3b6a8ce8c13fb711253630"><td class="mdescLeft"> </td><td class="mdescRight">Signed 24 Bit PCM, in LSB of 32 Bit words, reverse endian. <a href="#addb0fe697d3b6a8ce8c13fb711253630">More...</a><br /></td></tr>
<tr class="separator:addb0fe697d3b6a8ce8c13fb711253630"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adce65a384a3af05a2481aff5fd2632fb"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="sample_8h.html#adce65a384a3af05a2481aff5fd2632fb">PA_SAMPLE_FLOAT32</a>   <a class="el" href="sample_8h.html#a25befbdbf9fdc57012ce00dcc1756eac">PA_SAMPLE_FLOAT32NE</a></td></tr>
<tr class="memdesc:adce65a384a3af05a2481aff5fd2632fb"><td class="mdescLeft"> </td><td class="mdescRight">A Shortcut for PA_SAMPLE_FLOAT32NE. <a href="#adce65a384a3af05a2481aff5fd2632fb">More...</a><br /></td></tr>
<tr class="separator:adce65a384a3af05a2481aff5fd2632fb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a61844a6fa4a5a91bbeca1049c4969bb8"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="sample_8h.html#a61844a6fa4a5a91bbeca1049c4969bb8">PA_SAMPLE_SPEC_SNPRINT_MAX</a>   32</td></tr>
<tr class="memdesc:a61844a6fa4a5a91bbeca1049c4969bb8"><td class="mdescLeft"> </td><td class="mdescRight">Maximum required string length for <a class="el" href="sample_8h.html#a3dd4815bbd51d5467b40e28d05ad948d" title="Pretty print a sample type specification to a string. ">pa_sample_spec_snprint()</a>. <a href="#a61844a6fa4a5a91bbeca1049c4969bb8">More...</a><br /></td></tr>
<tr class="separator:a61844a6fa4a5a91bbeca1049c4969bb8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af61a5e667357b7f9568a7b283d517a6f"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="sample_8h.html#af61a5e667357b7f9568a7b283d517a6f">PA_BYTES_SNPRINT_MAX</a>   11</td></tr>
<tr class="memdesc:af61a5e667357b7f9568a7b283d517a6f"><td class="mdescLeft"> </td><td class="mdescRight">Maximum required string length for <a class="el" href="sample_8h.html#a4992ec70d79de601c6f8f6cc5cab8e59" title="Pretty print a byte size value (i.e. "2.5 MiB") ">pa_bytes_snprint()</a>. <a href="#af61a5e667357b7f9568a7b283d517a6f">More...</a><br /></td></tr>
<tr class="separator:af61a5e667357b7f9568a7b283d517a6f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a09a7ac737ee5b9bbbd8f859d96cbf1c9"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="sample_8h.html#a09a7ac737ee5b9bbbd8f859d96cbf1c9">pa_sample_format_is_ne</a>(f)   <a class="el" href="sample_8h.html#a8173354fab0b323c172eeff97b2fa54f">pa_sample_format_is_le</a>(f)</td></tr>
<tr class="memdesc:a09a7ac737ee5b9bbbd8f859d96cbf1c9"><td class="mdescLeft"> </td><td class="mdescRight">Return 1 when the specified format is native endian, return -1 when endianness does not apply to this format. <a href="#a09a7ac737ee5b9bbbd8f859d96cbf1c9">More...</a><br /></td></tr>
<tr class="separator:a09a7ac737ee5b9bbbd8f859d96cbf1c9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2bd6ce1c4bb88001b58181b407da6b79"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="sample_8h.html#a2bd6ce1c4bb88001b58181b407da6b79">pa_sample_format_is_re</a>(f)   <a class="el" href="sample_8h.html#aa4fb3c574f13c657b8a0e554ebab52c9">pa_sample_format_is_be</a>(f)</td></tr>
<tr class="memdesc:a2bd6ce1c4bb88001b58181b407da6b79"><td class="mdescLeft"> </td><td class="mdescRight">Return 1 when the specified format is reverse endian, return -1 when endianness does not apply to this format. <a href="#a2bd6ce1c4bb88001b58181b407da6b79">More...</a><br /></td></tr>
<tr class="separator:a2bd6ce1c4bb88001b58181b407da6b79"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a41051ceaa5cfbe60c9b176deb7bfed0e"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="sample_8h.html#a3c622fc51f4fc6ebfdcc7b454ac9c05f">pa_sample_format</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sample_8h.html#a41051ceaa5cfbe60c9b176deb7bfed0e">pa_sample_format_t</a></td></tr>
<tr class="memdesc:a41051ceaa5cfbe60c9b176deb7bfed0e"><td class="mdescLeft"> </td><td class="mdescRight">Sample format. <a href="#a41051ceaa5cfbe60c9b176deb7bfed0e">More...</a><br /></td></tr>
<tr class="separator:a41051ceaa5cfbe60c9b176deb7bfed0e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0ea4218994217063e138a29397c09636"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structpa__sample__spec.html">pa_sample_spec</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sample_8h.html#a0ea4218994217063e138a29397c09636">pa_sample_spec</a></td></tr>
<tr class="memdesc:a0ea4218994217063e138a29397c09636"><td class="mdescLeft"> </td><td class="mdescRight">A sample format and attribute specification. <a href="#a0ea4218994217063e138a29397c09636">More...</a><br /></td></tr>
<tr class="separator:a0ea4218994217063e138a29397c09636"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a885df3b973773f0dccbbec6bc6777f89"><td class="memItemLeft" align="right" valign="top">typedef uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="sample_8h.html#a885df3b973773f0dccbbec6bc6777f89">pa_usec_t</a></td></tr>
<tr class="memdesc:a885df3b973773f0dccbbec6bc6777f89"><td class="mdescLeft"> </td><td class="mdescRight">Type for usec specifications (unsigned). <a href="#a885df3b973773f0dccbbec6bc6777f89">More...</a><br /></td></tr>
<tr class="separator:a885df3b973773f0dccbbec6bc6777f89"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a3c622fc51f4fc6ebfdcc7b454ac9c05f"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="sample_8h.html#a3c622fc51f4fc6ebfdcc7b454ac9c05f">pa_sample_format</a> { <br />
  <a class="el" href="sample_8h.html#a3c622fc51f4fc6ebfdcc7b454ac9c05fa40e5414deb5fbd486c2929e6993a5544">PA_SAMPLE_U8</a>,
<br />
  <a class="el" href="sample_8h.html#a3c622fc51f4fc6ebfdcc7b454ac9c05fa267f6542eb6f66ca61c4cccf61326522">PA_SAMPLE_ALAW</a>,
<br />
  <a class="el" href="sample_8h.html#a3c622fc51f4fc6ebfdcc7b454ac9c05fa83116fc70f8577fdcf694474a60c2e1f">PA_SAMPLE_ULAW</a>,
<br />
  <a class="el" href="sample_8h.html#a3c622fc51f4fc6ebfdcc7b454ac9c05fa50e4a2b43c258e559fa9d252275131ce">PA_SAMPLE_S16LE</a>,
<br />
  <a class="el" href="sample_8h.html#a3c622fc51f4fc6ebfdcc7b454ac9c05fa783cb88f5021ff01fa7ba6d1c2bee84c">PA_SAMPLE_S16BE</a>,
<br />
  <a class="el" href="sample_8h.html#a3c622fc51f4fc6ebfdcc7b454ac9c05fad2f6c96c4f0cd2a841fbe4840488b548">PA_SAMPLE_FLOAT32LE</a>,
<br />
  <a class="el" href="sample_8h.html#a3c622fc51f4fc6ebfdcc7b454ac9c05fa3550123d5ef697b349edea2ddf61d6b4">PA_SAMPLE_FLOAT32BE</a>,
<br />
  <a class="el" href="sample_8h.html#a3c622fc51f4fc6ebfdcc7b454ac9c05fa3eb5213ed7a0887b5dcd28cfc97e3457">PA_SAMPLE_S32LE</a>,
<br />
  <a class="el" href="sample_8h.html#a3c622fc51f4fc6ebfdcc7b454ac9c05faf81ba0a2b599c490228f619e2a8d3b0e">PA_SAMPLE_S32BE</a>,
<br />
  <a class="el" href="sample_8h.html#a3c622fc51f4fc6ebfdcc7b454ac9c05faab50478dbb74cceddcb254928646a0c7">PA_SAMPLE_S24LE</a>,
<br />
  <a class="el" href="sample_8h.html#a3c622fc51f4fc6ebfdcc7b454ac9c05faadff0a924aee5c95c7fdd923c56621b6">PA_SAMPLE_S24BE</a>,
<br />
  <a class="el" href="sample_8h.html#a3c622fc51f4fc6ebfdcc7b454ac9c05fa6d91d680c240fde8ae3cdafa9900c055">PA_SAMPLE_S24_32LE</a>,
<br />
  <a class="el" href="sample_8h.html#a3c622fc51f4fc6ebfdcc7b454ac9c05facd9ce7bf2cc5d2c4f72a59b9ae0bef89">PA_SAMPLE_S24_32BE</a>,
<br />
  <a class="el" href="sample_8h.html#a3c622fc51f4fc6ebfdcc7b454ac9c05faa6fe0e0623f9e2204c63c293f13597a1">PA_SAMPLE_MAX</a>,
<br />
  <a class="el" href="sample_8h.html#a3c622fc51f4fc6ebfdcc7b454ac9c05fafe8a3cc049d2c9820efd8fea80e01e10">PA_SAMPLE_INVALID</a> = -1
<br />
}<tr class="memdesc:a3c622fc51f4fc6ebfdcc7b454ac9c05f"><td class="mdescLeft"> </td><td class="mdescRight">Sample format. <a href="sample_8h.html#a3c622fc51f4fc6ebfdcc7b454ac9c05f">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:a3c622fc51f4fc6ebfdcc7b454ac9c05f"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a674c3449416e97b71a75feb64ca59ad4"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="sample_8h.html#a674c3449416e97b71a75feb64ca59ad4">pa_bytes_per_second</a> (const <a class="el" href="structpa__sample__spec.html">pa_sample_spec</a> *spec) <a class="el" href="gccmacro_8h.html#aa1c5f50faa1073e28ba469b86f6a0548">PA_GCC_PURE</a></td></tr>
<tr class="memdesc:a674c3449416e97b71a75feb64ca59ad4"><td class="mdescLeft"> </td><td class="mdescRight">Return the amount of bytes playback of a second of audio with the specified sample type takes. <a href="#a674c3449416e97b71a75feb64ca59ad4">More...</a><br /></td></tr>
<tr class="separator:a674c3449416e97b71a75feb64ca59ad4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a035d79171e183f6315e6e65436f5e939"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="sample_8h.html#a035d79171e183f6315e6e65436f5e939">pa_frame_size</a> (const <a class="el" href="structpa__sample__spec.html">pa_sample_spec</a> *spec) <a class="el" href="gccmacro_8h.html#aa1c5f50faa1073e28ba469b86f6a0548">PA_GCC_PURE</a></td></tr>
<tr class="memdesc:a035d79171e183f6315e6e65436f5e939"><td class="mdescLeft"> </td><td class="mdescRight">Return the size of a frame with the specific sample type. <a href="#a035d79171e183f6315e6e65436f5e939">More...</a><br /></td></tr>
<tr class="separator:a035d79171e183f6315e6e65436f5e939"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aae286d84c2975248f65f804d4c24ef39"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="sample_8h.html#aae286d84c2975248f65f804d4c24ef39">pa_sample_size</a> (const <a class="el" href="structpa__sample__spec.html">pa_sample_spec</a> *spec) <a class="el" href="gccmacro_8h.html#aa1c5f50faa1073e28ba469b86f6a0548">PA_GCC_PURE</a></td></tr>
<tr class="memdesc:aae286d84c2975248f65f804d4c24ef39"><td class="mdescLeft"> </td><td class="mdescRight">Return the size of a sample with the specific sample type. <a href="#aae286d84c2975248f65f804d4c24ef39">More...</a><br /></td></tr>
<tr class="separator:aae286d84c2975248f65f804d4c24ef39"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a46b2c919b75efbb2b3c3d703ba57fdf6"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="sample_8h.html#a46b2c919b75efbb2b3c3d703ba57fdf6">pa_sample_size_of_format</a> (<a class="el" href="sample_8h.html#a41051ceaa5cfbe60c9b176deb7bfed0e">pa_sample_format_t</a> f) <a class="el" href="gccmacro_8h.html#aa1c5f50faa1073e28ba469b86f6a0548">PA_GCC_PURE</a></td></tr>
<tr class="memdesc:a46b2c919b75efbb2b3c3d703ba57fdf6"><td class="mdescLeft"> </td><td class="mdescRight">Similar to <a class="el" href="sample_8h.html#aae286d84c2975248f65f804d4c24ef39" title="Return the size of a sample with the specific sample type. ">pa_sample_size()</a> but take a sample format instead of a full sample spec. <a href="#a46b2c919b75efbb2b3c3d703ba57fdf6">More...</a><br /></td></tr>
<tr class="separator:a46b2c919b75efbb2b3c3d703ba57fdf6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab3c5f4af357686fdc7df46c9581154bd"><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="sample_8h.html#ab3c5f4af357686fdc7df46c9581154bd">pa_bytes_to_usec</a> (uint64_t length, const <a class="el" href="structpa__sample__spec.html">pa_sample_spec</a> *spec) <a class="el" href="gccmacro_8h.html#aa1c5f50faa1073e28ba469b86f6a0548">PA_GCC_PURE</a></td></tr>
<tr class="memdesc:ab3c5f4af357686fdc7df46c9581154bd"><td class="mdescLeft"> </td><td class="mdescRight">Calculate the time the specified bytes take to play with the specified sample type. <a href="#ab3c5f4af357686fdc7df46c9581154bd">More...</a><br /></td></tr>
<tr class="separator:ab3c5f4af357686fdc7df46c9581154bd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa941cbdb65f1f0265a1d165bc14db034"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="sample_8h.html#aa941cbdb65f1f0265a1d165bc14db034">pa_usec_to_bytes</a> (<a class="el" href="sample_8h.html#a885df3b973773f0dccbbec6bc6777f89">pa_usec_t</a> t, const <a class="el" href="structpa__sample__spec.html">pa_sample_spec</a> *spec) <a class="el" href="gccmacro_8h.html#aa1c5f50faa1073e28ba469b86f6a0548">PA_GCC_PURE</a></td></tr>
<tr class="memdesc:aa941cbdb65f1f0265a1d165bc14db034"><td class="mdescLeft"> </td><td class="mdescRight">Calculates the number of bytes that are required for the specified time. <a href="#aa941cbdb65f1f0265a1d165bc14db034">More...</a><br /></td></tr>
<tr class="separator:aa941cbdb65f1f0265a1d165bc14db034"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5d392d4cc38109670585708f5062c2fe"><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="sample_8h.html#a5d392d4cc38109670585708f5062c2fe">pa_sample_spec_init</a> (<a class="el" href="structpa__sample__spec.html">pa_sample_spec</a> *spec)</td></tr>
<tr class="memdesc:a5d392d4cc38109670585708f5062c2fe"><td class="mdescLeft"> </td><td class="mdescRight">Initialize the specified sample spec and return a pointer to it. <a href="#a5d392d4cc38109670585708f5062c2fe">More...</a><br /></td></tr>
<tr class="separator:a5d392d4cc38109670585708f5062c2fe"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a50d62a8cdf47b930cba7413e7d553053"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sample_8h.html#a50d62a8cdf47b930cba7413e7d553053">pa_sample_format_valid</a> (unsigned format) <a class="el" href="gccmacro_8h.html#aa1c5f50faa1073e28ba469b86f6a0548">PA_GCC_PURE</a></td></tr>
<tr class="memdesc:a50d62a8cdf47b930cba7413e7d553053"><td class="mdescLeft"> </td><td class="mdescRight">Return non-zero if the given integer is a valid sample format. <a href="#a50d62a8cdf47b930cba7413e7d553053">More...</a><br /></td></tr>
<tr class="separator:a50d62a8cdf47b930cba7413e7d553053"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aed7a371985734a98d5d40ab0624aed09"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sample_8h.html#aed7a371985734a98d5d40ab0624aed09">pa_sample_rate_valid</a> (uint32_t rate) <a class="el" href="gccmacro_8h.html#aa1c5f50faa1073e28ba469b86f6a0548">PA_GCC_PURE</a></td></tr>
<tr class="memdesc:aed7a371985734a98d5d40ab0624aed09"><td class="mdescLeft"> </td><td class="mdescRight">Return non-zero if the rate is within the supported range. <a href="#aed7a371985734a98d5d40ab0624aed09">More...</a><br /></td></tr>
<tr class="separator:aed7a371985734a98d5d40ab0624aed09"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a815497e438819abde8efd477e4430ca2"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sample_8h.html#a815497e438819abde8efd477e4430ca2">pa_channels_valid</a> (uint8_t channels) <a class="el" href="gccmacro_8h.html#aa1c5f50faa1073e28ba469b86f6a0548">PA_GCC_PURE</a></td></tr>
<tr class="memdesc:a815497e438819abde8efd477e4430ca2"><td class="mdescLeft"> </td><td class="mdescRight">Return non-zero if the channel count is within the supported range. <a href="#a815497e438819abde8efd477e4430ca2">More...</a><br /></td></tr>
<tr class="separator:a815497e438819abde8efd477e4430ca2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0d9ad972ee71ef6bff8aaafd44fdb229"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sample_8h.html#a0d9ad972ee71ef6bff8aaafd44fdb229">pa_sample_spec_valid</a> (const <a class="el" href="structpa__sample__spec.html">pa_sample_spec</a> *spec) <a class="el" href="gccmacro_8h.html#aa1c5f50faa1073e28ba469b86f6a0548">PA_GCC_PURE</a></td></tr>
<tr class="memdesc:a0d9ad972ee71ef6bff8aaafd44fdb229"><td class="mdescLeft"> </td><td class="mdescRight">Return non-zero when the sample type specification is valid. <a href="#a0d9ad972ee71ef6bff8aaafd44fdb229">More...</a><br /></td></tr>
<tr class="separator:a0d9ad972ee71ef6bff8aaafd44fdb229"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac4c2262bf88bd90fc68767e69fb6810c"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sample_8h.html#ac4c2262bf88bd90fc68767e69fb6810c">pa_sample_spec_equal</a> (const <a class="el" href="structpa__sample__spec.html">pa_sample_spec</a> *a, const <a class="el" href="structpa__sample__spec.html">pa_sample_spec</a> *b) <a class="el" href="gccmacro_8h.html#aa1c5f50faa1073e28ba469b86f6a0548">PA_GCC_PURE</a></td></tr>
<tr class="memdesc:ac4c2262bf88bd90fc68767e69fb6810c"><td class="mdescLeft"> </td><td class="mdescRight">Return non-zero when the two sample type specifications match. <a href="#ac4c2262bf88bd90fc68767e69fb6810c">More...</a><br /></td></tr>
<tr class="separator:ac4c2262bf88bd90fc68767e69fb6810c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a70804b50d5507f9a7680d4e809e337ed"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="sample_8h.html#a70804b50d5507f9a7680d4e809e337ed">pa_sample_format_to_string</a> (<a class="el" href="sample_8h.html#a41051ceaa5cfbe60c9b176deb7bfed0e">pa_sample_format_t</a> f) <a class="el" href="gccmacro_8h.html#aa1c5f50faa1073e28ba469b86f6a0548">PA_GCC_PURE</a></td></tr>
<tr class="memdesc:a70804b50d5507f9a7680d4e809e337ed"><td class="mdescLeft"> </td><td class="mdescRight">Return a descriptive string for the specified sample format. <a href="#a70804b50d5507f9a7680d4e809e337ed">More...</a><br /></td></tr>
<tr class="separator:a70804b50d5507f9a7680d4e809e337ed"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2819db448dd45edb5d777b7568dd3236"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sample_8h.html#a41051ceaa5cfbe60c9b176deb7bfed0e">pa_sample_format_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sample_8h.html#a2819db448dd45edb5d777b7568dd3236">pa_parse_sample_format</a> (const char *format) <a class="el" href="gccmacro_8h.html#aa1c5f50faa1073e28ba469b86f6a0548">PA_GCC_PURE</a></td></tr>
<tr class="memdesc:a2819db448dd45edb5d777b7568dd3236"><td class="mdescLeft"> </td><td class="mdescRight">Parse a sample format text. <a href="#a2819db448dd45edb5d777b7568dd3236">More...</a><br /></td></tr>
<tr class="separator:a2819db448dd45edb5d777b7568dd3236"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3dd4815bbd51d5467b40e28d05ad948d"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="sample_8h.html#a3dd4815bbd51d5467b40e28d05ad948d">pa_sample_spec_snprint</a> (char *s, size_t l, const <a class="el" href="structpa__sample__spec.html">pa_sample_spec</a> *spec)</td></tr>
<tr class="memdesc:a3dd4815bbd51d5467b40e28d05ad948d"><td class="mdescLeft"> </td><td class="mdescRight">Pretty print a sample type specification to a string. <a href="#a3dd4815bbd51d5467b40e28d05ad948d">More...</a><br /></td></tr>
<tr class="separator:a3dd4815bbd51d5467b40e28d05ad948d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4992ec70d79de601c6f8f6cc5cab8e59"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="sample_8h.html#a4992ec70d79de601c6f8f6cc5cab8e59">pa_bytes_snprint</a> (char *s, size_t l, unsigned v)</td></tr>
<tr class="memdesc:a4992ec70d79de601c6f8f6cc5cab8e59"><td class="mdescLeft"> </td><td class="mdescRight">Pretty print a byte size value (i.e. "2.5 MiB") <a href="#a4992ec70d79de601c6f8f6cc5cab8e59">More...</a><br /></td></tr>
<tr class="separator:a4992ec70d79de601c6f8f6cc5cab8e59"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8173354fab0b323c172eeff97b2fa54f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sample_8h.html#a8173354fab0b323c172eeff97b2fa54f">pa_sample_format_is_le</a> (<a class="el" href="sample_8h.html#a41051ceaa5cfbe60c9b176deb7bfed0e">pa_sample_format_t</a> f) <a class="el" href="gccmacro_8h.html#aa1c5f50faa1073e28ba469b86f6a0548">PA_GCC_PURE</a></td></tr>
<tr class="memdesc:a8173354fab0b323c172eeff97b2fa54f"><td class="mdescLeft"> </td><td class="mdescRight">Return 1 when the specified format is little endian, return -1 when endianness does not apply to this format. <a href="#a8173354fab0b323c172eeff97b2fa54f">More...</a><br /></td></tr>
<tr class="separator:a8173354fab0b323c172eeff97b2fa54f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa4fb3c574f13c657b8a0e554ebab52c9"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sample_8h.html#aa4fb3c574f13c657b8a0e554ebab52c9">pa_sample_format_is_be</a> (<a class="el" href="sample_8h.html#a41051ceaa5cfbe60c9b176deb7bfed0e">pa_sample_format_t</a> f) <a class="el" href="gccmacro_8h.html#aa1c5f50faa1073e28ba469b86f6a0548">PA_GCC_PURE</a></td></tr>
<tr class="memdesc:aa4fb3c574f13c657b8a0e554ebab52c9"><td class="mdescLeft"> </td><td class="mdescRight">Return 1 when the specified format is big endian, return -1 when endianness does not apply to this format. <a href="#aa4fb3c574f13c657b8a0e554ebab52c9">More...</a><br /></td></tr>
<tr class="separator:aa4fb3c574f13c657b8a0e554ebab52c9"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Constants and routines for sample type handling. </p>
<p>See also <a class="el" href="sample.html">Sample Format Specifications</a> </p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="af61a5e667357b7f9568a7b283d517a6f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af61a5e667357b7f9568a7b283d517a6f">◆ </a></span>PA_BYTES_SNPRINT_MAX</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_BYTES_SNPRINT_MAX   11</td>
</tr>
</table>
</div><div class="memdoc">
<p>Maximum required string length for <a class="el" href="sample_8h.html#a4992ec70d79de601c6f8f6cc5cab8e59" title="Pretty print a byte size value (i.e. "2.5 MiB") ">pa_bytes_snprint()</a>. </p>
<p>Please note that this value can change with any release without warning and without being considered API or ABI breakage. You should not use this definition anywhere where it might become part of an ABI. </p><dl class="section since"><dt>Since</dt><dd>0.9.16 </dd></dl>
</div>
</div>
<a id="a4c6778fd8a093f9984ce0448f81d9dcf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4c6778fd8a093f9984ce0448f81d9dcf">◆ </a></span>PA_CHANNELS_MAX</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_CHANNELS_MAX   32U</td>
</tr>
</table>
</div><div class="memdoc">
<p>Maximum number of allowed channels. </p>
</div>
</div>
<a id="a3a7f31e73acc7e833fe0d49290adf839"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3a7f31e73acc7e833fe0d49290adf839">◆ </a></span>PA_RATE_MAX</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_RATE_MAX   (48000U*8U)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Maximum allowed sample rate. </p>
</div>
</div>
<a id="adce65a384a3af05a2481aff5fd2632fb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adce65a384a3af05a2481aff5fd2632fb">◆ </a></span>PA_SAMPLE_FLOAT32</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_SAMPLE_FLOAT32   <a class="el" href="sample_8h.html#a25befbdbf9fdc57012ce00dcc1756eac">PA_SAMPLE_FLOAT32NE</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>A Shortcut for PA_SAMPLE_FLOAT32NE. </p>
</div>
</div>
<a id="a25befbdbf9fdc57012ce00dcc1756eac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a25befbdbf9fdc57012ce00dcc1756eac">◆ </a></span>PA_SAMPLE_FLOAT32NE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_SAMPLE_FLOAT32NE   <a class="el" href="sample_8h.html#a3c622fc51f4fc6ebfdcc7b454ac9c05fad2f6c96c4f0cd2a841fbe4840488b548">PA_SAMPLE_FLOAT32LE</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>32 Bit IEEE floating point, native endian </p>
</div>
</div>
<a id="aa07717de5712b215af265b35d9daee78"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa07717de5712b215af265b35d9daee78">◆ </a></span>PA_SAMPLE_FLOAT32RE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_SAMPLE_FLOAT32RE   <a class="el" href="sample_8h.html#a3c622fc51f4fc6ebfdcc7b454ac9c05fa3550123d5ef697b349edea2ddf61d6b4">PA_SAMPLE_FLOAT32BE</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>32 Bit IEEE floating point, reverse endian </p>
</div>
</div>
<a id="a09a7ac737ee5b9bbbd8f859d96cbf1c9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a09a7ac737ee5b9bbbd8f859d96cbf1c9">◆ </a></span>pa_sample_format_is_ne</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define pa_sample_format_is_ne</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">f</td><td>)</td>
<td>   <a class="el" href="sample_8h.html#a8173354fab0b323c172eeff97b2fa54f">pa_sample_format_is_le</a>(f)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Return 1 when the specified format is native endian, return -1 when endianness does not apply to this format. </p>
<dl class="section since"><dt>Since</dt><dd>0.9.16 </dd></dl>
</div>
</div>
<a id="a2bd6ce1c4bb88001b58181b407da6b79"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2bd6ce1c4bb88001b58181b407da6b79">◆ </a></span>pa_sample_format_is_re</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define pa_sample_format_is_re</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">f</td><td>)</td>
<td>   <a class="el" href="sample_8h.html#aa4fb3c574f13c657b8a0e554ebab52c9">pa_sample_format_is_be</a>(f)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Return 1 when the specified format is reverse endian, return -1 when endianness does not apply to this format. </p>
<dl class="section since"><dt>Since</dt><dd>0.9.16 </dd></dl>
</div>
</div>
<a id="a292c1d8ebd4ca0de1d5d5379ee7be38a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a292c1d8ebd4ca0de1d5d5379ee7be38a">◆ </a></span>PA_SAMPLE_S16NE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_SAMPLE_S16NE   <a class="el" href="sample_8h.html#a3c622fc51f4fc6ebfdcc7b454ac9c05fa50e4a2b43c258e559fa9d252275131ce">PA_SAMPLE_S16LE</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Signed 16 Bit PCM, native endian. </p>
</div>
</div>
<a id="a688b20beba239784f7d92b79a626267a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a688b20beba239784f7d92b79a626267a">◆ </a></span>PA_SAMPLE_S16RE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_SAMPLE_S16RE   <a class="el" href="sample_8h.html#a3c622fc51f4fc6ebfdcc7b454ac9c05fa783cb88f5021ff01fa7ba6d1c2bee84c">PA_SAMPLE_S16BE</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Signed 16 Bit PCM, reverse endian. </p>
</div>
</div>
<a id="afaf7880f4fa75428bad1d458316e030e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afaf7880f4fa75428bad1d458316e030e">◆ </a></span>PA_SAMPLE_S24_32NE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_SAMPLE_S24_32NE   <a class="el" href="sample_8h.html#a3c622fc51f4fc6ebfdcc7b454ac9c05fa6d91d680c240fde8ae3cdafa9900c055">PA_SAMPLE_S24_32LE</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Signed 24 Bit PCM in LSB of 32 Bit words, native endian. </p>
<dl class="section since"><dt>Since</dt><dd>0.9.15 </dd></dl>
</div>
</div>
<a id="addb0fe697d3b6a8ce8c13fb711253630"></a>
<h2 class="memtitle"><span class="permalink"><a href="#addb0fe697d3b6a8ce8c13fb711253630">◆ </a></span>PA_SAMPLE_S24_32RE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_SAMPLE_S24_32RE   <a class="el" href="sample_8h.html#a3c622fc51f4fc6ebfdcc7b454ac9c05facd9ce7bf2cc5d2c4f72a59b9ae0bef89">PA_SAMPLE_S24_32BE</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Signed 24 Bit PCM, in LSB of 32 Bit words, reverse endian. </p>
<dl class="section since"><dt>Since</dt><dd>0.9.15 </dd></dl>
</div>
</div>
<a id="a095cd643a682ad1e55205283c42f9aa9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a095cd643a682ad1e55205283c42f9aa9">◆ </a></span>PA_SAMPLE_S24NE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_SAMPLE_S24NE   <a class="el" href="sample_8h.html#a3c622fc51f4fc6ebfdcc7b454ac9c05faab50478dbb74cceddcb254928646a0c7">PA_SAMPLE_S24LE</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Signed 24 Bit PCM packed, native endian. </p>
<dl class="section since"><dt>Since</dt><dd>0.9.15 </dd></dl>
</div>
</div>
<a id="adcdf168f62fd7a27705de50058c6bd5c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adcdf168f62fd7a27705de50058c6bd5c">◆ </a></span>PA_SAMPLE_S24RE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_SAMPLE_S24RE   <a class="el" href="sample_8h.html#a3c622fc51f4fc6ebfdcc7b454ac9c05faadff0a924aee5c95c7fdd923c56621b6">PA_SAMPLE_S24BE</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Signed 24 Bit PCM, packed reverse endian. </p>
<dl class="section since"><dt>Since</dt><dd>0.9.15 </dd></dl>
</div>
</div>
<a id="af5b3efe108944c746a07128d9f24c889"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af5b3efe108944c746a07128d9f24c889">◆ </a></span>PA_SAMPLE_S32NE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_SAMPLE_S32NE   <a class="el" href="sample_8h.html#a3c622fc51f4fc6ebfdcc7b454ac9c05fa3eb5213ed7a0887b5dcd28cfc97e3457">PA_SAMPLE_S32LE</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Signed 32 Bit PCM, native endian. </p>
</div>
</div>
<a id="ac9bfd0ece22174acad5eb021ff159a61"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac9bfd0ece22174acad5eb021ff159a61">◆ </a></span>PA_SAMPLE_S32RE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_SAMPLE_S32RE   <a class="el" href="sample_8h.html#a3c622fc51f4fc6ebfdcc7b454ac9c05faf81ba0a2b599c490228f619e2a8d3b0e">PA_SAMPLE_S32BE</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Signed 32 Bit PCM, reverse endian. </p>
</div>
</div>
<a id="a61844a6fa4a5a91bbeca1049c4969bb8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a61844a6fa4a5a91bbeca1049c4969bb8">◆ </a></span>PA_SAMPLE_SPEC_SNPRINT_MAX</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PA_SAMPLE_SPEC_SNPRINT_MAX   32</td>
</tr>
</table>
</div><div class="memdoc">
<p>Maximum required string length for <a class="el" href="sample_8h.html#a3dd4815bbd51d5467b40e28d05ad948d" title="Pretty print a sample type specification to a string. ">pa_sample_spec_snprint()</a>. </p>
<p>Please note that this value can change with any release without warning and without being considered API or ABI breakage. You should not use this definition anywhere where it might become part of an ABI. </p>
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="a41051ceaa5cfbe60c9b176deb7bfed0e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a41051ceaa5cfbe60c9b176deb7bfed0e">◆ </a></span>pa_sample_format_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef enum <a class="el" href="sample_8h.html#a3c622fc51f4fc6ebfdcc7b454ac9c05f">pa_sample_format</a> <a class="el" href="sample_8h.html#a41051ceaa5cfbe60c9b176deb7bfed0e">pa_sample_format_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sample format. </p>
</div>
</div>
<a id="a0ea4218994217063e138a29397c09636"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0ea4218994217063e138a29397c09636">◆ </a></span>pa_sample_spec</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structpa__sample__spec.html">pa_sample_spec</a> <a class="el" href="structpa__sample__spec.html">pa_sample_spec</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>A sample format and attribute specification. </p>
</div>
</div>
<a id="a885df3b973773f0dccbbec6bc6777f89"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a885df3b973773f0dccbbec6bc6777f89">◆ </a></span>pa_usec_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef uint64_t <a class="el" href="sample_8h.html#a885df3b973773f0dccbbec6bc6777f89">pa_usec_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Type for usec specifications (unsigned). </p>
<p>Always 64 bit. </p>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="a3c622fc51f4fc6ebfdcc7b454ac9c05f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3c622fc51f4fc6ebfdcc7b454ac9c05f">◆ </a></span>pa_sample_format</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="sample_8h.html#a3c622fc51f4fc6ebfdcc7b454ac9c05f">pa_sample_format</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sample format. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a3c622fc51f4fc6ebfdcc7b454ac9c05fa40e5414deb5fbd486c2929e6993a5544"></a>PA_SAMPLE_U8 </td><td class="fielddoc"><p>Unsigned 8 Bit PCM. </p>
</td></tr>
<tr><td class="fieldname"><a id="a3c622fc51f4fc6ebfdcc7b454ac9c05fa267f6542eb6f66ca61c4cccf61326522"></a>PA_SAMPLE_ALAW </td><td class="fielddoc"><p>8 Bit a-Law </p>
</td></tr>
<tr><td class="fieldname"><a id="a3c622fc51f4fc6ebfdcc7b454ac9c05fa83116fc70f8577fdcf694474a60c2e1f"></a>PA_SAMPLE_ULAW </td><td class="fielddoc"><p>8 Bit mu-Law </p>
</td></tr>
<tr><td class="fieldname"><a id="a3c622fc51f4fc6ebfdcc7b454ac9c05fa50e4a2b43c258e559fa9d252275131ce"></a>PA_SAMPLE_S16LE </td><td class="fielddoc"><p>Signed 16 Bit PCM, little endian (PC) </p>
</td></tr>
<tr><td class="fieldname"><a id="a3c622fc51f4fc6ebfdcc7b454ac9c05fa783cb88f5021ff01fa7ba6d1c2bee84c"></a>PA_SAMPLE_S16BE </td><td class="fielddoc"><p>Signed 16 Bit PCM, big endian. </p>
</td></tr>
<tr><td class="fieldname"><a id="a3c622fc51f4fc6ebfdcc7b454ac9c05fad2f6c96c4f0cd2a841fbe4840488b548"></a>PA_SAMPLE_FLOAT32LE </td><td class="fielddoc"><p>32 Bit IEEE floating point, little endian (PC), range -1.0 to 1.0 </p>
</td></tr>
<tr><td class="fieldname"><a id="a3c622fc51f4fc6ebfdcc7b454ac9c05fa3550123d5ef697b349edea2ddf61d6b4"></a>PA_SAMPLE_FLOAT32BE </td><td class="fielddoc"><p>32 Bit IEEE floating point, big endian, range -1.0 to 1.0 </p>
</td></tr>
<tr><td class="fieldname"><a id="a3c622fc51f4fc6ebfdcc7b454ac9c05fa3eb5213ed7a0887b5dcd28cfc97e3457"></a>PA_SAMPLE_S32LE </td><td class="fielddoc"><p>Signed 32 Bit PCM, little endian (PC) </p>
</td></tr>
<tr><td class="fieldname"><a id="a3c622fc51f4fc6ebfdcc7b454ac9c05faf81ba0a2b599c490228f619e2a8d3b0e"></a>PA_SAMPLE_S32BE </td><td class="fielddoc"><p>Signed 32 Bit PCM, big endian. </p>
</td></tr>
<tr><td class="fieldname"><a id="a3c622fc51f4fc6ebfdcc7b454ac9c05faab50478dbb74cceddcb254928646a0c7"></a>PA_SAMPLE_S24LE </td><td class="fielddoc"><p>Signed 24 Bit PCM packed, little endian (PC). </p>
<dl class="section since"><dt>Since</dt><dd>0.9.15 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a id="a3c622fc51f4fc6ebfdcc7b454ac9c05faadff0a924aee5c95c7fdd923c56621b6"></a>PA_SAMPLE_S24BE </td><td class="fielddoc"><p>Signed 24 Bit PCM packed, big endian. </p>
<dl class="section since"><dt>Since</dt><dd>0.9.15 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a id="a3c622fc51f4fc6ebfdcc7b454ac9c05fa6d91d680c240fde8ae3cdafa9900c055"></a>PA_SAMPLE_S24_32LE </td><td class="fielddoc"><p>Signed 24 Bit PCM in LSB of 32 Bit words, little endian (PC). </p>
<dl class="section since"><dt>Since</dt><dd>0.9.15 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a id="a3c622fc51f4fc6ebfdcc7b454ac9c05facd9ce7bf2cc5d2c4f72a59b9ae0bef89"></a>PA_SAMPLE_S24_32BE </td><td class="fielddoc"><p>Signed 24 Bit PCM in LSB of 32 Bit words, big endian. </p>
<dl class="section since"><dt>Since</dt><dd>0.9.15 </dd></dl>
</td></tr>
<tr><td class="fieldname"><a id="a3c622fc51f4fc6ebfdcc7b454ac9c05faa6fe0e0623f9e2204c63c293f13597a1"></a>PA_SAMPLE_MAX </td><td class="fielddoc"><p>Upper limit of valid sample types. </p>
</td></tr>
<tr><td class="fieldname"><a id="a3c622fc51f4fc6ebfdcc7b454ac9c05fafe8a3cc049d2c9820efd8fea80e01e10"></a>PA_SAMPLE_INVALID </td><td class="fielddoc"><p>An invalid value. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a674c3449416e97b71a75feb64ca59ad4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a674c3449416e97b71a75feb64ca59ad4">◆ </a></span>pa_bytes_per_second()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t pa_bytes_per_second </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structpa__sample__spec.html">pa_sample_spec</a> * </td>
<td class="paramname"><em>spec</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the amount of bytes playback of a second of audio with the specified sample type takes. </p>
</div>
</div>
<a id="a4992ec70d79de601c6f8f6cc5cab8e59"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4992ec70d79de601c6f8f6cc5cab8e59">◆ </a></span>pa_bytes_snprint()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* pa_bytes_snprint </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>l</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"><em>v</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Pretty print a byte size value (i.e. "2.5 MiB") </p>
</div>
</div>
<a id="ab3c5f4af357686fdc7df46c9581154bd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab3c5f4af357686fdc7df46c9581154bd">◆ </a></span>pa_bytes_to_usec()</h2>
<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_bytes_to_usec </td>
<td>(</td>
<td class="paramtype">uint64_t </td>
<td class="paramname"><em>length</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structpa__sample__spec.html">pa_sample_spec</a> * </td>
<td class="paramname"><em>spec</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Calculate the time the specified bytes take to play with the specified sample type. </p>
<p>The return value will always be rounded down for non-integral return values. </p>
</div>
</div>
<a id="a815497e438819abde8efd477e4430ca2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a815497e438819abde8efd477e4430ca2">◆ </a></span>pa_channels_valid()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int pa_channels_valid </td>
<td>(</td>
<td class="paramtype">uint8_t </td>
<td class="paramname"><em>channels</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return non-zero if the channel count is within the supported range. </p>
<dl class="section since"><dt>Since</dt><dd>5.0 </dd></dl>
</div>
</div>
<a id="a035d79171e183f6315e6e65436f5e939"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a035d79171e183f6315e6e65436f5e939">◆ </a></span>pa_frame_size()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t pa_frame_size </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structpa__sample__spec.html">pa_sample_spec</a> * </td>
<td class="paramname"><em>spec</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the size of a frame with the specific sample type. </p>
</div>
</div>
<a id="a2819db448dd45edb5d777b7568dd3236"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2819db448dd45edb5d777b7568dd3236">◆ </a></span>pa_parse_sample_format()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="sample_8h.html#a41051ceaa5cfbe60c9b176deb7bfed0e">pa_sample_format_t</a> pa_parse_sample_format </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>format</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Parse a sample format text. </p>
<p>Inverse of <a class="el" href="sample_8h.html#a70804b50d5507f9a7680d4e809e337ed" title="Return a descriptive string for the specified sample format. ">pa_sample_format_to_string()</a> </p>
</div>
</div>
<a id="aa4fb3c574f13c657b8a0e554ebab52c9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa4fb3c574f13c657b8a0e554ebab52c9">◆ </a></span>pa_sample_format_is_be()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int pa_sample_format_is_be </td>
<td>(</td>
<td class="paramtype"><a class="el" href="sample_8h.html#a41051ceaa5cfbe60c9b176deb7bfed0e">pa_sample_format_t</a> </td>
<td class="paramname"><em>f</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return 1 when the specified format is big endian, return -1 when endianness does not apply to this format. </p>
<dl class="section since"><dt>Since</dt><dd>0.9.16 </dd></dl>
</div>
</div>
<a id="a8173354fab0b323c172eeff97b2fa54f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8173354fab0b323c172eeff97b2fa54f">◆ </a></span>pa_sample_format_is_le()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int pa_sample_format_is_le </td>
<td>(</td>
<td class="paramtype"><a class="el" href="sample_8h.html#a41051ceaa5cfbe60c9b176deb7bfed0e">pa_sample_format_t</a> </td>
<td class="paramname"><em>f</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return 1 when the specified format is little endian, return -1 when endianness does not apply to this format. </p>
<dl class="section since"><dt>Since</dt><dd>0.9.16 </dd></dl>
</div>
</div>
<a id="a70804b50d5507f9a7680d4e809e337ed"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a70804b50d5507f9a7680d4e809e337ed">◆ </a></span>pa_sample_format_to_string()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* pa_sample_format_to_string </td>
<td>(</td>
<td class="paramtype"><a class="el" href="sample_8h.html#a41051ceaa5cfbe60c9b176deb7bfed0e">pa_sample_format_t</a> </td>
<td class="paramname"><em>f</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return a descriptive string for the specified sample format. </p>
<dl class="section since"><dt>Since</dt><dd>0.8 </dd></dl>
</div>
</div>
<a id="a50d62a8cdf47b930cba7413e7d553053"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a50d62a8cdf47b930cba7413e7d553053">◆ </a></span>pa_sample_format_valid()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int pa_sample_format_valid </td>
<td>(</td>
<td class="paramtype">unsigned </td>
<td class="paramname"><em>format</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return non-zero if the given integer is a valid sample format. </p>
<dl class="section since"><dt>Since</dt><dd>5.0 </dd></dl>
</div>
</div>
<a id="aed7a371985734a98d5d40ab0624aed09"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aed7a371985734a98d5d40ab0624aed09">◆ </a></span>pa_sample_rate_valid()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int pa_sample_rate_valid </td>
<td>(</td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>rate</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return non-zero if the rate is within the supported range. </p>
<dl class="section since"><dt>Since</dt><dd>5.0 </dd></dl>
</div>
</div>
<a id="aae286d84c2975248f65f804d4c24ef39"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aae286d84c2975248f65f804d4c24ef39">◆ </a></span>pa_sample_size()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t pa_sample_size </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structpa__sample__spec.html">pa_sample_spec</a> * </td>
<td class="paramname"><em>spec</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the size of a sample with the specific sample type. </p>
</div>
</div>
<a id="a46b2c919b75efbb2b3c3d703ba57fdf6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a46b2c919b75efbb2b3c3d703ba57fdf6">◆ </a></span>pa_sample_size_of_format()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t pa_sample_size_of_format </td>
<td>(</td>
<td class="paramtype"><a class="el" href="sample_8h.html#a41051ceaa5cfbe60c9b176deb7bfed0e">pa_sample_format_t</a> </td>
<td class="paramname"><em>f</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Similar to <a class="el" href="sample_8h.html#aae286d84c2975248f65f804d4c24ef39" title="Return the size of a sample with the specific sample type. ">pa_sample_size()</a> but take a sample format instead of a full sample spec. </p>
<dl class="section since"><dt>Since</dt><dd>0.9.15 </dd></dl>
</div>
</div>
<a id="ac4c2262bf88bd90fc68767e69fb6810c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac4c2262bf88bd90fc68767e69fb6810c">◆ </a></span>pa_sample_spec_equal()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int pa_sample_spec_equal </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structpa__sample__spec.html">pa_sample_spec</a> * </td>
<td class="paramname"><em>a</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structpa__sample__spec.html">pa_sample_spec</a> * </td>
<td class="paramname"><em>b</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return non-zero when the two sample type specifications match. </p>
</div>
</div>
<a id="a5d392d4cc38109670585708f5062c2fe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5d392d4cc38109670585708f5062c2fe">◆ </a></span>pa_sample_spec_init()</h2>
<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_sample_spec_init </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structpa__sample__spec.html">pa_sample_spec</a> * </td>
<td class="paramname"><em>spec</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize the specified sample spec and return a pointer to it. </p>
<p>The sample spec will have a defined state but <a class="el" href="sample_8h.html#a0d9ad972ee71ef6bff8aaafd44fdb229" title="Return non-zero when the sample type specification is valid. ">pa_sample_spec_valid()</a> will fail for it. </p><dl class="section since"><dt>Since</dt><dd>0.9.13 </dd></dl>
</div>
</div>
<a id="a3dd4815bbd51d5467b40e28d05ad948d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3dd4815bbd51d5467b40e28d05ad948d">◆ </a></span>pa_sample_spec_snprint()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* pa_sample_spec_snprint </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>l</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structpa__sample__spec.html">pa_sample_spec</a> * </td>
<td class="paramname"><em>spec</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Pretty print a sample type specification to a string. </p>
</div>
</div>
<a id="a0d9ad972ee71ef6bff8aaafd44fdb229"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0d9ad972ee71ef6bff8aaafd44fdb229">◆ </a></span>pa_sample_spec_valid()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int pa_sample_spec_valid </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structpa__sample__spec.html">pa_sample_spec</a> * </td>
<td class="paramname"><em>spec</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return non-zero when the sample type specification is valid. </p>
</div>
</div>
<a id="aa941cbdb65f1f0265a1d165bc14db034"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa941cbdb65f1f0265a1d165bc14db034">◆ </a></span>pa_usec_to_bytes()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t pa_usec_to_bytes </td>
<td>(</td>
<td class="paramtype"><a class="el" href="sample_8h.html#a885df3b973773f0dccbbec6bc6777f89">pa_usec_t</a> </td>
<td class="paramname"><em>t</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structpa__sample__spec.html">pa_sample_spec</a> * </td>
<td class="paramname"><em>spec</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Calculates the number of bytes that are required for the specified time. </p>
<p>The return value will always be rounded down for non-integral return values. </p><dl class="section since"><dt>Since</dt><dd>0.9 </dd></dl>
</div>
</div>
</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="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_ec5b0a79aff2db41fe5d1b9326f09c28.html">pulse</a></li><li class="navelem"><a class="el" href="sample_8h.html">sample.h</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.13 </li>
</ul>
</div>
</body>
</html>
distrib
>
Mageia
>
6
>
x86_64
>
media
>
core-updates
>
by-pkgid
>
a41e5ac5fb332416cb8019ae392f1f99
>
files
>
240
