chrome.ttsEngine

Descrição

Permissões

Conceitos e uso

Uma extensão pode se registrar como um mecanismo de fala. Ao fazer isso, ele pode interceptar algumas ou todas as chamadas a funções como tts.speak() e tts.stop(), além de fornecer uma implementação alternativa. As extensões podem usar qualquer tecnologia da Web disponível para fornecer voz, incluindo streaming de áudio a partir de um servidor, áudio HTML5. Uma extensão pode até fazer algo diferente com os enunciados, como exibir legendas em pop-up ou enviá-los como mensagens de registro um servidor remoto.

Para implementar um mecanismo TTS, uma extensão deve declarar o mecanismo "ttsEngine" a permissão e, em seguida, declarar todas que são fornecidas no manifesto da extensão, da seguinte forma:

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

Uma extensão pode especificar qualquer número de vozes.

O parâmetro voice_name é obrigatório. O nome deve ser descritivo o suficiente para identificar o nome da voz e do mecanismo usado. No caso improvável de duas extensões registrarem vozes com o mesmo nome, um cliente pode especificar o ID da extensão que fará a síntese.

O parâmetro lang é opcional, mas altamente recomendado. Quase sempre, uma voz pode sintetizar fala em um único idioma. Quando um mecanismo aceita mais de um idioma, ele pode facilmente registrar uma voz separada para cada idioma. Em raras circunstâncias em que uma única voz pode lidar com mais de um idioma, é mais fácil listar duas vozes separadas e lidar com elas usando a mesma lógica internamente. No entanto, se você quiser criar uma voz para lidar com enunciados de qualquer desconsidere o parâmetro lang do manifesto da sua extensão.

Por fim, o parâmetro event_types será obrigatório se o mecanismo puder enviar eventos para atualizar o cliente. sobre o progresso da síntese de fala. No mínimo, oferecendo suporte ao tipo de evento 'end' para indicar quando a fala é concluída é altamente recomendado. Caso contrário, o Chrome não pode programar falas na fila.

Depois de carregada, uma extensão pode substituir a lista de vozes declaradas chamando chrome.ttsEngine.updateVoices: Os parâmetros usados na chamada programática para updateVoices estão em letras concatenadas: por exemplo, voiceName, ao contrário do arquivo de manifesto, que usa voice_name.

Os tipos de evento possíveis que você pode enviar correspondem aos tipos de evento que o método speak() recebe:

• 'start': o mecanismo começou a falar o enunciado.
• 'word': um limite de palavras foi atingido. Usar event.charIndex para determinar a fala atual posição
• 'sentence': um limite de frases foi atingido. Use event.charIndex para determinar o na posição da fala.
• 'marker': um marcador SSML foi atingido. Usar event.charIndex para determinar a fala atual posição
• 'end': o mecanismo terminou de falar o enunciado.
• 'error': ocorreu um erro específico do mecanismo, e este enunciado não pode ser falado. Passar mais informações em event.errorMessage.

Os eventos 'interrupted' e 'cancelled' não são enviados pelo mecanismo de fala. eles são gerados automaticamente pelo Chrome.

Os clientes de conversão de texto em voz podem receber as informações de voz do manifesto da sua extensão chamando tts.getVoices, supondo que você tenha registrado listeners de eventos de fala conforme descrito abaixo.

Processar eventos de fala

Para gerar fala a pedido dos clientes, sua extensão precisa registrar listeners para ambos onSpeak e onStop, assim:

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

A decisão de enviar ou não uma determinada solicitação de fala a uma extensão é baseada apenas no se a extensão é compatível com os parâmetros de voz fornecidos em seu manifesto e se registrou listeners para onSpeak e onStop. Em outras palavras, uma extensão não pode receber uma solicitação de fala e decide dinamicamente se vai processá-la.

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