Skip to content

Commit 559193f

Browse files
committed
README: update.
1 parent fc678e7 commit 559193f

File tree

1 file changed

+21
-15
lines changed

1 file changed

+21
-15
lines changed

README.md

+21-15
Original file line numberDiff line numberDiff line change
@@ -24,24 +24,30 @@ You can also run the executable from the command-line, specifying a midi file an
2424

2525
### General options
2626

27-
--midi path to a MIDI file to load
28-
--config path to a configuration INI file
29-
--size dimensions of the window (--size W H)
30-
--fullscreen start in fullscreen (1 or 0 to enabled/disable)
31-
--gui-size GUI text and button scaling (number, default 1.0)
32-
--version display the current version and build information
33-
--help display a detailed help of all options
34-
27+
--midi path to a MIDI file to load
28+
--device name of a MIDI device to start a live session to (or VIRTUAL to act as a virtual device)
29+
--config path to a configuration INI file
30+
--size dimensions of the window (--size W H)
31+
--position position of the window (--position X Y)
32+
--fullscreen start in fullscreen (1 or 0 to enable/disable)
33+
--gui-size GUI text and button scaling (number, default 1.0)
34+
--transparency enable transparent window background if supported (1 or 0 to enable/disable)
35+
--forbid-transparency prevent transparent window background(1 or 0 to enable/disable)
36+
--help display a detailed help of all options
37+
--version display the current version and build information
38+
3539
### Export options
3640
If you want to directly export a video/images, `--export ...` is mandatory. You can completely hide the application window using `--hide-window`.
3741

38-
--export path to the output video (or directory for PNG)
39-
--format output format (values: PNG, MPEG2, MPEG4)
40-
--framerate number of frames per second to export (integer)
41-
--bitrate target video bitrate in Mb (integer)
42-
--png-alpha use transparent PNG background (1 or 0 to enabled/disable)
43-
--hide-window do not display the window (1 or 0 to enabled/disable)
44-
42+
--export path to the output video (or directory for PNG)
43+
--format output format (values: PNG, MPEG2, MPEG4, PRORES)
44+
--framerate number of frames per second to export (integer)
45+
--bitrate target video bitrate in Mb (integer)
46+
--postroll Postroll time after the track, in seconds (number, default 10.0)
47+
--out-alpha use transparent output background, only for PNG and PRORES (1 or 0 to enable/disable)
48+
--fix-premultiply cancel alpha premultiplication, only when out-alpha is enabled (1 or 0 to enable/disable)
49+
--hide-window do not display the window (1 or 0 to enable/disable)
50+
4551
### Configuration options
4652
If display options are given, they will override those specified in the configuration file. Almost every option available in the GUI can be specified on the command line, refer to the detailed help for a complete list (`./MIDIVisualizer --help`). Options include:
4753

0 commit comments

Comments
 (0)