mpvipc-async/README.md
h7x4 5a02499005
Some checks failed
Build and test / build (push) Failing after 12m13s
Build and test / check (push) Failing after 11m46s
Build and test / test (push) Failing after 11m32s
Build and test / docs (push) Failing after 11m11s
Move repo to Projects, some pipeline updates
2024-12-12 11:04:41 +01:00

34 lines
1.0 KiB
Markdown

[![Coverage](https://pages.pvv.ntnu.no/Projects/mpvipc-async/master/coverage/badges/for_the_badge.svg)](https://pages.pvv.ntnu.no/Projects/mpvipc-async/master/coverage/src/)
[![Docs](https://img.shields.io/badge/docs-blue?style=for-the-badge&logo=rust)](https://pages.pvv.ntnu.no/Projects/mpvipc-async/master/docs/mpvipc-async/)
# mpvipc-async
A small library which provides bindings to control existing mpv instances through sockets.
## Dependencies
- `mpv`
- `cargo` (make dependency)
- `cargo-nextest` (test depencency)
- `grcov` (test depencency)
## Example
Make sure mpv is started with the following option:
```bash
$ 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.
```rust
use mpvipc::*;
#[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).expect("Error pausing");
}
```