chrome.ttsEngine

Deskripsi

Izin

Konsep dan penggunaan

Ekstensi dapat mendaftarkan dirinya sebagai mesin ucapan. Dengan melakukannya, kode dapat mencegat beberapa atau semua panggilan ke fungsi seperti tts.speak() dan tts.stop() serta memberikan implementasi alternatif. Ekstensi bebas menggunakan teknologi web apa pun yang tersedia untuk memberikan ucapan, termasuk streaming audio dari server, audio HTML5. Ekstensi bahkan bisa melakukan sesuatu yang berbeda dengan ucapan tersebut, seperti menampilkan teks tertutup dalam pop-up atau mengirimnya sebagai pesan log ke server jarak jauh.

Untuk menerapkan mesin TTS, ekstensi harus mendeklarasikan "ttsEngine" izin akses dan kemudian mendeklarasikan semua suara yang disediakannya dalam manifes ekstensi, seperti ini:

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

Ekstensi dapat menentukan jumlah suara.

Parameter voice_name wajib diisi. Nama harus cukup deskriptif sehingga dapat mengidentifikasi nama suara dan mesin yang digunakan. Jika dua ekstensi mendaftarkan suara, kemungkinan yang jarang terjadi dengan nama yang sama, klien dapat menentukan ID ekstensi yang harus melakukan sintesis.

Parameter lang bersifat opsional, tetapi sangat direkomendasikan. Hampir selalu, suara dapat menyintesis ucapan hanya dalam satu bahasa. Jika mesin mendukung lebih dari satu bahasa, mesin dapat dengan mudah mendaftarkan suara terpisah untuk setiap bahasa. Dalam situasi yang jarang terjadi, saat satu suara dapat menangani lebih dari satu bahasa, cara termudah adalah cukup mencantumkan dua suara terpisah dan menanganinya menggunakan logika yang sama secara internal. Namun, jika Anda ingin membuat suara yang akan menangani ucapan dalam bahasa, jangan sertakan parameter lang dari manifes ekstensi Anda.

Terakhir, parameter event_types diperlukan jika mesin telusur dapat mengirim peristiwa untuk memperbarui klien tentang kemajuan sintesis ucapan. Setidaknya, mendukung jenis peristiwa 'end' untuk menunjukkan saat ucapan selesai sangat direkomendasikan, jika tidak, Chrome tidak dapat menjadwalkan ucapan dalam antrean.

Setelah dimuat, ekstensi dapat menggantikan daftar suara yang dideklarasikan dengan memanggil chrome.ttsEngine.updateVoices. (Perhatikan bahwa parameter yang digunakan dalam panggilan terprogram ke updateVoices dalam format camel case: misalnya, voiceName, tidak seperti file manifes yang menggunakan voice_name.)

Kemungkinan jenis peristiwa yang dapat Anda kirim sesuai dengan jenis peristiwa yang digunakan oleh metode speak() menerima:

• 'start': Mesin mulai mengucapkan ucapan.
• 'word': Batas kata tercapai. Gunakan event.charIndex untuk menentukan ucapan saat ini posisi Anda.
• 'sentence': Batas kalimat tercapai. Gunakan event.charIndex untuk menentukan posisi ucapan.
• 'marker': Penanda SSML tercapai. Gunakan event.charIndex untuk menentukan ucapan saat ini posisi Anda.
• 'end': Mesin telah selesai mengucapkan ucapan tersebut.
• 'error': Terjadi error khusus mesin dan ucapan ini tidak dapat diucapkan. Lewati lebih banyak informasi di event.errorMessage.

Peristiwa 'interrupted' dan 'cancelled' tidak dikirim oleh mesin ucapan; kunci dibuat secara otomatis oleh Chrome.

Klien text-to-speech bisa mendapatkan informasi suara dari manifes ekstensi Anda dengan memanggil tts.getVoices, dengan asumsi Anda telah mendaftarkan pemroses peristiwa ucapan seperti yang dijelaskan di bawah.

Menangani peristiwa ucapan

Untuk menghasilkan ucapan atas permintaan klien, ekstensi Anda harus mendaftarkan pemroses untuk keduanya onSpeak dan onStop, seperti ini:

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

Keputusan apakah akan mengirimkan permintaan ucapan tertentu ke ekstensi atau tidak hanya didasarkan pada apakah ekstensi mendukung parameter suara yang diberikan dalam manifesnya dan telah terdaftar pemroses untuk onSpeak dan onStop. Dengan kata lain, tidak ada cara bagi ekstensi untuk menerima dan memutuskan secara dinamis apakah akan menanganinya atau tidak.

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