开始使用

安装

bun add @capgo/capacitor-speech-synthesis
bunx cap sync

导入

import { SpeechSynthesis } from '@capgo/capacitor-speech-synthesis';

API 介绍

speak

使用指定选项朗读给定的文本。 朗读的内容会被添加到语音队列中。

import { SpeechSynthesis } from '@capgo/capacitor-speech-synthesis';

const result = await SpeechSynthesis.speak({
  text: 'Hello, world!',
  language: 'en-US',
  rate: 1.0,
  pitch: 1.0,
  volume: 1.0,
  queueStrategy: 'Add'
});
console.log('Utterance ID:', result.utteranceId);

synthesizeToFile

合成语音到音频文件（仅限 Android/iOS）。 返回音频文件的保存路径。

import { SpeechSynthesis } from '@capgo/capacitor-speech-synthesis';

const result = await SpeechSynthesis.synthesizeToFile({
  text: 'Hello, world!',
  language: 'en-US'
});
console.log('Audio file saved at:', result.filePath);

cancel

取消所有排队的语音和停止当前语音。

import { SpeechSynthesis } from '@capgo/capacitor-speech-synthesis';

await SpeechSynthesis.cancel();

pause

立即暂停语音。

import { SpeechSynthesis } from '@capgo/capacitor-speech-synthesis';

await SpeechSynthesis.pause();

resume

恢复暂停的语音。

import { SpeechSynthesis } from '@capgo/capacitor-speech-synthesis';

await SpeechSynthesis.resume();

isSpeaking

检查语音合成是否正在说话。

import { SpeechSynthesis } from '@capgo/capacitor-speech-synthesis';

const { isSpeaking } = await SpeechSynthesis.isSpeaking();
console.log('Is speaking:', isSpeaking);

isAvailable

检查设备上语音合成是否可用。

import { SpeechSynthesis } from '@capgo/capacitor-speech-synthesis';

const { isAvailable } = await SpeechSynthesis.isAvailable();
if (isAvailable) {
  console.log('Speech synthesis is available');
}

getVoices

获取所有可用的语音。

import { SpeechSynthesis } from '@capgo/capacitor-speech-synthesis';

const { voices } = await SpeechSynthesis.getVoices();
voices.forEach(voice => {
  console.log(`${voice.name} (${voice.language})`);
});

getLanguages

获取所有可用的语言。

import { SpeechSynthesis } from '@capgo/capacitor-speech-synthesis';

const { languages } = await SpeechSynthesis.getLanguages();
console.log('Available languages:', languages);

isLanguageAvailable

检查特定语言是否可用。

import { SpeechSynthesis } from '@capgo/capacitor-speech-synthesis';

const { isAvailable } = await SpeechSynthesis.isLanguageAvailable({
  language: 'es-ES'
});
console.log('Spanish available:', isAvailable);

isVoiceAvailable

检查特定语音是否可用。

import { SpeechSynthesis } from '@capgo/capacitor-speech-synthesis';

const { isAvailable } = await SpeechSynthesis.isVoiceAvailable({
  voiceId: 'com.apple.ttsbundle.Samantha-compact'
});
console.log('Voice available:', isAvailable);

initialize

初始化语音合成引擎（iOS优化）。 这可以减少首次语音请求的延迟。

import { SpeechSynthesis } from '@capgo/capacitor-speech-synthesis';

await SpeechSynthesis.initialize();

activateAudioSession

激活音频会话（iOS only）

import { SpeechSynthesis } from '@capgo/capacitor-speech-synthesis';

await SpeechSynthesis.activateAudioSession({
  category: 'Playback'
});

deactivateAudioSession

取消激活音频会话（iOS only）

import { SpeechSynthesis } from '@capgo/capacitor-speech-synthesis';

await SpeechSynthesis.deactivateAudioSession();

类型参考

SpeakOptions

用于说话文本的选项

export interface SpeakOptions {
  /**
   * The text to speak.
   *
   * @since 1.0.0
   */
  text: string;

