izackp/Apollo
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update config.html

Browse Source 
- Fix some typos
- Reformat some tags
This commit is contained in:
ReenigneArcher
2022-02-09 19:44:05 -05:00
parent 067214a9f9
commit 91465ed257
1 changed files with 40 additions and 69 deletions
Download Patch File Download Diff File Expand all files Collapse all files

109
assets/web/config.html
View File

@@ -26,8 +26,7 @@
v-model="config.sunshine_name" v-model="config.sunshine_name"
/> />
<div class="form-text"> <div class="form-text">
The name displayed by Moonlight. If not specified, the PC's hostname The name displayed by Moonlight. If not specified, the PC's hostname is used
is used
</div> </div>
</div> </div>
<!--Log Level--> <!--Log Level-->
@@ -65,8 +64,7 @@
<option value="wan">Anyone may access Web UI</option> <option value="wan">Anyone may access Web UI</option>
</select> </select>
<div class="form-text"> <div class="form-text">
The origin of the remote endpoint address that is not denied access to The origin of the remote endpoint address that is not denied access to Web UI
Web UI
</div> </div>
</div> </div>
<!--UPnP--> <!--UPnP-->
@@ -98,8 +96,7 @@
v-model="config.ping_timeout" v-model="config.ping_timeout"
/> />
<div class="form-text"> <div class="form-text">
How long to wait in milliseconds for data from moonlight before How long to wait in milliseconds for data from moonlight before shutting down the stream
shutting down the stream
</div> </div>
</div> </div>
<!--Advertised FPS and Resolutions--> <!--Advertised FPS and Resolutions-->
@@ -184,9 +181,8 @@
</div> </div>
<div class="form-text"> <div class="form-text">
The display modes advertised by Sunshine<br /> The display modes advertised by Sunshine<br />
Some versions of Moonlight, such as Moonlight-nx (Switch), rely on Some versions of Moonlight, such as Moonlight-nx (Switch), rely on this list to ensure that the requested
this list to ensure that the requested resolutions and fps are resolutions and fps are supported.<br>
supported.<br>
This setting does <b>not</b> change how the screen stream is sent to Moonlight This setting does <b>not</b> change how the screen stream is sent to Moonlight
</div> </div>
</div> </div>
@@ -205,10 +201,8 @@
</select> </select>
</div> </div>
<div class="form-text"> <div class="form-text">
It may be possible that you cannot send the Windows Key from Moonlight It may be possible that you cannot send the Windows Key from Moonlight directly.<br />
directly.<br /> In those cases it may be useful to make Sunshine think the Right Alt key is the Windows key
In those cases it may be usefull to make Sunshine think the Right Alt
key is the Windows key
</div> </div>
</div> </div>
<!--Files Tab--> <!--Files Tab-->
@@ -284,12 +278,9 @@
/> />
<div class="form-text"> <div class="form-text">
The back/select button on the controller.<br /> The back/select button on the controller.<br />
On the Shield, the home and powerbutton are not passed to On the Shield, the home and power button are not passed to Moonlight.<br />
Moonlight.<br /> If, after the timeout, the back button is still pressed down, Home/Guide button press is emulated.<br />
If, after the timeout, the back button is still pressed down, If back_button_timeout &lt; 0, then the Home/Guide button will not be emulated<br />
Home/Guide button press is emulated.<br />
If back_button_timeout &lt; 0, then the Home/Guide button will not be
emulated<br />
</div> </div>
</div> </div>
<!-- Key Repeat Delay--> <!-- Key Repeat Delay-->
@@ -341,8 +332,7 @@
/> />
<div class="form-text"> <div class="form-text">
The name of the audio sink used for Audio Loopback<br /> The name of the audio sink used for Audio Loopback<br />
You can find the name of the audio sink using the following You can find the name of the audio sink using the following command:<br />
command:<br />
<pre>tools\audio-info.exe</pre> <pre>tools\audio-info.exe</pre>
</div> </div>
</div> </div>
@@ -357,8 +347,7 @@
/> />
<div class="form-text"> <div class="form-text">
The name of the audio sink used for Audio Loopback<br /> The name of the audio sink used for Audio Loopback<br />
If you do not specify this variable, pulseaudio will select the If you do not specify this variable, pulseaudio will select the default monitor device.<br />
default monitor device.<br />
<br /> <br />
You can find the name of the audio sink using either command:<br /> You can find the name of the audio sink using either command:<br />
<pre>pacmd list-sinks | grep "name:"</pre> <pre>pacmd list-sinks | grep "name:"</pre>
@@ -377,9 +366,8 @@
v-model="config.virtual_sink" v-model="config.virtual_sink"
/> />
<div class="form-text"> <div class="form-text">
The virtual sink, is the audio device that's virtual (Like Steam The virtual sink, is the audio device that's virtual (Like Steam Streaming Speakers), it allows Sunshine to
Streaming Speakers), it allows Sunshine to stream audio, while muting stream audio, while muting the speakers.
the speakers.
</div> </div>
</div> </div>
<!--Adapter Name --> <!--Adapter Name -->
@@ -411,7 +399,8 @@
<div class="form-text"> <div class="form-text">
You can select the video card you want to stream:<br /> You can select the video card you want to stream:<br />
The appropriate values can be found using the following command:<br /> The appropriate values can be found using the following command:<br />
tools\dxgi-info.exe<br /><br /> tools\dxgi-info.exe<br />
<br />
</div> </div>
</div> </div>
<div class="mb-3" class="config-page" v-if="platform === 'linux'"> <div class="mb-3" class="config-page" v-if="platform === 'linux'">
@@ -431,7 +420,7 @@
</div> </div>
</div> </div>
<div v-if="currentTab === 'advanced'" class="config-page"> <div v-if="currentTab === 'advanced'" class="config-page">
<!--Port familly--> <!--Port family-->
<div class="mb-3"> <div class="mb-3">
<label for="port" class="form-label">Port</label> <label for="port" class="form-label">Port</label>
<input <input
@@ -443,7 +432,7 @@
placeholder="47989" placeholder="47989"
v-model="config.port" v-model="config.port"
/> />
<div class="form-text">Set the familly of ports used by Sunshine</div> <div class="form-text">Set the family of ports used by Sunshine</div>
</div> </div>
<!-- Quantization Parameter --> <!-- Quantization Parameter -->
<div class="mb-3"> <div class="mb-3">
@@ -477,15 +466,12 @@
/> />
<div class="form-text"> <div class="form-text">
Minimum number of threads used by ffmpeg to encode the video.<br /> Minimum number of threads used by ffmpeg to encode the video.<br />
Increasing the value slightly reduces encoding efficiency, but the Increasing the value slightly reduces encoding efficiency, but the tradeoff is usually<br />
tradeoff is usually<br /> worth it to gain the use of more CPU cores for encoding. The ideal value is the lowest<br />
worth it to gain the use of more CPU cores for encoding. The ideal value that can reliably encode at your desired streaming settings on your hardware.
value is the lowest<br />
value that can reliably encode at your desired streaming settings on
your hardware.
</div> </div>
</div> </div>
<!--HEVC Suppport --> <!--HEVC Support -->
<div class="mb-3"> <div class="mb-3">
<label for="hevc_mode" class="form-label">HEVC Support</label> <label for="hevc_mode" class="form-label">HEVC Support</label>
<select id="hevc_mode" class="form-select" v-model="config.hevc_mode"> <select id="hevc_mode" class="form-select" v-model="config.hevc_mode">
@@ -499,15 +485,12 @@
Sunshine will advertise support for HEVC Main profile Sunshine will advertise support for HEVC Main profile
</option> </option>
<option value="3"> <option value="3">
Sunshine will advertise support for HEVC Main and Main10 (HDR) Sunshine will advertise support for HEVC Main and Main10 (HDR) profiles
profiles
</option> </option>
</select> </select>
<div class="form-text"> <div class="form-text">
Allows the client to request HEVC Main or HEVC Main10 video Allows the client to request HEVC Main or HEVC Main10 video streams.<br />
streams.<br /> HEVC is more CPU-intensive to encode, so enabling this may reduce performance when using software encoding.
HEVC is more CPU-intensive to encode, so enabling this may reduce
performance when using software encoding.
</div> </div>
</div> </div>
<!--Encoder --> <!--Encoder -->
@@ -521,8 +504,7 @@
<option value="software">Software</option> <option value="software">Software</option>
</select> </select>
<div class="form-text"> <div class="form-text">
Force a specific encoder, otherwise Sunshine will use the first Force a specific encoder, otherwise Sunshine will use the first encoder that is available
encoder that is available
</div> </div>
</div> </div>
<!--FEC Percentage--> <!--FEC Percentage-->
@@ -536,10 +518,8 @@
v-model="config.fec_percentage" v-model="config.fec_percentage"
/> />
<div class="form-text"> <div class="form-text">
Percentage of error correcting packets per data packet in each video Percentage of error correcting packets per data packet in each video frame.<br />
frame.<br /> Higher values can correct for more network packet loss, but at the cost of increasing bandwidth usage.<br />
Higher values can correct for more network packet loss, but at the
cost of increasing bandwidth usage.<br />
The default value of 20 is what GeForce Experience uses. The default value of 20 is what GeForce Experience uses.
</div> </div>
</div> </div>
@@ -554,17 +534,16 @@
v-model="config.channels" v-model="config.channels"
/> />
<div class="form-text"> <div class="form-text">
When multicasting, it could be useful to have different configurations When multicasting, it could be useful to have different configurations for each connected Client. For example:
for each connected Client. For example:
<ul> <ul>
<li> <li>
Clients connected through WAN and LAN have different bitrate Clients connected through WAN and LAN have different bitrate constraints.
contstraints. </li>
<li>
Decoders may require different settings for color
</li> </li>
<li>Decoders may require different settings for color</li>
</ul> </ul>
Unlike simply broadcasting to multiple Client, this will generate Unlike simply broadcasting to multiple Client, this will generate distinct video streams.<br />
distinct video streams.<br />
Note, CPU usage increases for each distinct video stream generated Note, CPU usage increases for each distinct video stream generated
</div> </div>
</div> </div>
@@ -581,7 +560,7 @@
v-model="config.credentials_file" v-model="config.credentials_file"
/> />
<div class="form-text"> <div class="form-text">
Store Username/Password seperately from Sunshine's state file. Store Username/Password separately from Sunshine's state file.
</div> </div>
</div> </div>
<!--Origin PIN Allowed--> <!--Origin PIN Allowed-->
@@ -599,8 +578,7 @@
<option value="wan">Anyone may access /pin</option> <option value="wan">Anyone may access /pin</option>
</select> </select>
<div class="form-text"> <div class="form-text">
The origin of the remote endpoint address that is not denied for HTTP The origin of the remote endpoint address that is not denied for HTTP method /pin
method /pin
</div> </div>
</div> </div>
<!--External IP--> <!--External IP-->
@@ -614,8 +592,7 @@
v-model="config.external_ip" v-model="config.external_ip"
/> />
<div class="form-text"> <div class="form-text">
If no external IP address is given, Sunshine will automatically detect If no external IP address is given, Sunshine will automatically detect external IP
external IP
</div> </div>
</div> </div>
</div> </div>
@@ -680,9 +657,7 @@
<option value="vbr">vbr -- variable bitrate</option> <option value="vbr">vbr -- variable bitrate</option>
<option value="cbr">cbr -- constant bitrate</option> <option value="cbr">cbr -- constant bitrate</option>
<option value="cbr_hq">cbr_hq -- cbr high quality</option> <option value="cbr_hq">cbr_hq -- cbr high quality</option>
<option value="cbr_ld_hq"> <option value="cbr_ld_hq">cbr_ld_hq -- cbr low delay high quality</option>
cbr_ld_hq -- cbr low delay high quality
</option>
<option value="vbr_hq">vbr_hq -- vbr high quality</option> <option value="vbr_hq">vbr_hq -- vbr high quality</option>
</select> </select>
</div> </div>
@@ -715,12 +690,8 @@
<select id="amd_rc" class="form-select" v-model="config.amd_rc"> <select id="amd_rc" class="form-select" v-model="config.amd_rc">
<option value="auto">auto -- let ffmpeg decide rate control</option> <option value="auto">auto -- let ffmpeg decide rate control</option>
<option value="constqp">constqp -- constant QP mode</option> <option value="constqp">constqp -- constant QP mode</option>
<option value="vbr_latency"> <option value="vbr_latency">vbr_latency -- Latency Constrained Variable Bitrate</option>
vbr_latency -- Latency Constrained Variable Bitrate <option value="vbr_peak">vbr_peak -- Peak Contrained Variable Bitrate</option>
</option>
<option value="vbr_peak">
vbr_peak -- Peak Contrained Variable Bitrate
</option>
<option value="cbr">cbr -- constant bitrate</option> <option value="cbr">cbr -- constant bitrate</option>
</select> </select>
</div> </div>