הודעות להפעלת מדיה

אפליקציות שולחות של Google Cast שולטות בהפעלה במכשיר המקבל על ידי שליחת הודעות בפורמט JSON לאפליקציה המקבלת. באופן דומה, המקבל שולח הודעות בחזרה לשולח, גם בפורמט JSON. ההודעות יכולות להיות פקודות מהשולח שמשנות את מצב הנגן, תגובות לפקודות האלה מהמקלט או מבני נתונים שמתארים את המדיה לאפליקציית המקלט.

בהתאם לתנאים ולהגבלות הנוספים למפתחים של Google Cast SDK, אפליקציית מדיה של Cast חייבת להשתמש בהודעות האלה כמו שהן מוגדרות כאן כדי לשלוט בהפעלת המדיה במכשיר המקבל. כך אפליקציית המדיה מספקת חוויית משתמש עקבית בפלטפורמות שונות, ומבטיחה שאפליקציית Cast תתמוך בתרחישי שימוש חדשים ועתידיים. המבנים האלה תומכים גם בנתונים מותאמים אישית, במקרים המתאימים, ואפליקציה יכולה להגדיר הודעות משלה לפקודות שלא נתמכות על ידי ערכת ה-SDK.

מרחב השמות של הודעות הפעלת המדיה מוגדר כ-urn:x-cast:com.google.cast.media.

הערה: להודעות ולמבנים במפרט הזה יש גודל מקסימלי מרומז שנקבע לפי הגודל המקסימלי של הודעת העברה, ואין מגבלה לשדות בודדים. הגודל המקסימלי של הודעה בשינוע הוא כרגע 64KB.

מבני נתונים נפוצים של מרחבי שמות

קבוצת-על של מבני נתונים שמשמשים את כל הארטיפקטים של מרחב השמות של המדיה מוגדרת במרחב שמות משותף.

תמונה

זהו תיאור של תמונה, כולל כמות קטנה של מטא-נתונים שמאפשרת לאפליקציה של השולח לבחור תמונות, בהתאם לאופן שבו היא תציג אותן.

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

שם סוג תיאור
url URI URI של התמונה
height מספר שלם אופציונלי גובה התמונה
width מספר שלם אופציונלי רוחב התמונה

נפח

עוצמת הקול של שידור המדיה. המאפיין משמש לאפקטים של הופעה הדרגתית והיעלמות הדרגתית בזרם המדיה. (הערה: נפח המערכת משתנה באמצעות ממשקי ה-API של השולח). אסור להשתמש בעוצמת הקול של הסטרימינג בשילוב עם פס ההזזה או הלחצנים של עוצמת הקול כדי לשלוט בעוצמת הקול של המכשיר. כדי לשנות את עוצמת הקול של הסטרימינג, צריך להעביר לפחות אחד מהפרמטרים הבאים.

שם סוג תיאור
רמה double אופציונלי רמת עוצמת הקול הנוכחית של הסטרימינג כערך בין 0.0 ל-1.0, כאשר 1.0 היא עוצמת הקול המקסימלית.
muted בוליאני אופציונלי האם מכשיר Cast מושתק, ללא קשר לרמת עוצמת הקול

מבני נתונים של מרחב שמות של מדיה

ההודעות האלה מתארות את המצב של נגן המדיה. מרחב השמות הוא urn:x-cast:com.google.cast.media.

MediaInformation

מבנה הנתונים הזה מתאר סטרימינג של מדיה.

שם סוג תיאור
contentId מחרוזת מזהה ספציפי לשירות של התוכן שנטען כרגע על ידי נגן המדיה. זהו מחרוזת חופשית שספציפית לאפליקציה. ברוב המקרים, זו תהיה כתובת ה-URL של המדיה, אבל השולח יכול לבחור להעביר מחרוזת שהמקבל יכול לפרש בצורה נכונה. אורך מקסימלי: 1,000
streamType enum
(string)

מתאר את סוג ארטיפקט המדיה כאחד מהבאים:

  • NONE
  • BUFFERED
  • LIVE
