jyapayne/Sunshine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update macOS documentation

Browse source
This commit is contained in:
ReenigneArcher 2022-06-28 19:16:24 -04:00
commit 3cd3d261e9
9 changed files with 51 additions and 30 deletions
Download patch file Download diff file Expand all files Collapse all files

22
docs/source/about/advanced_usage.rst
View file

@ -22,7 +22,7 @@ location by modifying the configuration file.
======= ===========
Docker /config/
Linux /usr/local/sunshine/config/
MacOS /usr/local/sunshine/config/
macOS /usr/local/sunshine/config/
Windows ./config/
======= ===========
@ -225,7 +225,7 @@ Description
To be supported by Sunshine, it needs to have at the very minimum:
``VAProfileH264High : VAEntrypointEncSlice``
.. Todo:: MacOS
.. Todo:: macOS
Windows
.. code-block:: batch
@ -241,7 +241,7 @@ Examples
adapter_name = /dev/dri/renderD128
.. Todo:: MacOS
.. Todo:: macOS
Windows
.. code-block:: text
@ -265,7 +265,7 @@ Description
You need to use the value before the colon in the output, e.g. ``0``.
.. Todo:: MacOS
.. Todo:: macOS
Windows
.. code-block:: batch
@ -281,7 +281,7 @@ Examples
output_name = 0
.. Todo:: MacOS
.. Todo:: macOS
Windows
.. code-block:: text
@ -376,8 +376,8 @@ Description
# in some causes you'd need to use the `Sink` device, if `Source` doesn't work, so try:
pactl info | grep Sink
MacOS
Sunshine can only access microphones on MacOS due to system limitations. To stream system audio use
macOS
Sunshine can only access microphones on macOS due to system limitations. To stream system audio use
`Soundflower <https://github.com/mattingalls/Soundflower>`_ or
`BlackHole <https://github.com/ExistentialAudio/BlackHole>`_.
@ -395,7 +395,7 @@ Examples
audio_sink = alsa_output.pci-0000_09_00.3.analog-stereo
MacOS
macOS
.. code-block:: text
audio_sink = BlackHole 2ch
@ -993,7 +993,7 @@ vt_software
Description
Force Video Toolbox to use software encoding.
.. Note:: This option only applies when using MacOS.
.. Note:: This option only applies when using macOS.
**Choices**
@ -1023,7 +1023,7 @@ vt_realtime
Description
Realtime encoding.
.. Note:: This option only applies when using MacOS.
.. Note:: This option only applies when using macOS.
.. Warning:: Disabling realtime encoding might result in a delayed frame encoding or frame drop.
@ -1041,7 +1041,7 @@ vt_coder
Description
The entropy encoding to use.
.. Note:: This option only applies when using MacOS.
.. Note:: This option only applies when using macOS.
**Choices**