Struct SpeechBuilder 

pub struct SpeechBuilder { /* private fields */ }

Helper type that can construct a Speech from a sequence of rendering instructions.

It’s important to understand that the instructions do not override the configuration of the synthesizer, but adjust them instead. For example, if you call set_volume(80) on the synthesizer, and your speech starts with the instruction start_volume(50), the volume at that point will be set to 40 (i.e. 50% of 80%).

NOTE: Although any complex speech is encoded as XML, the builder performs no validation. This is because SAPI itself is very lax when processing speech. For example, SAPI will be perfectly happy to render the following XML:

<emph><volume level="50">Hello</emph>world</volume>

Implementations

impl SpeechBuilder

pub fn new() -> Self

Constructs a new, empty instance.

pub fn start_emphasis(&mut self) -> &mut Self

Emphasizes all subsequent speech until the corresponding end_emphasis call.

pub fn start_pitch<P: Into<Pitch>>(&mut self, pitch: P) -> &mut Self

Changes the pitch of all subsequent speech until the corresponding end_pitch call.

pub fn start_rate<R: Into<Rate>>(&mut self, rate: R) -> &mut Self

Changes the rate of all subsequent speech until the corresponding end_rate call.

pub fn start_voice(&mut self, voice: &Voice) -> &mut Self

Switches to the specified voice until the corresponding end_voice call.

pub fn select_and_start_voice( &mut self, required: Option<VoiceSelector>, optional: Option<VoiceSelector>, ) -> &mut Self

Switches to a voice that matches the specified criteria until the corresponding end_voice call. For the explanation of required and optional criteria, see installed_voices.

pub fn start_volume<V: Into<Volume>>(&mut self, volume: V) -> &mut Self

Changes the volume of all subsequent speech until the corresponding end_rate call.

pub fn say<S: AsRef<str>>(&mut self, text: S) -> &mut Self

Appends text to pronounce.

pub fn say_as<S: AsRef<str>>(&mut self, text: S, ctx: SayAs<'_>) -> &mut Self

Appends text to pronounce, along witha hint on how to pronounce it.

pub fn pronounce<S: AsRef<str>>(&mut self, pronunciation: S) -> &mut Self

Appends a specific pronunciation to render. The pronunciation specification depends on the language of the current voice. For example, “m ah dh ax r” in American English is pronounced as “mother”.

pub fn silence(&mut self, duration: Duration) -> &mut Self

Appends a silence with a specified duration. Does not support sub-millisecond precision.

pub fn end_emphasis(&mut self) -> &mut Self

Ends the effect of the corresponding start_emphasis call.

pub fn end_pitch(&mut self) -> &mut Self

Ends the effect of the corresponding start_pitch call.

pub fn end_rate(&mut self) -> &mut Self

Ends the effect of the corresponding start_rate call.

pub fn end_voice(&mut self) -> &mut Self

Ends the effect of the corresponding start_voice or select_and_start_voice call.

pub fn end_volume(&mut self) -> &mut Self

Ends the effect of the corresponding start_volume call.

pub fn build<'s>(&mut self) -> Speech<'s>

Builds the Speech from instructions received so far. Clears the contents of the builder.

Trait Implementations

impl<'s> From<&mut SpeechBuilder> for Speech<'s>

fn from(builder: &mut SpeechBuilder) -> Self

Converts to this type from the input type.

impl<'s> From<SpeechBuilder> for Speech<'s>

fn from(builder: SpeechBuilder) -> Self

Converts to this type from the input type.

impl Write for SpeechBuilder

fn write_str(&mut self, s: &str) -> Result

Writes a string slice into this writer, returning whether the write succeeded.

fn write_char(&mut self, c: char) -> Result<(), Error>

Writes a char into this writer, returning whether the write succeeded.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Glue for usage of the write! macro with implementors of this trait.