Struct SSML

pub struct SSML { /* private fields */ }

SSML format support

Note: to use the characters &, <, and > within the SSML element’s value or text, you must use the entity format. Specifically you must use & in place of &, use < in place of <, and use > in place of >. Otherwise the SSML will not be parsed correctly.

Source: https://learn.microsoft.com/en-us/azure/cognitive-services/speech-service/speech-synthesis-markup-structure#special-characters

If you would like to create a most simple SSML document, you will find Speak::voice_content very helpful. Just convert the Speak instance to SSML and that’s done.

Example

use rust_ai::azure::{ssml::Speak, Locale, VoiceName, SSML};
 
let ssml = SSML::from(
   Speak::voice_content(
       VoiceName::zh_CN_YunhaoNeural,
       "亲爱的朋友，美丽中国欢迎你！",
   )
   .lang(Locale::zh_CN),
);

Implementations

impl SSML

pub fn lang(self, lang: Locale) -> Self

pub fn speak(self, speak: Speak) -> Self

Replace internal root speak element

Trait Implementations

impl Clone for SSML

fn clone(&self) -> SSML

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SSML

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

Formats the value using the given formatter.

impl Default for SSML

fn default() -> Self

Returns the “default value” for a type.

impl From<SSML> for Speech

fn from(value: SSML) -> Self

Convert SSML document into Speech endpoint instance directly.

impl From<Speak> for SSML

fn from(value: Speak) -> Self

Create an SSML document with new speak root element.

impl Into<String> for SSML

fn into(self) -> String

Converts this type into the (usually inferred) input type.

impl ToString for SSML

fn to_string(&self) -> String

Converts the given value to a String.