From d2d53cc9d6413871ba956f89b384b25b9b76bbea Mon Sep 17 00:00:00 2001
From: Shen-Ta Hsieh <ibmibmibm.tw@gmail.com>
Date: Sat, 30 May 2020 14:04:58 +0800
Subject: [PATCH] doc: add docs for wasapi plugin

---
 doc/mpdconf.example | 14 ++++++++++++++
 doc/plugins.rst     | 19 +++++++++++++++++++
 2 files changed, 33 insertions(+)

diff --git a/doc/mpdconf.example b/doc/mpdconf.example
index 36a26a828..c401d6605 100644
--- a/doc/mpdconf.example
+++ b/doc/mpdconf.example
@@ -294,6 +294,20 @@ input {
 ##	mixer_type	"hardware"	# optional
 #}
 #
+# An example of a wasapi output (Windows multimedia API).
+#
+#audio_output {
+#	type		"wasapi"
+#	name		"My WASAPI output"
+##	device		"Digital Audio (S/PDIF) (High Definition Audio Device)" # optional
+#		or
+##	device		"0"		# optional
+## Exclusive mode blocks all other audio source, and get best audio quality without resampling.
+##	exclusive	"no"		# optional
+## Enumerate all devices in log.
+##	enumerate	"no"		# optional
+#}
+#
 # An example of an openal output.
 #
 #audio_output {
diff --git a/doc/plugins.rst b/doc/plugins.rst
index 95e2bfa47..db700bd69 100644
--- a/doc/plugins.rst
+++ b/doc/plugins.rst
@@ -1086,6 +1086,25 @@ The "Solaris" plugin runs only on SUN Solaris, and plays via /dev/audio.
      - Sets the path of the audio device, defaults to /dev/audio.
 
 
+wasapi
+------
+
+The `Windows Audio Session API <https://docs.microsoft.com/en-us/windows/win32/coreaudio/wasapi>`_ plugin uses WASAPI, which is supported started from Windows Vista. It is recommended if you are using Windows.
+
+.. list-table::
+   :widths: 20 80
+   :header-rows: 1
+
+   * - Setting
+     - Description
+   * - **device NAME**
+     - Sets the device which should be used. This can be any valid audio device name, or index number. The default value is "", which makes WASAPI choose the default output device.
+   * - **enumerate yes|no**
+     - Enumerate all devices in log while playing started. Useful for device configuration. The default value is "no".
+   * - **exclusive yes|no**
+     - Exclusive mode blocks all other audio source, and get best audio quality without resampling. Stopping playing release the exclusive control of the output device. The default value is "no".
+
+
 .. _filter_plugins:
 
 Filter plugins