chrome.ttsEngine

Descrizione

Autorizzazioni

Concetti e utilizzo

Un'estensione può registrarsi come motore vocale. In questo modo, può intercettare alcune o tutte le chiamate a funzioni come tts.speak() e tts.stop() e fornire un'implementazione alternativa. Le estensioni possono utilizzare qualsiasi tecnologia web disponibile per fornire contenuti vocali, incluso lo streaming audio da un server e l'audio HTML5. Un'estensione potrebbe anche fare qualcosa di diverso con le espressioni enunciate, ad esempio visualizzare sottotitoli codificati in un popup o inviarli come messaggi di log a un server remoto.

Per implementare un motore TTS, un'estensione deve dichiarare l'autorizzazione "ttsEngine" e poi dichiarare tutte le voci che fornisce nel manifest dell'estensione, in questo modo:

{
  "name": "My TTS Engine",
  "version": "1.0",
  "permissions": ["ttsEngine"],
  "tts_engine": {
    "voices": [
      {
        "voice_name": "Alice",
        "lang": "en-US",
        "event_types": ["start", "marker", "end"]
      },
      {
        "voice_name": "Pat",
        "lang": "en-US",
        "event_types": ["end"]
      }
    ]
  },
  "background": {
    "page": "background.html",
    "persistent": false
  }
}

Un'estensione può specificare un numero qualsiasi di voci.

Il parametro voice_name è obbligatorio. Il nome deve essere sufficientemente descrittivo da identificare il nome della voce e il motore utilizzato. Nell'improbabile caso che due estensioni registrino voci con lo stesso nome, un client può specificare l'ID dell'estensione che deve eseguire la sintesi.

Il parametro lang è facoltativo, ma vivamente consigliato. Quasi sempre, una voce è in grado di sintetizzare il parlato in un'unica lingua. Quando un motore supporta più lingue, può registrare facilmente una voce separata per ogni lingua. Nei rari casi in cui una singola voce è in grado di gestire più lingue, è più semplice elencare due voci separate e gestirle utilizzando la stessa logica internamente. Tuttavia, se vuoi creare una voce che gestisca le espressioni in qualsiasi lingua, escludi il parametro lang dal file manifest dell'estensione.

Infine, il parametro event_types è obbligatorio se il motore può inviare eventi per aggiornare il client sull'avanzamento della sintesi vocale. Come minimo, consigliamo vivamente di supportare il tipo di evento 'end' per indicare quando la voce è finita, altrimenti Chrome non può pianificare enunciati in coda.

Una volta caricata, un'estensione può sostituire l'elenco di voci dichiarate chiamando chrome.ttsEngine.updateVoices. (Tieni presente che i parametri utilizzati nella chiamata di programmazione a updateVoices sono in caso di cammello: ad es. voiceName, a differenza del file manifest che utilizza voice_name.)

I possibili tipi di eventi che puoi inviare corrispondono ai tipi di eventi che il metodo speak() riceve:

• 'start': il motore ha iniziato a pronunciare l'espressione.
• 'word': è stato raggiunto un limite di parola. Usa event.charIndex per determinare la posizione attuale del parlato.
• 'sentence': è stato raggiunto un limite della frase. Usa event.charIndex per determinare la posizione attuale del parlato.
• 'marker': è stato raggiunto un indicatore SSML. Usa event.charIndex per determinare la posizione attuale del parlato.
• 'end': il motore ha finito di pronunciare l'espressione.
• 'error': si è verificato un errore specifico del motore e questa espressione non può essere pronunciata. Trasmetti più informazioni in event.errorMessage.

Gli eventi 'interrupted' e 'cancelled' non vengono inviati dal motore vocale, ma generati automaticamente da Chrome.

I client di sintesi vocale possono recuperare le informazioni vocali dal manifest dell'estensione chiamando tts.getVoices, supponendo che tu abbia registrato i listener di eventi vocali come descritto di seguito.

Gestire gli eventi vocali

Per generare contenuti vocali su richiesta dei client, l'estensione deve registrare i listener sia per onSpeak che per onStop, in questo modo:

const speakListener = (utterance, options, sendTtsEvent) => {
  sendTtsEvent({type: 'start', charIndex: 0})

  // (start speaking)

  sendTtsEvent({type: 'end', charIndex: utterance.length})
};

const stopListener = () => {
  // (stop all speech)
};

chrome.ttsEngine.onSpeak.addListener(speakListener);
chrome.ttsEngine.onStop.addListener(stopListener);

La decisione di inviare o meno una determinata richiesta vocale a un'estensione dipende esclusivamente dal fatto che l'estensione supporti i parametri vocali specificati nel file manifest e abbia registrato ascoltatori per onSpeak e onStop. In altre parole, un'estensione non può ricevere una richiesta vocale e decidere dinamicamente se gestirla.

chrome.ttsEngine.updateVoices(
  voices: TtsVoice[],
)

chrome.ttsEngine.onPause.addListener(
  callback: function,
)

chrome.ttsEngine.onResume.addListener(
  callback: function,
)

chrome.ttsEngine.onSpeak.addListener(
  callback: function,
)

chrome.ttsEngine.onSpeakWithAudioStream.addListener(
  callback: function,
)

chrome.ttsEngine.onStop.addListener(
  callback: function,
)