diff options
Diffstat (limited to 'DOCS/man/osc.rst')
| -rw-r--r-- | DOCS/man/osc.rst | 140 |
1 files changed, 83 insertions, 57 deletions
diff --git a/DOCS/man/osc.rst b/DOCS/man/osc.rst index 20f7fbf7e6..ecb4d99244 100644 --- a/DOCS/man/osc.rst +++ b/DOCS/man/osc.rst @@ -147,95 +147,117 @@ Example:: Configurable Options ~~~~~~~~~~~~~~~~~~~~ +``layout`` + 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), knob (circle + marker with guide), 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 + 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 + of the window it will span. Values between 0.0 and 1.0, where 0 means the + OSC will always popup with mouse movement in the window, and 1 means the + 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 + 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.0 + + Scale factor of the OSC when windowed. ``scalefullscreen`` - | Default: 1.5 - | Scale factor of the OSC when fullscreen + Default: 1.0 + + 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 -``hidetimeout`` - | Default: 500 - | Duration in ms until the OSC hides if no mouse movement, must not be - negative + Alpha of the background box, 0 (opaque) to 255 (fully transparent) -``fadeduration`` - | Default: 200 - | Duration of fade out in ms, 0 = no fade - -``deadzonesize`` - | Default: 1 - | 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 - of the window it will span. Values between 0 and 1, where 0 means the - OSC will always popup with mouse movement in the window, and 1 means the - OSC will only show up when the mouse hovers it. +``hidetimeout`` + Default: 500 -``minmousemove`` - | Default: 0 - | Minimum amount of pixels the mouse has to move between ticks to make - the OSC show up + Duration in ms until the OSC hides if no mouse movement, must not be + negative -``layout`` - | Default: bottombar - | The layout for the OSC. Currently available are: box, slimbox, - bottombar and topbar. +``fadeduration`` + Default: 200 -``seekbarstyle`` - | Default: bar - | Sets the style of the seekbar, slider (diamond marker) or bar (fill) + 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 ~~~~~~~~~~~~~~~ @@ -259,3 +281,7 @@ to set auto mode (the default) with ``b``:: a script-message osc-visibility never b script-message osc-visibility auto +``osc-playlist``, ``osc-chapterlist``, ``osc-tracklist`` + Shows a limited view of the respective type of list using the OSC. First + argument is duration in seconds. + |