chrome.tts

Beschrijving

Chrome biedt deze mogelijkheid op Windows (met SAPI 5), Mac OS X en Chrome OS, met behulp van de spraaksynthesemogelijkheden van het besturingssysteem. Op alle platforms kan de gebruiker extensies installeren die zichzelf registreren als alternatieve spraakengines.

Machtigingen

Begrippen en gebruik

Spraak genereren

Roep speak() aan vanuit uw extensie om te spreken. Bijvoorbeeld:

chrome.tts.speak('Hello, world.'); 

Om onmiddellijk te stoppen met spreken, roept u gewoon stop() aan:

chrome.tts.stop(); 

U kunt opties bieden waarmee u verschillende eigenschappen van de spraak kunt regelen, zoals de snelheid, toonhoogte en meer. Bijvoorbeeld:

chrome.tts.speak('Hello, world.', {'rate': 2.0}); 

Het is ook een goed idee om de taal te specificeren, zodat er een synthesizer wordt gekozen die die taal ondersteunt (en eventueel een regionaal dialect).

chrome.tts.speak('Hello, world.', {'lang': 'en-US', 'rate': 2.0}); 

Standaard onderbreekt elke aanroep van speak() alle lopende spraak en spreekt direct. Om te bepalen of een aanroep iets zou onderbreken, kunt u isSpeaking() aanroepen. Daarnaast kunt u de optie enqueue gebruiken om deze uiting toe te voegen aan een wachtrij met uitingen die worden uitgesproken wanneer de huidige uiting is afgelopen.

chrome.tts.speak('Speak this first.'); chrome.tts.speak(     'Speak this next, when the first sentence is done.', {'enqueue': true}); 

Een volledige beschrijving van alle opties is te vinden onder tts.speak() . Niet alle spraakengines ondersteunen alle opties.

Om fouten op te sporen en ervoor te zorgen dat je speak() correct aanroept, geef je een callbackfunctie door die geen argumenten accepteert. Controleer binnen de callback runtime.lastError om te zien of er fouten zijn opgetreden.

chrome.tts.speak(   utterance,   options,   function() {     if (chrome.runtime.lastError) {       console.log('Error: ' + chrome.runtime.lastError.message);     }   } ); 

De callback retourneert direct, voordat de engine spraak begint te genereren. Het doel van de callback is om u te waarschuwen voor syntaxisfouten in uw gebruik van de TTS API, niet om alle mogelijke fouten op te sporen die kunnen optreden tijdens het synthetiseren en uitvoeren van spraak. Om ook deze fouten op te sporen, moet u een event listener gebruiken, die in de volgende sectie wordt beschreven.

Luister naar evenementen

Om meer realtime informatie over de status van gesynthetiseerde spraak te krijgen, kunt u een gebeurtenislistener in de opties van speak() doorgeven, zoals deze:

chrome.tts.speak(   utterance,   {     onEvent: function(event) {       console.log('Event ' + event.type + ' at position ' + event.charIndex);       if (event.type == 'error') {         console.log('Error: ' + event.errorMessage);       }     }   },   callback ); 

Elke gebeurtenis bevat een gebeurtenistype, de tekenindex van de huidige spraak ten opzichte van de uiting en, voor foutgebeurtenissen, een optioneel foutbericht. De gebeurtenistypen zijn:

• 'start' : De engine is begonnen met het uitspreken van de uiting.
• 'word' : Er is een woordgrens bereikt. Gebruik event.charIndex om de huidige spraakpositie te bepalen.
• 'sentence' : Er is een zinsgrens bereikt. Gebruik event.charIndex om de huidige spreekpositie te bepalen.
• 'marker' : Er is een SSML-markering bereikt. Gebruik event.charIndex om de huidige spraakpositie te bepalen.
• 'end' : De engine is klaar met het uitspreken van de uiting.
• 'interrupted' : Deze uiting werd onderbroken door een andere aanroep van speak() of stop() en is niet voltooid.
• 'cancelled' : Deze uiting werd in de wachtrij geplaatst, maar vervolgens geannuleerd door een andere aanroep van speak() of stop() en is nooit meer begonnen met spreken.
• 'error' : Er is een engine-specifieke fout opgetreden en deze uiting kan niet worden uitgesproken. Raadpleeg event.errorMessage voor meer informatie.

Vier van de gebeurtenistypen – 'end' , 'interrupted' , 'cancelled' en 'error' zijn definitief . Nadat een van deze gebeurtenissen is ontvangen, wordt deze uiting niet meer uitgesproken en worden er geen nieuwe gebeurtenissen van deze uiting meer ontvangen.

Sommige stemmen ondersteunen mogelijk niet alle gebeurtenistypen en sommige stemmen verzenden mogelijk helemaal geen gebeurtenissen. Als u een stem alleen wilt gebruiken als deze bepaalde gebeurtenissen verzendt, geeft u de gewenste gebeurtenissen door aan het lid requiredEventTypes van het options-object of gebruikt u getVoices() om een stem te kiezen die aan uw vereisten voldoet. Beide worden hieronder beschreven.

SSML-markering

Uitingen die in deze API worden gebruikt, kunnen markup bevatten met behulp van de Speech Synthesis Markup Language (SSML) . Als u SSML gebruikt, moet het eerste argument van speak() een volledig SSML-document zijn met een XML-header en een <speak> -tag op het hoogste niveau, en geen documentfragment.

Bijvoorbeeld:

chrome.tts.speak(   '<?xml version="1.0"?>' +   '<speak>' +   '  The <emphasis>second</emphasis> ' +   '  word of this sentence was emphasized.' +   '</speak>' ); 

Niet alle spraakengines ondersteunen alle SSML-tags en sommige ondersteunen SSML zelfs helemaal niet. Maar alle engines moeten SSML negeren die ze niet ondersteunen en toch de onderliggende tekst uitspreken.

Kies een stem

Standaard kiest Chrome de meest geschikte stem voor elke uiting die u wilt uitspreken, op basis van de taal. Op de meeste Windows-, Mac OS X- en ChromeOS-systemen zou de spraaksynthese van het besturingssysteem elke tekst in ten minste één taal moeten kunnen uitspreken. Sommige gebruikers hebben echter mogelijk verschillende stemmen beschikbaar, zowel via hun besturingssysteem als via spraakengines die door andere Chrome-extensies zijn geïmplementeerd. In die gevallen kunt u aangepaste code implementeren om de juiste stem te kiezen of de gebruiker een lijst met keuzemogelijkheden te tonen.

Om een lijst met alle stemmen te krijgen, roept u getVoices() aan en geeft u er een functie aan door die een reeks TtsVoice objecten als argument ontvangt:

chrome.tts.getVoices(   function(voices) {     for (var i = 0; i < voices.length; i++) {       console.log('Voice ' + i + ':');       console.log('  name: ' + voices[i].voiceName);       console.log('  lang: ' + voices[i].lang);       console.log('  extension id: ' + voices[i].extensionId);       console.log('  event types: ' + voices[i].eventTypes);     }   } ); 

chrome.tts.getVoices(): Promise<TtsVoice[]>

chrome.tts.isSpeaking(): Promise<boolean>

chrome.tts.pause(): void

chrome.tts.resume(): void

chrome.tts.speak(
  utterance: string,
  options?: TtsOptions,
): Promise<void>

chrome.tts.stop(): void

chrome.tts.onVoicesChanged.addListener(
  callback: function,
)