chrome.ttsEngine

คำอธิบาย

ใช้ chrome.ttsEngine API เพื่อติดตั้งใช้งานเครื่องมืออ่านออกเสียงข้อความ(TTS) โดยใช้ส่วนขยาย หากส่วนขยายลงทะเบียนโดยใช้ API นี้ ส่วนขยายจะได้รับเหตุการณ์ที่มีข้อความที่จะพูดและพารามิเตอร์อื่นๆ เมื่อส่วนขยายหรือแอป Chrome ใดก็ตามใช้ tts API เพื่อสร้างคำพูด จากนั้นส่วนขยายจะใช้เทคโนโลยีเว็บที่มีอยู่เพื่อสังเคราะห์และส่งออกคำพูด รวมถึงส่งเหตุการณ์กลับไปยังฟังก์ชันการเรียกเพื่อรายงานสถานะ

สิทธิ์

ttsEngine

แนวคิดและการใช้งาน

ส่วนขยายสามารถลงทะเบียนตัวเองเป็น Speech Engine ได้ การทำเช่นนี้จะช่วยดักจับการเรียกฟังก์ชันบางส่วนหรือทั้งหมด เช่น tts.speak() และ tts.stop() และให้การใช้งานทางเลือก ส่วนขยายสามารถใช้เทคโนโลยีเว็บที่มีอยู่เพื่อให้บริการเสียงพูดได้ฟรี ซึ่งรวมถึงการสตรีมเสียงจากเซิร์ฟเวอร์และเสียง HTML5 ส่วนขยายอาจทำสิ่งต่างๆ กับคำพูดได้ด้วย เช่น แสดงคำบรรยายแทนเสียงในป๊อปอัปหรือส่งเป็นข้อความบันทึกไปยังเซิร์ฟเวอร์ระยะไกล

หากต้องการใช้เอ็นจิน TTS ส่วนขยายต้องประกาศสิทธิ์ "ttsEngine" แล้วประกาศเสียงทั้งหมด ที่ส่วนขยายมีในไฟล์ Manifest ของส่วนขยาย ดังนี้

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

ส่วนขยายสามารถระบุจำนวนเสียงได้

ต้องระบุพารามิเตอร์ voice_name ชื่อควรสื่อความหมายมากพอที่จะระบุ ชื่อของเสียงและเครื่องมือที่ใช้ ในกรณีที่เกิดขึ้นไม่บ่อยนัก หากส่วนขยาย 2 รายการลงทะเบียนเสียง ที่มีชื่อเดียวกัน ไคลเอ็นต์จะระบุรหัสของส่วนขยายที่ควรทำการสังเคราะห์ได้

พารามิเตอร์ lang จะใส่หรือไม่ใส่ก็ได้ แต่เราขอแนะนำเป็นอย่างยิ่งให้ใส่ โดยส่วนใหญ่แล้ว เสียงจะสังเคราะห์ คำพูดได้ในภาษาเดียวเท่านั้น เมื่อเครื่องยนต์รองรับมากกว่า 1 ภาษา ก็จะลงทะเบียนเสียงแยกต่างหากสำหรับแต่ละภาษาได้อย่างง่ายดาย ในกรณีที่พบได้ยากซึ่งเสียงเดียวสามารถ รองรับได้มากกว่า 1 ภาษา วิธีที่ง่ายที่สุดคือการระบุเสียงแยกกัน 2 เสียงและจัดการเสียงเหล่านั้นโดยใช้ ตรรกะเดียวกันภายใน อย่างไรก็ตาม หากต้องการสร้างเสียงที่จะจัดการคำพูดในภาษาใดก็ได้ ให้เว้นพารามิเตอร์ lang ไว้ในไฟล์ Manifest ของส่วนขยาย

สุดท้ายนี้ ต้องระบุพารามิเตอร์ event_types หากเครื่องมือส่งเหตุการณ์เพื่ออัปเดตความคืบหน้าของการสังเคราะห์เสียงให้ไคลเอ็นต์ได้ ขอแนะนำให้รองรับ'end'ประเภทเหตุการณ์เพื่อระบุ เมื่อพูดจบแล้วเป็นอย่างน้อย ไม่เช่นนั้น Chrome จะกำหนดเวลาการออกเสียงที่อยู่ในคิวไม่ได้

เมื่อโหลดแล้ว ส่วนขยายจะแทนที่รายการเสียงที่ประกาศได้โดยการเรียกใช้ chrome.ttsEngine.updateVoices (โปรดทราบว่าพารามิเตอร์ที่ใช้ในการเรียกแบบเป็นโปรแกรมไปยัง updateVoices จะอยู่ในรูปแบบ Camel Case เช่น voiceName ซึ่งแตกต่างจากไฟล์ Manifest ที่ใช้ voice_name)

