CVS change done by Diego Biurrun CVS Update of /cvsroot/mplayer/main/DOCS/tech In directory mail:/var2/tmp/cvs-serv17430 Modified Files: slave.txt Log Message: Reorder slave mode commands to appear in alphabetical order with a few exceptions for commands that are very closely related. Index: slave.txt =================================================================== RCS file: /cvsroot/mplayer/main/DOCS/tech/slave.txt,v retrieving revision 1.43 retrieving revision 1.44 diff -u -r1.43 -r1.44 --- slave.txt 18 Aug 2005 10:50:27 -0000 1.43 +++ slave.txt 4 Sep 2005 16:08:18 -0000 1.44 @@ -19,70 +19,105 @@ as possible after processing the command. Please note that this can be before the command is fully executed. + Available commands ('mplayer -input cmdlist' will print a list): -seek <value> [<type>] - Seek to some place in the movie. - 0 is a relative seek of +/- <value> seconds (default). - 1 is a seek to <value> % in the movie. - 2 is a seek to an absolute position of <value> seconds. +alt_src_step <value> (ASX playlist only) + When more than one source is available it selects the next/previous one. -speed_set <value> - Set the speed to <value>. +audio_delay <value> + Adjust the audio delay by <value> seconds. -speed_incr <value> - Add <value> to the current playback speed. +[brightness|contrast|gamma|hue|saturation] <-100 - 100> [<abs>] + Set/adjust video parameters. -speed_mult <value> - Multiply the current speed by <value>. +change_rectangle <val1> <val2> + Change the position of the rectangle filter rectangle. + <val1> + Must be one of the following: + 0 = width + 1 = height + 2 = x position + 3 = y position + <val2> + If <val1> is 0 or 1: + Integer amount to add/subtract from the width/height. + Positive values add to width/height and negative values + subtract from it. + If <val1> is 2 or 3: + Relative integer amount by which to move the upper left + rectangle corner. Positive values move the rectangle + right/down and negative values move the rectangle left/up. + +dvb_set_channel <channel_number> <card_number> + Set DVB channel. + +dvdnav <button> + Press the given dvdnav button. + 1 up + 2 down + 3 left + 4 right + 5 menu + 6 select + +dvdnav_event <value> + Send <value> as DVDNAV event. DVDNAV support in MPlayer is disabled. edl_mark Write the current position into the EDL file. -audio_delay <value> - Adjust the audio delay by <value> seconds. +frame_drop [<value>] + Toggle/set frame dropping mode. -quit [<value>] - Quit MPlayer. The optional integer value is used as the return code - for the mplayer process (default: 0). +get_percent_pos + Print out the current position in the file, as integer percentage [0-100). -pause - Pause/unpause the playback. +get_sub_visibility + Print out subtitle visibility (1 == on, 0 == off). -frame_step - Play one frame, then pause again. +get_time_length + Print out the length of the current file in seconds. + +get_time_pos + Print out the current position in the file in seconds, as float. + +get_vo_fullscreen + Print out fullscreen status (1 == fullscreened, 0 == windowed). grab_frames Currently unimplemented. -pt_step <value> [<force>] - Go to the next/previous entry in the playtree. The sign of <value> tells - the direction. If no entry is available in the given direction it will do - nothing unless force is non-zero. +screenshot + Take a screenshot. Currently not implemented in any video output driver. -pt_up_step <value> [<force>] - Similar to pt_step but jumps to the next/previous entry in the parent list. - Useful to break out of the inner loop in the playtree. +gui_[about|loadfile|loadsubtitle|play|playlist|preferences|skinbrowser|stop] + GUI actions -alt_src_step <value> (ASX playlist only) - When more than one source is available it selects the next/previous one. +loadfile <file|url> <append> + Load the given file/URL, stopping playback of the current file/URL. + If <append> is nonzero playback continues and the file/URL is + appended to the current playlist instead. -sub_delay <value> [<abs>] - Adjust the subtitle delay by +/- <value> seconds or set it to <value> - seconds when <abs> is nonzero. +loadlist <file> <append> + Load the given playlist file, stopping playback of the current file. + If <append> is nonzero playback continues and the playlist file is + appended to the current playlist instead. -sub_step <value> - Step forward in the subtitle list by <value> steps or backwards if <value> - is negative. +menu <command> + Execute an OSD menu command. + up Move cursor up. + down Move cursor down. + ok Accept selection. + cancel Cancel selection. + hide Hide the OSD menu. -sub_load <subtitle_file> - Loads subtitles from <subtitle_file>. +set_menu <menu_name> + Display the menu named <menu_name>. -sub_remove [<value>] - If the <value> argument is present and non-negative, removes the subtitle - file with index <value>. If the argument is omitted or negative, removes - all subtitle files. +mute + Mute/unmute sound output. osd [<level>] Toggle OSD mode or set it to level when <level> >= 0. @@ -90,43 +125,55 @@ osd_show_text <string> Show <string> on the OSD. -volume <value> - Increase/decrease volume. +panscan <-1.0 - 1.0> | <0.0 - 1.0> <absolute> + Increase or decrease the pan-and-scan range by <value>, 1.0 is the maximum. + Negative values decrease the pan-and-scan range. + If <absolute> is != 0, then the pan-and scan range is interpreted as an + absolute range. -use_master - Switch volume control between master and PCM. +pause + Pause/unpause the playback. -mute - Mute/unmute sound output. +frame_step + Play one frame, then pause again. -switch_audio [<value>] (MPEG and Matroska only) - Switch to the audio track with the id <value>. Cycle through the - available tracks if <value> is omitted or negative. +pt_step <value> [<force>] + Go to the next/previous entry in the playtree. The sign of <value> tells + the direction. If no entry is available in the given direction it will do + nothing unless force is non-zero. -[contrast|gamma|brightness|hue|saturation] <-100 - 100> [<abs>] - Set/adjust video parameters. +pt_up_step <value> [<force>] + Similar to pt_step but jumps to the next/previous entry in the parent list. + Useful to break out of the inner loop in the playtree. -frame_drop [<value>] - Toggle/set frame dropping mode. +quit [<value>] + Quit MPlayer. The optional integer value is used as the return code + for the mplayer process (default: 0). -sub_pos <value> - Adjust subtitle position. +seek <value> [<type>] + Seek to some place in the movie. + 0 is a relative seek of +/- <value> seconds (default). + 1 is a seek to <value> % in the movie. + 2 is a seek to an absolute position of <value> seconds. + +speed_incr <value> + Add <value> to the current playback speed. + +speed_mult <value> + Multiply the current speed by <value>. + +speed_set <value> + Set the speed to <value>. sub_alignment <value> Set subtitle alignment. -sub_visibility - Toggle subtitle visibility. - -get_sub_visibility - Print out subtitle visibility (1 == on, 0 == off). +sub_delay <value> [<abs>] + Adjust the subtitle delay by +/- <value> seconds or set it to <value> + seconds when <abs> is nonzero. -sub_select [<value>] - Display subtitle with index <value>. Turn subtitle display off if - <value> is -1 or greater than the highest available subtitle index. - Cycle through the available subtitles if <value> is omitted or less - than -1. Supported subtitle sources are -sub options on the command - line, VOBsubs, DVD subtitles, and Ogg and Matroska text streams. +sub_load <subtitle_file> + Loads subtitles from <subtitle_file>. sub_log Logs the current or last displayed subtitle together with filename @@ -134,84 +181,46 @@ is to allow convenient marking of bogus subtitles which need to be fixed while watching the movie. -vobsub_lang - This is a stub linked to sub_select for backwards compatibility. - -get_percent_pos - Print out the current position in the file, as integer percentage [0-100). +sub_pos <value> + Adjust subtitle position. -get_time_pos - Print out the current position in the file in seconds, as float. +sub_remove [<value>] + If the <value> argument is present and non-negative, removes the subtitle + file with index <value>. If the argument is omitted or negative, removes + all subtitle files. -get_time_length - Print out the length of the current file in seconds. +sub_select [<value>] + Display subtitle with index <value>. Turn subtitle display off if + <value> is -1 or greater than the highest available subtitle index. + Cycle through the available subtitles if <value> is omitted or less + than -1. Supported subtitle sources are -sub options on the command + line, VOBsubs, DVD subtitles, and Ogg and Matroska text streams. -vo_fullscreen - Switch to fullscreen mode. +vobsub_lang + This is a stub linked to sub_select for backwards compatibility. -get_vo_fullscreen - Print out fullscreen status (1 == fullscreened, 0 == windowed). +sub_step <value> + Step forward in the subtitle list by <value> steps or backwards if <value> + is negative. -vo_ontop - Toggle stay-on-top. +sub_visibility + Toggle subtitle visibility. -vo_rootwin - Toggle playback on the root window. +forced_subs_only + Display forced subtitles only. -switch_vsync [<value>] - Toggle vsync (1 == on, 0 == off). If no value is provided, - vsync status is inverted. +switch_audio [<value>] (MPEG and Matroska only) + Switch to the audio track with the id <value>. Cycle through the + available tracks if <value> is omitted or negative. switch_ratio [<value>] Change aspect ratio at runtime. Value is the new aspect ratio expressed as a float (e.g. 1.77778 for 16/9). There might be problems with some video filters. -panscan <-1.0 - 1.0> | <0.0 - 1.0> <absolute> - Increase or decrease the pan-and-scan range by <value>, 1.0 is the maximum. - Negative values decrease the pan-and-scan range. - If <absolute> is != 0, then the pan-and scan range is interpreted as an - absolute range. - -loadfile <file|url> <append> - Load the given file/URL, stopping playback of the current file/URL. - If <append> is nonzero playback continues and the file/URL is - appended to the current playlist instead. - -loadlist <file> <append> - Load the given playlist file, stopping playback of the current file. - If <append> is nonzero playback continues and the playlist file is - appended to the current playlist instead. - -change_rectangle <val1> <val2> - Change the position of the rectangle filter rectangle. - <val1> - Must be one of the following: - 0 = width - 1 = height - 2 = x position - 3 = y position - <val2> - If <val1> is 0 or 1: - Integer amount to add/subtract from the width/height. - Positive values add to width/height and negative values - subtract from it. - If <val1> is 2 or 3: - Relative integer amount by which to move the upper left - rectangle corner. Positive values move the rectangle - right/down and negative values move the rectangle left/up. - -dvdnav <button> - Press the given dvdnav button. - 1 up - 2 down - 3 left - 4 right - 5 menu - 6 select - -dvdnav_event <value> - Send <value> as DVDNAV event. DVDNAV support in MPlayer is disabled. +switch_vsync [<value>] + Toggle vsync (1 == on, 0 == off). If no value is provided, + vsync status is inverted. tv_step_channel <channel> Select next/previous TV channel. @@ -246,28 +255,21 @@ tv_set_saturation <-100 - 100> Set TV tuner saturation. -gui_[loadfile|loadsubtitle|about|play|stop|playlist|preferences|skinbrowser] - GUI actions +use_master + Switch volume control between master and PCM. -forced_subs_only - Display forced subtitles only. +vo_fullscreen + Switch to fullscreen mode. -dvb_set_channel <channel_number> <card_number> - Set DVB channel. +vo_ontop + Toggle stay-on-top. -screenshot - Take a screenshot. Currently not implemented in any video output driver. +vo_rootwin + Toggle playback on the root window. -menu <command> - Execute an OSD menu command. - up Move cursor up. - down Move cursor down. - ok Accept selection. - cancel Cancel selection. - hide Hide the OSD menu. +volume <value> + Increase/decrease volume. -set_menu <menu_name> - Display the menu named <menu_name>. The following commands are really only useful for OSD menu console mode: