Enum MpvCommand

pub enum MpvCommand {
    LoadFile {
        file: String,
        option: PlaylistAddOptions,
    },
    LoadList {
        file: String,
        option: PlaylistAddOptions,
    },
    PlaylistClear,
    PlaylistMove {
        from: usize,
        to: usize,
    },
    Observe {
        id: u64,
        property: String,
    },
    PlaylistNext,
    PlaylistPrev,
    PlaylistRemove(usize),
    PlaylistShuffle,
    Quit,
    ScriptMessage(Vec<String>),
    ScriptMessageTo {
        target: String,
        args: Vec<String>,
    },
    Seek {
        seconds: f64,
        option: SeekOptions,
    },
    Stop,
    Unobserve(u64),
}

All possible commands that can be sent to mpv.

Not all commands are guaranteed to be implemented. If something is missing, please open an issue.

You can also use the run_command_raw function to run commands that are not implemented here.

See https://mpv.io/manual/master/#list-of-input-commands for the upstream list of commands.

Variants

LoadFile

Load the given file or URL and play it.

Fields

file: String

option: PlaylistAddOptions

LoadList

Load the given playlist file or URL.

Fields

file: String

option: PlaylistAddOptions

PlaylistClear

Clear the playlist, except for the currently playing file.

PlaylistMove

Move the playlist entry at from, so that it takes the place of the entry to. (Paradoxically, the moved playlist entry will not have the index value to after moving if from was lower than to, because to refers to the target entry, not the index the entry will have after moving.)

Fields

from: usize

to: usize

Observe

Observe a property. This will start triggering Event::PropertyChange events in the event stream whenever the specific property changes. You can use Mpv::get_event_stream to get the stream.

Fields

id: u64

property: String

PlaylistNext

Skip to the next entry in the playlist.

PlaylistPrev

Skip to the previous entry in the playlist.

PlaylistRemove(usize)

Remove an entry from the playlist by its position in the playlist.

PlaylistShuffle

Shuffle the playlist

Quit

Exit the player

ScriptMessage(Vec<String>)

Send a message to all clients, and pass it the following list of arguments. What this message means, how many arguments it takes, and what the arguments mean is fully up to the receiver and the sender.

ScriptMessageTo

Same as MpvCommand::ScriptMessage, but send the message to a specific target.

Fields

target: String

args: Vec<String>

Seek

Change the playback position.

Fields

seconds: f64

option: SeekOptions

Stop

Stop the current playback, and clear the playlist. This esentially resets the entire player state without exiting mpv.

Unobserve(u64)

Unobserve all properties registered with the given id. See MpvCommand::Observe for more context.

Trait Implementations

impl Clone for MpvCommand

fn clone(&self) -> MpvCommand

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MpvCommand

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MpvCommand

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for MpvCommand

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.