contentType מחרוזת סוג תוכן MIME של המדיה שמופעלת
מטא-נתונים אובייקט

אופציונלי אובייקט המטא-נתונים של המדיה, אחת מהאפשרויות הבאות:

duration double אופציונלי משך הסטרימינג שמופעל כרגע בשניות
customData אובייקט אופציונלי בלוב נתונים ספציפי לאפליקציה שמוגדר על ידי אפליקציית השולח או אפליקציית המקבל

GenericMediaMetadata

מתאר ארטיפקט מדיה גנרי.

שם סוג תיאור
metadataType מספר שלם ‫0  (הערך היחיד)
title מחרוזת אופציונלי כותרת תיאורית של התוכן. הנגן יכול לאחזר את שם התוכן באופן עצמאי באמצעות content_id, או שהשולח יכול לציין אותו בהודעה Load.
subtitle מחרוזת אופציונלי כותרת משנה תיאורית של התוכן. הנגן יכול לאחזר את שם התוכן באופן עצמאי באמצעות content_id, או שהשולח יכול לציין אותו בהודעה Load.
תמונות תמונה[] אופציונלי מערך של כתובות URL לתמונה שמשויכת לתוכן. השולח יכול לספק את הערך הראשוני של השדה בהודעת Load. צריך לספק גדלים מומלצים
releaseDate מחרוזת (ISO 8601) אופציונלי תאריך ושעה בפורמט ISO 8601 שבהם התוכן הזה פורסם. הנגן יכול לאחזר את שם התוכן באופן עצמאי באמצעות content_id, או שהשולח יכול לציין אותו בהודעה Load.

MovieMediaMetadata

מתאר ארטיפקט מדיה של סרט.

שם סוג תיאור
metadataType מספר שלם ‫1  (הערך היחיד)
title מחרוזת אופציונלי כותרת תיאורית של התוכן. הנגן יכול לאחזר את שם התוכן באופן עצמאי באמצעות content_id, או שהשולח יכול לציין אותו בהודעה Load.
subtitle מחרוזת אופציונלי כותרת משנה תיאורית של התוכן. הנגן יכול לאחזר את שם התוכן באופן עצמאי באמצעות content_id, או שהשולח יכול לציין אותו בהודעה Load.
studio מחרוזת אופציונלי הסטודיו שהפיק את התוכן. הנגן יכול לאחזר באופן עצמאי את הסטודיו באמצעות content_id או שהשולח יכול להעביר אותו בהודעה Load
תמונות תמונה[] אופציונלי מערך של כתובות URL לתמונה שמשויכת לתוכן. השולח יכול לספק את הערך הראשוני של השדה בהודעת Load. צריך לספק גדלים מומלצים
releaseDate מחרוזת (ISO 8601) אופציונלי תאריך ושעה בפורמט ISO 8601 שבהם התוכן הזה פורסם. הנגן יכול לאחזר את שם התוכן באופן עצמאי באמצעות content_id, או שהשולח יכול לציין אותו בהודעה Load.

TvShowMediaMetadata

מתאר ארטיפקט מדיה של פרק בתוכנית טלוויזיה.

שם סוג תיאור
metadataType מספר שלם ‫2  (הערך היחיד)
seriesTitle מחרוזת אופציונלי שם תיאורי של סדרת הטלוויזיה. הנגן יכול לאחזר את שם התוכן באופן עצמאי באמצעות content_id, או שהשולח יכול לציין אותו בהודעה Load.
subtitle מחרוזת אופציונלי כתובית תיאורית של פרק בתוכנית טלוויזיה. הנגן יכול לאחזר את שם התוכן באופן עצמאי באמצעות content_id, או שהשולח יכול לציין אותו בהודעה Load.
season מספר שלם אופציונלי מספר העונה של תוכנית הטלוויזיה
episode מספר שלם אופציונלי מספר הפרק (בעונה) של תוכנית הטלוויזיה
תמונות תמונה[] אופציונלי מערך של כתובות URL לתמונה שמשויכת לתוכן. השולח יכול לספק את הערך הראשוני של השדה בהודעת Load. צריך לספק גדלים מומלצים
originalAirDate מחרוזת (ISO 8601) אופציונלי תאריך ושעה בפורמט ISO 8601 שבהם הפרק הזה פורסם. הנגן יכול לאחזר באופן עצמאי את התאריך המקורי של שידור הפרק באמצעות content_id, או שהשולח יכול לציין אותו בהודעה Load

