oysteikt/mpvipc-async
oysteikt
/
mpvipc-async
1
0
Fork 0
Code Issues 4 Pull Requests Actions Releases 1 Activity

README: small fixups, add fork notice

This commit is contained in:
Oystein Kristoffer Tveit 2024-08-03 15:52:41 +02:00
parent bb050d7a6d
commit 9e0d8c0117
Signed by: oysteikt
GPG Key ID: 9F2F7D8250F35146
1 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -3,14 +3,17 @@
# mpvipc # mpvipc
> **NOTE:** This is a fork of [gitlab.com/mpv-ipc/mpvipc](https://gitlab.com/mpv-ipc/mpvipc), which introduces a lot of changes to be able to use the library asynchronously with [tokio](https://github.com/tokio-rs/tokio).
---
A small library which provides bindings to control existing mpv instances through sockets. A small library which provides bindings to control existing mpv instances through sockets.
## Dependencies ## Dependencies
- `mpv` - `mpv` (runtime dependency)
- `cargo` (make dependency) - `cargo-nextest` (optional test depencency)
- `cargo-nextest` (test depencency) - `grcov` (optional test depencency)
- `grcov` (test depencency)
## Example ## Example
@ -29,6 +32,6 @@ use mpvipc::*;
async fn main() -> Result<(), MpvError> { async fn main() -> Result<(), MpvError> {
let mpv = Mpv::connect("/tmp/mpv.sock").await?; let mpv = Mpv::connect("/tmp/mpv.sock").await?;
let paused: bool = mpv.get_property("pause").await?; let paused: bool = mpv.get_property("pause").await?;
mpv.set_property("pause", !paused).expect("Error pausing"); mpv.set_property("pause", !paused).await.expect("Error pausing");
} }
``` ```