chrome.ttsEngine

Descripción

Permisos

Conceptos y uso

Una extensión puede registrarse por sí misma 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 pueden usar cualquier tecnología web disponible para proporcionar voz, incluida la transmisión de audio desde un servidor, 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 atributo "ttsEngine" permiso y, luego, declarar todos voces que proporciona en el manifiesto de extensiones, 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 improbable caso 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. Casi siempre, una voz puede sintetizar la voz en un solo idioma. Cuando un motor admite más de un idioma, puede una voz independiente para cada idioma. En raras ocasiones, cuando una sola voz puede manejar más de un idioma, es más fácil enumerar dos voces distintas y manejarlas usando la misma lógica internamente. Sin embargo, si deseas crear una voz que se encargue de las declaraciones en cualquier idioma, omite el parámetro lang del manifiesto de tu extensión.

Por último, se requiere el parámetro event_types si el motor puede enviar eventos para actualizar el cliente sobre el progreso de la síntesis de voz. Como mínimo, debes admitir el tipo de evento 'end' para indicar cuando finaliza la voz es muy recomendable. De lo contrario, Chrome no podrá programar las declaraciones en cola.

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

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

• 'start': El motor comenzó a pronunciar la declaración.
• 'word': Se alcanzó un límite de palabras. Usa event.charIndex para determinar la voz actual. posición.
• 'sentence': Se alcanzó un límite de oraciones. Usa event.charIndex para determinar el valor actual posición de voz.
• 'marker': Se alcanzó un marcador de SSML. Usa event.charIndex para determinar la voz actual. posición.
• 'end': El motor terminó de pronunciar la declaración.
• 'error': se produjo un error específico del motor y no se puede pronunciar esta declaración. Pasar más información en event.errorMessage.

El motor de voz no envía los eventos 'interrupted' y 'cancelled'. se generan automáticamente.

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

Cómo controlar eventos de voz

Para generar voz a pedido de los clientes, tu extensión debe registrar objetos de escucha para ambos 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 determinada solicitud de voz a una extensión se basa únicamente en si la extensión admite los parámetros de voz indicados en su manifiesto y se registró objetos de escucha para onSpeak y onStop. En otras palabras, no hay forma de que una extensión reciba una una solicitud de voz y decidir de forma dinámica si la manejará o no.

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