หมายเหตุ: หากเครื่องมือ TTS ไม่รองรับประเภทเหตุการณ์ 'end' Chrome จะจัดคิวคำพูดไม่ได้ เนื่องจากไม่มีวิธีทราบว่าคำพูดของคุณสิ้นสุดเมื่อใด Chrome จะส่งตัวเลือกบูลีน enqueue เพิ่มเติมไปยังตัวแฮนเดิล onSpeak ของเครื่องมือ เพื่อให้คุณมีตัวเลือกในการใช้การจัดคิวของคุณเอง เราไม่แนะนำให้ทำเช่นนี้เนื่องจากไคลเอ็นต์จะไม่สามารถจัดคิวข้อความที่ควรพูดโดยเครื่องมือการพูดที่แตกต่างกันได้

ประเภทเหตุการณ์ที่คุณส่งได้จะสอดคล้องกับประเภทเหตุการณ์ที่เมธอด speak() ได้รับ ดังนี้

• 'start': เครื่องยนต์เริ่มพูดคำพูดแล้ว
• 'word': ถึงขอบเขตของคำแล้ว ใช้ event.charIndex เพื่อกำหนดตำแหน่งคำพูดปัจจุบัน
• 'sentence': ถึงขอบเขตประโยคแล้ว ใช้ event.charIndex เพื่อระบุตำแหน่งคำพูดปัจจุบัน
• 'marker': ถึงเครื่องหมาย SSML แล้ว ใช้ event.charIndex เพื่อกำหนดตำแหน่งคำพูดปัจจุบัน
• 'end': เครื่องยนต์พูดข้อความจบแล้ว
• 'error': เกิดข้อผิดพลาดเฉพาะเครื่องมือและพูดคำนี้ไม่ได้ ส่งข้อมูลเพิ่มเติมใน event.errorMessage

เครื่องมือ Speech จะไม่ส่งเหตุการณ์ 'interrupted' และ 'cancelled' แต่ Chrome จะสร้างเหตุการณ์เหล่านี้โดยอัตโนมัติ

ไคลเอ็นต์ข้อความเป็นเสียงพูดจะรับข้อมูลเสียงจากไฟล์ Manifest ของส่วนขยายได้โดยการเรียกใช้ tts.getVoices โดยสมมติว่าคุณได้ลงทะเบียนเครื่องมือฟังเหตุการณ์การพูดตามที่อธิบายไว้ด้านล่าง

จัดการเหตุการณ์การพูด

หากต้องการสร้างคำพูดตามคำขอของไคลเอ็นต์ ส่วนขยายของคุณต้องลงทะเบียน Listener สำหรับทั้ง onSpeak และ onStop ดังนี้

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

ข้อควรระวัง: หากส่วนขยายไม่ได้ลงทะเบียน Listener สำหรับทั้ง onSpeak และ onStop ส่วนขยายจะไม่สกัดกั้นการเรียกใช้ Speech ใดๆ ไม่ว่าจะมีอะไรอยู่ในไฟล์ Manifest ก็ตาม

การตัดสินใจว่าจะส่งคำขอการพูดที่ระบุไปยังส่วนขยายหรือไม่นั้นขึ้นอยู่กับว่าส่วนขยายรองรับพารามิเตอร์เสียงที่ระบุในไฟล์ Manifest และได้ลงทะเบียน Listener สำหรับ onSpeak และ onStop หรือไม่ กล่าวอีกนัยหนึ่งคือไม่มีวิธีใดที่ส่วนขยายจะรับคำขอพูดและตัดสินใจแบบไดนามิกว่าจะจัดการหรือไม่

ประเภท

AudioBuffer

Chrome 92 ขึ้นไป

พารามิเตอร์ที่มีบัฟเฟอร์เสียงและข้อมูลที่เกี่ยวข้อง

พร็อพเพอร์ตี้

• audioBuffer

  ArrayBuffer

  บัฟเฟอร์เสียงจากเครื่องมืออ่านออกเสียงข้อความ โดยควรมีความยาวเท่ากับ audioStreamOptions.bufferSize และเข้ารหัสเป็นโมโนที่ audioStreamOptions.sampleRate และเป็นแบบ PCM เชิงเส้น, 32 บิตแบบมีเครื่องหมายทศนิยม เช่น ประเภท Float32Array ใน JavaScript

• charIndex

  หมายเลข ไม่บังคับ

  ดัชนีอักขระที่เชื่อมโยงกับบัฟเฟอร์เสียงนี้

