diff --git a/docs/configuration.md b/docs/configuration.md index 6024df7cdb6..20bc33fbefc 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -835,6 +835,10 @@ consent prompt for directory ACLs, so the Web UI shows setup steps for correctin } @attention{If you want to mute the host speakers, use [virtual_sink](#virtual_sink) instead.} + @tip{On FreeBSD/Linux, Sunshine also provides its own null sinks (for example + `sink-sunshine-stereo`). Enter one here to capture a private mix you route + yourself; combined with [keep_default_sink](#keep_default_sink), the host + default output is left untouched.}
| Description |
- Enables capture-only operation when an external audio router manages application playback.
- An explicit [audio_sink](#audio_sink) is required; use an endpoint ID when names are ambiguous.
- Sunshine captures that endpoint directly without changing or restoring Windows default devices
- or endpoint formats.
+ Capture the selected audio sink without changing the host default sink. When disabled, Sunshine sets
+ the selected (or virtual) sink as the host default sink while streaming on platforms that swap
+ defaults; macOS never changes the default output.
- In this mode, [virtual_sink](#virtual_sink), automatic Steam audio driver installation, - and Moonlight's host-playback toggle do not affect routing. Configure local playback and the audio - sent to the selected endpoint in your external mixer. If the endpoint is unavailable, audio capture - fails rather than falling back to another endpoint. Video streaming can continue without audio. - @note{This option is only supported on Windows. Other platforms retain their existing behavior.} + This replaces the Windows-only external_audio option. An existing
+ external_audio = enabled setting is migrated to keep_default_sink = enabled
+ on upgrade, unless keep_default_sink is also set. Unlike the old Windows mode, an
+ explicit [audio_sink](#audio_sink) is no longer required. Note that [virtual_sink](#virtual_sink)
+ and Moonlight's host-playback selection only apply on the swap path; in keep-default mode the
+ capture target is the configured audio_sink, or the host sink when none is configured.
+ @note{Platform behavior:+ Windows: captures the target endpoint directly and is hands-off, so an external + router such as VoiceMeeter or GoXLR keeps owning endpoint defaults and formats; it also skips the + Steam driver install, the startup default-device reset, and default reinstallation. When no + audio_sink is configured and Sunshine launched the application, Windows may instead
+ capture the launched process tree with WASAPI process loopback, so other applications stay out of
+ the stream; endpoint capture remains the fallback.+ Linux: captures the configured sink's monitor, or the host sink's monitor when + none is configured, and adopts pre-existing null sinks instead of unloading them. + FreeBSD: captures the configured sink's monitor, or the host sink's monitor when + none is configured, without changing the default sink. + macOS: honors the option natively through a system tap or the selected input, + without touching the default output.} |
|
| Example | @code{} - external_audio = enabled - audio_sink = My Streaming Mix + keep_default_sink = enabled @endcode | |