241 lines
12 KiB
HTML
241 lines
12 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="UTF-8" />
|
|
<title>ScStwSoundPlayer class | ScStw shared libraries</title>
|
|
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,600,600i%7CSource+Code+Pro:400,400i,600" />
|
|
<link rel="stylesheet" href="m-dark+documentation.compiled.css" />
|
|
<link rel="icon" href="favicon.png" type="image/png" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
<meta name="theme-color" content="#0094ff" />
|
|
</head>
|
|
<body>
|
|
<header><nav id="navigation">
|
|
<div class="m-container">
|
|
<div class="m-row">
|
|
<a href="index.html" id="m-navbar-brand" class="m-col-t-8 m-col-m-none m-left-m"><img src="favicon.png" alt="" />ScStw shared libraries</a>
|
|
<div class="m-col-t-4 m-hide-m m-text-right m-nopadr">
|
|
<a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
|
|
<path id="m-doc-search-icon-path" d="m6 0c-3.31 0-6 2.69-6 6 0 3.31 2.69 6 6 6 1.49 0 2.85-0.541 3.89-1.44-0.0164 0.338 0.147 0.759 0.5 1.15l3.22 3.79c0.552 0.614 1.45 0.665 2 0.115 0.55-0.55 0.499-1.45-0.115-2l-3.79-3.22c-0.392-0.353-0.812-0.515-1.15-0.5 0.895-1.05 1.44-2.41 1.44-3.89 0-3.31-2.69-6-6-6zm0 1.56a4.44 4.44 0 0 1 4.44 4.44 4.44 4.44 0 0 1-4.44 4.44 4.44 4.44 0 0 1-4.44-4.44 4.44 4.44 0 0 1 4.44-4.44z"/>
|
|
</svg></a>
|
|
<a id="m-navbar-show" href="#navigation" title="Show navigation"></a>
|
|
<a id="m-navbar-hide" href="#" title="Hide navigation"></a>
|
|
</div>
|
|
<div id="m-navbar-collapse" class="m-col-t-12 m-show-m m-col-m-none m-right-m">
|
|
<div class="m-row">
|
|
<ol class="m-col-t-6 m-col-m-none">
|
|
</ol>
|
|
<ol class="m-col-t-6 m-col-m-none" start="1">
|
|
<li><a href="index.html">Introduction</a></li>
|
|
<li><a href="annotated.html">Classes</a></li>
|
|
<li><a href="refman.pdf">Download</a></li>
|
|
<li class="m-show-m"><a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
|
|
<use href="#m-doc-search-icon-path" />
|
|
</svg></a></li>
|
|
</ol>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</nav></header>
|
|
<main><article>
|
|
<div class="m-container m-container-inflatable">
|
|
<div class="m-row">
|
|
<div class="m-col-l-10 m-push-l-1">
|
|
<h1>
|
|
ScStwSoundPlayer <span class="m-thin">class</span>
|
|
</h1>
|
|
<p>The <a href="classScStwSoundPlayer.html" class="m-doc">ScStwSoundPlayer</a> class is used for ultra low latency sound playback of the speed clibing start tones and commands.</p>
|
|
<nav class="m-block m-default">
|
|
<h3>Contents</h3>
|
|
<ul>
|
|
<li>
|
|
Reference
|
|
<ul>
|
|
<li><a href="#typeless-methods">Constructors, destructors, conversion operators</a></li>
|
|
<li><a href="#signals">Signals</a></li>
|
|
<li><a href="#pub-slots">Public slots</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
<section id="typeless-methods">
|
|
<h2><a href="#typeless-methods">Constructors, destructors, conversion operators</a></h2>
|
|
<dl class="m-doc">
|
|
<dt>
|
|
<span class="m-doc-wrap-bumper"><a href="#a8fb670ba6b752464f7a2f729803dfc45" class="m-doc">ScStwSoundPlayer</a>(</span><span class="m-doc-wrap">QObject* parent = nullptr) <span class="m-label m-flat m-info">explicit</span> </span>
|
|
</dt>
|
|
<dd><a href="classScStwSoundPlayer.html" class="m-doc">ScStwSoundPlayer</a> constructor.</dd>
|
|
</dl>
|
|
</section>
|
|
<section id="signals">
|
|
<h2><a href="#signals">Signals</a></h2>
|
|
<dl class="m-doc">
|
|
<dt id="aa2fee0a62891c8375659ec24adc8f15c">
|
|
<span class="m-doc-wrap-bumper">void <a href="#aa2fee0a62891c8375659ec24adc8f15c" class="m-doc-self">playbackStarted</a>(</span><span class="m-doc-wrap">)</span>
|
|
</dt>
|
|
<dd>Emitted whenever a playback started.</dd>
|
|
</dl>
|
|
</section>
|
|
<section id="pub-slots">
|
|
<h2><a href="#pub-slots">Public slots</a></h2>
|
|
<dl class="m-doc">
|
|
<dt>
|
|
<span class="m-doc-wrap-bumper">auto <a href="#a8406a6f6877a700a6872980ca1497b0e" class="m-doc">play</a>(</span><span class="m-doc-wrap">StartSound sound,
|
|
double volume,
|
|
double* timeOfStart = nullptr) -> ScStwSoundPlayer::PlayResult</span>
|
|
</dt>
|
|
<dd>Function to begin playing the sound of a certain state.</dd>
|
|
<dt>
|
|
<span class="m-doc-wrap-bumper">auto <a href="#a027f45d562b787bfe94872b5fb797575" class="m-doc">waitForSoundFinish</a>(</span><span class="m-doc-wrap">double* timeOfStop = nullptr) -> ScStwSoundPlayer::PlayResult</span>
|
|
</dt>
|
|
<dd>Function to wait for the playback to finish.</dd>
|
|
<dt>
|
|
<span class="m-doc-wrap-bumper">auto <a href="#a3e09578b2da014e3a2324e7f3c5549f1" class="m-doc">cancel</a>(</span><span class="m-doc-wrap">) -> bool</span>
|
|
</dt>
|
|
<dd>Function to cancel the current playback.</dd>
|
|
</dl>
|
|
</section>
|
|
<section>
|
|
<h2>Function documentation</h2>
|
|
<section class="m-doc-details" id="a8fb670ba6b752464f7a2f729803dfc45"><div>
|
|
<h3>
|
|
<span class="m-doc-wrap-bumper"> ScStwSoundPlayer::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a8fb670ba6b752464f7a2f729803dfc45" class="m-doc-self">ScStwSoundPlayer</a>(</span><span class="m-doc-wrap">QObject* parent = nullptr) <span class="m-label m-info">explicit</span> </span></span>
|
|
</h3>
|
|
<p><a href="classScStwSoundPlayer.html" class="m-doc">ScStwSoundPlayer</a> constructor.</p>
|
|
<table class="m-table m-fullwidth m-flat">
|
|
<thead>
|
|
<tr><th colspan="2">Parameters</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td style="width: 1%">parent</td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div></section>
|
|
<section class="m-doc-details" id="a8406a6f6877a700a6872980ca1497b0e"><div>
|
|
<h3>
|
|
<span class="m-doc-wrap-bumper">ScStwSoundPlayer::PlayResult ScStwSoundPlayer::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a8406a6f6877a700a6872980ca1497b0e" class="m-doc-self">play</a>(</span><span class="m-doc-wrap">StartSound sound,
|
|
double volume,
|
|
double* timeOfStart = nullptr) <span class="m-label m-success">public slot</span></span></span>
|
|
</h3>
|
|
<p>Function to begin playing the sound of a certain state.</p>
|
|
<table class="m-table m-fullwidth m-flat">
|
|
<thead>
|
|
<tr><th colspan="2">Parameters</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td style="width: 1%">sound</td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td>volume</td>
|
|
<td>The volume to play at</td>
|
|
</tr>
|
|
<tr>
|
|
<td>timeOfStart</td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
<tfoot>
|
|
<tr>
|
|
<th>Returns</th>
|
|
<td>TODO true if the playback was successfully started, false otherwise</td>
|
|
</tr>
|
|
</tfoot>
|
|
</table>
|
|
</div></section>
|
|
<section class="m-doc-details" id="a027f45d562b787bfe94872b5fb797575"><div>
|
|
<h3>
|
|
<span class="m-doc-wrap-bumper">ScStwSoundPlayer::PlayResult ScStwSoundPlayer::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a027f45d562b787bfe94872b5fb797575" class="m-doc-self">waitForSoundFinish</a>(</span><span class="m-doc-wrap">double* timeOfStop = nullptr) <span class="m-label m-success">public slot</span></span></span>
|
|
</h3>
|
|
<p>Function to wait for the playback to finish.</p>
|
|
<table class="m-table m-fullwidth m-flat">
|
|
<thead>
|
|
<tr><th colspan="2">Parameters</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td style="width: 1%">timeOfStop</td>
|
|
<td>the point in time when the plyback actually stopped (msecs since epoch)</td>
|
|
</tr>
|
|
</tbody>
|
|
<tfoot>
|
|
<tr>
|
|
<th>Returns</th>
|
|
<td>false if there was any error (eg. there was no playback currently), true otherwise</td>
|
|
</tr>
|
|
</tfoot>
|
|
</table>
|
|
</div></section>
|
|
<section class="m-doc-details" id="a3e09578b2da014e3a2324e7f3c5549f1"><div>
|
|
<h3>
|
|
<span class="m-doc-wrap-bumper">bool ScStwSoundPlayer::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a3e09578b2da014e3a2324e7f3c5549f1" class="m-doc-self">cancel</a>(</span><span class="m-doc-wrap">) <span class="m-label m-success">public slot</span></span></span>
|
|
</h3>
|
|
<p>Function to cancel the current playback.</p>
|
|
<table class="m-table m-fullwidth m-flat">
|
|
<tfoot>
|
|
<tr>
|
|
<th style="width: 1%">Returns</th>
|
|
<td>true if the playback was successfully stopped, false otherwise</td>
|
|
</tr>
|
|
</tfoot>
|
|
</table>
|
|
<p>Note that this function will automatically play the false start tone if the currently playing action is 2</p>
|
|
</div></section>
|
|
</section>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</article></main>
|
|
<div class="m-doc-search" id="search">
|
|
<a href="#!" onclick="return hideSearch()"></a>
|
|
<div class="m-container">
|
|
<div class="m-row">
|
|
<div class="m-col-m-8 m-push-m-2">
|
|
<div class="m-doc-search-header m-text m-small">
|
|
<div><span class="m-label m-default">Tab</span> / <span class="m-label m-default">T</span> to search, <span class="m-label m-default">Esc</span> to close</div>
|
|
<div id="search-symbolcount">…</div>
|
|
</div>
|
|
<div class="m-doc-search-content">
|
|
<form>
|
|
<input type="search" name="q" id="search-input" placeholder="Loading …" disabled="disabled" autofocus="autofocus" autocomplete="off" spellcheck="false" />
|
|
</form>
|
|
<noscript class="m-text m-danger m-text-center">Unlike everything else in the docs, the search functionality <em>requires</em> JavaScript.</noscript>
|
|
<div id="search-help" class="m-text m-dim m-text-center">
|
|
<p class="m-noindent">Search for symbols, directories, files, pages or
|
|
modules. You can omit any prefix from the symbol or file path; adding a
|
|
<code>:</code> or <code>/</code> suffix lists all members of given symbol or
|
|
directory.</p>
|
|
<p class="m-noindent">Use <span class="m-label m-dim">↓</span>
|
|
/ <span class="m-label m-dim">↑</span> to navigate through the list,
|
|
<span class="m-label m-dim">Enter</span> to go.
|
|
<span class="m-label m-dim">Tab</span> autocompletes common prefix, you can
|
|
copy a link to the result using <span class="m-label m-dim">⌘</span>
|
|
<span class="m-label m-dim">L</span> while <span class="m-label m-dim">⌘</span>
|
|
<span class="m-label m-dim">M</span> produces a Markdown link.</p>
|
|
</div>
|
|
<div id="search-notfound" class="m-text m-warning m-text-center">Sorry, nothing was found.</div>
|
|
<ul id="search-results"></ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<script src="search-v2.js"></script>
|
|
<script src="searchdata-v2.js" async="async"></script>
|
|
<footer><nav>
|
|
<div class="m-container">
|
|
<div class="m-row">
|
|
<div class="m-col-l-10 m-push-l-1">
|
|
<p>ScStw shared libraries. Created with <a href="https://doxygen.org/">Doxygen</a> 1.9.4 and <a href="https://mcss.mosra.cz/">m.css</a>.</p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</nav></footer>
|
|
</body>
|
|
</html>
|