~ubuntu-branches/ubuntu/wily/mpv/wily

« back to all changes in this revision

Viewing changes to DOCS/man/en/osc.rst

  • Committer: Package Import Robot
  • Author(s): Alessandro Ghedini
  • Date: 2013-10-16 12:38:59 UTC
  • mfrom: (1.1.4)
  • Revision ID: package-import@ubuntu.com-20131016123859-wj70wr6n3mzimx3e
Tags: 0.2.0-1
* New upstream release
* Install sample configuration files as examples
* Enable Lua scripting support
* Remove copyright for talloc (not used anymore)
* Update installed docs list
* Update 01_spelling.patch
* Enable VAAPI support

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
ON SCREEN CONTROLLER
 
2
====================
 
3
 
 
4
The On Screen Controller (short: OSC) is a minimal GUI integrated with mpv to
 
5
offer basic mouse-controllability. It is intended to make interaction easier
 
6
for new users and to enable precise and direct seeking.
 
7
 
 
8
The OSC is enabled by default if mpv was compiled with lua support. It can be
 
9
disabled using ``--osc=no``.
 
10
 
 
11
Using the OSC
 
12
-------------
 
13
 
 
14
By default, the OSC will show up whenever the mouse is moved inside the
 
15
player window and will hide if the mouse is not moved outside the OSC for
 
16
0.5 seconds or if the mouse leaves the window.
 
17
 
 
18
The Interface
 
19
~~~~~~~~~~~~~
 
20
 
 
21
::
 
22
 
 
23
    +------------------+-----------+--------------------+
 
24
    | playlist prev    |   title   |      playlist next |
 
25
    +-------+------+---+--+------+-+----+------+--------+
 
26
    | audio | skip | seek |      | seek | skip |  full  |
 
27
    +-------+ back | back | play | frwd | frwd | screen |
 
28
    | sub   |      |      |      |      |      |        |
 
29
    +-------+------+------+------+------+------+--------+
 
30
    |                     seekbar                       |
 
31
    +----------------+--------------+-------------------+
 
32
    | time passed    | cache status |    time remaining |
 
33
    +----------------+--------------+-------------------+
 
34
 
 
35
 
 
36
playlist prev
 
37
    =============   ================================================
 
38
    left-click      play previous file in playlist
 
39
    shift+L-click   show playlist
 
40
    =============   ================================================
 
41
 
 
42
title
 
43
    | Displays current media-title or filename
 
44
 
 
45
    =============   ================================================
 
46
    left-click      show playlist position and length and full title
 
47
    right-click     show filename
 
48
    =============   ================================================
 
49
 
 
50
playlist next
 
51
    =============   ================================================
 
52
    left-click      play next file in playlist
 
53
    shift+L-click   show playlist
 
54
    =============   ================================================
 
55
 
 
56
audio and sub
 
57
    | Displays selected track and amount of available tracks
 
58
 
 
59
    =============   ================================================
 
60
    left-click      cycle audio/sub tracks forward
 
61
    right-click     cycle audio/sub tracks backwards
 
62
    shift+L-click   show available audio/sub tracks
 
63
    =============   ================================================
 
64
 
 
65
skip back
 
66
    =============   ================================================
 
67
    left-click      go to beginning of chapter / previous chapter
 
68
    shift+L-click   show chapters
 
69
    =============   ================================================
 
70
 
 
71
seek back
 
72
    =============   ================================================
 
73
    left-click      skip back  5 seconds
 
74
    right-click     skip back 30 seconds
 
75
    shift-L-click   skip back  1 frame
 
76
    =============   ================================================
 
77
 
 
78
play
 
79
    =============   ================================================
 
80
    left-click      toggle play/pause
 
81
    =============   ================================================
 
82
 
 
83
seek frwd
 
84
    =============   ================================================
 
85
    left-click      skip forward 10 seconds
 
86
    right-click     skip forward 60 seconds
 
87
    shift-L-click   skip forward  1 frame
 
88
    =============   ================================================
 
89
 
 
90
skip frwd
 
91
    =============   ================================================
 
92
    left-click      go to next chapter
 
93
    shift+L-click   show chapters
 
94
    =============   ================================================
 
95
 
 
96
fullscreen
 
97
    =============   ================================================
 
98
    left-click      toggle fullscreen
 
99
    =============   ================================================
 
100
 
 
101
seekbar
 
102
    | Indicates current playback position and position of chapters
 
103
 
 
104
    =============   ================================================
 
105
    left-click      seek to position
 
106
    =============   ================================================
 
107
 
 
108
time passed
 
109
    | Shows current playback position timestamp
 
110
 
 
111
    =============   ================================================
 
112
    left-click      toggle displaying timecodes with milliseconds
 
113
    =============   ================================================
 
114
 
 
115
cache status
 
116
    | Shows current cache fill status (only visible when below 48%)
 
117
 
 
118
time remaining
 
119
    | Shows remaining playback time timestamp
 
120
 
 
121
    =============   ================================================
 
122
    left-click      toggle between total and remaining time
 
123
    =============   ================================================
 
124
 
 
125
 
 
126
Configuration
 
127
-------------
 
128
 
 
129
The OSC offers limited configuration through a config file ``plugin_osc.conf``
 
130
placed in mpv's user dir.
 
131
 
 
132
Config Syntax
 
133
~~~~~~~~~~~~~
 
134
 
 
135
The config file must exactly follow the following syntax::
 
136
 
 
137
    # this is a comment
 
138
    parameter1=value1
 
139
    parameter2=value2
 
140
 
 
141
``#`` can only be used at the beginning of a line and there may be no
 
142
spaces around the ``=`` or anywhere else.
 
143
 
 
144
Configurable parameters
 
145
~~~~~~~~~~~~~~~~~~~~~~~
 
146
 
 
147
``showwindowed``
 
148
    | Default: yes
 
149
    | Show OSC when windowed?
 
150
 
 
151
``showfullscreen``
 
152
    | Default: yes
 
153
    | Show OSC when fullscreen?
 
154
 
 
155
``scalewindowed``
 
156
    | Default: 1
 
157
    | Scaling of the controller when windowed
 
158
 
 
159
``scalefullscreen``
 
160
    | Default: 1
 
161
    | Scaling of the controller when fullscreen
 
162
 
 
163
``scaleforcedwindow``
 
164
    | Default: 2
 
165
    | Scaling of the controller when rendered on a forced (dummy) window
 
166
 
 
167
``vidscale``
 
168
    | Default: yes
 
169
    | Scale the controller with the video?
 
170
 
 
171
``valign``
 
172
    | Default: 0.8
 
173
    | Vertical alignment, -1 (top) to 1 (bottom)
 
174
 
 
175
``halign``
 
176
    | Default: 0
 
177
    | Horizontal alignment, -1 (left) to 1 (right)
 
178
 
 
179
``hidetimeout``
 
180
    | Default: 500
 
181
    | Duration in ms until the OSC hides if no mouse movement, negative value
 
182
      disables auto-hide
 
183
 
 
184
``fadeduration``
 
185
    | Default: 200
 
186
    | Duration of fade out in ms, 0 = no fade
 
187
 
 
188
``deadzonesize``
 
189
    | Default: 0
 
190
    | Size of the deadzone. The deadzone is an area that makes the mouse act
 
191
      like leaving the window. Movement there won't make the OSC show up and
 
192
      it will hide immediately if the mouse enters it.
 
193
 
 
194
``minmousemove``
 
195
    | Default: 3
 
196
    | Minimum amount of pixels the mouse has to move between ticks to make
 
197
      the OSC show up
 
198