MusicTrackMediaMetadata

מתאר ארטיפקט מדיה של טראק מוזיקה.

שם סוג תיאור
metadataType מספר שלם ‫3  (הערך היחיד)
albumName מחרוזת אופציונלי האלבום או האוסף שממנו נלקח הטראק הזה. הנגן יכול לאחזר באופן עצמאי את albumName באמצעות content_id או שהשולח יכול לציין אותו בהודעה Load
title מחרוזת אופציונלי שם הטראק (לדוגמה, שם השיר). הנגן יכול לאחזר את שם התוכן באופן עצמאי באמצעות content_id, או שהשולח יכול לציין אותו בהודעה Load.
albumArtist מחרוזת אופציונלי שם האומן שמשויך לאלבום שכולל את הטראק הזה. הנגן יכול לאחזר באופן עצמאי את albumArtist באמצעות content_id או שהשולח יכול לציין אותו בהודעה Load
artist מחרוזת אופציונלי שם האומן שמשויך לטראק המדיה. הנגן יכול לאחזר אמן באופן עצמאי באמצעות content_id או שהשולח יכול לציין אותו בהודעה Load
composer מחרוזת אופציונלי שם היוצר שמשויך לרצועת המדיה. הנגן יכול לאחזר באופן עצמאי את הרכיב באמצעות content_id או שהשולח יכול להעביר אותו בהודעה Load
trackNumber מספר שלם אופציונלי מספר הטראק באלבום
discNumber מספר שלם אופציונלי מספר הכרך (לדוגמה, דיסק) של האלבום
תמונות תמונה[] אופציונלי מערך של כתובות URL לתמונה שמשויכת לתוכן. השולח יכול לספק את הערך הראשוני של השדה בהודעת Load. צריך לספק גדלים מומלצים
releaseDate מחרוזת (ISO 8601) אופציונלי תאריך ושעה בפורמט ISO 8601 שבהם התוכן הזה פורסם. הנגן יכול לאחזר באופן עצמאי את הערך של releaseDate באמצעות content_id, או שהשולח יכול לציין אותו בהודעה Load.

PhotoMediaMetadata

מתאר ארטיפקט של מדיה צילומית.

שם סוג תיאור
metadataType מספר שלם ‫4  (הערך היחיד)
title מחרוזת אופציונלי כותרת הצילום. הנגן יכול לאחזר את שם התוכן באופן עצמאי באמצעות content_id, או שהשולח יכול לציין אותו בהודעה Load.
artist מחרוזת אופציונלי שם הצלם. הנגן יכול לאחזר אמן באופן עצמאי באמצעות content_id או שהשולח יכול לציין אותו בהודעה Load
מיקום מחרוזת אופציונלי מיקום מילולי שבו צולמה התמונה, לדוגמה, 'מדריד, ספרד'. הנגן יכול לאחזר את המיקום באופן עצמאי באמצעות content_id, או שהשולח יכול לציין אותו בהודעה Load
latitude double אופציונלי ערך קו הרוחב הגיאוגרפי של המיקום שבו צולמה התמונה. הנגן יכול לאחזר את קו הרוחב באופן עצמאי באמצעות content_id, או שהשולח יכול לציין אותו בהודעה Load.
longitude double אופציונלי ערך קו האורך הגיאוגרפי של המיקום שבו צולמה התמונה. הנגן יכול לאחזר את קו האורך באופן עצמאי באמצעות content_id או שהשולח יכול לציין אותו בהודעה Load
width מספר שלם אופציונלי רוחב התמונה בפיקסלים. הנגן יכול לאחזר את הרוחב באופן עצמאי באמצעות content_id, או שהשולח יכול לציין אותו בהודעה Load.
height מספר שלם אופציונלי גובה התמונה בפיקסלים. הנגן יכול לאחזר את הגובה באופן עצמאי באמצעות content_id או שהשולח יכול לציין אותו בהודעה Load
creationDateTime מחרוזת (ISO 8601) אופציונלי תאריך ושעה בפורמט ISO 8601 שבהם הצילום צולם. הנגן יכול לאחזר באופן עצמאי את creationDateTime באמצעות content_id, או שהשולח יכול לציין אותו בהודעה Load

