Struct TTSPlugin 

pub struct TTSPlugin { /* private fields */ }

TTS Plugin implementing AgentPlugin

Implementations

impl TTSPlugin

pub fn new(plugin_id: &str) -> TTSPlugin

Create a new TTS plugin

pub fn with_engine<E>( plugin_id: &str, engine: E, default_voice: Option<&str>, ) -> TTSPlugin

where E: TTSEngine + 'static,

Create a TTS plugin with engine and voice (便捷方法)

参数

• plugin_id: 插件ID
• engine: TTS 引擎
• default_voice: 默认音色，如 "zf_090"，默认为 "default"

示例

use mofa_plugins::TTSPlugin;

// 使用默认音色
let plugin = TTSPlugin::with_engine("tts", kokoro_engine, None);

// 指定音色
let plugin = TTSPlugin::with_engine("tts", kokoro_engine, Some("zf_090"));

pub fn with_config(self, config: TTSPluginConfig) -> TTSPlugin

Set the plugin configuration

pub fn with_engine_ref<E>(self, engine: E) -> TTSPlugin

where E: TTSEngine + 'static,

Set a custom TTS engine (链式调用版本，用于已有实例)

pub fn with_voice(self, voice: &str) -> TTSPlugin

Set the default voice

pub fn engine(&self) -> Option<&Arc<dyn TTSEngine>>

Get the TTS engine

pub async fn synthesize_and_play(&mut self, text: &str) -> Result<(), Error>

Synthesize text to audio and play it

pub async fn synthesize_to_audio( &mut self, text: &str, ) -> Result<Vec<u8>, Error>

Synthesize text to audio data (no playback)

pub async fn synthesize_streaming( &mut self, text: &str, callback: Box<dyn Fn(Vec<u8>) + Sync + Send>, ) -> Result<(), Error>

Stream synthesize text with callback

pub async fn synthesize_streaming_f32( &mut self, text: &str, callback: Box<dyn Fn(Vec<f32>) + Sync + Send>, ) -> Result<(), Error>

Stream synthesize text with f32 callback (native format)

This method is more efficient for KokoroTTS as it uses the native f32 format without the overhead of f32 -> i16 -> u8 conversion.

Arguments

• text: The text to synthesize
• callback: Function to call with each audio chunk (Vec)

Example

plugin.synthesize_streaming_f32("Hello", Box::new(|audio_f32| {
    // audio_f32 is Vec<f32> with values in [-1.0, 1.0]
    sink.append(SamplesBuffer::new(1, 24000, audio_f32));
})).await?;

pub async fn list_voices(&self) -> Result<Vec<VoiceInfo>, Error>

List available voices

pub fn set_default_voice(&mut self, voice: &str)

Set the default voice

pub fn stats(&self) -> HashMap<String, Value>

Get synthesis statistics

pub fn last_audio(&self) -> Vec<u8>

Get the last synthesized audio data

Trait Implementations

impl AgentPlugin for TTSPlugin

fn metadata(&self) -> &PluginMetadata

获取插件元数据

fn state(&self) -> PluginState

获取插件状态

fn load<'life0, 'life1, 'async_trait>( &'life0 mut self, ctx: &'life1 PluginContext, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, TTSPlugin: 'async_trait,

插件加载（分配资源）

fn init_plugin<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, TTSPlugin: 'async_trait,

插件初始化（配置初始化）

fn start<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, TTSPlugin: 'async_trait,

插件启动

fn stop<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, TTSPlugin: 'async_trait,

插件停止

fn unload<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, TTSPlugin: 'async_trait,

插件卸载（释放资源）

fn execute<'life0, 'async_trait>( &'life0 mut self, input: String, ) -> Pin<Box<dyn Future<Output = Result<String, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, TTSPlugin: 'async_trait,

执行插件功能

fn stats(&self) -> HashMap<String, Value>

获取插件统计信息

fn as_any(&self) -> &(dyn Any + 'static)

转换为 Any（用于向下转型）

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

转换为可变 Any

fn into_any(self: Box<TTSPlugin>) -> Box<dyn Any>

消费并转换为 Any（用于提取具体的插件类型）

fn plugin_id(&self) -> &str

获取插件 ID（便捷方法）

fn plugin_type(&self) -> PluginType

获取插件类型

fn pause<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: 'async_trait,

插件暂停

fn resume<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: 'async_trait,

插件恢复

fn health_check<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<bool, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: 'async_trait,

健康检查