chrome.ttsEngine

Descripción

Permisos

Conceptos y uso

Una extensión se puede registrar como un motor de voz. De esta manera, puede interceptar algunas o todas las llamadas a funciones como tts.speak() y tts.stop(), y proporcionar una implementación alternativa. Las extensiones son gratuitas y pueden usar cualquier tecnología web disponible para proporcionar voz, incluida la transmisión de audio desde un servidor o audio HTML5. Una extensión incluso podría hacer algo diferente con las expresiones, como mostrar subtítulos en una ventana emergente o enviarlos como mensajes de registro a un servidor remoto.

Para implementar un motor de TTS, una extensión debe declarar el permiso "ttsEngine" y, luego, todas las voces que proporciona en el manifiesto de la extensión de la siguiente manera:

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

Una extensión puede especificar cualquier cantidad de voces.

El parámetro voice_name es obligatorio. El nombre debe ser lo suficientemente descriptivo como para identificar el nombre de la voz y el motor utilizado. En el caso improbable de que dos extensiones registren voces con el mismo nombre, un cliente puede especificar el ID de la extensión que debería realizar la síntesis.

El parámetro lang es opcional, pero se recomienda incluirlo. Casi siempre, una voz puede sintetizar la voz en un solo idioma. Cuando un motor admite más de un idioma, puede registrar fácilmente una voz independiente para cada uno. En circunstancias excepcionales, en las que una sola voz puede manejar más de un idioma, es más fácil enumerar dos voces distintas y manejarlas con la misma lógica internamente. Sin embargo, si deseas crear una voz que controle las declaraciones en cualquier idioma, omite el parámetro lang del manifiesto de tu extensión.

Por último, el parámetro event_types es obligatorio si el motor puede enviar eventos para actualizar al cliente sobre el progreso de la síntesis de voz. Se recomienda como mínimo admitir el tipo de evento 'end' para indicar cuándo finaliza la voz. De lo contrario, Chrome no podrá programar las declaraciones en cola.

Una vez cargada, una extensión puede llamar a chrome.ttsEngine.updateVoices para reemplazar la lista de voces declaradas. (Ten en cuenta que los parámetros que se usan en la llamada programática a updateVoices están en mayúsculas mediales, p.ej., voiceName, a diferencia del archivo de manifiesto que usa voice_name).

Los tipos de eventos posibles que puedes enviar corresponden a los tipos de eventos que recibe el método speak():

• 'start': El motor comenzó a decir el enunciado.
• 'word': Se alcanzó el límite de una palabra. Usa event.charIndex para determinar la posición de voz actual.
• 'sentence': Se alcanzó el límite de una oración. Usa event.charIndex para determinar la posición de voz actual.
• 'marker': Se alcanzó un marcador de SSML. Usa event.charIndex para determinar la posición de voz actual.
• 'end': El motor terminó de decir el enunciado.
• 'error': Se produjo un error específico del motor y no se puede pronunciar este enunciado. Pasa más información en event.errorMessage.

El motor de voz no envía los eventos 'interrupted' y 'cancelled', sino que Chrome los genera automáticamente.

Los clientes de texto a voz pueden obtener la información de voz del manifiesto de tu extensión si llaman a tts.getVoices, suponiendo que registraste objetos de escucha de eventos de voz como se describe a continuación.

Controla eventos de voz

Para generar voz a pedido de los clientes, tu extensión debe registrar objetos de escucha para onSpeak y onStop, de la siguiente manera:

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 decisión de enviar o no una solicitud de voz determinada a una extensión se basa únicamente en si la extensión admite los parámetros de voz determinados en su manifiesto y si tiene objetos de escucha registrados para onSpeak y onStop. En otras palabras, no hay forma de que una extensión reciba una solicitud de voz y decida de forma dinámica si la maneja.

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