comparison DOCS/tech/slave.txt @ 17954:16ecd1994e2a

Use <value> and [value] consistently.

17953:2cfdd3cf44de

alt_src_step <value> (ASX playlist only)
    When more than one source is available it selects the next/previous one.

audio_delay <value> [<abs>]
    Set/adjust the audio delay.
    If <abs> is not given or is zero, adjust the delay by <value> seconds.
    If <abs> is nonzero, set the delay to <value> seconds.

[brightness|contrast|gamma|hue|saturation] <value> [<abs>]
    Set/adjust video parameters.
    If abs is not given or is zero, modifies parameter by <value>.
    If abs is non-zero, parameter is set to <value>.
    <value> is in the range [-100, 100].

change_rectangle <val1> <val2>
    Change the position of the rectangle filter rectangle.
        <val1>

    Send <value> as DVDNAV event. DVDNAV support in MPlayer is disabled.

edl_mark
    Write the current position into the EDL file.

frame_drop [<value>]
    Toggle/set frame dropping mode.

get_percent_pos
    Print out the current position in the file, as integer percentage [0-100).

        hide   Hide the OSD menu.

set_menu <menu_name>
    Display the menu named <menu_name>.

mute [<value>]
    Toggle sound output mutting or set it to <value> when <value> >= 0
    (1 == on, 0 == off).

osd [<level>]
    Toggle OSD mode or set it to level when <level> >= 0.

osd_show_text <string>
    Show <string> on the OSD.

panscan <-1.0 - 1.0> | <0.0 - 1.0> <absolute>

    Pause/unpause the playback.

frame_step
    Play one frame, then pause again.

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.

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.

quit [<value>]
    Quit MPlayer. The optional integer value is used as the return code
    for the mplayer process (default: 0).

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.

    Set the speed to <value>.

sub_alignment [<value>]
    Toggle/set subtitle alignment.

sub_delay <value> [<abs>]
    Adjust the subtitle delay by +/- <value> seconds or set it to <value>
    seconds when <abs> is nonzero.

sub_load <subtitle_file>
    Loads subtitles from <subtitle_file>.

sub_log
    Logs the current or last displayed subtitle together with filename
    and time information to ~/.mplayer/subtitle_log. Intended purpose
    is to allow convenient marking of bogus subtitles which need to be
    fixed while watching the movie.

sub_pos <value> [<abs>]
    Adjust/set subtitle position.

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.

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.

vobsub_lang
    This is a stub linked to sub_select for backwards compatibility.

sub_step <value>
    Step forward in the subtitle list by <value> steps or backwards if <value>
    is negative.

sub_visibility [<value>]
    Toggle/set subtitle visibility.

forced_subs_only [<value>]
    Toggle/set forced subtitles only.

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.

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.

    Set TV tuner saturation.

use_master
    Switch volume control between master and PCM.

vo_border [<value>]
    Toggle/set borderless display.

vo_fullscreen [<value>]
    Toggle/set fullscreen mode.

vo_ontop [<value>]
    Toggle/set stay-on-top.

vo_rootwin [<value>]
    Toggle/set playback on the root window.

volume <value> [<abs>]
    Increase/decrease volume or set it to <value> if <abs> is nonzero.


The following commands are really only useful for OSD menu console mode:

help

17954:16ecd1994e2a

alt_src_step <value> (ASX playlist only)
    When more than one source is available it selects the next/previous one.

audio_delay <value> [abs]
    Set/adjust the audio delay.
    If [abs] is not given or is zero, adjust the delay by <value> seconds.
    If [abs] is nonzero, set the delay to <value> seconds.

[brightness|contrast|gamma|hue|saturation] <value> [abs]
    Set/adjust video parameters.
    If [abs] is not given or is zero, modifies parameter by <value>.
    If [abs] is non-zero, parameter is set to <value>.
    <value> is in the range [-100, 100].

change_rectangle <val1> <val2>
    Change the position of the rectangle filter rectangle.
        <val1>

    Send <value> as DVDNAV event. DVDNAV support in MPlayer is disabled.

edl_mark
    Write the current position into the EDL file.

frame_drop [value]
    Toggle/set frame dropping mode.

get_percent_pos
    Print out the current position in the file, as integer percentage [0-100).

        hide   Hide the OSD menu.

set_menu <menu_name>
    Display the menu named <menu_name>.

mute [value]
    Toggle sound output mutting or set it to [value] when [value] >= 0
    (1 == on, 0 == off).

osd [level]
    Toggle OSD mode or set it to [level] when [level] >= 0.

osd_show_text <string>
    Show <string> on the OSD.

panscan <-1.0 - 1.0> | <0.0 - 1.0> <absolute>

    Pause/unpause the playback.

frame_step
    Play one frame, then pause again.

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.

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.

quit [value]
    Quit MPlayer. The optional integer [value] is used as the return code
    for the mplayer process (default: 0).

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.

    Set the speed to <value>.

sub_alignment [<value>]
    Toggle/set subtitle alignment.

sub_delay <value> [abs]
    Adjust the subtitle delay by +/- <value> seconds or set it to <value>
    seconds when [abs] is nonzero.

sub_load <subtitle_file>
    Loads subtitles from <subtitle_file>.

sub_log
    Logs the current or last displayed subtitle together with filename
    and time information to ~/.mplayer/subtitle_log. Intended purpose
    is to allow convenient marking of bogus subtitles which need to be
    fixed while watching the movie.

sub_pos <value> [abs]
    Adjust/set subtitle position.

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.

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.

vobsub_lang
    This is a stub linked to sub_select for backwards compatibility.

sub_step <value>
    Step forward in the subtitle list by <value> steps or backwards if <value>
    is negative.

sub_visibility [value]
    Toggle/set subtitle visibility.

forced_subs_only [value]
    Toggle/set forced subtitles only.

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.

switch_vsync [value]
    Toggle vsync (1 == on, 0 == off). If [value] is not provided,
    vsync status is inverted.

tv_step_channel <channel>
    Select next/previous TV channel.

    Set TV tuner saturation.

use_master
    Switch volume control between master and PCM.

vo_border [value]
    Toggle/set borderless display.

vo_fullscreen [value]
    Toggle/set fullscreen mode.

vo_ontop [value]
    Toggle/set stay-on-top.

vo_rootwin [value]
    Toggle/set playback on the root window.

volume <value> [abs]
    Increase/decrease volume or set it to <value> if [abs] is nonzero.


The following commands are really only useful for OSD menu console mode:

help