#client #set #events #parser #async

ssip-client-async

Client API for Speech Dispatcher

3 releases (breaking)

0.11.0 Jun 17, 2023
0.10.0 Mar 22, 2023
0.9.0 Mar 19, 2023

#762 in Asynchronous

Download history 14/week @ 2023-08-12 11/week @ 2023-08-19 11/week @ 2023-08-26 8/week @ 2023-09-02 24/week @ 2023-09-09 16/week @ 2023-09-16 7/week @ 2023-09-23 13/week @ 2023-09-30 8/week @ 2023-10-07 13/week @ 2023-10-14 10/week @ 2023-10-21 17/week @ 2023-10-28 11/week @ 2023-11-04 15/week @ 2023-11-11 12/week @ 2023-11-18 22/week @ 2023-11-25

62 downloads per month
Used in 2 crates

MIT/Apache

175KB
3.5K SLoC

Rust SSIP Client

license Crates.io Version

Speech Dispatcher SSIP client library 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. This fork also offers a working version using the tokio flag, or an occasionally working async-std flag.

  • Unix socket.
  • TCP socket.
  • Stop, cancel, pause and resume.
  • List, set voices.
  • Set rate, pitch, volume.
  • Notifications.
  • Message history.
  • tokio support.
  • async-std support.
    • If you're interested in helping us implement this, please reach out on Gituhb.

Getting Started

To use the synchronous API or an asynchronous API compatible with low-level crates based on poll, use:

[dependencies]
ssip-client-async = "0.9"

For the tokio API, use:

[dependencies]
ssip-client = { version = "0.9", features = ["tokio"] }

Example

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 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 and LICENSE-MIT for details.

Dependencies

~4–15MB
~195K SLoC