Remote Desktop & Audio

The session.remoteDesktop node tailors the full-desktop experience — taskbar, icons, notifications, shell, wallpaper and shutdown control — and the session.audio node governs audio capture and how it is scoped.

Editor Advanced → Session JSON · JSON session.remoteDesktop, session.audio

session.remoteDesktop

Applies only when the workspace type is Remote Desktop.

Property	Type	Default	Notes
`showTaskbar`	boolean	true	Show the Windows taskbar.
`showDesktopIcons`	boolean	true	Show desktop icons.
`enableNotifications`	boolean	true	Allow Windows notifications.
`enableAudio`	boolean	true	Legacy audio toggle — superseded by `session.audio` (below).
`startupShell`	string	"explorer.exe"	Shell executable launched on session start.
`wallpaper`	string	—	Optional custom wallpaper path.
`allowUserDisconnect`	boolean	true	Allow the user to disconnect / log off.
`blockSystemShutdown`	boolean	true	Block shutdown/restart commands (log off only).

session.audio

Property	Type	Default	Values	Notes
`enabled`	boolean	true	—	Enable audio streaming. Cannot exceed the app.config ceiling (see below).
`captureMode`	enum	auto	`auto`, `perApp`, `perSession`, `hostLoopback`	How audio is scoped (see modes below).

captureMode	Behaviour
`auto`	Pick the best for the OS: `perSession` on Server 2022+/Win11, `hostLoopback` elsewhere.
`perApp`	Capture only the launched app's process tree (Process Loopback).
`perSession`	Capture the streamer's process tree (all WebStream-launched apps).
`hostLoopback`	Classic default-render-endpoint capture (needs a virtual cable or real audio device on the host).

perApp and perSession require Windows 10 build 20348+ (Server 2022 / Win11); older OSes silently fall back to hostLoopback. When both session.audio.enabled and the legacy session.remoteDesktop.enableAudio are set, session.audio wins.

Sample

"remoteDesktop": {
  "showTaskbar": true,
  "showDesktopIcons": true,
  "enableNotifications": true,
  "enableAudio": false,
  "startupShell": "explorer.exe",
  "allowUserDisconnect": true,
  "blockSystemShutdown": true
},
"audio": {
  "enabled": true,
  "captureMode": "auto"
}

app.config.xml override

The remoteDesktop toggles each have a default in app.config.xml <remoteDesktopSettings> and policy wins. Audio is the exception: <remoteDesktopSettings><enableAudio> is a ceiling — a policy may disable audio, but if the app.config value is false (for example, no audio device on the host), the policy cannot enable it. captureMode takes its default from <audioCaptureMode>; policy wins when a valid value is supplied.