tauri-plugin-tts 0.1.9

Native text-to-speech plugin for Tauri with multi-language and voice selection
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85

use tauri::{command, AppHandle, Runtime};

use crate::models::*;
use crate::Result;
use crate::TtsExt;

/// Speak the given text using text-to-speech
#[command]
pub(crate) async fn speak<R: Runtime>(
    app: AppHandle<R>,
    payload: SpeakRequest,
) -> Result<SpeakResponse> {
    app.tts().speak(payload)
}

/// Stop any ongoing speech
#[command]
pub(crate) async fn stop<R: Runtime>(app: AppHandle<R>) -> Result<StopResponse> {
    app.tts().stop()
}

/// Get available voices, optionally filtered by language
#[command]
pub(crate) async fn get_voices<R: Runtime>(
    app: AppHandle<R>,
    payload: GetVoicesRequest,
) -> Result<GetVoicesResponse> {
    app.tts().get_voices(payload)
}

/// Check if TTS is currently speaking
#[command]
pub(crate) async fn is_speaking<R: Runtime>(app: AppHandle<R>) -> Result<IsSpeakingResponse> {
    app.tts().is_speaking()
}

/// Check if TTS engine is initialized and ready
#[command]
pub(crate) async fn is_initialized<R: Runtime>(app: AppHandle<R>) -> Result<IsInitializedResponse> {
    app.tts().is_initialized()
}

/// Pause the current speech (mobile only, desktop will return error)
#[command]
pub(crate) async fn pause_speaking<R: Runtime>(app: AppHandle<R>) -> Result<PauseResumeResponse> {
    app.tts().pause_speaking()
}

/// Resume paused speech (mobile only, desktop will return error)
#[command]
pub(crate) async fn resume_speaking<R: Runtime>(app: AppHandle<R>) -> Result<PauseResumeResponse> {
    app.tts().resume_speaking()
}

/// Preview a voice by speaking a sample text
#[command]
pub(crate) async fn preview_voice<R: Runtime>(
    app: AppHandle<R>,
    payload: PreviewVoiceRequest,
) -> Result<SpeakResponse> {
    app.tts().preview_voice(payload)
}

/// Register the native event relay channel (mobile only, no-op on desktop).
/// Must be called once before listening with `onSpeechEvent`.
#[command]
pub(crate) async fn register_listener<R: Runtime>(app: AppHandle<R>) -> Result<()> {
    #[cfg(not(mobile))]
    let _ = app;
    #[cfg(mobile)]
    {
        let app_clone = app.clone();
        app.tts().setup_event_relay(&app_clone)?;
    }
    Ok(())
}

/// Set whether TTS should continue in background when screen locks (mobile only)
#[command]
pub(crate) async fn set_background_behavior<R: Runtime>(
    app: AppHandle<R>,
    payload: SetBackgroundBehaviorRequest,
) -> Result<SetBackgroundBehaviorResponse> {
    app.tts().set_background_behavior(payload)
}