mpv

https://mpv.io/manual/master
Admin
mpv is a free, open-source, and cross-platform media player that supports a wide variety of media...
Tokens:254,275
Snippets:2,445
Trust Score:9.7
Update:1 day ago
Show doc for...
Tokens:
Raw
### mpv --start examples for seeking

Source: https://mpv.io/manual/master/

Examples of using --start with different time formats: relative seconds, absolute times, percentages, and chapter numbers. Note that + is relative to start time, - is relative to end time, and pp% seeks to a percentage position.

```bash
--start=+56, --start=00:56
```

```bash
--start=-56, --start=-00:56
```

```bash
--start=01:10:00
```

```bash
--start=50%
```

```bash
--start=30 --end=40
```

```bash
--start=-3:20 --length=10
```

```bash
--start='#2' --end='#4'
```

--------------------------------

### --input-commands example: playlist-play-index and set ao-volume

Source: https://mpv.io/manual/master/

Example of the --input-commands option, which defines a list of commands to run at startup or when changed at runtime. The example sets the playlist index to 1 and the ao-volume to 40.

```plaintext
--input-commands="playlist-play-index 1,set ao-volume 40"
```

--------------------------------

### Example mpv.conf configuration file

Source: https://mpv.io/manual/master/

Shows a sample mpv.conf with three options: autofit-larger, hwdec, and osd-playing-msg. Comments start with #. Options without values can be enabled by setting them to yes or omitted (yes implied).

```plaintext
# Don't allow new windows to be larger than the screen.
autofit-larger=100%x100%
# Enable hardware decoding if available, =yes is implied.
hwdec
# Spaces don't have to be escaped.
osd-playing-msg=File: ${filename}

```

--------------------------------

### Example: loadfile with autocompletion

Source: https://mpv.io/manual/master/

Example input.conf binding that pre-fills the console with 'loadfile '' and sets the cursor position to 11, enabling autocompletion of paths.

```plaintext
Ctrl+o script-message-to commands type "loadfile ''" 11
```

--------------------------------

### Example config file for script options

Source: https://mpv.io/manual/master/

Shows the format of the config file stored in script-opts/identifier.conf. Comment lines start with #, stray spaces are not removed, and boolean values are represented with yes/no.

```ini
# comment
optionA=Hello World
optionB=9999
optionC=no
```

--------------------------------

### vf command examples for input.conf

Source: https://mpv.io/manual/master/

Example bindings for the vf command: toggle vflip, clear filters, and toggle gradfun. These are meant for input.conf.

```plaintext
- a vf set vflip turn the video upside-down on the a key
- b vf set "" remove all video filters on b
- c vf toggle gradfun toggle debanding on c
```

--------------------------------

### mpv --vf suboption example with multiple options

Source: https://mpv.io/manual/master/

Demonstrates passing multiple suboptions to a filter using the --vf option. The example passes option1 and option3 to the foo filter, with option2 as a flag (implicitly option2=yes), and adds a bar filter after that.

```shell
mpv test.mkv \--vf=foo:option1=value1:option2:option3=value3,bar
```

--------------------------------

### ytdl-raw-options examples

Source: https://mpv.io/manual/master/

Examples of passing arbitrary options to youtube-dl via --ytdl-raw-options. Options without arguments must include '='. No sanity checking is performed, so invalid parameters can break things.

```plaintext
--ytdl-raw-options=username=user,password=pass
```

```plaintext
--ytdl-raw-options=force-ipv6=
```

```plaintext
--ytdl-raw-options=proxy=[http://127.0.0.1:3128]
```

```plaintext
--ytdl-raw-options-append=proxy=http://127.0.0.1:3128
```

--------------------------------

### input.conf key binding examples

Source: https://mpv.io/manual/master/

Example key bindings in input.conf: 's' triggers a screenshot, 'LEFT' seeks forward by 15 seconds. Keys are literal characters or special key names; uppercase implies Shift.

```plaintext
s screenshot      # take a screenshot with the s key
LEFT seek 15      # map the left-arrow key to seeking forward by 15 seconds
```

