chrome.ttsEngine

Deskripsi

Izin

Konsep dan penggunaan

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

Untuk mengimplementasikan mesin TTS, ekstensi harus mendeklarasikan izin "ttsEngine", lalu mendeklarasikan semua suara yang disediakan 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 berapa pun jumlah suara.

Parameter voice_name wajib diisi. Nama harus cukup deskriptif agar dapat mengidentifikasi nama suara dan mesin yang digunakan. Jika dua ekstensi mendaftarkan suara 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 suara hanya dalam satu bahasa. Saat 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 yang paling mudah 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 apa pun, kosongkan parameter lang dari manifes ekstensi Anda.

Terakhir, parameter event_types diperlukan jika mesin dapat mengirim peristiwa untuk memberi tahu klien tentang progres sintesis ucapan. Setidaknya, mendukung jenis peristiwa 'end' untuk menunjukkan kapan 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 berada dalam camel case: misalnya, voiceName, tidak seperti file manifes yang menggunakan voice_name.)

Kemungkinan jenis peristiwa yang dapat Anda kirim sesuai dengan jenis peristiwa yang diterima metode speak():

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

Peristiwa 'interrupted' dan 'cancelled' tidak dikirim oleh mesin ucapan; peristiwa tersebut 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 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 untuk mengirim permintaan ucapan tertentu ke ekstensi atau tidak hanya didasarkan pada apakah ekstensi mendukung parameter suara tertentu dalam manifesnya dan telah mendaftarkan pemroses untuk onSpeak dan onStop. Dengan kata lain, tidak ada cara bagi ekstensi untuk menerima permintaan ucapan dan secara dinamis memutuskan 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,
)