MediaStatus

תיאור של הסטטוס הנוכחי של ארטיפקט המדיה ביחס לסשן.

שם סוג תיאור
mediaSessionId מספר שלם מזהה ייחודי להפעלה של הסשן הספציפי הזה. המזהה הזה מוגדר על ידי המקבל בזמן הטעינה, ואפשר להשתמש בו כדי לזהות מופע ספציפי של הפעלה. לדוגמה, לשני ניגונים של השיר Wish you were here באותו סשן יהיה כל אחד mediaSessionId ייחודי.
media MediaInformation אופציונלי (להודעות סטטוס) תיאור מלא של התוכן שמופעל. הערך הזה יוחזר בהודעות סטטוס רק אם MediaInformation השתנה.
playbackRate מספר ממשי (float) השדה מציין אם הזמן במדיה מתקדם, ובאיזו מהירות. הפעולה הזו לא תלויה במצב הנגן, כי הזמן של המדיה יכול להיעצר בכל מצב. ‫1.0 היא מהירות רגילה, 0.5 היא הילוך איטי
playerState enum (string)

תיאור המצב של נגן המדיה, כאחת מהאפשרויות הבאות:

  • IDLE  הנגן עדיין לא נטען
  • הפעלה  התוכן מוצג באופן פעיל בנגן
  • BUFFERING  הנגן במצב PLAY אבל לא מפעיל תוכן באופן פעיל (הערך של currentTime לא משתנה)
  • מושהה  ההפעלה מושהית
idleReason enum (string)

אופציונלי אם הערך של playerState הוא IDLE והסיבה לכך שהוא הפך ל-IDLE ידועה, המאפיין הזה מסופק. אם הנגן במצב IDLE כי הוא רק התחיל לפעול, המאפיין הזה לא יסופק. אם הנגן נמצא במצב אחר, המאפיין הזה לא אמור להיות מסופק. אלה הערכים הרלוונטיים:

  • בוטלה  השולח ביקש להפסיק את ההפעלה באמצעות הפקודה STOP
  • הופסקה  השולח ביקש להפעיל מדיה אחרת באמצעות הפקודה LOAD
  • הפעולה הסתיימה  ההפעלה של המדיה הסתיימה
  • שגיאה  ההפעלה של המדיה הופסקה בגלל שגיאה. לדוגמה, אם הנגן לא הצליח להוריד את המדיה בגלל בעיות ברשת
currentTime double המיקום הנוכחי של נגן המדיה מאז תחילת התוכן, בשניות. אם מדובר בתוכן של שידור חי, השדה הזה מייצג את הזמן בשניות מתחילת האירוע שצריך להיות ידוע לנגן.
supportedMediaCommands דגלים

דגלים שמתארים אילו פקודות מדיה נתמכות על ידי נגן המדיה:

  • ‫1 << 0  השהיה
  • ‫1 << 1  חיפוש
  • ‫1 << 2  עוצמת הקול של הסטרימינג
  • ‫1 << 3  השתקת השידור
  • ‫1 << 4  דילוג קדימה (הוצא משימוש)
  • ‫1 << 5  דילוג אחורה (הוצא משימוש)
  • ‫1 << 6  הוספה למקום הבא ברשימת ההשמעה
  • ‫1 << 7  הוספה לתור של השיר הקודם
  • ‫1 << 8  הפעלה אקראית של התור
  • ‫1 << 9  דילוג על המודעה
  • ‫1 << 10  חזרה על כל התור
  • ‫1 << 11  הוספה לתור של חזרה על פריט מדיה אחד
  • ‫1 << 12  עריכת טראקים
  • ‫1 << 13  מהירות ההפעלה
  • ‫1 << 14  לייק
  • ‫1 << 15  דיסלייק
  • ‫1 << 16  מעקב
  • ‫1 << 17  ביטול המעקב