--------------------------------

### mp.register_event example

Source: https://mpv.io/manual/master/

Registers a callback for the file-loaded event. The callback prints a message when playback starts. All scripts receive events equally and cannot block other scripts.

```lua
function my_fn(event)
    print("start of playback!")
end

mp.register_event("file-loaded", my_fn)
```

--------------------------------

### Example command-line for script options

Source: https://mpv.io/manual/master/

Shows how to pass script options via the --script-opts parameter. All keys must be prefixed with the identifier followed by a hyphen to avoid collisions.

```bash
--script-opts=myscript-optionA=TEST,myscript-optionB=0,myscript-optionC=yes
```

--------------------------------

### mpv --af=lavfi-tempo=filter=ascale --speed=1.2 media.ogg

Source: https://mpv.io/manual/master/

Same as the previous example, using the filter= syntax.

```bash
mpv --af=lavfi-tempo=filter=ascale --speed=1.2 media.ogg
```

--------------------------------

### mpv --af=lavfi-tempo=filter=atempo --speed=1.2 media.ogg

Source: https://mpv.io/manual/master/

Same as the previous example, using the filter= syntax.

```bash
mpv --af=lavfi-tempo=filter=atempo --speed=1.2 media.ogg
```

--------------------------------

### Example: seek absolute-percent

Source: https://mpv.io/manual/master/

Example input.conf binding that pre-fills the console with 'seek absolute-percent' and sets the cursor position to 6.

```plaintext
% script-message-to commands type "seek  absolute-percent" 6
```

--------------------------------

### lavfi filter example with named parameters

Source: https://mpv.io/manual/master/

Same lavfi example but uses named parameters for the gradfun filter (radius and strength).

```bash
'--vf=lavfi=graph="gradfun=radius=30:strength=20,vflip"'
```

--------------------------------

### mpv --af=lavfi-tempo=atempo --speed=1.2 media.ogg

Source: https://mpv.io/manual/master/

Same as the previous example, explicitly selecting the atempo filter.

```bash
mpv --af=lavfi-tempo=atempo --speed=1.2 media.ogg
```

--------------------------------

### Example mpv config file with profiles

Source: https://mpv.io/manual/master/

Shows a full mpv configuration file with top-level options, named profiles ([big-cache], [network], [reduce-judder]), profile extension, and inclusion of other profiles via the profile option. Profiles are enabled with --profile=<name> or apply-profile <name> command.

```ini
# normal top-level option
fullscreen=yes

# a profile that can be enabled with --profile=big-cache
[big-cache]
cache=yes
demuxer-max-bytes=512MiB
demuxer-readahead-secs=20

[network]
profile-desc="profile for content over network"
force-window=immediate
# you can also include other profiles
profile=big-cache

[reduce-judder]
video-sync=display-resample
interpolation=yes

# using a profile again extends it
[network]
demuxer-max-back-bytes=512MiB
# reference a builtin profile
profile=low-latency
```

--------------------------------

### Custom buttons script-opts example

Source: https://mpv.io/manual/master/

Example script-opts to define custom buttons in bottombar and topbar layouts. Adds loop, shuffle, and speed buttons with mouse and wheel commands.

```plaintext
custom_button_1_content=🔁
custom_button_1_mbtn_left_command=cycle-values loop-file inf no
custom_button_1_mbtn_right_command=cycle-values loop-playlist inf no

custom_button_2_content=🔀
custom_button_2_mbtn_left_command=playlist-shuffle

custom_button_3_content=⏱
custom_button_3_mbtn_left_command=add speed 1
custom_button_3_mbtn_right_command=set speed 1
custom_button_3_wheel_up_command=add speed 0.25
custom_button_3_wheel_down_command=add speed -0.25
```

--------------------------------

### List available scaling filters with --scale=help

Source: https://mpv.io/manual/master/

Run this command to see the complete list of filters available for the --scale option. The output is not shown in the source.

```bash
mpv --scale=help
```

--------------------------------

### sub-start

Source: https://mpv.io/manual/master/