• isLastBuffer

  บูลีน ไม่บังคับ

  เป็นจริงหากบัฟเฟอร์เสียงนี้เป็นบัฟเฟอร์สุดท้ายสำหรับข้อความที่กำลังพูด

AudioStreamOptions

Chrome 92 ขึ้นไป

มีรูปแบบสตรีมเสียงที่เครื่องมือคาดว่าจะสร้าง

พร็อพเพอร์ตี้

• bufferSize

  ตัวเลข

  จำนวนตัวอย่างภายในบัฟเฟอร์เสียง

• sampleRate

  ตัวเลข

  อัตราการสุ่มตัวอย่างที่คาดไว้ในบัฟเฟอร์เสียง

LanguageInstallStatus

Chrome 132 ขึ้นไป

สถานะการติดตั้งเสียง

ค่าแจกแจง

"notInstalled"

"กำลังติดตั้ง"

"ติดตั้งแล้ว"

"ล้มเหลว"

LanguageStatus

Chrome 132 ขึ้นไป

สถานะการติดตั้งของภาษา

พร็อพเพอร์ตี้

• ข้อผิดพลาด

  สตริง ไม่บังคับ

  รายละเอียดเกี่ยวกับการติดตั้งที่ไม่สำเร็จ ระบุหรือไม่ก็ได้หากติดตั้งภาษาไม่สำเร็จ

• installStatus

  LanguageInstallStatus

  สถานะการติดตั้ง

• lang

  สตริง

  สตริงภาษาในรูปแบบรหัสภาษา-รหัสภูมิภาค โดยอาจละเว้นภูมิภาคได้ ตัวอย่างเช่น en, en-AU, zh-CH

LanguageUninstallOptions

Chrome 132 ขึ้นไป

ตัวเลือกสำหรับการถอนการติดตั้งภาษาที่ต้องการ

พร็อพเพอร์ตี้

• uninstallImmediately

  บูลีน

  จริงหากไคลเอ็นต์ TTS ต้องการถอนการติดตั้งภาษาทันที เครื่องมืออาจเลือกได้ว่าจะถอนการติดตั้งภาษาเมื่อใด โดยอิงตามพารามิเตอร์นี้และข้อมูลผู้ขอ หากเป็นเท็จ ระบบอาจใช้เกณฑ์อื่นๆ เช่น การใช้งานล่าสุด เพื่อพิจารณาเวลาที่จะถอนการติดตั้ง

SpeakOptions

Chrome 92 ขึ้นไป

ตัวเลือกที่ระบุให้กับเมธอด tts.speak()

พร็อพเพอร์ตี้

• gender

  VoiceGender ไม่บังคับ

  เลิกใช้งานตั้งแต่ Chrome 92

  ระบบเลิกใช้งานเพศแล้วและจะไม่สนใจ

  เพศของเสียงสำหรับคำพูดที่สังเคราะห์

• lang

  สตริง ไม่บังคับ

  ภาษาที่จะใช้สำหรับการสังเคราะห์ในรูปแบบ language-region ตัวอย่าง: "en", "en-US", "en-GB", "zh-CN"

• พิช

  หมายเลข ไม่บังคับ

  ระดับเสียงพูดอยู่ระหว่าง 0 ถึง 2 โดย 0 คือต่ำสุดและ 2 คือสูงสุด 1.0 สอดคล้องกับระดับเสียงเริ่มต้นของเสียงนี้

• อัตรา

  หมายเลข ไม่บังคับ

  อัตราการพูดที่สัมพันธ์กับอัตราเริ่มต้นสำหรับเสียงนี้ 1.0 คืออัตราเริ่มต้น ซึ่งโดยปกติจะอยู่ที่ประมาณ 180-220 คำต่อนาที 2.0 คือเร็วขึ้น 2 เท่า และ 0.5 คือช้าลงครึ่งหนึ่ง ค่านี้รับประกันว่าจะอยู่ระหว่าง 0.1 ถึง 10.0 (รวม) เมื่อเสียงไม่รองรับช่วงอัตรานี้ทั้งหมด อย่าแสดงข้อผิดพลาด แต่ให้ตัดอัตราการพูดให้อยู่ในช่วงที่เสียงรองรับ

• voiceName

  สตริง ไม่บังคับ

  ชื่อของเสียงที่จะใช้ในการสังเคราะห์

• ระดับเสียง

  หมายเลข ไม่บังคับ

  ระดับเสียงพูดระหว่าง 0 ถึง 1 โดย 0 คือระดับต่ำสุดและ 1 คือระดับสูงสุด และค่าเริ่มต้นคือ 1.0

TtsClient

