Merge remote-tracking branch 'origin/master'

docs/Doxyfile

@@ -32,7 +32,7 @@ PROJECT_NAME = Sunshine
 # project specific settings
 DOT_GRAPH_MAX_NODES = 60
 IMAGE_PATH = ../docs/images
-INCLUDE_PATH = ../third-party/build-deps/ffmpeg/Linux-x86_64/include/
+INCLUDE_PATH = ../third-party/build-deps/dist/Linux-x86_64/include/
 PREDEFINED += SUNSHINE_BUILD_WAYLAND
 PREDEFINED += SUNSHINE_TRAY=1
 
@@ -52,6 +52,7 @@ INPUT = ../README.md \
         app_examples.md \
         guides.md \
         performance_tuning.md \
+        api.md \
         troubleshooting.md \
         building.md \
         contributing.md \

docs/api.md

@@ -0,0 +1,64 @@
+# API
+
+Sunshine has a RESTful API which can be used to interact with the service.
+
+Unless otherwise specified, authentication is required for all API calls. You can authenticate using
+basic authentication with the admin username and password.
+
+## GET /api/apps
+@copydoc confighttp::getApps()
+
+## GET /api/logs
+@copydoc confighttp::getLogs()
+
+## POST /api/apps
+@copydoc confighttp::saveApp()
+
+## DELETE /api/apps{index}
+@copydoc confighttp::deleteApp()
+
+## POST /api/covers/upload
+@copydoc confighttp::uploadCover()
+
+## GET /api/config
+@copydoc confighttp::getConfig()
+
+## GET /api/configLocale
+@copydoc confighttp::getLocale()
+
+## POST /api/config
+@copydoc confighttp::saveConfig()
+
+## POST /api/restart
+@copydoc confighttp::restart()
+
+## POST /api/password
+@copydoc confighttp::savePassword()
+
+## POST /api/pin
+@copydoc confighttp::savePin()
+
+## POST /api/clients/unpair-all
+@copydoc confighttp::unpairAll()
+
+## POST /api/clients/unpair
+@copydoc confighttp::unpair()
+
+## GET /api/clients/list
+@copydoc confighttp::listClients()
+
+## GET /api/apps/close
+@copydoc confighttp::closeApp()
+
+<div class="section_buttons">
+
+| Previous                                    |                                  Next |
+|:--------------------------------------------|--------------------------------------:|
+| [Performance Tuning](performance_tuning.md) | [Troubleshooting](troubleshooting.md) |
+
+</div>
+
+<details style="display: none;">
+  <summary></summary>
+  [TOC]
+</details>

docs/configuration.md

@@ -2303,6 +2303,33 @@ editing the `conf` file in a text editor. Use the examples as reference.
     </tr>
 </table>
 
+## VA-API Encoder
+
+### vaapi_strict_rc_buffer
+
+<table>
+    <tr>
+        <td>Description</td>
+        <td colspan="2">
+            Enabling this option can avoid dropped frames over the network during scene changes, but video quality may
+            be reduced during motion.
+            @note{This option only applies for H.264 and HEVC when using VA-API [encoder](#encoder) on AMD GPUs.}
+        </td>
+    </tr>
+    <tr>
+        <td>Default</td>
+        <td colspan="2">@code{}
+            disabled
+            @endcode</td>
+    </tr>
+    <tr>
+        <td>Example</td>
+        <td colspan="2">@code{}
+            vaapi_strict_rc_buffer = enabled
+            @endcode</td>
+    </tr>
+</table>
+
 ## Software Encoder
 
 ### sw_preset

docs/getting_started.md

@@ -20,7 +20,7 @@ No support will be provided for third party packages!}
 ### Docker
 @warning{The Docker images are not recommended for most users.}
 
-Docker images are available on [Dockerhub.io](https://hub.docker.com/repository/docker/lizardbyte/sunshin)
+Docker images are available on [Dockerhub.io](https://hub.docker.com/repository/docker/lizardbyte/sunshine)
 and [ghcr.io](https://github.com/orgs/LizardByte/packages?repo_name=sunshine).
 
 See [Docker](../DOCKER_README.md) for more information.
@@ -240,6 +240,8 @@ This package requires that you have [Homebrew](https://docs.brew.sh/Installation
 
 ##### Install
 ```bash
+brew update
+brew upgrade
 brew tap LizardByte/homebrew
 brew install sunshine
 ```

docs/performance_tuning.md

@@ -13,9 +13,9 @@ Enabling *Fast Sync* in Nvidia settings may help reduce latency.
 
 <div class="section_buttons">
 
-| Previous            |                                  Next |
-|:--------------------|--------------------------------------:|
-| [Guides](guides.md) | [Troubleshooting](troubleshooting.md) |
+| Previous            |          Next |
+|:--------------------|--------------:|
+| [Guides](guides.md) | [API](api.md) |
 
 </div>
 

docs/troubleshooting.md

@@ -165,14 +165,6 @@ high as long as the encoder is used.
 ### Gamescope compatibility
 Some users have reported stuttering issues when streaming games running within Gamescope.
 
-### Occasional flickering in KDE
-
-The `blur` plugin causes flickering during streaming for some people. Disable it from the
-KDE System Settings or from the commandline:
-```bash
-qdbus org.kde.KWin /Effects unloadEffect blur
-```
-
 ## macOS
 
 ### Dynamic session lookup failed
@@ -200,9 +192,9 @@ permissions on the disk.
 
 <div class="section_buttons">
 
-| Previous                                    |                    Next |
-|:--------------------------------------------|------------------------:|
-| [Performance Tuning](performance_tuning.md) | [Building](building.md) |
+| Previous      |                    Next |
+|:--------------|------------------------:|
+| [API](api.md) | [Building](building.md) |
 
 </div>