Struct Engine

pub struct Engine { /* private fields */ }

A Pico TTS engine.

Implementations

impl Engine

pub fn put_text( &mut self, utf8_text: impl AsRef<[u8]>, ) -> Result<usize, PicoError>

Puts UTF-8 text to be spoken into the TTS engine. Returns the number of bytes of utf8_text that were in fact put in the engine (or a PicoError on failure).

Put null terminators (\0) in the text to flush the engine, forcing speech generation.

See

ttspico_sys::pico_putTextUtf8.

pub fn flush(&mut self) -> Result<usize, PicoError>

Flushes the TTS engine, forcing speech generation. Equivalent to `self.put_text(“\0”).

pub fn reset(&mut self, mode: EngineResetMode) -> Result<(), PicoError>

Resets the TTS engine according to mode.

See

ttspico_sys::pico_resetEngine.

pub fn get_data( &mut self, buf: impl AsMut<[i16]>, ) -> Result<(usize, EngineStatus), PicoError>

Generates speech audio from the text input via put_text, outputting to buf.
Returns either a <number of samples generated, EngineStatus after stepping> pair (on success) or a PicoError (on failure).

Output data is encoded as 16-bit signed PCM, at a sample rate of 16kHz. buf should have length <= PICO_INT16_MAX.

See

ttspico_sys::pico_getData.

Trait Implementations

impl Debug for Engine

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for Engine

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Engine

impl Send for Engine