diff options
| -rw-r--r-- | DOCS/man/osc.rst | 102 |
1 files changed, 61 insertions, 41 deletions
diff --git a/DOCS/man/osc.rst b/DOCS/man/osc.rst index c5c75d6a72..48cc8e3fd6 100644 --- a/DOCS/man/osc.rst +++ b/DOCS/man/osc.rst @@ -148,18 +148,21 @@ Configurable Options ~~~~~~~~~~~~~~~~~~~~ ``layout`` - | Default: bottombar - | The layout for the OSC. Currently available are: box, slimbox, + Default: bottombar + + The layout for the OSC. Currently available are: box, slimbox, bottombar and topbar. Default pre-0.21.0 was 'box'. ``seekbarstyle`` - | Default: bar - | Sets the style of the seekbar, slider (diamond marker) or bar (fill). + Default: bar + + Sets the style of the seekbar, slider (diamond marker) or bar (fill). Default pre-0.21.0 was 'slider'. ``deadzonesize`` - | Default: 0.5 - | Size of the deadzone. The deadzone is an area that makes the mouse act + Default: 0.5 + + Size of the deadzone. The deadzone is an area that makes the mouse act like leaving the window. Movement there won't make the OSC show up and it will hide immediately if the mouse enters it. The deadzone starts at the window border opposite to the OSC and the size controls how much @@ -168,75 +171,92 @@ Configurable Options OSC will only show up when the mouse hovers it. Default pre-0.21.0 was 0. ``minmousemove`` - | Default: 0 - | Minimum amount of pixels the mouse has to move between ticks to make + Default: 0 + + Minimum amount of pixels the mouse has to move between ticks to make the OSC show up. Default pre-0.21.0 was 3. ``showwindowed`` - | Default: yes - | Enable the OSC when windowed + Default: yes + + Enable the OSC when windowed ``showfullscreen`` - | Default: yes - | Enable the OSC when fullscreen + Default: yes + + Enable the OSC when fullscreen ``scalewindowed`` - | Default: 1.5 - | Scale factor of the OSC when windowed + Default: 1.5 + + Scale factor of the OSC when windowed ``scalefullscreen`` - | Default: 1.5 - | Scale factor of the OSC when fullscreen + Default: 1.5 + + Scale factor of the OSC when fullscreen ``scaleforcedwindow`` - | Default: 2.0 - | Scale factor of the OSC when rendered on a forced (dummy) window + Default: 2.0 + + Scale factor of the OSC when rendered on a forced (dummy) window ``vidscale`` - | Default: yes - | Scale the OSC with the video - | ``no`` tries to keep the OSC size constant as much as the window size allows + Default: yes + + Scale the OSC with the video + ``no`` tries to keep the OSC size constant as much as the window size allows ``valign`` - | Default: 0.8 - | Vertical alignment, -1 (top) to 1 (bottom) + Default: 0.8 + + Vertical alignment, -1 (top) to 1 (bottom) ``halign`` - | Default: 0.0 - | Horizontal alignment, -1 (left) to 1 (right) + Default: 0.0 + + Horizontal alignment, -1 (left) to 1 (right) ``barmargin`` - | Default: 0 - | Margin from bottom (bottombar) or top (topbar), in pixels + Default: 0 + + Margin from bottom (bottombar) or top (topbar), in pixels ``boxalpha`` - | Default: 80 - | Alpha of the background box, 0 (opaque) to 255 (fully transparent) + Default: 80 + + Alpha of the background box, 0 (opaque) to 255 (fully transparent) ``hidetimeout`` - | Default: 500 - | Duration in ms until the OSC hides if no mouse movement, must not be + Default: 500 + + Duration in ms until the OSC hides if no mouse movement, must not be negative ``fadeduration`` - | Default: 200 - | Duration of fade out in ms, 0 = no fade + Default: 200 + + Duration of fade out in ms, 0 = no fade ``tooltipborder`` - | Default: 1 - | Size of the tooltip outline when using bottombar or topbar layouts + Default: 1 + + Size of the tooltip outline when using bottombar or topbar layouts ``timetotal`` - | Default: no - | Show total time instead of time remaining + Default: no + + Show total time instead of time remaining ``timems`` - | Default: no - | Display timecodes with milliseconds + Default: no + + Display timecodes with milliseconds ``visibility`` - | Default: auto (auto hide/show on mouse move) - | Also supports ``never`` and ``always`` + Default: auto (auto hide/show on mouse move) + + Also supports ``never`` and ``always`` Script Commands ~~~~~~~~~~~~~~~ |