vocloj.protocols — com.github.brianium/vocloj 1.0.24

Contains vocloj protocols. Speech recognizers and speech synthesizers may adhere to the vocloj.core api by implementing their respective protcols as well as the Initializable and StateMachine protocols.

Initializable clj/s protocol

-init clj/s

(-init _)

Initialize a type. Useful for setting up event streams and necessary resources

Lifecycle clj/s protocol

-start clj/s

(-start _)

Start a component

-stop clj/s

(-stop _)

Stop a component

ReceivesSpeech clj/s protocol

-get-speech-channel clj/s

(-get-speech-channel _)

Returns a channel that receives speech data

-get-stop-channel clj/s

(-get-stop-channel _)

Return a channel that receives stop signals

-listen clj/s

(-listen _)

Start listening for speech

StateMachine clj/s protocol

-add-effect clj/s

(-add-effect _ key fn-3)

Add a side effect that is invoked when a change to state happens. Is called with the state machine, previous, and next state

-current-state clj/s

(-current-state _)

Return the current state of the state machine

-transition clj/s

(-transition _ event payload)

Transition the state machine to a new state

Suspendable clj/s protocol

-pause clj/s

(-pause _)

Pause a component

-resume clj/s

(-resume _)

Resume a component

SynthesizesSpeech clj/s protocol

-cancel clj/s

(-cancel _)

Cancel all speech, including any enqueued for further utterance

-speak clj/s

(-speak _ voice-id utterance)

Speak an utterance using the given voice id