+ Open
+
+ | The audio device that's virtual, like Steam Streaming Speakers. This allows Sunshine to stream audio, while muting the speakers. - @tip{See [audio_sink](#audio_sinkhttpslocalhost47990configaudio_sink)!} + @tip{See [audio_sink](#audio_sink)!} @tip{These are some options for virtual sound devices. * Stream Streaming Speakers (Linux, macOS, Windows) * Steam must be installed. - * Enable [install_steam_audio_drivers](#install_steam_audio_drivershttpslocalhost47990configinstall_steam_audio_drivers) + * Enable [install_steam_audio_drivers](#install_steam_audio_drivers) or use Steam Remote Play at least once to install the drivers. * [Virtual Audio Cable](https://vb-audio.com/Cable) (macOS, Windows) } @@ -767,7 +772,7 @@ editing the `conf` file in a text editor. Use the examples as reference. |
| Assign higher QP values to flat regions of the video. Recommended to enable when streaming at lower bitrates. - @note{This option only applies when using NVENC [encoder](#encoderhttpslocalhost47990configencoder).} + @note{This option only applies when using NVENC [encoder](#encoder).} @warning{Enabling this option may reduce performance.} |
| Adaptive P-State algorithm which NVIDIA drivers employ doesn't work well with low latency streaming, so Sunshine requests high power mode explicitly. - @note{This option only applies when using NVENC [encoder](#encoderhttpslocalhost47990configencoder).} + @note{This option only applies when using NVENC [encoder](#encoder).} @warning{Disabling this is not recommended since this can lead to significantly increased encoding latency.} @note{Applies to Windows only.} | @@ -1801,7 +1806,7 @@ editing the `conf` file in a text editor. Use the examples as reference.
| Description | The encoder preset to use. - @note{This option only applies when using quicksync [encoder](#encoderhttpslocalhost47990configencoder).} + @note{This option only applies when using quicksync [encoder](#encoder).} | |
| The entropy encoding to use. @note{This option only applies when using H.264 with the quicksync - [encoder](#encoderhttpslocalhost47990configencoder).} + [encoder](#encoder).} | |
| Description | This options enables use of HEVC on older Intel GPUs that only support low power encoding for H.264. - @note{This option only applies when using quicksync [encoder](#encoderhttpslocalhost47990configencoder).} + @note{This option only applies when using quicksync [encoder](#encoder).} @caution{Streaming performance may be significantly reduced when this option is enabled.} | |
| Description | The encoder usage profile is used to set the base set of encoding parameters. - @note{This option only applies when using amdvce [encoder](#encoderhttpslocalhost47990configencoder).} + @note{This option only applies when using amdvce [encoder](#encoder).} @note{The other AMF options that follow will override a subset of the settings applied by your usage profile, but there are hidden parameters set in usage profiles that cannot be overridden elsewhere.} | @@ -2022,14 +2027,14 @@ editing the `conf` file in a text editor. Use the examples as reference.|
| Description | The encoder rate control. - @note{This option only applies when using amdvce [encoder](#encoderhttpslocalhost47990configencoder).} + @note{This option only applies when using amdvce [encoder](#encoder).} @warning{The `vbr_latency` option generally works best, but some bitrate overshoots may still occur. Enabling HRD allows all bitrate based rate controls to better constrain peak bitrate, but may result in encoding artifacts depending on your card.} @@ -2066,14 +2071,14 @@ editing the `conf` file in a text editor. Use the examples as reference. | |
| Description | Enable Hypothetical Reference Decoder (HRD) enforcement to help constrain the target bitrate. - @note{This option only applies when using amdvce [encoder](#encoderhttpslocalhost47990configencoder).} + @note{This option only applies when using amdvce [encoder](#encoder).} @warning{HRD is known to cause encoding artifacts or negatively affect encoding quality on certain cards.} | |
| Description | The quality profile controls the tradeoff between speed and quality of encoding. - @note{This option only applies when using amdvce [encoder](#encoderhttpslocalhost47990configencoder).} + @note{This option only applies when using amdvce [encoder](#encoder).} | |
| Description | Preanalysis can increase encoding quality at the cost of latency. - @note{This option only applies when using amdvce [encoder](#encoderhttpslocalhost47990configencoder).} + @note{This option only applies when using amdvce [encoder](#encoder).} | |
| Variance Based Adaptive Quantization (VBAQ) can increase subjective visual quality by prioritizing allocation of more bits to smooth areas compared to more textured areas. - @note{This option only applies when using amdvce [encoder](#encoderhttpslocalhost47990configencoder).} + @note{This option only applies when using amdvce [encoder](#encoder).} | |
| The entropy encoding to use. @note{This option only applies when using H.264 with the amdvce - [encoder](#encoderhttpslocalhost47990configencoder).} + [encoder](#encoder).} | |
| Description |
The encoder preset to use.
- @note{This option only applies when using software [encoder](#encoderhttpslocalhost47990configencoder).}
+ @note{This option only applies when using software [encoder](#encoder).}
@note{From [FFmpeg](https://trac.ffmpeg.org/wiki/Encode/H.264#preset).
@@ -2393,14 +2398,14 @@ editing the `conf` file in a text editor. Use the examples as reference. | |
| Description |
The tuning preset to use.
- @note{This option only applies when using software [encoder](#encoderhttpslocalhost47990configencoder).}
+ @note{This option only applies when using software [encoder](#encoder).}
@note{From [FFmpeg](https://trac.ffmpeg.org/wiki/Encode/H.264#preset).
diff --git a/docs/doc-styles.css b/docs/doc-styles.css new file mode 100644 index 00000000000..e221b85ac08 --- /dev/null +++ b/docs/doc-styles.css @@ -0,0 +1,6 @@ +/* A fake button as doxygen doesn't allow button elements */ +.open-button { + background: #1779c4; + color: white; + cursor: pointer; +} | |