comparison DOCS/tech/slave.txt @ 13108:a7ff30cf339f

spelling, rewording, some additions
author diego
date Tue, 24 Aug 2004 10:52:28 +0000
parents 25f51c72eb06
children 693f3b591c25
comparison
equal deleted inserted replaced
13107:5f58b31a706f 13108:a7ff30cf339f
1 SLAVE MODE PROTOCOL 1 SLAVE MODE PROTOCOL
2 ------------------- 2 -------------------
3
4 FIXME: Some of these options are still not documented, patches welcome.
5
6 Most slave mode commands are equivalent to command line options.
7 Have a look at the man page for more detailed descriptions.
3 8
4 If the -slave option is given, playback is controlled by a line-based protocol. 9 If the -slave option is given, playback is controlled by a line-based protocol.
5 Each line must contain one of the following commands: 10 Each line must contain one of the following commands:
6 11
7 seek <value> [<type>] 12 seek <value> [<type>]
24 29
25 grab_frames 30 grab_frames
26 ??? 31 ???
27 32
28 pt_step <value> [<force>] 33 pt_step <value> [<force>]
29 Go to next/previous entry in the playtree. 34 Go to the next/previous entry in the playtree.
30 35
31 pt_up_step <value> [<force>] 36 pt_up_step <value> [<force>]
32 Like pt_step but it jumps to next/previous in the parent list. 37 Like pt_step but it jumps to next/previous in the parent list.
33 38
34 alt_src_step <value> 39 alt_src_step <value>
35 When more than one source is available it selects the next/previous one 40 When more than one source is available it selects the next/previous one
36 (only supported by ASX playlist). 41 (only supported by ASX playlist).
37 42
38 sub_delay <value> [<abs>] 43 sub_delay <value> [<abs>]
39 Adjust the subtitles delay of +/- <value> seconds or set it to <value> 44 Adjust the subtitle delay by +/- <value> seconds or set it to <value>
40 seconds when abs is nonzero. 45 seconds when <abs> is nonzero.
46
47 sub_step
48 ???
41 49
42 osd [<level>] 50 osd [<level>]
43 Toggle OSD mode or set it to level when level >= 0. 51 Toggle OSD mode or set it to level when <level> >= 0.
44 52
45 osd_show_text <value> 53 osd_show_text <value>
54 ???
46 55
47 volume <value> 56 volume <value>
48 Increase/decrease volume. 57 Increase/decrease volume.
49 58
50 use_master 59 use_master
52 61
53 mute 62 mute
54 Mute/unmute sound output. 63 Mute/unmute sound output.
55 64
56 [contrast|gamma|brightness|hue|saturation] <-100 - 100> [<abs>] 65 [contrast|gamma|brightness|hue|saturation] <-100 - 100> [<abs>]
57 Set/Adjust video parameters. 66 Set/adjust video parameters.
58 67
59 frame_drop [<value>] 68 frame_drop [<value>]
60 Toggle/Set frame dropping mode. 69 Toggle/set frame dropping mode.
61 70
62 sub_pos <value> 71 sub_pos <value>
63 Adjust subtitles position. 72 Adjust subtitle position.
64 73
65 sub_alignment <value> 74 sub_alignment <value>
66 Set subtitle alignment. 75 Set subtitle alignment.
67 76
68 sub_visibility 77 sub_visibility
70 79
71 get_sub_visibility 80 get_sub_visibility
72 Print out subtitle visibility (1 == on, 0 == off). 81 Print out subtitle visibility (1 == on, 0 == off).
73 82
74 sub_select 83 sub_select
75 Cycle through the subtitle set. Supported subtitle sources are -sub 84 Cycle through the available subtitles. Supported subtitle sources are
76 options on the command line, VOBSubs, DVD subtitles, and OGG text 85 -sub options on the command line, VOBsubs, DVD subtitles, and Ogg text
77 streams. 86 streams.
78 87
79 vobsub_lang 88 vobsub_lang
80 This is a stub linked to sub_select for backwards compatibility. 89 This is a stub linked to sub_select for backwards compatibility.
81 90
82 get_percent_pos 91 get_percent_pos
83 Print out the current position in the file, in integer percentage [0-100). 92 Print out the current position in the file, as integer percentage [0-100).
84 93
85 get_time_length 94 get_time_length
86 Print out the length of the current file in seconds. 95 Print out the length of the current file in seconds.
87 96
88 vo_fullscreen 97 vo_fullscreen
90 99
91 get_vo_fullscreen 100 get_vo_fullscreen
92 Print out fullscreen status (1 == fullscreened, 0 == windowed). 101 Print out fullscreen status (1 == fullscreened, 0 == windowed).
93 102
94 vo_ontop 103 vo_ontop
95 Toggle stay-on-top. Supported by drivers which use X11, except SDL, 104 Toggle stay-on-top.
96 as well as directx and gl2 under Windows.
97 105
98 vo_rootwin 106 vo_rootwin
99 Toggle playback on the root window. This runtime toggle is only 107 Toggle playback on the root window.
100 supported by the directx driver at the moment.
101 108
102 panscan <value> [value2] 109 panscan <value> [value2]
103 ??? 110 ???
104 111
105 loadfile <file|url> 112 loadfile <file|url>
106 Load the given file/url. 113 Load the given file/URL.
107 114
108 loadlist <file> 115 loadlist <file>
109 Load the given playlist file. 116 Load the given playlist file.
110 117
111 change_rectangle <val1> <val2> 118 change_rectangle <val1> <val2>
115 0 = width 122 0 = width
116 1 = height 123 1 = height
117 2 = x position 124 2 = x position
118 3 = y position 125 3 = y position
119 <val2> 126 <val2>
120 For values of 0 or 1 for <val1>: 127 If <val1> is 0 or 1:
121 Integer amount to add/subtract from the width/height. 128 Integer amount to add/subtract from the width/height.
122 Positive values add to width/height and negative values 129 Positive values add to width/height and negative values
123 subtract from it. 130 subtract from it.
124 For values of 2 or 3 for <val1>: 131 If <val1> is 2 or 3:
125 Relative integer amount by which to move the upper left corner 132 Relative integer amount by which to move the upper left corner
126 of the rectangle. Positive values move the rectangle right/down 133 of the rectangle. Positive values move the rectangle right/down
127 and negative values move the rectangle left/up. 134 and negative values move the rectangle left/up.
128 135
129 dvdnav <button> 136 dvdnav <button>
137 144
138 dvdnav_event <value> 145 dvdnav_event <value>
139 ??? 146 ???
140 147
141 tv_step_channel <channel> 148 tv_step_channel <channel>
142 Select next/previous tv channel. 149 Select next/previous TV channel.
143 150
144 tv_step_norm 151 tv_step_norm
145 Change TV norm. 152 Change TV norm.
146 153
147 tv_step_chanlist 154 tv_step_chanlist
152 159
153 tv_last_channel 160 tv_last_channel
154 Set the current TV channel to the last one. 161 Set the current TV channel to the last one.
155 162
156 tv_set_freq <frequency in MHz> 163 tv_set_freq <frequency in MHz>
157 Set the tv tuner frequency. 164 Set the TV tuner frequency.
158 165
159 tv_set_norm <norm> 166 tv_set_norm <norm>
160 Set the tv tuner norm. PAL, SECAM, NTSC and so on.. 167 Set the TV tuner norm (PAL, SECAM, NTSC, ...).
161 168
162 tv_set_brightness <-100 - 100> 169 tv_set_brightness <-100 - 100>
163 Set tv tuner brightness. 170 Set TV tuner brightness.
164 171
165 tv_set_contrast <-100 -100> 172 tv_set_contrast <-100 -100>
166 Set tv tuner contrast. 173 Set TV tuner contrast.
167 174
168 tv_set_hue <-100 - 100> 175 tv_set_hue <-100 - 100>
169 Set tv tuner hue. 176 Set TV tuner hue.
170 177
171 tv_set_saturation <-100 - 100> 178 tv_set_saturation <-100 - 100>
172 Set tv tuner saturation. 179 Set TV tuner saturation.
173 180
174 gui_[loadfile|loadsubtitle|about|play|stop|gui_playlist|gui_preferences|skinbrowser] 181 gui_[loadfile|loadsubtitle|about|play|stop|gui_playlist|gui_preferences|skinbrowser]
175 GUI actions 182 GUI actions
176 183
177 forced_subs_only 184 forced_subs_only