mpv-socket

A Rust library for the JSON-based IPC protocol of mpv.

Example

Here's a simple example.

Prerequisite

Please note that this requires a running mpv player that is started with the --input-ipc-server option, otherwise MpvSocket::connect(...) will fail.

On Windows this might look like:

mpv.exe --input-ipc-server=\\.\pipe\mpv-socket [file|url|...]

On Linux this might look like:

mpv --input-ipc-server=/tmp/mpv-socket [file|url|...]

Rust Application

Now let's get to the Rust code.
This example uses the Windows connect string, replace it with the input-ipc-server path given to mpv like /tmp/mpv-socket when on Linux.

use mpv_socket::{Error, MpvSocket, Property};

fn main() -> Result<(), Error> {
    pretty_env_logger::init_timed();

    let mut mpv_socket = MpvSocket::connect(r#"\\.\pipe\mpv-socket"#)?;

    let client_name = mpv_socket.client_name()?;
    let version = mpv_socket.get_version()?;
    let filename: String = mpv_socket.get_property(Property::Filename)?;

    println!("Client name: {}", client_name);
    println!("Version: {}", version);
    println!("Filename: {}", filename);

    // Observe property changes with a iterator based API:
    for result in mpv_socket
        .observe_property(Property::PlaybackTime)?
        .take(10)
    {
        let playback_time: f64 = result?;
        log::info!("Playback time: {}", playback_time);
    }

    Ok(())
}

Check out the examples directory for more.

License

Licensed under either of:

Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

mmitteregger / mpv-socket