Chrome 131 ขึ้นไป

ตัวระบุสำหรับไคลเอ็นต์ที่ขอสถานะ

พร็อพเพอร์ตี้

• id

  สตริง

  ไคลเอ็นต์ส่งคำขอการจัดการภาษา สำหรับส่วนขยาย นี่คือรหัสส่วนขยายที่ไม่ซ้ำกัน สำหรับฟีเจอร์ของ Chrome นี่คือชื่อที่มนุษย์อ่านได้ของฟีเจอร์

• source

  TtsClientSource

  ประเภทผู้ขอ

TtsClientSource

Chrome 131 ขึ้นไป

ประเภทผู้ขอ

ค่าแจกแจง

"chromefeature"

"ส่วนขยาย"

VoiceGender

Chrome 54 ขึ้นไป เลิกใช้งานตั้งแต่ Chrome 70

ระบบเลิกใช้งานเพศแล้วและจะไม่สนใจ

ค่าแจกแจง

"ชาย"

"female"

เมธอด

updateLanguage()

Chrome 132 ขึ้นไป

chrome.ttsEngine.updateLanguage(
  status: LanguageStatus,
): void

เรียกใช้โดยเครื่องมือเมื่อมีการพยายามติดตั้งภาษาและเมื่อมีการถอนการติดตั้งภาษา เรียกใช้เพื่อตอบสนองต่อคำขอสถานะจากไคลเอ็นต์ด้วย เมื่อมีการติดตั้งหรือถอนการติดตั้งเสียง เครื่องมือควรเรียกใช้ ttsEngine.updateVoices เพื่อลงทะเบียนเสียงด้วย

พารามิเตอร์

• สถานะ

  LanguageStatus

  สถานะการติดตั้งของภาษา

updateVoices()

Chrome 66 ขึ้นไป

chrome.ttsEngine.updateVoices(
  voices: TtsVoice[],
): void

เรียกใช้โดยเครื่องมือเพื่ออัปเดตรายการเสียง รายการนี้จะลบล้างเสียงที่ประกาศไว้ในไฟล์ Manifest ของส่วนขยายนี้

พารามิเตอร์

• เสียง

  TtsVoice[]

  อาร์เรย์ของออบเจ็กต์ tts.TtsVoice ที่แสดงเสียงที่พร้อมใช้งานสำหรับการสังเคราะห์เสียง

กิจกรรม

onInstallLanguageRequest

Chrome 131 ขึ้นไป

chrome.ttsEngine.onInstallLanguageRequest.addListener(
  callback: function,
)

ทริกเกอร์เมื่อไคลเอ็นต์ TTS ขอติดตั้งภาษาใหม่ เครื่องมือควรพยายามดาวน์โหลดและติดตั้งภาษา แล้วเรียกใช้ ttsEngine.updateLanguage พร้อมผลลัพธ์ เมื่อสำเร็จแล้ว เครื่องมือควรเรียกใช้ ttsEngine.updateVoices เพื่อลงทะเบียนเสียงที่พร้อมใช้งานใหม่ด้วย

พารามิเตอร์

• callback

  ฟังก์ชัน

  พารามิเตอร์ callback มีลักษณะดังนี้

  (requestor: TtsClient, lang: string) => void

  • ผู้ขอ

    TtsClient

  • lang

    สตริง

onLanguageStatusRequest

Chrome 132 ขึ้นไป

chrome.ttsEngine.onLanguageStatusRequest.addListener(
  callback: function,
)

เริ่มทำงานเมื่อไคลเอ็นต์ TTS ขอสถานะการติดตั้งของภาษา

พารามิเตอร์

• callback

  ฟังก์ชัน

  พารามิเตอร์ callback มีลักษณะดังนี้

  (requestor: TtsClient, lang: string) => void

  • ผู้ขอ

    TtsClient

  • lang

    สตริง

onPause

chrome.ttsEngine.onPause.addListener(
  callback: function,
)

ไม่บังคับ: หากเครื่องมือรองรับเหตุการณ์หยุดชั่วคราว เครื่องมือควรหยุดชั่วคราวการพูดปัจจุบัน (หากมี) จนกว่าจะได้รับเหตุการณ์กลับมาทำงานต่อหรือเหตุการณ์หยุด โปรดทราบว่าเหตุการณ์หยุดควรล้างสถานะหยุดชั่วคราวด้วย

พารามิเตอร์

• callback

  ฟังก์ชัน

  พารามิเตอร์ callback มีลักษณะดังนี้

  () => void

onResume

chrome.ttsEngine.onResume.addListener(
  callback: function,
)

