summaryrefslogtreecommitdiffstatshomepage
path: root/docs
diff options
context:
space:
mode:
author hap <happppp@users.noreply.github.com>2025-05-31 12:25:31 +0200
committer hap <happppp@users.noreply.github.com>2025-05-31 12:25:42 +0200
commit6fbb9dc728cdac7dc7a09c14ed35dbcf7af569cb (patch)
tree1816fff70407d31a38dca64753e140e72ab4b68b /docs
parentce38627640d48a9329b06a6358f36d98090a7faa (diff)
sound: print verbose message if module doesn't support audio_latency option,
docs: small update, remove references to dsound
Diffstat (limited to 'docs')
-rw-r--r--docs/man/mame.67
-rw-r--r--docs/source/commandline/commandline-all.rst22
2 files changed, 14 insertions, 15 deletions
diff --git a/docs/man/mame.6 b/docs/man/mame.6
index e45985a3011..fab6c3f22d8 100644
--- a/docs/man/mame.6
+++ b/docs/man/mame.6
@@ -907,7 +907,7 @@ Split full screen image across monitors. Default is OFF (\-nouseallheads).
.SS Sound options
.\" *******************************************************
.TP
-.B \-sound\fR [\fIsdl\fR|\fIportaudio\fR|\fIcoreaudio\fR|\fIdsound\fR|\fIxaudio2\fR|\fInone\fR]
+.B \-sound\fR [\fIsdl\fR|\fIportaudio\fR|\fIcoreaudio\fR|\fIwasapi\fR|\fIxaudio2\fR|\fInone\fR]
Specifies which sound subsystem to use for audio output:
.br
\fBsdl\fR uses the Simple DirectMedia Layer audio output system
@@ -919,14 +919,15 @@ output and multiple audio APIs.
\fBcoreaudio\fR uses the Core Audio API which supports low-latency
output and AudioUnit effects (only available on macOS).
.br
-\fBdsound\fR uses the DirectSound API (only available on Windows).
+\fBwasapi\fR uses the Windows Audio Session API (WASAPI) (only available
+on Windows).
.br
\fBxaudio2\fR uses the XAudio2 API which supports low-latency output
(only available on Windows).
.br
\fBnone\fR produces no audio output.
.br
-Default is 'dsound' on Windows, 'coreaudio' on macOS or 'sdl' on other
+Default is 'wasapi' on Windows, 'coreaudio' on macOS or 'sdl' on other
platforms.
.TP
.B \-samplerate, \-srf \fIvalue
diff --git a/docs/source/commandline/commandline-all.rst b/docs/source/commandline/commandline-all.rst
index e9a0d79b2df..8ee84ae9a27 100644
--- a/docs/source/commandline/commandline-all.rst
+++ b/docs/source/commandline/commandline-all.rst
@@ -1937,9 +1937,9 @@ Core Performance Options
half speed, and a *<factor>* of 2.0 means run at double speed. Note that
changing this value affects sound playback as well, which will scale in
pitch accordingly. A very low speed will introduce sound glitches, this
- can be prevented by increasing **-audio_latency**. The internal precision
- of the fraction is two decimal places, so a *<factor>* of ``1.002`` is
- rounded to ``1.00``.
+ can be prevented by increasing the :ref:`audio latency
+ <mame-commandline-audiolatency>`. The internal precision of the fraction is
+ two decimal places, so a *<factor>* of ``1.002`` is rounded to ``1.00``.
The default is ``1.0`` (normal speed).
@@ -2977,17 +2977,16 @@ Core Sound Options
Specifies which sound module to use. Selecting ``none`` disables sound
output and input altogether (sound hardware is still emulated).
- Available features, performance and latency vary between sound modules. The
- exact interpretation and useful range of the :ref:`latency option
- <mame-commandline-audiolatency>` varies between sound modules. You may have
- to change the value of the latency option if you change the sound module.
+ Available features, performance and latency vary between sound modules.
+ You may have to change the value of the :ref:`latency option
+ <mame-commandline-audiolatency>` if you change the sound module.
When using the ``sdl`` sound subsystem, the audio API to use may be selected
by setting the *SDL_AUDIODRIVER* environment variable. Available audio APIs
depend on the operating system. On Windows, it may be necessary to set
``SDL_AUDIODRIVER=directsound`` if no sound output is produced by default.
- The default is ``dsound`` on Windows. On Mac, ``coreaudio`` is the default.
+ The default is ``wasapi`` on Windows. On Mac, ``coreaudio`` is the default.
On all other platforms, ``sdl`` is the default.
Example:
@@ -3072,10 +3071,9 @@ Core Sound Options
interruptions. A value of 0.0 will use the default for the selected sound
module.
- The exact interpretation and useful range of values for this option depends
- on the selected sound module. You may need to change the value of this
- option if you change the sound module using the :ref:`sound option
- <mame-commandline-sound>`.
+ You may need to change the value of this option if you change the sound module
+ using the :ref:`sound option <mame-commandline-sound>`. This option is
+ unsupported on sound modules ``pipewire``, ``pulse``, ``sdl``.
The default is ``0.0``.