השילובים מתוארים כסכומים; לדוגמה, Pause+Seek+StreamVolume+Mute == 15.
volume עוצמת הקול עוצמת הקול של השידור
customData אובייקט אופציונלי בלוב נתונים ספציפי לאפליקציה שהוגדר על ידי אפליקציית המקבל

פקודות מהשולח אל המקבל

הפקודות האלה שולטות בנגן המדיה. כל אובייקטי ה-customData בהודעות שלמטה צריכים להיות אופציונליים (כלומר, המקבל צריך לבצע שדרוג לאחור בצורה תקינה אם הנתונים לא מועברים). כך אפליקציות כלליות לשליטה מרחוק יוכלו לפעול בצורה תקינה.

טעינה

טוען תוכן חדש לנגן המדיה.

שם סוג תיאור
requestId מספר שלם מזהה הבקשה, לתיאום בין הבקשה לתגובה
type מחרוזת ‫LOAD (רק ערך)
media MediaInformation מטא-נתונים (כולל contentId) של המדיה לטעינה
הפעלה אוטומטית בוליאני

אופציונלי (ברירת המחדל היא true) אם מציינים את הפרמטר autoplay, נגן המדיה יתחיל להפעיל את התוכן כשהוא ייטען. גם אם לא מציינים הפעלה אוטומטית, יכול להיות שההטמעה של נגן המדיה תתחיל את ההפעלה באופן מיידי. אם ההפעלה מתחילה, מצב הנגן בתגובה צריך להיות BUFFERING, אחרת הוא צריך להיות PAUSED
currentTime double אופציונלי מספר השניות שעברו מתחילת התוכן. אם התוכן הוא תוכן בשידור חי ולא מצוין מיקום, הסטרימינג יתחיל במיקום של השידור החי
customData אובייקט אופציונלי בלוב נתונים ספציפי לאפליקציה שהוגדר על ידי אפליקציית השולח
תשובה טריגרים שידורים שגיאות
ללא שינוי במצב של המקבל הודעה על שינוי סטטוס המדיה מצב נגן לא תקין
הטעינה נכשלה
הטעינה בוטלה

השהיה

השהיית ההפעלה של התוכן הנוכחי. מפעילה התראה על אירוע STATUS לכל האפליקציות השולחות.

שם סוג תיאור
mediaSessionId מספר שלם המזהה של סשן המדיה שצריך להשהות
requestId מספר שלם מזהה הבקשה, לשימוש בקורלציה של בקשה/תגובה
type מחרוזת PAUSE (רק ערך)
customData אובייקט אופציונלי בלוב נתונים ספציפי לאפליקציה שהוגדר על ידי אפליקציית השולח
תשובה טריגרים שידורים שגיאות
ללא שינוי במצב של המקבל הודעה על שינוי סטטוס של מדיה מצב שחקן לא תקין

חפש

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

שם סוג תיאור
mediaSessionId מספר שלם המזהה של סשן המדיה שבו מוגדר המיקום של הסטרימינג
requestId מספר שלם מזהה הבקשה, לתיאום בין הבקשה לתגובה
type מחרוזת SEEK (רק ערך)
resumeState enum (string)

אופציונלי אם לא מגדירים את הערך הזה, סטטוס ההפעלה לא ישתנה. הערכים האפשריים:

  • ‫PLAYBACK_START  כפייה של התחלת הפעלת המדיה
  • PLAYBACK_PAUSE  כפיית השהיה של המדיה
