speak v0.1.0 Speak.Backend behaviour

Backend for speaking.

Link to this section Summary

Types

Process Identifier for a backend

Options that get passed to a backend

Callbacks

Close a backend

Open/Initialize a backend

Say some words

Link to this section Types

Link to this type backend_id()
backend_id() :: pid()

Process Identifier for a backend

Link to this type backend_opts()
backend_opts() :: Keyword.t()

Options that get passed to a backend.

Link to this section Callbacks

Link to this callback close(backend_id)
close(backend_id()) :: :ok | {:error, term()}

Close a backend.

Link to this callback open(backend_opts)
open(backend_opts()) :: {:ok, backend_id()} | {:error, term()}

Open/Initialize a backend.

Link to this callback speak(backend_id, binary)
speak(backend_id(), binary()) :: :ok | {:error, term()}

Say some words.