mpvipc-async/README.md

34 lines
1009 B
Markdown
Raw Normal View History

[![Coverage](https://pvv.ntnu.no/~oysteikt/gitea/mpvipc/master/coverage/badges/for_the_badge.svg)](https://pvv.ntnu.no/~oysteikt/gitea/mpvipc/master/coverage/src/)
[![Docs](https://img.shields.io/badge/docs-blue?style=for-the-badge&logo=rust)](https://pvv.ntnu.no/~oysteikt/gitea/mpvipc/master/docs/mpvipc/)
# mpvipc
A small library which provides bindings to control existing mpv instances through sockets.
## Dependencies
- `mpv`
2024-05-04 00:06:43 +02:00
- `cargo` (make dependency)
- `cargo-nextest` (test depencency)
- `grcov` (test depencency)
## Example
Make sure mpv is started with the following option:
2024-05-04 00:06:43 +02:00
```bash
$ mpv --input-ipc-server=/tmp/mpv.sock --idle
2024-05-04 00:06:43 +02:00
```
2024-05-04 00:06:43 +02:00
Here is a small code example which connects to the socket `/tmp/mpv.sock` and toggles playback.
```rust
use mpvipc::*;
2024-05-04 00:06:43 +02:00
#[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");
}
2024-05-04 00:06:43 +02:00
```