Returns the current subtitle start time in seconds. If multiple current subtitles exist, returns the first start time. If no current subtitle is present, null is returned.

```APIDOC
## sub-start

### Description
Returns the current subtitle start time (in seconds). If there's multiple current subtitles, returns the first start time. If no current subtitle is present null is returned instead.

### Property
sub-start

### Sub-properties
- **sub-start/full** - sub-start with milliseconds.
```

--------------------------------

### Start mpv with IPC server on Windows named pipe

Source: https://mpv.io/manual/master/

Command to start mpv with the IPC server listening on a Windows named pipe. Use this before sending commands via the command prompt.

```bash
mpv file.mkv --input-ipc-server=\\.\pipe\mpvsocket
```

--------------------------------

### Example implementation of options.read_options

Source: https://mpv.io/manual/master/

Defines a table of default options and passes it to options.read_options with identifier 'myscript'. The function overwrites defaults with values from the config file and command-line. The table is then printed to show the resulting values.

```lua
local options = {
    optionA = "defaultvalueA",
    optionB = -0.5,
    optionC = true,
}

require "mp.options".read_options(options, "myscript")
print(options.optionA)
```

--------------------------------

### Start mpv with IPC server socket

Source: https://mpv.io/manual/master/

Starts mpv with a Unix socket for JSON IPC at /tmp/mpvsocket. Use the --idle option to prevent mpv from exiting immediately when no file is played.

```bash
mpv file.mkv --input-ipc-server=/tmp/mpvsocket
```

--------------------------------

### VapourSynth script example for mpv vapoursynth filter

Source: https://mpv.io/manual/master/

Example VapourSynth script that adds borders to the video_in source. The script must read from video_in and set output. The script is reloaded on every seek.

```python
import vapoursynth as vs
from vapoursynth import core
core.std.AddBorders(video_in, 10, 10, 20, 20).set_output()
```

--------------------------------

### lavfi-complex: Stack two video tracks with vstack

Source: https://mpv.io/manual/master/

Command-line example for --lavfi-complex that stacks video tracks 1 and 2 using the vstack filter. Both tracks must have the same width or filter initialization fails; use --external-file=other.mkv to load a video track from another file.

```bash
--lavfi-complex='[vid1] [vid2] vstack [vo]'
```

--------------------------------

### mpv dvd:// --dvd-device=/path/to/dvd/

Source: https://mpv.io/manual/master/

Example command to play a DVD using a specified device or ISO file path.

```shell
mpv dvd:// --dvd-device=/path/to/dvd/
```

--------------------------------

### mp.input.get

Source: https://mpv.io/manual/master/

Gets input from the user.

```APIDOC
## mp.input.get(obj)

### Description
Gets input from the user.

### Method
N/A (Scripting API)

### Parameters
- **obj** (object) - Required - Input request object.
```

--------------------------------

### loadfile <url> [<flags> [<index> [<options>]]]

Source: https://mpv.io/manual/master/

Loads a file and starts playback. The flags, index, and options arguments are optional.

```APIDOC
## loadfile <url> [<flags> [<index> [<options>]]]

### Description
Loads the given URL and starts playback. The flags, index, and options arguments are optional.

### Method
N/A (input command)

### Endpoint
N/A

### Parameters
- **url** (string) - Required - The URL or file path to load.
- **flags** (string) - Optional - Playback flags.
- **index** (integer) - Optional - Playlist index to play.
- **options** (string) - Optional - Additional options.

### Request Example
N/A

### Response
N/A
```

--------------------------------

### Play CD tracks 4 to 6 with cdda://

Source: https://mpv.io/manual/master/

Starts playback from track 4, plays track 5, and ends after track 6. Use --start and --end with chapter numbers.

```shell
mpv cdda:// --start=#4 --end=#6
```

--------------------------------

### mpv dvda:// --dvda-device=/path/to/dvda/

Source: https://mpv.io/manual/master/

Example command to play a DVD-Audio disc using a specified device or ISO file path.

```shell
mpv dvda:// --dvda-device=/path/to/dvda/
```
Tokens:
Raw