Skip to content

Commit 3cbaa8c

Browse files
author
API Doc Deploy
committed
Updating API doc from fluidsynth master
1 parent 933b08f commit 3cbaa8c

2 files changed

Lines changed: 22 additions & 0 deletions

File tree

api/fluidsettings.xml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -735,6 +735,17 @@ Developers:
735735
<def>default</def>
736736
<desc>
737737
Device to use for WASAPI driver output. Starting with 2.3.6 all device names are expected to be UTF8 encoded.
738+
<br /><br />
739+
<strong>Note</strong><br />
740+
When using the WASAPI audio driver, more detailed information about device and format negotiation (e.g. whether the requested format was accepted natively, adjusted, or rejected) may be obtained by installing a custom log callback using <code>fluid_set_log_function()</code>.
741+
<br />
742+
The WASAPI driver reports informational, warning, and error messages received from the OS during device initialization, which can be used as a best-effort heuristic to distinguish between:
743+
<ul>
744+
<li>Successful native opens,</li>
745+
<li>successful opens with format adjustment or resampling, and</li>
746+
<li>failed opens.</li>
747+
</ul>
748+
This mechanism is used internally by the <code>fluidsynth -Q</code> command, see <a href="https://github.com/FluidSynth/fluidsynth/blob/master/src/fluid_wasapi_device_enumerate.c"><code>fluid_wasapi_device_enumerate.c</code></a> for a reference implementation. The content and meaning of log messages are not part of the public API contract and may change between releases.
738749
</desc>
739750
</setting>
740751
<setting>

api/settings_audio.html

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -683,6 +683,17 @@ <h1><a class="anchor" id="settings_audio_wasapi_device"></a>
683683
<p>
684684
<desc>
685685
Device to use for WASAPI driver output. Starting with 2.3.6 all device names are expected to be UTF8 encoded.
686+
<br><br>
687+
<strong>Note</strong><br>
688+
When using the WASAPI audio driver, more detailed information about device and format negotiation (e.g. whether the requested format was accepted natively, adjusted, or rejected) may be obtained by installing a custom log callback using <code>fluid_set_log_function()</code>.
689+
<br>
690+
The WASAPI driver reports informational, warning, and error messages received from the OS during device initialization, which can be used as a best-effort heuristic to distinguish between:
691+
<ul>
692+
<li>Successful native opens,</li>
693+
<li>successful opens with format adjustment or resampling, and</li>
694+
<li>failed opens.</li>
695+
</ul>
696+
This mechanism is used internally by the <code>fluidsynth -Q</code> command, see <a href="https://github.com/FluidSynth/fluidsynth/blob/master/src/fluid_wasapi_device_enumerate.c"><code>fluid_wasapi_device_enumerate.c</code></a> for a reference implementation. The content and meaning of log messages are not part of the public API contract and may change between releases.
686697
</desc>
687698

688699
</div>

0 commit comments

Comments
 (0)