ไม่บังคับ: หากเอนจินรองรับเหตุการณ์หยุดชั่วคราว ก็ควรจะรองรับเหตุการณ์เล่นต่อด้วย เพื่อพูดข้อความปัจจุบันต่อไป หากมี โปรดทราบว่าเหตุการณ์หยุดควรล้างสถานะหยุดชั่วคราวด้วย

พารามิเตอร์

• callback

  ฟังก์ชัน

  พารามิเตอร์ callback มีลักษณะดังนี้

  () => void

onSpeak

chrome.ttsEngine.onSpeak.addListener(
  callback: function,
)

เรียกใช้เมื่อผู้ใช้โทรหา tts.speak() และเสียงใดเสียงหนึ่งจากไฟล์ Manifest ของส่วนขยายนี้เป็นเสียงแรกที่ตรงกับออบเจ็กต์ตัวเลือก

พารามิเตอร์

• callback

  ฟังก์ชัน

  พารามิเตอร์ callback มีลักษณะดังนี้

  (utterance: string, options: SpeakOptions, sendTtsEvent: function) => void

  • คำพูด

    สตริง

  • ตัวเลือก

    SpeakOptions

  • sendTtsEvent

    ฟังก์ชัน

    พารามิเตอร์ sendTtsEvent มีลักษณะดังนี้

    (event: tts.TtsEvent) => void

    • เหตุการณ์

      tts.TtsEvent

      เหตุการณ์จากเครื่องมืออ่านออกเสียงข้อความที่ระบุสถานะของคำพูดนี้

onSpeakWithAudioStream

Chrome 92 ขึ้นไป

chrome.ttsEngine.onSpeakWithAudioStream.addListener(
  callback: function,
)

เรียกใช้เมื่อผู้ใช้โทรหา tts.speak() และเสียงใดเสียงหนึ่งจากไฟล์ Manifest ของส่วนขยายนี้เป็นเสียงแรกที่ตรงกับออบเจ็กต์ตัวเลือก แตกต่างจาก ttsEngine.onSpeak ตรงที่ Chrome ให้บริการการเล่นเสียงและจัดการการส่งเหตุการณ์ TTS

พารามิเตอร์

• callback

  ฟังก์ชัน

  พารามิเตอร์ callback มีลักษณะดังนี้

  (utterance: string, options: SpeakOptions, audioStreamOptions: AudioStreamOptions, sendTtsAudio: function, sendError: function) => void

  • คำพูด

    สตริง

  • ตัวเลือก

    SpeakOptions

  • audioStreamOptions

    AudioStreamOptions

  • sendTtsAudio

    ฟังก์ชัน

    พารามิเตอร์ sendTtsAudio มีลักษณะดังนี้

    (audioBufferParams: AudioBuffer) => void

    • audioBufferParams

      AudioBuffer

      พารามิเตอร์ที่มีบัฟเฟอร์เสียงและข้อมูลที่เกี่ยวข้อง

  • sendError

    ฟังก์ชัน

    Chrome 94 ขึ้นไป

    พารามิเตอร์ sendError มีลักษณะดังนี้

    (errorMessage?: string) => void

    • errorMessage

      สตริง ไม่บังคับ

      สตริงที่อธิบายข้อผิดพลาด

onStop

chrome.ttsEngine.onStop.addListener(
  callback: function,
)

ทริกเกอร์เมื่อมีการโทรไปยัง tts.stop และส่วนขยายนี้อาจอยู่ระหว่างการพูด หากส่วนขยายได้รับการเรียกใช้ onStop และหยุดการพูดไปแล้ว ส่วนขยายไม่ควรดำเนินการใดๆ (ไม่ควรทำให้เกิดข้อผิดพลาด) หากเสียงพูดอยู่ในสถานะหยุดชั่วคราว การดำเนินการนี้จะยกเลิกสถานะหยุดชั่วคราว

พารามิเตอร์

• callback

  ฟังก์ชัน

  พารามิเตอร์ callback มีลักษณะดังนี้

  () => void

onUninstallLanguageRequest

Chrome 132 ขึ้นไป

chrome.ttsEngine.onUninstallLanguageRequest.addListener(
  callback: function,
)

ทริกเกอร์เมื่อไคลเอ็นต์ TTS ระบุว่าไม่จำเป็นต้องใช้ภาษาอีกต่อไป

พารามิเตอร์

• callback

  ฟังก์ชัน

  พารามิเตอร์ callback มีลักษณะดังนี้

  (requestor: TtsClient, lang: string, uninstallOptions: LanguageUninstallOptions) => void

  • ผู้ขอ

    TtsClient

  • lang

    สตริง

  • uninstallOptions

    LanguageUninstallOptions