  /**
   * The BCP-47 language tag (e.g., 'en-US', 'es-ES').
   *
   * @since 1.0.0
   */
  language?: string;

  /**
   * The voice identifier to use.
   *
   * @since 1.0.0
   */
  voiceId?: string;

  /**
   * The pitch of the voice (0.5 to 2.0, default: 1.0).
   *
   * @since 1.0.0
   */
  pitch?: number;

  /**
   * The speaking rate (0.1 to 10.0, default: 1.0).
   *
   * @since 1.0.0
   */
  rate?: number;

  /**
   * The volume (0.0 to 1.0, default: 1.0).
   *
   * @since 1.0.0
   */
  volume?: number;

  /**
   * The queue strategy: 'Add' to append or 'Flush' to replace queue.
   * Default: 'Add'
   *
   * @since 1.0.0
   */
  queueStrategy?: 'Add' | 'Flush';
}

SpeakResult

从文本中获取的结果。

export interface SpeakResult {
  /**
   * Unique identifier for this utterance.
   *
   * @since 1.0.0
   */
  utteranceId: string;
}

SynthesizeToFileResult

将文本合成到文件中的结果。

export interface SynthesizeToFileResult {
  /**
   * The file path where audio was saved.
   *
   * @since 1.0.0
   */
  filePath: string;

  /**
   * Unique identifier for this utterance.
   *
   * @since 1.0.0
   */
  utteranceId: string;
}

VoiceInfo

复制到剪贴板

export interface VoiceInfo {
  /**
   * Unique voice identifier.
   *
   * @since 1.0.0
   */
  id: string;

  /**
   * Display name of the voice.
   *
   * @since 1.0.0
   */
  name: string;

  /**
   * BCP-47 language code.
   *
   * @since 1.0.0
   */
  language: string;

  /**
   * Gender of the voice (iOS only).
   *
   * @since 1.0.0
   */
  gender?: 'male' | 'female' | 'neutral';

  /**
   * Whether this voice requires a network connection.
   *
   * @since 1.0.0
   */
  isNetworkConnectionRequired?: boolean;

  /**
   * Whether this is the default voice (Web only).
   *
   * @since 1.0.0
   */
  default?: boolean;
}

IsLanguageAvailableOptions

复制到剪贴板

export interface IsLanguageAvailableOptions {
  /**
   * The BCP-47 language code to check.
   *
   * @since 1.0.0
   */
  language: string;
}

IsVoiceAvailableOptions

检查语音可用性的选项。

export interface IsVoiceAvailableOptions {
  /**
   * The voice ID to check.
   *
   * @since 1.0.0
   */
  voiceId: string;
}

ActivateAudioSessionOptions

激活音频会话（仅限iOS）的选项。

export interface ActivateAudioSessionOptions {
  /**
   * The audio session category.
   * - 'Ambient': Mixes with other audio
   * - 'Playback': Stops other audio
   *
   * @since 1.0.0
   */
  category: 'Ambient' | 'Playback';
}

UtteranceEvent

发音开始或结束时发出的事件。

export interface UtteranceEvent {
  /**
   * The utterance identifier.
   *
   * @since 1.0.0
   */
  utteranceId: string;
}

BoundaryEvent

发音界限处发出的事件。

export interface BoundaryEvent {
  /**
   * The utterance identifier.
   *
   * @since 1.0.0
   */
  utteranceId: string;

  /**
   * The character index in the text.
   *
   * @since 1.0.0
   */
  charIndex: number;

  /**
   * The character length of the current word.
   *
   * @since 1.0.0
   */
  charLength?: number;
}

ErrorEvent

在合成错误时发射的事件。

export interface ErrorEvent {
  /**
   * The utterance identifier.
   *
   * @since 1.0.0
   */
  utteranceId: string;

  /**
   * The error message.
   *
   * @since 1.0.0
   */
  error: string;
}

真实来源

本页面由插件生成。 src/definitions.ts当公共API上游更改时，请重新运行同步。