mpvipc-async/README.md

1.3 KiB

Coverage Docs

mpvipc-async

NOTE: This is a fork of gitlab.com/mpv-ipc/mpvipc, which introduces a lot of changes to be able to use the library asynchronously with tokio.


A small library which provides bindings to control existing mpv instances through sockets.

Dependencies

  • mpv (runtime dependency)
  • cargo-nextest (optional test depencency)
  • grcov (optional test depencency)

Example

Make sure mpv is started with the following option:

$ mpv --input-ipc-server=/tmp/mpv.sock --idle

Here is a small code example which connects to the socket /tmp/mpv.sock and toggles playback.

use mpvipc_async::*;

#[tokio::main]
async fn main() -> Result<(), MpvError> {
    let mpv = Mpv::connect("/tmp/mpv.sock").await?;
    let paused: bool = mpv.get_property("pause").await?;
    mpv.set_property("pause", !paused).await.expect("Error pausing");
}