currentTime double אופציונלי מספר השניות שעברו מתחילת התוכן. אם התוכן הוא תוכן בשידור חי ולא מצוין מיקום, הסטרימינג יתחיל במיקום של השידור החי
customData אובייקט אופציונלי בלוב נתונים ספציפי לאפליקציה שהוגדר על ידי אפליקציית השולח
תשובה טריגרים שידורים שגיאות
ללא שינוי במצב של המקבל הודעה על שינוי סטטוס המדיה מצב שחקן לא תקין

עצירה

הפסקת ההפעלה של התוכן הנוכחי. מפעילה התראה על אירוע STATUS לכל האפליקציות השולחות. אחרי הפעלת הפקודה הזו, התוכן לא ייטען יותר והערך של mediaSessionId יהיה לא תקף.

שם סוג תיאור
mediaSessionId מספר שלם המזהה של סשן המדיה של התוכן שרוצים להפסיק
requestId מספר שלם מזהה הבקשה, לתיאום בין הבקשה לתגובה
type מחרוזת STOP (רק ערך)
customData אובייקט אופציונלי בלוב נתונים ספציפי לאפליקציה שהוגדר על ידי אפליקציית השולח
תשובה טריגרים שידורים שגיאות
ללא שינוי במצב של המקבל הודעה על שינוי סטטוס המדיה מצב שחקן לא תקין

הפעלה

הפעלת התוכן שנטען באמצעות קריאת הפונקציה load, ההפעלה נמשכת מהמיקום הנוכחי בציר הזמן.

שם סוג תיאור
mediaSessionId מספר שלם המזהה של סשן המדיה שבו התוכן מושמע
requestId מספר שלם מזהה הבקשה, לתיאום בין הבקשה לתגובה
type מחרוזת PLAY (רק ערך)
customData אובייקט אופציונלי בלוב נתונים ספציפי לאפליקציה שהוגדר על ידי אפליקציית השולח
תשובה טריגרים שידורים שגיאות
ללא שינוי במצב של המקבל הודעה על שינוי סטטוס המדיה מצב שחקן לא תקין

קבלת סטטוס

מאחזר את סטטוס המדיה.

שם סוג תיאור
mediaSessionId מספר שלם אופציונלי מזהה סשן המדיה של המדיה שעבורה צריך להחזיר את סטטוס המדיה. אם לא מציינים מזהה, הסטטוס של כל מזהי סשן המדיה יסופק.
requestId מספר שלם מזהה הבקשה, לתיאום בין הבקשה לתגובה
type מחרוזת GET_STATUS (הערך היחיד)
customData אובייקט אופציונלי בלוב נתונים ספציפי לאפליקציה שהוגדר על ידי אפליקציית השולח
תשובה טריגרים שידורים שגיאות
הודעת MediaStatus לשולח שביקש אותה ללא ללא ללא

SetVolume

מגדירה את עוצמת הקול של שידור המדיה. משמשת לאפקטים של הוספה הדרגתית והסרה הדרגתית בזרם המדיה. (הערה: העוצמה של הרמקול משתנה באמצעות השולח באינטרנט setVolume.) אסור להשתמש בעוצמת הקול של הסטרימינג יחד עם פס עוצמת הקול או לחצני עוצמת הקול כדי לשלוט בעוצמת הקול של המכשיר. שינוי עוצמת הקול של הסטרימינג לא יפעיל את ממשק המשתמש במכשיר המקבל.

שם סוג תיאור
mediaSessionId מספר שלם מזהה סשן המדיה של המדיה שעוצמת הקול של הסטרימינג שלה משתנה
requestId מספר שלם מזהה הבקשה, לתיאום בין הבקשה לתגובה
type מחרוזת VOLUME (רק ערך)
volume עוצמת הקול עוצמת הקול של השידור
customData אובייקט אופציונלי בלוב נתונים ספציפי לאפליקציה שהוגדר על ידי אפליקציית השולח
תשובה טריגרים שידורים שגיאות
ללא שינוי במצב של המקבל הודעה על שינוי סטטוס המדיה מצב שחקן לא תקין

