comparison DOCS/tech/slave.txt @ 16386:9e1ba1ac3c7d

Reorder slave mode commands to appear in alphabetical order with a few exceptions for commands that are very closely related.
author diego
date Sun, 04 Sep 2005 16:08:18 +0000
parents 136d745cc980
children 9597d55ee7ab
comparison
equal deleted inserted replaced
16385:35b310d35aa0 16386:9e1ba1ac3c7d
17 17
18 All commands can be prefixed with "pausing ", causing MPlayer to pause as soon 18 All commands can be prefixed with "pausing ", causing MPlayer to pause as soon
19 as possible after processing the command. Please note that this can be before 19 as possible after processing the command. Please note that this can be before
20 the command is fully executed. 20 the command is fully executed.
21 21
22
22 Available commands ('mplayer -input cmdlist' will print a list): 23 Available commands ('mplayer -input cmdlist' will print a list):
23 24
24 25
25 seek <value> [<type>] 26 alt_src_step <value> (ASX playlist only)
26 Seek to some place in the movie. 27 When more than one source is available it selects the next/previous one.
27 0 is a relative seek of +/- <value> seconds (default).
28 1 is a seek to <value> % in the movie.
29 2 is a seek to an absolute position of <value> seconds.
30
31 speed_set <value>
32 Set the speed to <value>.
33
34 speed_incr <value>
35 Add <value> to the current playback speed.
36
37 speed_mult <value>
38 Multiply the current speed by <value>.
39
40 edl_mark
41 Write the current position into the EDL file.
42 28
43 audio_delay <value> 29 audio_delay <value>
44 Adjust the audio delay by <value> seconds. 30 Adjust the audio delay by <value> seconds.
45 31
46 quit [<value>] 32 [brightness|contrast|gamma|hue|saturation] <-100 - 100> [<abs>]
47 Quit MPlayer. The optional integer value is used as the return code
48 for the mplayer process (default: 0).
49
50 pause
51 Pause/unpause the playback.
52
53 frame_step
54 Play one frame, then pause again.
55
56 grab_frames
57 Currently unimplemented.
58
59 pt_step <value> [<force>]
60 Go to the next/previous entry in the playtree. The sign of <value> tells
61 the direction. If no entry is available in the given direction it will do
62 nothing unless force is non-zero.
63
64 pt_up_step <value> [<force>]
65 Similar to pt_step but jumps to the next/previous entry in the parent list.
66 Useful to break out of the inner loop in the playtree.
67
68 alt_src_step <value> (ASX playlist only)
69 When more than one source is available it selects the next/previous one.
70
71 sub_delay <value> [<abs>]
72 Adjust the subtitle delay by +/- <value> seconds or set it to <value>
73 seconds when <abs> is nonzero.
74
75 sub_step <value>
76 Step forward in the subtitle list by <value> steps or backwards if <value>
77 is negative.
78
79 sub_load <subtitle_file>
80 Loads subtitles from <subtitle_file>.
81
82 sub_remove [<value>]
83 If the <value> argument is present and non-negative, removes the subtitle
84 file with index <value>. If the argument is omitted or negative, removes
85 all subtitle files.
86
87 osd [<level>]
88 Toggle OSD mode or set it to level when <level> >= 0.
89
90 osd_show_text <string>
91 Show <string> on the OSD.
92
93 volume <value>
94 Increase/decrease volume.
95
96 use_master
97 Switch volume control between master and PCM.
98
99 mute
100 Mute/unmute sound output.
101
102 switch_audio [<value>] (MPEG and Matroska only)
103 Switch to the audio track with the id <value>. Cycle through the
104 available tracks if <value> is omitted or negative.
105
106 [contrast|gamma|brightness|hue|saturation] <-100 - 100> [<abs>]
107 Set/adjust video parameters. 33 Set/adjust video parameters.
108
109 frame_drop [<value>]
110 Toggle/set frame dropping mode.
111
112 sub_pos <value>
113 Adjust subtitle position.
114
115 sub_alignment <value>
116 Set subtitle alignment.
117
118 sub_visibility
119 Toggle subtitle visibility.
120
121 get_sub_visibility
122 Print out subtitle visibility (1 == on, 0 == off).
123
124 sub_select [<value>]
125 Display subtitle with index <value>. Turn subtitle display off if
126 <value> is -1 or greater than the highest available subtitle index.
127 Cycle through the available subtitles if <value> is omitted or less
128 than -1. Supported subtitle sources are -sub options on the command
129 line, VOBsubs, DVD subtitles, and Ogg and Matroska text streams.
130
131 sub_log
132 Logs the current or last displayed subtitle together with filename
133 and time information to ~/.mplayer/subtitle_log. Intended purpose
134 is to allow convenient marking of bogus subtitles which need to be
135 fixed while watching the movie.
136
137 vobsub_lang
138 This is a stub linked to sub_select for backwards compatibility.
139
140 get_percent_pos
141 Print out the current position in the file, as integer percentage [0-100).
142
143 get_time_pos
144 Print out the current position in the file in seconds, as float.
145
146 get_time_length
147 Print out the length of the current file in seconds.
148
149 vo_fullscreen
150 Switch to fullscreen mode.
151
152 get_vo_fullscreen
153 Print out fullscreen status (1 == fullscreened, 0 == windowed).
154
155 vo_ontop
156 Toggle stay-on-top.
157
158 vo_rootwin
159 Toggle playback on the root window.
160
161 switch_vsync [<value>]
162 Toggle vsync (1 == on, 0 == off). If no value is provided,
163 vsync status is inverted.
164
165 switch_ratio [<value>]
166 Change aspect ratio at runtime. Value is the new aspect ratio expressed
167 as a float (e.g. 1.77778 for 16/9).
168 There might be problems with some video filters.
169
170 panscan <-1.0 - 1.0> | <0.0 - 1.0> <absolute>
171 Increase or decrease the pan-and-scan range by <value>, 1.0 is the maximum.
172 Negative values decrease the pan-and-scan range.
173 If <absolute> is != 0, then the pan-and scan range is interpreted as an
174 absolute range.
175
176 loadfile <file|url> <append>
177 Load the given file/URL, stopping playback of the current file/URL.
178 If <append> is nonzero playback continues and the file/URL is
179 appended to the current playlist instead.
180
181 loadlist <file> <append>
182 Load the given playlist file, stopping playback of the current file.
183 If <append> is nonzero playback continues and the playlist file is
184 appended to the current playlist instead.
185 34
186 change_rectangle <val1> <val2> 35 change_rectangle <val1> <val2>
187 Change the position of the rectangle filter rectangle. 36 Change the position of the rectangle filter rectangle.
188 <val1> 37 <val1>
189 Must be one of the following: 38 Must be one of the following:
199 If <val1> is 2 or 3: 48 If <val1> is 2 or 3:
200 Relative integer amount by which to move the upper left 49 Relative integer amount by which to move the upper left
201 rectangle corner. Positive values move the rectangle 50 rectangle corner. Positive values move the rectangle
202 right/down and negative values move the rectangle left/up. 51 right/down and negative values move the rectangle left/up.
203 52
53 dvb_set_channel <channel_number> <card_number>
54 Set DVB channel.
55
204 dvdnav <button> 56 dvdnav <button>
205 Press the given dvdnav button. 57 Press the given dvdnav button.
206 1 up 58 1 up
207 2 down 59 2 down
208 3 left 60 3 left
211 6 select 63 6 select
212 64
213 dvdnav_event <value> 65 dvdnav_event <value>
214 Send <value> as DVDNAV event. DVDNAV support in MPlayer is disabled. 66 Send <value> as DVDNAV event. DVDNAV support in MPlayer is disabled.
215 67
216 tv_step_channel <channel> 68 edl_mark
217 Select next/previous TV channel. 69 Write the current position into the EDL file.
218 70
219 tv_step_norm 71 frame_drop [<value>]
220 Change TV norm. 72 Toggle/set frame dropping mode.
221 73
222 tv_step_chanlist 74 get_percent_pos
223 Change channel list. 75 Print out the current position in the file, as integer percentage [0-100).
224 76
225 tv_set_channel <channel> 77 get_sub_visibility
226 Set the current TV channel. 78 Print out subtitle visibility (1 == on, 0 == off).
227 79
228 tv_last_channel 80 get_time_length
229 Set the current TV channel to the last one. 81 Print out the length of the current file in seconds.
230 82
231 tv_set_freq <frequency in MHz> 83 get_time_pos
232 Set the TV tuner frequency. 84 Print out the current position in the file in seconds, as float.
233 85
234 tv_set_norm <norm> 86 get_vo_fullscreen
235 Set the TV tuner norm (PAL, SECAM, NTSC, ...). 87 Print out fullscreen status (1 == fullscreened, 0 == windowed).
236 88
237 tv_set_brightness <-100 - 100> 89 grab_frames
238 Set TV tuner brightness. 90 Currently unimplemented.
239
240 tv_set_contrast <-100 -100>
241 Set TV tuner contrast.
242
243 tv_set_hue <-100 - 100>
244 Set TV tuner hue.
245
246 tv_set_saturation <-100 - 100>
247 Set TV tuner saturation.
248
249 gui_[loadfile|loadsubtitle|about|play|stop|playlist|preferences|skinbrowser]
250 GUI actions
251
252 forced_subs_only
253 Display forced subtitles only.
254
255 dvb_set_channel <channel_number> <card_number>
256 Set DVB channel.
257 91
258 screenshot 92 screenshot
259 Take a screenshot. Currently not implemented in any video output driver. 93 Take a screenshot. Currently not implemented in any video output driver.
94
95 gui_[about|loadfile|loadsubtitle|play|playlist|preferences|skinbrowser|stop]
96 GUI actions
97
98 loadfile <file|url> <append>
99 Load the given file/URL, stopping playback of the current file/URL.
100 If <append> is nonzero playback continues and the file/URL is
101 appended to the current playlist instead.
102
103 loadlist <file> <append>
104 Load the given playlist file, stopping playback of the current file.
105 If <append> is nonzero playback continues and the playlist file is
106 appended to the current playlist instead.
260 107
261 menu <command> 108 menu <command>
262 Execute an OSD menu command. 109 Execute an OSD menu command.
263 up Move cursor up. 110 up Move cursor up.
264 down Move cursor down. 111 down Move cursor down.
267 hide Hide the OSD menu. 114 hide Hide the OSD menu.
268 115
269 set_menu <menu_name> 116 set_menu <menu_name>
270 Display the menu named <menu_name>. 117 Display the menu named <menu_name>.
271 118
119 mute
120 Mute/unmute sound output.
121
122 osd [<level>]
123 Toggle OSD mode or set it to level when <level> >= 0.
124
125 osd_show_text <string>
126 Show <string> on the OSD.
127
128 panscan <-1.0 - 1.0> | <0.0 - 1.0> <absolute>
129 Increase or decrease the pan-and-scan range by <value>, 1.0 is the maximum.
130 Negative values decrease the pan-and-scan range.
131 If <absolute> is != 0, then the pan-and scan range is interpreted as an
132 absolute range.
133
134 pause
135 Pause/unpause the playback.
136
137 frame_step
138 Play one frame, then pause again.
139
140 pt_step <value> [<force>]
141 Go to the next/previous entry in the playtree. The sign of <value> tells
142 the direction. If no entry is available in the given direction it will do
143 nothing unless force is non-zero.
144
145 pt_up_step <value> [<force>]
146 Similar to pt_step but jumps to the next/previous entry in the parent list.
147 Useful to break out of the inner loop in the playtree.
148
149 quit [<value>]
150 Quit MPlayer. The optional integer value is used as the return code
151 for the mplayer process (default: 0).
152
153 seek <value> [<type>]
154 Seek to some place in the movie.
155 0 is a relative seek of +/- <value> seconds (default).
156 1 is a seek to <value> % in the movie.
157 2 is a seek to an absolute position of <value> seconds.
158
159 speed_incr <value>
160 Add <value> to the current playback speed.
161
162 speed_mult <value>
163 Multiply the current speed by <value>.
164
165 speed_set <value>
166 Set the speed to <value>.
167
168 sub_alignment <value>
169 Set subtitle alignment.
170
171 sub_delay <value> [<abs>]
172 Adjust the subtitle delay by +/- <value> seconds or set it to <value>
173 seconds when <abs> is nonzero.
174
175 sub_load <subtitle_file>
176 Loads subtitles from <subtitle_file>.
177
178 sub_log
179 Logs the current or last displayed subtitle together with filename
180 and time information to ~/.mplayer/subtitle_log. Intended purpose
181 is to allow convenient marking of bogus subtitles which need to be
182 fixed while watching the movie.
183
184 sub_pos <value>
185 Adjust subtitle position.
186
187 sub_remove [<value>]
188 If the <value> argument is present and non-negative, removes the subtitle
189 file with index <value>. If the argument is omitted or negative, removes
190 all subtitle files.
191
192 sub_select [<value>]
193 Display subtitle with index <value>. Turn subtitle display off if
194 <value> is -1 or greater than the highest available subtitle index.
195 Cycle through the available subtitles if <value> is omitted or less
196 than -1. Supported subtitle sources are -sub options on the command
197 line, VOBsubs, DVD subtitles, and Ogg and Matroska text streams.
198
199 vobsub_lang
200 This is a stub linked to sub_select for backwards compatibility.
201
202 sub_step <value>
203 Step forward in the subtitle list by <value> steps or backwards if <value>
204 is negative.
205
206 sub_visibility
207 Toggle subtitle visibility.
208
209 forced_subs_only
210 Display forced subtitles only.
211
212 switch_audio [<value>] (MPEG and Matroska only)
213 Switch to the audio track with the id <value>. Cycle through the
214 available tracks if <value> is omitted or negative.
215
216 switch_ratio [<value>]
217 Change aspect ratio at runtime. Value is the new aspect ratio expressed
218 as a float (e.g. 1.77778 for 16/9).
219 There might be problems with some video filters.
220
221 switch_vsync [<value>]
222 Toggle vsync (1 == on, 0 == off). If no value is provided,
223 vsync status is inverted.
224
225 tv_step_channel <channel>
226 Select next/previous TV channel.
227
228 tv_step_norm
229 Change TV norm.
230
231 tv_step_chanlist
232 Change channel list.
233
234 tv_set_channel <channel>
235 Set the current TV channel.
236
237 tv_last_channel
238 Set the current TV channel to the last one.
239
240 tv_set_freq <frequency in MHz>
241 Set the TV tuner frequency.
242
243 tv_set_norm <norm>
244 Set the TV tuner norm (PAL, SECAM, NTSC, ...).
245
246 tv_set_brightness <-100 - 100>
247 Set TV tuner brightness.
248
249 tv_set_contrast <-100 -100>
250 Set TV tuner contrast.
251
252 tv_set_hue <-100 - 100>
253 Set TV tuner hue.
254
255 tv_set_saturation <-100 - 100>
256 Set TV tuner saturation.
257
258 use_master
259 Switch volume control between master and PCM.
260
261 vo_fullscreen
262 Switch to fullscreen mode.
263
264 vo_ontop
265 Toggle stay-on-top.
266
267 vo_rootwin
268 Toggle playback on the root window.
269
270 volume <value>
271 Increase/decrease volume.
272
273
272 The following commands are really only useful for OSD menu console mode: 274 The following commands are really only useful for OSD menu console mode:
273 275
274 help 276 help
275 Displays help text, currently empty. 277 Displays help text, currently empty.
276 278