14 releases (8 breaking)

0.10.0 Dec 30, 2023
0.9.0 Aug 27, 2023
0.8.4 Aug 14, 2023
0.8.3 Jul 30, 2023
0.6.0 Mar 25, 2022

#211 in Audio

36 downloads per month

MIT/Apache

88KB
2K SLoC

Rust SSIP Client

build status license Crates.io Version docs.rs

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.

  • Unix socket.
  • TCP socket.
  • Stop, cancel, pause and resume.
  • List, set voices.
  • Set rate, pitch, volume.
  • Notifications.
  • Message history.

The crate is considered as feature complete. It is in maintenance mode. For a real async API, see ssip-client-async which is a fork of this crate.

Getting Started

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

[dependencies]
ssip-client = "0.9"

For the asynchronous API, use:

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

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

~0.5–10MB
~76K SLoC