הודעות מהמקבל לשולח

הנמען שולח שני סוגים של הודעות:

  • שגיאות: הודעות Unicast נשלחות כשיש תגובת שגיאה לבקשת השולח.
  • סטטוס: שידור הודעות.
    • תוצאה של פעולה שהשולח יזם. יכיל את מזהה הבקשה שגרמה לשינוי.
    • ספונטני: לדוגמה, בגלל שינוי שהופעל על ידי אפליקציית המקלט. ערך RequestId יהיה 0.

שגיאה: מצב נגן לא תקין

האירוע נשלח כשאי אפשר למלא את הבקשה של השולח כי הנגן לא נמצא במצב תקין. לדוגמה, אם האפליקציה עדיין לא יצרה רכיב מדיה.

שם סוג תיאור
requestId מספר שלם מזהה הבקשה שגרמה לשגיאה הזו
type מחרוזת INVALID_PLAYER_STATE (רק ערך)
customData אובייקט אופציונלי בלוב נתונים ספציפי לאפליקציה שהוגדר על ידי אפליקציית המקבל

שגיאה: הטעינה נכשלה

האירוע נשלח כשטעינת הבקשה נכשלה. מצב הנגן יהיה IDLE (בטלה).

שם סוג תיאור
requestId מספר שלם מזהה הבקשה שגרמה לשגיאה הזו
type מחרוזת ‫LOAD_FAILED (ערך בלבד)
customData אובייקט אופציונלי בלוב נתונים ספציפי לאפליקציה שהוגדר על ידי אפליקציית המקבל

שגיאה: הטעינה בוטלה

האירוע נשלח כשהבקשה לטעינה בוטלה (התקבלה בקשה שנייה לטעינה).

שם סוג תיאור
requestId מספר שלם מזהה הבקשה שגרמה לשגיאה הזו
type מחרוזת LOAD_CANCELLED (הערך היחיד)
customData אובייקט אופציונלי בלוב נתונים ספציפי לאפליקציה שהוגדר על ידי אפליקציית המקבל

שגיאה: בקשה לא תקינה

הודעה שנשלחת כשהבקשה לא תקינה (למשל, סוג בקשה לא ידוע).

שם סוג תיאור
requestId מספר שלם מזהה הבקשה שגרמה לשגיאה הזו
type מחרוזת ‫INVALID_REQUEST (ערך בלבד)
reason טיפוסים בני מנייה (enum) ‏(string)

הערכים:

  • INVALID_COMMAND  הפקודה לא נתמכת
  • ‫DUPLICATE_REQUESTID  מזהה הבקשה לא ייחודי (המקבל מעבד בקשה עם אותו מזהה)
customData אובייקט אופציונלי בלוב נתונים ספציפי לאפליקציה שהוגדר על ידי אפליקציית המקבל

סטטוס המדיה

ההודעה נשלחת אחרי שינוי במצב או אחרי בקשה לסטטוס של מדיה. יישלחו רק אובייקטים של MediaStatus שהשתנו או שהתבקשו.

שם סוג תיאור
requestId מספר שלם מזהה שמשמש לקורלציה בין תגובת הסטטוס הזו לבין הבקשה שיצרה אותה, או 0 אם הודעת הסטטוס היא ספונטנית (לא הופעלה על ידי בקשת שולח). אפליקציות שולחות ייצרו מזהי בקשות ייחודיים על ידי בחירת מספר אקראי והגדלה שלו באופן רציף (הן לא ישתמשו ב-0).
type מחרוזת ‫MEDIA_STATUS (רק ערך)
סטטוס MediaStatus[] מערך של אובייקטים מהטיפוס Media Status. הערה: רכיב המדיה ב-MediaStatus יוחזר רק אם הוא השתנה.
customData אובייקט אופציונלי בלוב נתונים ספציפי לאפליקציה שהוגדר על ידי אפליקציית המקבל