chrome.ttsEngine

תיאור

הרשאות

מושגים ושימוש

תוסף יכול לרשום את עצמו כמנוע דיבור. כך היא יכולה ליירט חלק מהקריאות לפונקציות כמו tts.speak() ו-tts.stop() או את כולן, ולספק הטמעה חלופית. התוספים מאפשרים להשתמש בחינם בכל טכנולוגיית האינטרנט הזמינה כדי לספק דיבור, כולל סטרימינג של אודיו מהשרת, מסוג HTML5. תוסף יכול אפילו לעשות משהו שונה עם ההגיות, כמו להציג כתוביות בחלון קופץ או לשלוח אותן כהודעות יומן לשרת מרוחק.

כדי להטמיע מנוע TTS, תוסף צריך להצהיר על ההרשאה "ttsEngine" ואז להצהיר על כל הקולות שהוא מספק במניפסט של התוסף, באופן הבא:

{
  "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 נדרש. השם צריך להיות תיאורי מספיק כדי לזהות את שם הקול ואת המנוע שבו נעשה שימוש. במקרה הלא סביר שבו שני תוספים רושמים קולות עם אותו שם, הלקוח יכול לציין את המזהה של התוסף שאמור לבצע את הסינתזה.

הפרמטר lang הוא אופציונלי, אבל מומלץ מאוד. כמעט תמיד, קול יכול לסנתז דיבור בשפה אחת בלבד. כשהמנוע תומך ביותר משפה אחת, אפשר לרשום בקלות קול נפרד לכל שפה. במקרים נדירים שבהם קול יחיד יכול לטפל ביותר משפה אחת, קל יותר לציין שני קולות נפרדים ולטפל בהם בעזרת אותה לוגיקה פנימית. עם זאת, אם רוצים ליצור קול שמטפל בביטויים בכל שפה, צריך להסיר את הפרמטר lang מהמניפסט של התוסף.

לבסוף, הפרמטר event_types נדרש אם המנוע יכול לשלוח אירועים כדי לעדכן את הלקוח בהתקדמות של סינתזת הדיבור. לכל הפחות, מומלץ לתמוך באירוע מסוג 'end' כדי לציין כשהדיבור מסתיים, אחרת Chrome לא יכול לתזמן ביטויים בתור.

אחרי הטעינה, התוסף יכול להחליף את רשימת הקולות המוצהרים על ידי קריאה ל-chrome.ttsEngine.updateVoices. (שימו לב שהפרמטרים שמשמשים בקריאה הפרוגרמטית ל-updateVoices הם באותיות גמל: למשל, voiceName, בניגוד לקובץ המניפסט שבו נעשה שימוש ב-voice_name).

סוגי האירועים האפשריים שאפשר לשלוח תואמים לסוגי האירועים שמתקבלים בשיטת speak():

• 'start': המנוע התחיל לומר את הביטוי.
• 'word': המערכת הגיעה לגבול של מילים. משתמשים ב-event.charIndex כדי לקבוע את מיקום הדיבור הנוכחי.
• 'sentence': הגעת לגבול של משפט. אפשר להשתמש ב-event.charIndex כדי לקבוע את מיקום הדיבור הנוכחי.
• 'marker': הגעה לסמן SSML. משתמשים ב-event.charIndex כדי לקבוע את מיקום הדיבור הנוכחי.
• 'end': המנוע סיים לומר את הביטוי.
• 'error': אירעה שגיאה ספציפית למנוע ולא ניתן לומר את הביטוי הזה. ניתן להעביר מידע נוסף ב-event.errorMessage.

האירועים 'interrupted' ו-'cancelled' לא נשלחים על ידי מנוע הדיבור. הם נוצרים על ידי Chrome באופן אוטומטי.

לקוחות של המרת טקסט לדיבור (TTS) יכולים לקבל את המידע הקולי מהמניפסט של התוסף על ידי התקשרות אל tts.getVoices, בהנחה שרשמתם מאזינים לאירועי דיבור כפי שמתואר בהמשך.

טיפול באירועי דיבור

כדי ליצור דיבור לבקשת לקוחות, התוסף צריך לרשום מאזינים גם ל-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);

ההחלטה אם לשלוח בקשת דיבור נתונה לתוסף מבוססת אך ורק על ההחלטה אם התוסף תומך בפרמטרים קוליים מסוימים במניפסט שלו, ואם יש מאזינים רשומים ל-onSpeak ול-onStop. במילים אחרות, אין דרך שבה תוסף יוכל לקבל בקשת דיבור ולהחליט באופן דינמי אם לטפל בה.

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