chrome.ttsEngine

Description

Autorisations

Présentation

Une extension peut s'enregistrer elle-même en tant que moteur de synthèse vocale. Ainsi, il peut intercepter tout ou partie des appels à des fonctions telles que tts.speak et tts.stop et fournissent une autre implémentation. Les extensions peuvent utiliser n'importe quelle technologie Web disponible pour transmettre la voix, y compris le streaming audio. à partir d'un serveur, HTML5. Une extension peut même faire quelque chose de différent avec les énoncés, comme afficher des sous-titres dans une fenêtre pop-up ou les envoyer sous forme de messages de journal à un serveur distant.

Fichier manifeste

Pour implémenter un moteur de synthèse vocale, une extension doit déclarer le moteur "ttsEngine". l'autorisation, puis déclarez toutes qu'il fournit dans le fichier manifeste de l'extension, comme ceci:

{
  "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
  }
}

Une extension peut spécifier un nombre illimité de voix.

Le paramètre voice_name est obligatoire. Le nom doit être suffisamment descriptif pour identifier le nom de la voix et le moteur utilisé. Dans l'éventualité peu probable où deux extensions enregistrent des voix portant le même nom, un client peut spécifier l'identifiant de l'extension qui doit effectuer la synthèse.

Le paramètre lang est facultatif, mais vivement recommandé. Presque toujours, une voix peut synthétiser la parole dans une seule langue. Lorsqu'un moteur prend en charge plusieurs langues, il peut facilement enregistrer une voix distincte pour chaque langue. Dans de rares cas où une seule voix peut gérer plus d'une langue, il est plus simple de répertorier deux voix distinctes et de les gérer en utilisant la même logique en interne. Toutefois, si vous souhaitez créer une voix capable de gérer les énoncés langue, omettez le paramètre lang dans le fichier manifeste de votre extension.

Enfin, le paramètre event_types est obligatoire si le moteur peut envoyer des événements pour mettre à jour le client sur les progrès de la synthèse vocale. Au minimum, la prise en charge du type d'événement 'end' pour indiquer est vivement recommandé lorsque la lecture est terminée. Sinon, Chrome ne pourra pas programmer d'énoncés en file d'attente.

Une fois chargée, une extension peut remplacer la liste des voix déclarées en appelant chrome.ttsEngine.updateVoices (Notez que les paramètres utilisés dans l'appel programmatique pour updateVoices sont en Camel Case ("casse de chameau") : par exemple, voiceName, contrairement au fichier manifeste qui utilise voice_name).

Les types d'événements possibles que vous pouvez envoyer correspondent aux types d'événements que la méthode speak() reçoit:

• 'start': le moteur a commencé à énoncer l'énoncé.
• 'word': une limite de mots a été atteinte. Utiliser event.charIndex pour déterminer la voix actuelle la position de votre annonce.
• 'sentence': une limite de phrase a été atteinte. Utiliser event.charIndex pour déterminer la valeur actuelle la position de la voix.
• 'marker': un repère SSML a été atteint. Utiliser event.charIndex pour déterminer la voix actuelle la position de votre annonce.
• 'end': le moteur a fini de lire l'énoncé.
• 'error': une erreur propre au moteur s'est produite et cet énoncé ne peut pas être énoncé. Réussir plus informations dans event.errorMessage.

Les événements 'interrupted' et 'cancelled' ne sont pas envoyés par le moteur de synthèse vocale. lorsqu'elles sont générées automatiquement par Chrome.

Les clients de synthèse vocale peuvent récupérer les informations vocales dans le fichier manifeste de votre extension en appelant tts.getVoices, en supposant que vous avez enregistré des écouteurs d'événements vocaux comme décrit ci-dessous.

Gérer les événements vocaux

Pour générer du discours à la demande des clients, votre extension doit enregistrer des écouteurs pour onSpeak et onStop, comme ceci:

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 décision d'envoyer ou non une requête vocale donnée à une extension dépend uniquement si l'extension accepte les paramètres vocaux indiqués dans son fichier manifeste et si elle a enregistré pour onSpeak et onStop. En d'autres termes, il n'existe aucun moyen pour une extension de requête vocale et décidez de manière dynamique de la gérer ou non.

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,
)