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

docs: update config defaults (#1070)

Browse source
This commit is contained in:
ReenigneArcher 2023-03-24 19:00:27 -04:00 • committed by GitHub
commit a0d7250c33
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 28 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -160,7 +160,7 @@ key_repeat_delay
^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^
**Description** **Description**
The initial delay in milliseconds before repeating keys. Controls how fast keys will repeat themselves. The initial delay, in milliseconds, before repeating keys. Controls how fast keys will repeat themselves.
**Default** **Default**
``500`` ``500``
@ -179,7 +179,7 @@ key_repeat_frequency
.. Tip:: This configurable option supports decimals. .. Tip:: This configurable option supports decimals.
**Default** **Default**
.. Todo:: Unknown ``24.9``
**Example** **Example**
.. code-block:: text .. code-block:: text
@ -197,7 +197,11 @@ keybindings
.. Hint:: keybindings needs to have a multiple of two elements. .. Hint:: keybindings needs to have a multiple of two elements.
**Default** **Default**
None .. code-block:: text
0x10, 0xA0,
0x11, 0xA2,
0x12, 0xA4
**Example** **Example**
.. code-block:: text .. code-block:: text
@ -217,7 +221,7 @@ key_rightalt_to_key_win
make Sunshine think the Right Alt key is the Windows key. make Sunshine think the Right Alt key is the Windows key.
**Default** **Default**
None ``disabled``
**Example** **Example**
.. code-block:: text .. code-block:: text
@ -322,7 +326,7 @@ fps
fps is supported. fps is supported.
**Default** **Default**
.. Todo:: Unknown ``[10, 30, 60, 90, 120]``
**Example** **Example**
.. code-block:: text .. code-block:: text
@ -339,7 +343,20 @@ resolutions
resolution is supported. resolution is supported.
**Default** **Default**
.. Todo:: Unknown .. code-block:: text
[
352x240,
480x360,
858x480,
1280x720,
1920x1080,
2560x1080,
3440x1440,
1920x1200,
3860x2160,
3840x1600,
]
**Example** **Example**
.. code-block:: text .. code-block:: text
@ -493,7 +510,7 @@ port
Mic (unused) 48002 UDP +13 Mic (unused) 48002 UDP +13
================ ============ =========================== ================ ============ ===========================
.. Attention:: Custom ports are only allowed on select Moonlight clients. .. Attention:: Custom ports may not be supported by all Moonlight clients.
**Default** **Default**
``47989`` ``47989``
@ -510,7 +527,7 @@ pkey
The private key. This must be 2048 bits. The private key. This must be 2048 bits.
**Default** **Default**
.. Todo:: Unknown ``credentials/cakey.pem``
**Example** **Example**
.. code-block:: text .. code-block:: text
@ -524,7 +541,7 @@ cert
The certificate. Must be signed with a 2048 bit key. The certificate. Must be signed with a 2048 bit key.
**Default** **Default**
.. Todo:: Unknown ``credentials/cacert.pem``
**Example** **Example**
.. code-block:: text .. code-block:: text
@ -604,7 +621,7 @@ upnp
===== =========== ===== ===========
**Default** **Default**
``off`` ``disabled``
**Example** **Example**
.. code-block:: text .. code-block:: text
@ -615,7 +632,7 @@ ping_timeout
^^^^^^^^^^^^ ^^^^^^^^^^^^
**Description** **Description**
How long to wait in milliseconds for data from Moonlight before shutting down the stream. How long to wait, in milliseconds, for data from Moonlight before shutting down the stream.
**Default** **Default**
``10000`` ``10000``