mika/libnx
1
0
Fork 0
mirror of https://github.com/switchbrew/libnx.git synced 2025-06-21 04:22:50 +02:00
Code Issues Packages Projects Releases Wiki Activity
bf00061749
libnx/audout_8h_source.html
WinterMute bf00061749 Deploying to gh-pages from @ 29f6f4fa7a 🚀
2025-05-08 06:59:12 +00:00

206 lines
33 KiB
HTML
Raw Blame History

<!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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libnx: include/switch/services/audout.h Source File</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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.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 id="projectrow">
<td id="projectalign">
<div id="projectname">libnx<span id="projectnumber">&#160;v4.9.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_42bea3d40f1f1694e41a8f3166c98108.html">switch</a></li><li class="navelem"><a class="el" href="dir_04a7e0b94d44ce4fc7ca3462163fd33c.html">services</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">audout.h</div></div>
</div><!--header-->
<div class="contents">
<a href="audout_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/**</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * @file audout.h</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * @brief Audio output service.</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * @author hexkyz</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * @copyright libnx Authors</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> */</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span> </div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include &quot;../types.h&quot;</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#include &quot;../audio/audio.h&quot;</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#include &quot;../sf/service.h&quot;</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> </div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="keyword">typedef</span> <span class="keyword">enum</span> {</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> AudioOutState_Started = 0,</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> AudioOutState_Stopped = 1,</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span>} AudioOutState;</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment"></span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment">/// Audio output buffer format</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="comment"></span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="structAudioOutBuffer.html">AudioOutBuffer</a> <a class="code hl_struct" href="structAudioOutBuffer.html">AudioOutBuffer</a>;</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> </div>
<div class="foldopen" id="foldopen00021" data-start="{" data-end="};">
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"><a class="line" href="structAudioOutBuffer.html"> 21</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structAudioOutBuffer.html">AudioOutBuffer</a></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span>{</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"><a class="line" href="structAudioOutBuffer.html#a92956f81a7e8e1d0a9250e5872b4623f"> 23</a></span> <a class="code hl_struct" href="structAudioOutBuffer.html">AudioOutBuffer</a>* <a class="code hl_variable" href="structAudioOutBuffer.html#a92956f81a7e8e1d0a9250e5872b4623f">next</a>; <span class="comment">///&lt; Next buffer. (Unused)</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"><a class="line" href="structAudioOutBuffer.html#ac54053e8f3696fb87f42c69560c013db"> 24</a></span> <span class="keywordtype">void</span>* <a class="code hl_variable" href="structAudioOutBuffer.html#ac54053e8f3696fb87f42c69560c013db">buffer</a>; <span class="comment">///&lt; Sample buffer (aligned to 0x1000 bytes).</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"><a class="line" href="structAudioOutBuffer.html#a178952601680583f2f6bdd7279a82c84"> 25</a></span> <a class="code hl_typedef" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> <a class="code hl_variable" href="structAudioOutBuffer.html#a178952601680583f2f6bdd7279a82c84">buffer_size</a>; <span class="comment">///&lt; Sample buffer size (aligned to 0x1000 bytes).</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"><a class="line" href="structAudioOutBuffer.html#aacb331ccc154fb5dd505585b482b0a4d"> 26</a></span> <a class="code hl_typedef" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> <a class="code hl_variable" href="structAudioOutBuffer.html#aacb331ccc154fb5dd505585b482b0a4d">data_size</a>; <span class="comment">///&lt; Size of data inside the buffer.</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"><a class="line" href="structAudioOutBuffer.html#a73a3a090a992b4672e8938b34dca307d"> 27</a></span> <a class="code hl_typedef" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> <a class="code hl_variable" href="structAudioOutBuffer.html#a73a3a090a992b4672e8938b34dca307d">data_offset</a>; <span class="comment">///&lt; Offset of data inside the buffer. (Unused?)</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span>};</div>
</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="comment"></span> </div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="comment">/// Initialize audout.</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"><a class="line" href="audout_8h.html#a6a1fa06e6ef9b6c4b237dd1cd6df8f00"> 31</a></span><span class="comment"></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="audout_8h.html#a6a1fa06e6ef9b6c4b237dd1cd6df8f00">audoutInitialize</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="comment"></span> </div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="comment">/// Exit audout.</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"><a class="line" href="audout_8h.html#a036eb5ef61c4b5740447ac17ae8b4a60"> 34</a></span><span class="comment"></span><span class="keywordtype">void</span> <a class="code hl_function" href="audout_8h.html#a036eb5ef61c4b5740447ac17ae8b4a60">audoutExit</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="comment"></span> </div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span><span class="comment">/// Gets the Service object for the actual audout service session.</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"><a class="line" href="audout_8h.html#ab62021bdc21d8647ee20d49a946c854b"> 37</a></span><span class="comment"></span><a class="code hl_struct" href="structService.html">Service</a>* <a class="code hl_function" href="audout_8h.html#ab62021bdc21d8647ee20d49a946c854b">audoutGetServiceSession</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span><span class="comment"></span> </div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span><span class="comment">/// Gets the Service object for IAudioOut.</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"><a class="line" href="audout_8h.html#a0262adfa3bc146b1316eaf87ea5f596a"> 40</a></span><span class="comment"></span><a class="code hl_struct" href="structService.html">Service</a>* <a class="code hl_function" href="audout_8h.html#a0262adfa3bc146b1316eaf87ea5f596a">audoutGetServiceSession_AudioOut</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> </div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> audoutListAudioOuts(<span class="keywordtype">char</span> *DeviceNames, <a class="code hl_typedef" href="types_8h.html#ae9b1af5c037e57a98884758875d3a7c4">s32</a> count, <a class="code hl_typedef" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *DeviceNamesCount);</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> audoutOpenAudioOut(<span class="keyword">const</span> <span class="keywordtype">char</span> *DeviceNameIn, <span class="keywordtype">char</span> *DeviceNameOut, <a class="code hl_typedef" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> SampleRateIn, <a class="code hl_typedef" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> ChannelCountIn, <a class="code hl_typedef" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *SampleRateOut, <a class="code hl_typedef" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *ChannelCountOut, <a class="code hl_enumeration" href="audio_8h.html#af852a505c66e89e10c8d44d059e7b20d">PcmFormat</a> *Format, AudioOutState *State);</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> audoutGetAudioOutState(AudioOutState *State);</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> audoutStartAudioOut(<span class="keywordtype">void</span>);</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> audoutStopAudioOut(<span class="keywordtype">void</span>);</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span><span class="comment"></span> </div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span><span class="comment">/// Submits an \ref AudioOutBuffer for playing.</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"><a class="line" href="audout_8h.html#a169791a69540e658faa35c093701bce0"> 49</a></span><span class="comment"></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="audout_8h.html#a169791a69540e658faa35c093701bce0">audoutAppendAudioOutBuffer</a>(<a class="code hl_struct" href="structAudioOutBuffer.html">AudioOutBuffer</a> *Buffer);</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> </div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> audoutGetReleasedAudioOutBuffer(<a class="code hl_struct" href="structAudioOutBuffer.html">AudioOutBuffer</a> **Buffer, <a class="code hl_typedef" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *ReleasedBuffersCount);</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> audoutContainsAudioOutBuffer(<a class="code hl_struct" href="structAudioOutBuffer.html">AudioOutBuffer</a> *Buffer, <span class="keywordtype">bool</span> *ContainsBuffer);</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span><span class="comment"></span> </div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span><span class="comment">/// Only available with [4.0.0+].</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"><a class="line" href="audout_8h.html#acd9745495cb188740ce6622ea1b956eb"> 55</a></span><span class="comment"></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="audout_8h.html#acd9745495cb188740ce6622ea1b956eb">audoutGetAudioOutBufferCount</a>(<a class="code hl_typedef" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *count);<span class="comment"></span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span><span class="comment">/// Only available with [4.0.0+].</span></div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"><a class="line" href="audout_8h.html#a8a05c80f2ccede4f15d6d07a42aba55b"> 57</a></span><span class="comment"></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="audout_8h.html#a8a05c80f2ccede4f15d6d07a42aba55b">audoutGetAudioOutPlayedSampleCount</a>(<a class="code hl_typedef" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> *count);<span class="comment"></span></div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span><span class="comment">/// Only available with [4.0.0+].</span></div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"><a class="line" href="audout_8h.html#ae93bb397c36aa8f6e549f37d0c89fc0a"> 59</a></span><span class="comment"></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="audout_8h.html#ae93bb397c36aa8f6e549f37d0c89fc0a">audoutFlushAudioOutBuffers</a>(<span class="keywordtype">bool</span> *flushed);<span class="comment"></span></div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span><span class="comment">/// Only available with [6.0.0+].</span></div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"><a class="line" href="audout_8h.html#a419e5e4e0209d0d0a0cc2293b110598e"> 61</a></span><span class="comment"></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="audout_8h.html#a419e5e4e0209d0d0a0cc2293b110598e">audoutSetAudioOutVolume</a>(<span class="keywordtype">float</span> volume);<span class="comment"></span></div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span><span class="comment">/// Only available with [6.0.0+].</span></div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"><a class="line" href="audout_8h.html#ae57224f75756da357c8cd34d3b034eed"> 63</a></span><span class="comment"></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="audout_8h.html#ae57224f75756da357c8cd34d3b034eed">audoutGetAudioOutVolume</a>(<span class="keywordtype">float</span> *volume);</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span><span class="comment"></span> </div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span><span class="comment">/**</span></div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span><span class="comment"> * @brief Submits an audio sample data buffer for playing and waits for it to finish playing.</span></div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span><span class="comment"> * @brief Uses \ref audoutAppendAudioOutBuffer and \ref audoutWaitPlayFinish internally.</span></div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span><span class="comment"> * @param source AudioOutBuffer containing the source sample data to be played.</span></div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span><span class="comment"> * @param released AudioOutBuffer to receive the played buffer after being released.</span></div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span><span class="comment"> */</span></div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"><a class="line" href="audout_8h.html#a691506f2185353163a59b00a2bdd4d82"> 71</a></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="audout_8h.html#a691506f2185353163a59b00a2bdd4d82">audoutPlayBuffer</a>(<a class="code hl_struct" href="structAudioOutBuffer.html">AudioOutBuffer</a> *source, <a class="code hl_struct" href="structAudioOutBuffer.html">AudioOutBuffer</a> **released);</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span><span class="comment"></span> </div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span><span class="comment">/**</span></div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span><span class="comment"> * @brief Waits for audio playback to finish.</span></div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span><span class="comment"> * @param released AudioOutBuffer to receive the first played buffer after being released.</span></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span><span class="comment"> * @param released_count Pointer to receive the number of played buffers.</span></div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span><span class="comment"> * @param timeout Timeout value, use UINT64_MAX to wait until all finished.</span></div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span><span class="comment"> */</span></div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"><a class="line" href="audout_8h.html#a5b36098c76e81095a059ee3872598260"> 79</a></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="audout_8h.html#a5b36098c76e81095a059ee3872598260">audoutWaitPlayFinish</a>(<a class="code hl_struct" href="structAudioOutBuffer.html">AudioOutBuffer</a> **released, <a class="code hl_typedef" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a>* released_count, <a class="code hl_typedef" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> timeout);</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span><span class="comment"></span> </div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span><span class="comment">/// These return the state associated with the currently active audio output device.</span></div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"><a class="line" href="audout_8h.html#a4bb035f19d98f4ea5c2f67d60ce0322d"> 82</a></span><span class="comment"></span><a class="code hl_typedef" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> <a class="code hl_function" href="audout_8h.html#a4bb035f19d98f4ea5c2f67d60ce0322d">audoutGetSampleRate</a>(<span class="keywordtype">void</span>); <span class="comment">///&lt; Supported sample rate (48000Hz).</span></div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"><a class="line" href="audout_8h.html#a7b3c69222d98af28390b8f7e4e3775cd"> 83</a></span><a class="code hl_typedef" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> <a class="code hl_function" href="audout_8h.html#a7b3c69222d98af28390b8f7e4e3775cd">audoutGetChannelCount</a>(<span class="keywordtype">void</span>); <span class="comment">///&lt; Supported channel count (2 channels).</span></div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"><a class="line" href="audout_8h.html#a1602fc668e3e88ff5bd419c94c5ada19"> 84</a></span><a class="code hl_enumeration" href="audio_8h.html#af852a505c66e89e10c8d44d059e7b20d">PcmFormat</a> <a class="code hl_function" href="audout_8h.html#a1602fc668e3e88ff5bd419c94c5ada19">audoutGetPcmFormat</a>(<span class="keywordtype">void</span>); <span class="comment">///&lt; Supported PCM format (Int16).</span></div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"><a class="line" href="audout_8h.html#aee859d1b23dbbedf74a2e02ea8b8b7a3"> 85</a></span>AudioOutState <a class="code hl_function" href="audout_8h.html#aee859d1b23dbbedf74a2e02ea8b8b7a3">audoutGetDeviceState</a>(<span class="keywordtype">void</span>); <span class="comment">///&lt; Initial device state (stopped).</span></div>
<div class="ttc" id="aaudio_8h_html_af852a505c66e89e10c8d44d059e7b20d"><div class="ttname"><a href="audio_8h.html#af852a505c66e89e10c8d44d059e7b20d">PcmFormat</a></div><div class="ttdeci">PcmFormat</div><div class="ttdoc">PcmFormat.</div><div class="ttdef"><b>Definition</b> audio.h:12</div></div>
<div class="ttc" id="aaudout_8h_html_a0262adfa3bc146b1316eaf87ea5f596a"><div class="ttname"><a href="audout_8h.html#a0262adfa3bc146b1316eaf87ea5f596a">audoutGetServiceSession_AudioOut</a></div><div class="ttdeci">Service * audoutGetServiceSession_AudioOut(void)</div><div class="ttdoc">Gets the Service object for IAudioOut.</div></div>
<div class="ttc" id="aaudout_8h_html_a036eb5ef61c4b5740447ac17ae8b4a60"><div class="ttname"><a href="audout_8h.html#a036eb5ef61c4b5740447ac17ae8b4a60">audoutExit</a></div><div class="ttdeci">void audoutExit(void)</div><div class="ttdoc">Exit audout.</div></div>
<div class="ttc" id="aaudout_8h_html_a1602fc668e3e88ff5bd419c94c5ada19"><div class="ttname"><a href="audout_8h.html#a1602fc668e3e88ff5bd419c94c5ada19">audoutGetPcmFormat</a></div><div class="ttdeci">PcmFormat audoutGetPcmFormat(void)</div><div class="ttdoc">Supported PCM format (Int16).</div></div>
<div class="ttc" id="aaudout_8h_html_a169791a69540e658faa35c093701bce0"><div class="ttname"><a href="audout_8h.html#a169791a69540e658faa35c093701bce0">audoutAppendAudioOutBuffer</a></div><div class="ttdeci">Result audoutAppendAudioOutBuffer(AudioOutBuffer *Buffer)</div><div class="ttdoc">Submits an AudioOutBuffer for playing.</div></div>
<div class="ttc" id="aaudout_8h_html_a419e5e4e0209d0d0a0cc2293b110598e"><div class="ttname"><a href="audout_8h.html#a419e5e4e0209d0d0a0cc2293b110598e">audoutSetAudioOutVolume</a></div><div class="ttdeci">Result audoutSetAudioOutVolume(float volume)</div><div class="ttdoc">Only available with [6.0.0+].</div></div>
<div class="ttc" id="aaudout_8h_html_a4bb035f19d98f4ea5c2f67d60ce0322d"><div class="ttname"><a href="audout_8h.html#a4bb035f19d98f4ea5c2f67d60ce0322d">audoutGetSampleRate</a></div><div class="ttdeci">u32 audoutGetSampleRate(void)</div><div class="ttdoc">These return the state associated with the currently active audio output device.</div></div>
<div class="ttc" id="aaudout_8h_html_a5b36098c76e81095a059ee3872598260"><div class="ttname"><a href="audout_8h.html#a5b36098c76e81095a059ee3872598260">audoutWaitPlayFinish</a></div><div class="ttdeci">Result audoutWaitPlayFinish(AudioOutBuffer **released, u32 *released_count, u64 timeout)</div><div class="ttdoc">Waits for audio playback to finish.</div></div>
<div class="ttc" id="aaudout_8h_html_a691506f2185353163a59b00a2bdd4d82"><div class="ttname"><a href="audout_8h.html#a691506f2185353163a59b00a2bdd4d82">audoutPlayBuffer</a></div><div class="ttdeci">Result audoutPlayBuffer(AudioOutBuffer *source, AudioOutBuffer **released)</div><div class="ttdoc">Submits an audio sample data buffer for playing and waits for it to finish playing.</div></div>
<div class="ttc" id="aaudout_8h_html_a6a1fa06e6ef9b6c4b237dd1cd6df8f00"><div class="ttname"><a href="audout_8h.html#a6a1fa06e6ef9b6c4b237dd1cd6df8f00">audoutInitialize</a></div><div class="ttdeci">Result audoutInitialize(void)</div><div class="ttdoc">Initialize audout.</div></div>
<div class="ttc" id="aaudout_8h_html_a7b3c69222d98af28390b8f7e4e3775cd"><div class="ttname"><a href="audout_8h.html#a7b3c69222d98af28390b8f7e4e3775cd">audoutGetChannelCount</a></div><div class="ttdeci">u32 audoutGetChannelCount(void)</div><div class="ttdoc">Supported channel count (2 channels).</div></div>
<div class="ttc" id="aaudout_8h_html_a8a05c80f2ccede4f15d6d07a42aba55b"><div class="ttname"><a href="audout_8h.html#a8a05c80f2ccede4f15d6d07a42aba55b">audoutGetAudioOutPlayedSampleCount</a></div><div class="ttdeci">Result audoutGetAudioOutPlayedSampleCount(u64 *count)</div><div class="ttdoc">Only available with [4.0.0+].</div></div>
<div class="ttc" id="aaudout_8h_html_ab62021bdc21d8647ee20d49a946c854b"><div class="ttname"><a href="audout_8h.html#ab62021bdc21d8647ee20d49a946c854b">audoutGetServiceSession</a></div><div class="ttdeci">Service * audoutGetServiceSession(void)</div><div class="ttdoc">Gets the Service object for the actual audout service session.</div></div>
<div class="ttc" id="aaudout_8h_html_acd9745495cb188740ce6622ea1b956eb"><div class="ttname"><a href="audout_8h.html#acd9745495cb188740ce6622ea1b956eb">audoutGetAudioOutBufferCount</a></div><div class="ttdeci">Result audoutGetAudioOutBufferCount(u32 *count)</div><div class="ttdoc">Only available with [4.0.0+].</div></div>
<div class="ttc" id="aaudout_8h_html_ae57224f75756da357c8cd34d3b034eed"><div class="ttname"><a href="audout_8h.html#ae57224f75756da357c8cd34d3b034eed">audoutGetAudioOutVolume</a></div><div class="ttdeci">Result audoutGetAudioOutVolume(float *volume)</div><div class="ttdoc">Only available with [6.0.0+].</div></div>
<div class="ttc" id="aaudout_8h_html_ae93bb397c36aa8f6e549f37d0c89fc0a"><div class="ttname"><a href="audout_8h.html#ae93bb397c36aa8f6e549f37d0c89fc0a">audoutFlushAudioOutBuffers</a></div><div class="ttdeci">Result audoutFlushAudioOutBuffers(bool *flushed)</div><div class="ttdoc">Only available with [4.0.0+].</div></div>
<div class="ttc" id="aaudout_8h_html_aee859d1b23dbbedf74a2e02ea8b8b7a3"><div class="ttname"><a href="audout_8h.html#aee859d1b23dbbedf74a2e02ea8b8b7a3">audoutGetDeviceState</a></div><div class="ttdeci">AudioOutState audoutGetDeviceState(void)</div><div class="ttdoc">Initial device state (stopped).</div></div>
<div class="ttc" id="astructAudioOutBuffer_html"><div class="ttname"><a href="structAudioOutBuffer.html">AudioOutBuffer</a></div><div class="ttdoc">Audio output buffer format.</div><div class="ttdef"><b>Definition</b> audout.h:22</div></div>
<div class="ttc" id="astructAudioOutBuffer_html_a178952601680583f2f6bdd7279a82c84"><div class="ttname"><a href="structAudioOutBuffer.html#a178952601680583f2f6bdd7279a82c84">AudioOutBuffer::buffer_size</a></div><div class="ttdeci">u64 buffer_size</div><div class="ttdoc">Sample buffer size (aligned to 0x1000 bytes).</div><div class="ttdef"><b>Definition</b> audout.h:25</div></div>
<div class="ttc" id="astructAudioOutBuffer_html_a73a3a090a992b4672e8938b34dca307d"><div class="ttname"><a href="structAudioOutBuffer.html#a73a3a090a992b4672e8938b34dca307d">AudioOutBuffer::data_offset</a></div><div class="ttdeci">u64 data_offset</div><div class="ttdoc">Offset of data inside the buffer. (Unused?)</div><div class="ttdef"><b>Definition</b> audout.h:27</div></div>
<div class="ttc" id="astructAudioOutBuffer_html_a92956f81a7e8e1d0a9250e5872b4623f"><div class="ttname"><a href="structAudioOutBuffer.html#a92956f81a7e8e1d0a9250e5872b4623f">AudioOutBuffer::next</a></div><div class="ttdeci">AudioOutBuffer * next</div><div class="ttdoc">Next buffer. (Unused)</div><div class="ttdef"><b>Definition</b> audout.h:23</div></div>
<div class="ttc" id="astructAudioOutBuffer_html_aacb331ccc154fb5dd505585b482b0a4d"><div class="ttname"><a href="structAudioOutBuffer.html#aacb331ccc154fb5dd505585b482b0a4d">AudioOutBuffer::data_size</a></div><div class="ttdeci">u64 data_size</div><div class="ttdoc">Size of data inside the buffer.</div><div class="ttdef"><b>Definition</b> audout.h:26</div></div>
<div class="ttc" id="astructAudioOutBuffer_html_ac54053e8f3696fb87f42c69560c013db"><div class="ttname"><a href="structAudioOutBuffer.html#ac54053e8f3696fb87f42c69560c013db">AudioOutBuffer::buffer</a></div><div class="ttdeci">void * buffer</div><div class="ttdoc">Sample buffer (aligned to 0x1000 bytes).</div><div class="ttdef"><b>Definition</b> audout.h:24</div></div>
<div class="ttc" id="astructService_html"><div class="ttname"><a href="structService.html">Service</a></div><div class="ttdoc">Service object structure.</div><div class="ttdef"><b>Definition</b> service.h:14</div></div>
<div class="ttc" id="atypes_8h_html_a3f7e2bcbb0b4c338f3c4f6c937cd4234"><div class="ttname"><a href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a></div><div class="ttdeci">uint64_t u64</div><div class="ttdoc">64-bit unsigned integer.</div><div class="ttdef"><b>Definition</b> types.h:22</div></div>
<div class="ttc" id="atypes_8h_html_ad1be2721625a17f1be47fac918032afe"><div class="ttname"><a href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a></div><div class="ttdeci">u32 Result</div><div class="ttdoc">Function error code result type.</div><div class="ttdef"><b>Definition</b> types.h:44</div></div>
<div class="ttc" id="atypes_8h_html_ae9b1af5c037e57a98884758875d3a7c4"><div class="ttname"><a href="types_8h.html#ae9b1af5c037e57a98884758875d3a7c4">s32</a></div><div class="ttdeci">int32_t s32</div><div class="ttdoc">32-bit signed integer.</div><div class="ttdef"><b>Definition</b> types.h:27</div></div>
<div class="ttc" id="atypes_8h_html_afaa62991928fb9fb18ff0db62a040aba"><div class="ttname"><a href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a></div><div class="ttdeci">uint32_t u32</div><div class="ttdoc">32-bit unsigned integer.</div><div class="ttdef"><b>Definition</b> types.h:21</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink