From 9d3c8c0e6e1a7ba43bf3dc19350d1dca68b657a3 Mon Sep 17 00:00:00 2001
From: Chris Xiong <chirs241097@gmail.com>
Date: Sun, 10 Feb 2019 11:16:07 +0800
Subject: Initial commit.

---
 QMidiPlayer/doc/optionsdialog.html | 89 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 89 insertions(+)
 create mode 100644 QMidiPlayer/doc/optionsdialog.html

(limited to 'QMidiPlayer/doc/optionsdialog.html')

diff --git a/QMidiPlayer/doc/optionsdialog.html b/QMidiPlayer/doc/optionsdialog.html
new file mode 100644
index 0000000..d90cf45
--- /dev/null
+++ b/QMidiPlayer/doc/optionsdialog.html
@@ -0,0 +1,89 @@
+<!DOCTYPE html>
+<html>
+<head>
+<title>QMidiPlayer Help</title>
+<link rel=stylesheet href='styles.css' type='text/css'>
+</head>
+<body>
+	<div id="panel">
+		<ul>
+			<li><a href="index.html">Overview</a></li>
+			<li><a href="mainwindow.html">Main Window</a></li>
+			<li><a href="channeldialog.html">Channels Dialog</a></li>
+			<li><a href="channeleditor.html">Channel Editor</a></li>
+			<li><a href="plistdialog.html">Playlist</a></li>
+			<li><a href="efxdialog.html">Effects</a></li>
+			<li><a class="active" href="optionsdialog.html">Settings</a></li>
+			<li><a href="visualization.html">Visualization</a></li>
+			<li><a href="cmdargs.html">Commandline arguments</a></li>
+			<li><a href="troubleshooting.html">Troubleshooting</a></li>
+			<li><a href="miscellaneous.html">Miscellaneous</a></li>
+			<li><a href="version.html">Version Info.</a></li>
+			<li><a href="license.html">License</a></li>
+		</ul>
+	</div>
+	<div id="content">
+	<h1>Settings Dialog</h1>
+	Settings are stored in $HOME/.config/qmprc<br>
+	For Windows users, $HOME refers to X:\Users\&lt;your user name&gt;\.config, where X is the system drive of your
+	Windows installation.<br>
+	Options with one asterisk will be applied after restarting QMidiPlayer.<br>
+	Options with two asterisks will be applied after the internal fluidsynth is restarted.<br>
+	Other options are applied immediately.<br>
+	<img src="../img/options1.png"><br>
+	<ul>
+		<li>Default Output Device*: specify the default midi device to use.</li>
+		<li>Disable Midi Mapping*: only use the default output device.</li>
+		<li>Send SysEx: whether to send system exclusive messages or not.</li>
+		<li>Wait for remaining voices before stopping:<br>
+		If checked, the player will not stop until the current polyphone reaches 0.<br>
+		Otherwise it will stop immediately after the last event is sent.
+		</li>
+		<li>Text encoding: text encoding used in the midi file.</li>
+	</ul>
+	<img src="../img/options2.png"><br>
+	<ul>
+		<li>Audio Driver**: specify the audio backend used by the internal synthesizer.</li>
+		<li>Audio Buffer Size**: Size per buffer used by the fluidsynth engine. Increase if experiencing audio interruption, decrease if audio is laggy or messed up.</li>
+		<li>Audio Buffer Count**: Number of buffers used by the fluidsynth engine. Increase if experiencing audio interruption or messy audio, decrease if audio is laggy.</li>
+		<li>Audio Format**: audio output format of the fluidsynth engine.</li>
+		<li>Audio Frequency**: audio output sampling frequency of the fluidsynth engine.</li>
+		<li>Max Polyphony**: maximum simultaniously played voices of synthesizer. High polyphony limit may cause lags. </li>
+		<li>CPU Cores**: threads used by the internal synthesizer. Too many threads may result in instability.</li>
+		<li>Auto bank select mode:<br>
+		If checked, the player will choose the appropriate bank selecting mode
+		according to the file standard. If the file doesn't specify the standard
+		the player will fallback to the default bank select mode.
+		Otherwise the player will only use the default bank select mode.
+		</li>
+		<li>(Fallback) Bank Select Mode: the default bank select mode.</li>
+	</ul>
+	<img src="../img/options3.png"><br>
+	You can manage soundfont used by the internal fluidsynth engine here.<br>
+	If multiple soundfonts provide instruments with the same bank numbers and preset numbers,
+	the preset provided by the top most soundfont will be used.<br>
+	<img src="../img/options4.png"><br>
+	<ul>
+		<li>Restore last playlist on startup*: If checked and QMidiPlayer is started without files
+		to open, the playlist from the last session will be used instead of an empty playlist.</li>
+		<li>Load files in the same folder*: If checked, QMidiPlayer will add all midi files in the
+		same folder to the playlist when started with a file.</li>
+		<li>Save dialog status*: Save dialog positions and restore on start up.</li>
+		<li>Save parameters in effects window</li>
+		<li>Persistent fluidsynth instance: Deprecated. Removing before 0.9.</li>
+		<li>Icon Theme: Leave it unchanged unless you can't see the icons on those buttons.</li>
+		<li>Customize toolbar: customize the functionalities shown in the main window.</li>
+		<li>Customize actions: customize the functionalities shown in the file action menu.</li>
+	</ul>
+	<img src="../img/options5.png"><br>
+	Plugin manager. View details of plugins, enable or disable them here.<br>
+	Enabled plugin list is applied after a restart.<br>
+	Plugin scanning follows the order below:
+	<ul>
+		<li>(*nix) /usr/lib/qmidiplayer</li>
+		<li>The folder containing QMidiPlayer's executable file.</li>
+	</ul>
+	<br><a href="index.html">Return</a>
+	</div>
+</body>
+</html> 
-- 
cgit v1.2.3