Crate ssip_client

source · [−]

Expand description

SSIP client

ssip-client implements a Speech Dispatcher SSIP client library in pure rust.

See client::Client for the synchronous API and poll::QueuedClient for the asynchronous API.

Example

use ssip_client::{fifo, 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()?;

Re-exports

pub use client::Client;

pub use client::Request;

pub use client::Response;

pub use constants::*;

Modules

Structs

Client name

Notification event

Event identifier

HistoryClientStatus

History client status

Client with a queue of requests.

Command status line

Synthesis voice

Enums

CapitalLettersRecognitionMode

Capital letters recognition mode.

Client error, either I/O error or SSIP error.

Client identifiers

CursorDirection

Cursor motion in history

Notification event type (returned by server)

HistoryPosition

Position in history

Symbolic key names

Message identifiers

NotificationType

Notification type

Sort ordering

Priority

PunctuationMode

Punctuation mode.

Sort direction in history

Property messages are ordered by in history

Type Definitions

Client identifier

Client result.

Client result consisting in a single status line

Message identifier

Return code of SSIP commands