You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
62 lines
1.9 KiB
62 lines
1.9 KiB
Rust SSIP Client
|
|
================
|
|
|
|
[](https://gitlab.com/lp-accessibility/ssip-client/commits/main)
|
|
[](https://gitlab.com/lp-accessibility/ssip-client/raw/main/LICENSE-MIT)
|
|
[](https://crates.io/crates/ssip-client)
|
|
[](https://docs.rs/ssip-client/latest/ssip_client/)
|
|
|
|
Speech Dispatcher [SSIP client library](http://htmlpreview.github.io/?https://github.com/brailcom/speechd/blob/master/doc/ssip.html) in pure rust.
|
|
|
|
The API is synchronous by default.
|
|
|
|
A non-blocking API can be used with a low-level polling mechanism based on `poll`, or
|
|
with [mio](https://github.com/tokio-rs/mio).
|
|
|
|
- [x] Unix socket.
|
|
- [x] TCP socket.
|
|
- [x] Stop, cancel, pause and resume.
|
|
- [x] List, set voices.
|
|
- [x] Set rate, pitch, volume.
|
|
- [x] Notifications.
|
|
- [x] Message history.
|
|
|
|
Getting Started
|
|
---------------
|
|
|
|
To use the synchronous API or an asynchronous API compatible with low-level crates based on `poll`, use:
|
|
|
|
```toml
|
|
[dependencies]
|
|
ssip-client = "0.8"
|
|
```
|
|
|
|
For the asynchronous API, use:
|
|
```toml
|
|
[dependencies]
|
|
ssip-client = { version = "0.8", features = ["async-mio"] }
|
|
```
|
|
|
|
Example
|
|
-------
|
|
|
|
```rust
|
|
use ssip_client::{FifoBuilder, ClientName};
|
|
let mut client = fifo::Builder::new().build()?;
|
|
client
|
|
.set_client_name(ClientName::new("joe", "hello"))?
|
|
.check_client_name_set()?;
|
|
let msg_id = client.speak()?.send_line("hello")?.receive_message_id()?;
|
|
client.quit()?;
|
|
```
|
|
|
|
See [other examples](https://gitlab.com/lp-accessibility/ssip-client/-/tree/main/examples) in the repository.
|
|
|
|
License
|
|
-------
|
|
|
|
This software is distributed under the terms of both the MIT license
|
|
and the Apache License (Version 2.0).
|
|
|
|
See [LICENSE-APACHE](LICENSE-APACHE) and [LICENSE-MIT](LICENSE-MIT) for details.
|