Crate aspeak

Source
Expand description

A simple text-to-speech client for Azure TTS API.

This crate provides the client binding for Azure TTS API. It supports both RESTful API and Websocket API.

§Quick Start

First, you need to setup authentication and select an audio format. Here we will use an Azure subscription key, but you can also use an auth token.

ⓘ
use aspeak::{synthesizer::SynthesizerConfig, AudioFormat, AuthOptionsBuilder};
use aspeak::{get_rest_endpoint_by_region, get_websocket_endpoint_by_region};

let auth = AuthOptionsBuilder::new(
    // Choose one of the following endpoints based on your selected API.
    // get_rest_endpoint_by_region("eastus"), // for RESTful API
    // get_websocket_endpoint_by_region("eastus") // for Websocket API
)
.key("YOUR_AZURE_SUBSCRIPTION_KEY")
.build();
let config = SynthesizerConfig::new(auth, AudioFormat::Riff16Khz16BitMonoPcm);

§RESTful Synthesizer

Then, you can create a RestSynthesizer from the SynthesizerConfig.

ⓘ
let rest_syn = config.rest_synthesizer()?;

Now you can synthesize SSML to audio data.

ⓘ
let ssml = r#"<speak version="1.0" xmlns="http://www.w3.org/2001/10/synthesis" xml:lang="en-US"><voice name="en-US-JennyNeural">Hello, world!</voice></speak>"#;
let audio_data = rest_syn.synthesize_ssml(ssml).await?;

Or you can synthesize text with TextOptions.

ⓘ
use aspeak::TextOptionsBuilder;
let text = "Hello, world!";
let options = TextOptionsBuilder::new().voice("en-US-JennyNeural").rate("fast").pitch("high").build();
let audio_data = rest_syn.synthesize_text(text, &options).await?;

The full code can be found in examples/03-rest-synthesizer-simple.rs

§Websocket Synthesizer

You can also create a WebsocketSynthesizer.

ⓘ
let mut ws_syn = config.connect_websocket().await?;

Then you can synthesize SSML to audio data.

ⓘ
let ssml = r#"<speak version="1.0" xmlns="http://www.w3.org/2001/10/synthesis" xml:lang="en-US"><voice name="en-US-JennyNeural">Hello, world!</voice></speak>"#;
let audio_data = ws_syn.synthesize_ssml(ssml).await?;

or synthesize text with TextOptions.

ⓘ
use aspeak::TextOptionsBuilder;
let text = "Hello, world!";
let options = TextOptionsBuilder::new().voice("en-US-JennyNeural").rate("fast").pitch("high").build();
let audio_data = ws_syn.synthesize_text(text, &options).await?;

The full code can be found in examples/04-websocket-synthesizer-simple.rs

§Unified synthesizer trait

There is also a unified synthesizer trait Synthesizer that can be used to provide a unified interface for both RESTful and Websocket synthesizers.

§TLS feature flags

By default, this crate uses native-tls. To use other TLS implementations, you can use the following feature flags:

  • native-tls-vendored: Use the vendored version of native-tls.
  • rustls-tls-native-roots
  • rustls-tls-webpki-roots

Note that you need to disable the default features to disable native-tls. And after that, you need to manually enable your desired synthesizer features.

§Feature flags

  • rest-synthesizer: Enable the RESTful synthesizer.
  • websocket-synthesizer: Enable the Websocket synthesizer.
  • unified-synthesizer: Enable the unified synthesizer trait.
  • synthesizers: Enable all synthesizers.

Re-exports§

pub use synthesizer::*;
pub use voice::*;

Modules§

synthesizer
voice

Structs§

AudioFormatParseError
An error that can occur in AudioFormat::from_container_and_quality.
AuthOptions
Options for authentication
AuthOptionsBuilder
Builder for AuthOptions
RichSsmlOptions
Options that are only available if rich ssml is enabled
RichSsmlOptionsBuilder
Builder for RichSsmlOptions
SsmlError
An error that occurred while interpolating SSML
TextOptions
Options for text-to-speech
TextOptionsBuilder
Builder for TextOptions

Enums§

AudioFormat
All possible audio formats
Role
Speech role
SsmlErrorKind

Statics§

QUALITY_MAP
QUALITY_RANGE_MAP

Functions§

get_default_voice_by_locale
Returns the default voice for the given locale.
get_rest_endpoint_by_region
Get the official REST endpoint by its region (e.g. eastus)
get_websocket_endpoint_by_region
Get the official websocket endpoint by its region (e.g. eastus)
interpolate_ssml
Interpolate SSML from text and options