docs: add system outputs docs

libretime · Dec 29, 2023 · 13e4653 · 13e4653
1 parent e8e5583
commit 13e4653
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 1 deletion.
diff --git a/docker/config.template.yml b/docker/config.template.yml
@@ -326,3 +326,7 @@ stream:
         # > must be one of (alsa, ao, oss, portaudio, pulseaudio)
         # > default is pulseaudio
         kind: pulseaudio
+
+        # System output device.
+        # > only available for kind=pulseaudio or kind=alsa
+        device:
diff --git a/docker/config.yml b/docker/config.yml
@@ -326,3 +326,7 @@ stream:
         # > must be one of (alsa, ao, oss, portaudio, pulseaudio)
         # > default is pulseaudio
         kind: pulseaudio
+
+        # System output device.
+        # > only available for kind=pulseaudio or kind=alsa
+        device:
diff --git a/docker/example/config.yml b/docker/example/config.yml
@@ -326,3 +326,7 @@ stream:
         # > must be one of (alsa, ao, oss, portaudio, pulseaudio)
         # > default is pulseaudio
         kind: pulseaudio
+
+        # System output device.
+        # > only available for kind=pulseaudio or kind=alsa
+        device:
diff --git a/docs/admin-manual/configuration.md b/docs/admin-manual/configuration.md
@@ -526,11 +526,15 @@ stream:
     system:
       - # Whether the output is enabled.
         # > default is false
-        enabled: false
+        enabled: true
         # System output kind.
         # > must be one of (alsa, ao, oss, portaudio, pulseaudio)
         # > default is pulseaudio
         kind: "pulseaudio"
+
+        # System output device.
+        # > only available for kind=pulseaudio or kind=alsa
+        device: "alsa_output.pci-0000_00_1f.3-platform-skl_hda_dsp_generic.HiFi__hw_sofhdadsp__sink"
 ```
 
 ## LDAP

diff --git a/installer/config.yml b/installer/config.yml
@@ -326,3 +326,7 @@ stream:
         # > must be one of (alsa, ao, oss, portaudio, pulseaudio)
         # > default is pulseaudio
         kind: pulseaudio
+
+        # System output device.
+        # > only available for kind=pulseaudio or kind=alsa
+        device: