אפליקציות של שולחים של Google Cast שולטות בהפעלה במכשיר המקבל על ידי שליחת הודעות בפורמט JSON לאפליקציה המקבלת. באופן דומה, המקבל שולח הודעות בחזרה לשולח, גם ב-JSON. ההודעות יכולות להיות פקודות מהשולח שמשנים את מצב הנגן, תשובות לפקודות האלה מהמקבל או מבני נתונים שמתארים את המדיה של האפליקציה של המקבל.
בהתאם לתנאים ולהגבלות הנוספים למפתחים של Google Cast SDK, אפליקציית מדיה מסוג Cast חייבת להשתמש בהודעות האלה, כפי שמוגדר כאן, כדי לשלוט בהפעלת המדיה במכשיר המקבל. באופן הזה, אפליקציית המדיה מספקת חוויית משתמש עקבית בכל הפלטפורמות, ומבטיחה שאפליקציית Cast תתמוך בתרחישים חדשים ועתידיים לשימוש. המבנים האלה תומכים גם בנתונים מותאמים אישית, כשזה רלוונטי, והאפליקציה עשויה להגדיר הודעות משלה לפקודות שלא נתמכות על ידי ה-SDK.
מרחב השמות של הודעות הפעלת המדיה מוגדר כ-urn:x-cast:com.google.cast.media.
הערה: להודעות ולמבנים במפרט הזה יש גודל מקסימלי משתמע שנקבע על סמך הגודל המקסימלי של הודעת העברה. אין מגבלה על שדות נפרדים. הגודל המקסימלי של הודעת ההעברה הוא כרגע 64KBytes.
מבני נתונים נפוצים של מרחבי שמות
קבוצת-על של מבני נתונים שמשמשים את כל פריטי המידע שנוצרו בתהליך הפיתוח (Artifact) של מרחב השמות של המדיה מוגדרת במרחב שמות נפוץ.
תמונה
זהו התיאור של תמונה, כולל כמות קטנה של מטא נתונים כדי לאפשר לאפליקציית השולח לבחור תמונות, בהתאם לאופן שבו היא תציג אותן.
הגובה והרוחב הם אופציונליים בפריט אחד מתוך מערך של תמונות. לדוגמה, אם הוחזר פריט אחד, לא חובה לבצע את הפעולה הזו. אם הוחזרו שני פריטים, פריט אחד צריך לציין גובה ורוחב, אבל השולח יכול לבחור לבחור באפשרות 'ברירת מחדל' אם הפריט שהועבר עם פרמטרים ספציפיים לא מתאים לו.
שם | תיאור | התיאור |
---|---|---|
כתובת URL | URI | URI של התמונה |
height | מספר שלם | אופציונלי : גובה התמונה |
רוחב | מספר שלם | אופציונלי . רוחב התמונה |
עוצמת הקול
עוצמת הקול של זרם המדיה. משמש לאפקטים של הגברת עמעום/החלשה הדרגתית על שידור המדיה. (הערה: עוצמת הקול של המערכת משתנה באמצעות ממשקי ה-API של השולח). כדי לשלוט בעוצמת הקול של המכשיר, אין להשתמש בעוצמת הקול של הסטרימינג יחד עם פס ההזזה של עוצמת הקול או עם לחצני עוצמת הקול. כדי לשנות את הנפח של השידור, צריך להעביר לפחות אחד מהפרמטרים הבאים.
שם | תיאור | התיאור |
---|---|---|
רמה | כפולה | אופציונלי רמת עוצמת הקול הנוכחית של השידור כערך בין 0.0 ל-1.0, כאשר 1.0 הוא עוצמת הקול המקסימלית. |
מושתק | boolean | אופציונלי מכשיר ה-CAST מושתק, ללא קשר לעוצמת הקול |
מבני נתונים של מרחב שמות של מדיה
ההודעות האלה מתארות את המצב של נגן המדיה. מרחב השמות הוא urn:x-cast:com.google.cast.media.
MediaInformation
מבנה הנתונים הזה מתאר מקור נתונים של מדיה.
שם | תיאור | התיאור |
---|---|---|
contentId | מחרוזת | מזהה ספציפי לשירות של התוכן שנטען כרגע על ידי נגן המדיה. זוהי מחרוזת בפורמט חופשי והיא ספציפית לאפליקציה. ברוב המקרים, זו תהיה כתובת ה-URL של המדיה, אבל השולח יכול לבחור להעביר מחרוזת שהנמען יכול לפרש כראוי. אורך מקסימלי: 1k |
streamType | טיפוסים בני מנייה (enum) (מחרוזת) |
מתאר את הסוג של פריט מדיה (Artifact) כאחת מהאפשרויות הבאות:
|
contentType | מחרוזת | סוג תוכן MIME של המדיה שמופעלת |
מטא-נתונים | אובייקט | אופציונלי אובייקט המטא-נתונים של המדיה, אחד מהבאים: |
משך זמן | כפולה | אופציונלי משך השידור שמשודר באותו רגע, בשניות |
customData | אובייקט | אופציונלי blob נתונים ספציפי לאפליקציה המוגדר על ידי אפליקציית השולח או האפליקציה המקבלת |
GenericMediaMetadata
מתאר פריט מדיה גנרי.
שם | תיאור | התיאור |
---|---|---|
metadataType | מספר שלם | 0 (הערך היחיד) |
שם הפריט | מחרוזת | אופציונלי כותרת תיאורית של התוכן. השחקן יכול לאחזר את הכותרת באופן עצמאי באמצעות content_id או לתת אותו על ידי השולח בהודעה טעינה |
כותרת משנה | מחרוזת | אופציונלי כותרת משנה תיאורית של התוכן. השחקן יכול לאחזר את הכותרת באופן עצמאי באמצעות content_id או לתת אותו על ידי השולח בהודעה טעינה |
תמונות | תמונה[] | אופציונלי מערך של כתובות URL לתמונה המשויכת לתוכן. השולח יכול לספק את הערך הראשוני של השדה בהודעה טעינה. צריך לספק גדלים מומלצים |
releaseDate | מחרוזת (ISO 8601) | אופציונלי : התאריך והשעה שבהם פורסם התוכן הזה לפי תקן ISO 8601. השחקן יכול לאחזר את הכותרת באופן עצמאי באמצעות content_id או לתת אותו על ידי השולח בהודעה טעינה |
MovieMediaMetadata
מתאר פריט מדיה שנוצר על ידי סרטים.
שם | תיאור | התיאור |
---|---|---|
metadataType | מספר שלם | 1 (הערך היחיד) |
שם הפריט | מחרוזת | אופציונלי כותרת תיאורית של התוכן. השחקן יכול לאחזר את הכותרת באופן עצמאי באמצעות content_id או לתת אותו על ידי השולח בהודעה טעינה |
כותרת משנה | מחרוזת | אופציונלי כותרת משנה תיאורית של התוכן. השחקן יכול לאחזר את הכותרת באופן עצמאי באמצעות content_id או לתת אותו על ידי השולח בהודעה טעינה |
סטודיו | מחרוזת | אופציונלי Studio שפרסם את התוכן השחקן יכול לאחזר את תוכן Studio באופן עצמאי באמצעות content_id או לספק אותו בהודעה טעינה. |
תמונות | תמונה[] | אופציונלי מערך של כתובות URL לתמונה המשויכת לתוכן. השולח יכול לספק את הערך הראשוני של השדה בהודעה טעינה. צריך לספק גדלים מומלצים |
releaseDate | מחרוזת (ISO 8601) | אופציונלי : התאריך והשעה שבהם פורסם התוכן הזה לפי תקן ISO 8601. השחקן יכול לאחזר את הכותרת באופן עצמאי באמצעות content_id או לתת אותו על ידי השולח בהודעה טעינה |
TvShowMediaMetadata
מתאר פריט מדיה שקשור לפרק של תוכנית טלוויזיה.
שם | תיאור | התיאור |
---|---|---|
metadataType | מספר שלם | 2 (הערך היחיד) |
seriesTitle | מחרוזת | אופציונלי שם תיאורי לסדרת הטלוויזיה. השחקן יכול לאחזר את הכותרת באופן עצמאי באמצעות content_id או לתת אותו על ידי השולח בהודעה טעינה |
כותרת משנה | מחרוזת | אופציונלי כותרת משנה תיאורית של הפרק בטלוויזיה. השחקן יכול לאחזר את הכותרת באופן עצמאי באמצעות content_id או לתת אותו על ידי השולח בהודעה טעינה |
עונה | מספר שלם | אופציונלי מספר העונה של תוכנית הטלוויזיה |
פרק | מספר שלם | אופציונלי מספר הפרק (בעונה) של תוכנית הטלוויזיה |
תמונות | תמונה[] | אופציונלי מערך של כתובות URL לתמונה המשויכת לתוכן. השולח יכול לספק את הערך הראשוני של השדה בהודעה טעינה. צריך לספק גדלים מומלצים |
originalAirDate | מחרוזת (ISO 8601) | אופציונלי : התאריך והשעה שבהם פרסמת את הפרק הזה לפי תקן ISO 8601. השחקן יכול לאחזר באופן עצמאי את sourceAirDate באמצעות content_id. לחלופין, השולח יכול לספק את המידע הזה בהודעת Load (טעינה). |
MusicTrackMediaMetadata
מיועד לתיאור פריט מדיה של טראק מוזיקה.
שם | תיאור | התיאור |
---|---|---|
metadataType | מספר שלם | 3 (הערך היחיד) |
albumName | מחרוזת | אופציונלי אלבום או אוסף שממנו נלקח הטראק הזה. הנגן יכול לאחזר באופן עצמאי את שם האלבום באמצעות content_id או שהשולח יכול לספק אותו בהודעה טעינה |
שם הפריט | מחרוזת | אופציונלי שם הטראק (לדוגמה: שם השיר). השחקן יכול לאחזר את הכותרת באופן עצמאי באמצעות content_id או לתת אותו על ידי השולח בהודעה טעינה |
albumArtist | מחרוזת | אופציונלי שם האומן המשויך לאלבום שבו מתארחת הטראק הזה. הנגן יכול לאחזר את האלבום AlbumArtist באופן עצמאי באמצעות content_id. לחלופין, השולח יכול לספק את המידע הזה בהודעת טעינה. |
אומן | מחרוזת | אופציונלי שם האומן המשויך לטראק המדיה. השחקן יכול לאחזר את האומן באופן עצמאי באמצעות content_id או לספק אותו בהודעה טעינה. |
מחבר | מחרוזת | אופציונלי שם המלחין המשויך לטראק של המדיה. הנגן יכול לאחזר באופן עצמאי את שם המלחין באמצעות content_id או שהשולח יכול לספק אותו בהודעה טעינה |
trackNumber | מספר שלם | אופציונלי מספר הטראק באלבום |
discNumber | מספר שלם | אופציונלי : מספר עוצמת הקול (למשל, דיסק) של האלבום |
תמונות | תמונה[] | אופציונלי מערך של כתובות URL לתמונה המשויכת לתוכן. השולח יכול לספק את הערך הראשוני של השדה בהודעה טעינה. צריך לספק גדלים מומלצים |
releaseDate | מחרוזת (ISO 8601) | אופציונלי : התאריך והשעה שבהם פורסם התוכן הזה לפי תקן ISO 8601. השחקן יכול לאחזר באופן עצמאי את הקובץ ReleaseDate באמצעות content_id. לחלופין, השולח יכול לספק את המידע הזה בהודעת טעינה. |
PhotoMediaMetadata
מתאר פריט מידע שנוצר בתהליך פיתוח (Artifact) ממדיה מצולמת.
שם | תיאור | התיאור |
---|---|---|
metadataType | מספר שלם | 4 (הערך היחיד) |
שם הפריט | מחרוזת | אופציונלי כותרת של התמונה. השחקן יכול לאחזר את הכותרת באופן עצמאי באמצעות content_id או לתת אותו על ידי השולח בהודעה טעינה |
אומן | מחרוזת | אופציונלי : שם הצלם. השחקן יכול לאחזר את האומן באופן עצמאי באמצעות content_id או לספק אותו בהודעה טעינה. |
מיקום | מחרוזת | אופציונלי מיקום מילולי שבו צולמה התמונה, לדוגמה "מדריד, ספרד". השחקן יכול לאחזר את המיקום באופן עצמאי באמצעות content_id או ששולח זה יכול לקבל זאת בהודעה טעינה |
latitude | כפולה | אופציונלי : ערכי קו רוחב גיאוגרפיים של המיקום שבו צולמה התמונה. השחקן יכול לאחזר באופן עצמאי את קו הרוחב באמצעות content_id או שהשולח יכול לציין זאת בהודעת הטעינה |
longitude | כפולה | אופציונלי : ערך של קו אורך גיאוגרפי של המיקום שבו צולמה התמונה. הנגן יכול לאחזר באופן עצמאי את קו האורך באמצעות content_id, או שהשולח יכול לציין זאת בהודעה טעינה |
רוחב | מספר שלם | אופציונלי . הרוחב בפיקסלים של התמונה. הנגן יכול לאחזר באופן עצמאי את הרוחב באמצעות content_id או שהשולח יכול לציין זאת בהודעה טעינה |
height | מספר שלם | אופציונלי גובה בפיקסלים של התמונה. הנגן יכול לאחזר את הגובה באופן עצמאי באמצעות content_id, או שהשולח יכול לציין זאת בהודעה טעינה |
creationDateTime | מחרוזת (ISO 8601) | אופציונלי : התאריך והשעה שבהם צולמה התמונה לפי תקן ISO 8601. השחקן יכול לאחזר באופן עצמאי את CreateDateTime באמצעות content_id. לחלופין, השולח יכול לספק את המידע הזה בהודעת Load (טעינה). |
MediaStatus
תיאור הסטטוס הנוכחי של פריט המדיה שנוצר בתהליך הפיתוח (Artifact) ביחס לסשן.
שם | תיאור | התיאור |
---|---|---|
mediaSessionId | מספר שלם | מזהה ייחודי להפעלת הסשן הספציפי הזה. המזהה הזה מוגדר על ידי המקבל ב-LOAD ואפשר להשתמש בו כדי לזהות אירוע ספציפי של הפעלה. לדוגמה, לשתי הפעלות של 'הלוואי שהיית כאן' בתוך אותה פעילות באתר, לכל אחת מהן יהיה mediaSessionId ייחודי. |
מדיה | MediaInformation | אופציונלי (להודעות סטטוס) תיאור מלא של התוכן שמופעל שוב. יוחזר בהודעת סטטוס רק אם ה-MediaInformation השתנה. |
playbackRate | float | מציין אם זמן המדיה מתקדם ובאיזה קצב. הפעולה הזו אינה תלויה במצב הנגן, כי זמן המדיה יכול לעצור בכל מצב. 1.0 זה זמן רגיל, 0.5 זה הילוך איטי |
playerState | טיפוסים בני מנייה (enum) (מחרוזת) | מתאר את מצב השחקן כאחת מהאפשרויות הבאות:
|
idleReason | טיפוסים בני מנייה (enum) (מחרוזת) | אופציונלי אם ה-PlayState הוא IDLE והסיבה שהוא הפך ל-IDLE ידועה, הנכס הזה מסופק. אם הנגן לא פעיל מאחר שהוא התחיל לאחרונה, לא יסופק המאפיין הזה. אם השחקן נמצא במצב אחר, אין לספק את הנכס הזה. הערכים הבאים חלים:
|
currentTime | כפולה | המיקום הנוכחי של נגן המדיה מאז תחילת התוכן, בשניות. אם מדובר בתוכן של שידור חי, השדה הזה מייצג את הזמן, בשניות מתחילת האירוע, שצריך להיות מוצג לשחקן. |
supportedMediaCommands | דגלים | דגלים שמתארים את פקודות המדיה שנתמכות בנגן המדיה:
השילובים מתוארים כסיכומים. לדוגמה, Pause+Seek+StreamVolume+mute == 15. |
נפח | עוצמת קול | עוצמת הקול של השידור |
customData | אובייקט | אופציונלי blob נתונים ספציפי לאפליקציה המוגדר על ידי האפליקציה המקבלת |
פקודות מהשולח למקבל
הפקודות האלה שולטות בנגן המדיה. כל האובייקטים של customData בהודעות שבהמשך חייבים להיות אופציונליים (כלומר, הצד המקבל ייפגע בצורה תקינה אם הנתונים לא מועברים). הפעולה הזו תאפשר לאפליקציות גנריות של שלט רחוק לפעול באופן תקין.
טען
טוען תוכן חדש בנגן המדיה.
שם | תיאור | התיאור |
---|---|---|
requestId | מספר שלם | מזהה הבקשה, כדי להתאים בין הבקשה לתגובה |
סוג | מחרוזת | LOAD (ערך בלבד) |
מדיה | MediaInformation | מטא נתונים (כולל contentId) של המדיה לטעינה |
הפעלה אוטומטית | boolean | אופציונלי (ברירת המחדל היא True) אם צוין פרמטר ההפעלה האוטומטית, נגן המדיה יתחיל להפעיל את התוכן לאחר הטעינה. גם אם לא צוינה הפעלה אוטומטית, ייתכן שההטמעה של נגן המדיה תתחיל את ההפעלה מיידית. אם ההפעלה מתחילה, יש להגדיר את מצב הנגן בתגובה ל'BUFFERING', אחרת יש להגדיר אותו בתור 'מושהה' |
currentTime | כפולה | אופציונלי בשניות מאז תחילת התוכן. אם התוכן הוא תוכן בשידור חי ולא צוין המיקום, השידור יתחיל במיקום השידור החי |
customData | אובייקט | אופציונלי blob נתונים ספציפי לאפליקציה שמוגדר על ידי אפליקציית השולח |
תשובה | גורמים מפעילים | שידורים | שגיאות |
---|---|---|---|
ללא | שינוי מצב של המקבל | הודעת שינוי בסטטוס מדיה | מצב הנגן לא חוקי הטעינה נכשלה הטעינה בוטלה |
השהיה
השהיית התוכן הנוכחי. מפעיל התראה על אירוע STATUS לכל אפליקציות השולחים.
שם | תיאור | התיאור |
---|---|---|
mediaSessionId | מספר שלם | המזהה של סשן המדיה המיועד להשהיה |
requestId | מספר שלם | מזהה הבקשה, שישמש להתאמה בין בקשה/תגובה |
סוג | מחרוזת | PAUSE (ערך בלבד) |
customData | אובייקט | אופציונלי blob נתונים ספציפי לאפליקציה שמוגדר על ידי אפליקציית השולח |
תשובה | גורמים מפעילים | שידורים | שגיאות |
---|---|---|---|
ללא | שינוי מצב של המקבל | הודעת שינוי בסטטוס מדיה | מצב נגן לא חוקי |
חפש
מגדיר את המיקום הנוכחי בזרם. מפעיל התראה על אירוע STATUS לכל אפליקציות השולחים. אם המיקום שצוין נמצא מחוץ לטווח המיקומים החוקיים עבור התוכן הנוכחי, השחקן צריך לבחור מיקום חוקי הקרוב ככל האפשר למיקום המבוקש.
שם | תיאור | התיאור |
---|---|---|
mediaSessionId | מספר שלם | מזהה של סשן המדיה שבו הוגדר המיקום של השידור החי |
requestId | מספר שלם | מזהה הבקשה, כדי להתאים בין הבקשה לתגובה |
סוג | מחרוזת | SEEK (ערך בלבד) |
resumeState | טיפוסים בני מנייה (enum) (מחרוזת) | אופציונלי אם המדיניות לא מוגדרת, סטטוס ההפעלה לא ישתנה. הערכים הבאים חלים:
|
currentTime | כפולה | אופציונלי בשניות מאז תחילת התוכן. אם התוכן הוא תוכן בשידור חי ולא צוין המיקום, השידור יתחיל במיקום השידור החי |
customData | אובייקט | אופציונלי blob נתונים ספציפי לאפליקציה שמוגדר על ידי אפליקציית השולח |
תשובה | גורמים מפעילים | שידורים | שגיאות |
---|---|---|---|
ללא | שינוי מצב של המקבל | הודעת שינוי בסטטוס מדיה | מצב נגן לא חוקי |
עצירה
עוצר את הפעלת התוכן הנוכחי. מפעיל התראה על אירוע STATUS לכל אפליקציות השולחים. אחרי הפקודה הזו, התוכן לא ייטען יותר וה-mediaSessionId יבוטל.
שם | תיאור | התיאור |
---|---|---|
mediaSessionId | מספר שלם | מזהה של סשן המדיה שבו התוכן יופסק |
requestId | מספר שלם | מזהה הבקשה, כדי להתאים בין הבקשה לתגובה |
סוג | מחרוזת | STOP (ערך בלבד) |
customData | אובייקט | אופציונלי blob נתונים ספציפי לאפליקציה שמוגדר על ידי אפליקציית השולח |
תשובה | גורמים מפעילים | שידורים | שגיאות |
---|---|---|---|
ללא | שינוי מצב של המקבל | הודעת שינוי בסטטוס מדיה | מצב נגן לא חוקי |
הפעלה
מתחיל בהפעלה של התוכן שנטען עם קריאת הטעינה, ההפעלה ממשיכה ממיקום הזמן הנוכחי.
שם | תיאור | התיאור |
---|---|---|
mediaSessionId | מספר שלם | מזהה של סשן המדיה שבו התוכן יופעל |
requestId | מספר שלם | מזהה הבקשה, כדי להתאים בין הבקשה לתגובה |
סוג | מחרוזת | PLAY (ערך בלבד) |
customData | אובייקט | אופציונלי blob נתונים ספציפי לאפליקציה שמוגדר על ידי אפליקציית השולח |
תשובה | גורמים מפעילים | שידורים | שגיאות |
---|---|---|---|
ללא | שינוי מצב של המקבל | הודעת שינוי בסטטוס מדיה | מצב נגן לא חוקי |
קבלת סטטוס
מאחזר את סטטוס המדיה.
שם | תיאור | התיאור |
---|---|---|
mediaSessionId | מספר שלם | אופציונלי מזהה סשן מדיה של המדיה שעבורה יש להחזיר את סטטוס המדיה. אם לא תספקו מזהה, יסופק הסטטוס של כל מזהי הסשנים במדיה. |
requestId | מספר שלם | מזהה הבקשה, כדי להתאים בין הבקשה לתגובה |
סוג | מחרוזת | GET_STATUS (ערך בלבד) |
customData | אובייקט | אופציונלי blob נתונים ספציפי לאפליקציה שמוגדר על ידי אפליקציית השולח |
תשובה | גורמים מפעילים | שידורים | שגיאות |
---|---|---|---|
הודעת MediaStatus לשולח שביקש אותה | ללא | ללא | ללא |
SetVolume
מגדיר את עוצמת הקול של זרם המדיה. משמש לאפקטים של הגברת עמעום/החלשה הדרגתית על שידור המדיה. (הערה: עוצמת הקול של המקבל משתנה באמצעות setVolume של שולח האינטרנט). כדי לשלוט בעוצמת הקול של המכשיר, אין להשתמש בעוצמת הקול של השידור יחד עם פס ההזזה של עוצמת הקול או עם לחצני עוצמת הקול. שינוי בעוצמת הקול של השידור לא יפעיל ממשק משתמש כלשהו במכשיר המקבל.
שם | תיאור | התיאור |
---|---|---|
mediaSessionId | מספר שלם | מזהה סשן מדיה של המדיה שעבורה השתנה עוצמת הקול של השידור |
requestId | מספר שלם | מזהה הבקשה, כדי להתאים בין הבקשה לתגובה |
סוג | מחרוזת | VOLUME (ערך בלבד) |
נפח | עוצמת קול | עוצמת הקול של השידור |
customData | אובייקט | אופציונלי blob נתונים ספציפי לאפליקציה שמוגדר על ידי אפליקציית השולח |
תשובה | גורמים מפעילים | שידורים | שגיאות |
---|---|---|---|
ללא | שינוי מצב של המקבל | הודעת שינוי בסטטוס מדיה | מצב נגן לא חוקי |
הודעות מהנמען לשולח
הנמען שולח שני סוגים של הודעות:
- שגיאות: הודעות Unicast שנשלחות כאשר יש תגובת שגיאה לבקשת שולח.
- סטטוס: הודעות שידור.
- התוצאה של פעולה ביוזמת השולח. תכלול את מזהה הבקשה של הבקשה שגרמה לשינוי.
- ספונטני: למשל, עקב שינוי שהופעל על ידי האפליקציה של המקבל. ערך הבקשה יהיה 0.
שגיאה: מצב שחקן לא חוקי
ההודעה נשלחת כשאי אפשר למלא את הבקשה של השולח כי השחקן לא במצב תקין. לדוגמה, אם האפליקציה עדיין לא יצרה רכיב מדיה.
שם | תיאור | התיאור |
---|---|---|
requestId | מספר שלם | מזהה הבקשה שגרמה לשגיאה הזו |
סוג | מחרוזת | INVALID_PLAYER_STATE (ערך בלבד) |
customData | אובייקט | אופציונלי blob נתונים ספציפי לאפליקציה המוגדר על ידי האפליקציה המקבלת |
שגיאה: הטעינה נכשלה
נשלחה כשבקשת הטעינה נכשלה. מצב הנגן יהיה פעיל.
שם | תיאור | התיאור |
---|---|---|
requestId | מספר שלם | מזהה הבקשה שגרמה לשגיאה הזו |
סוג | מחרוזת | LOAD_FAILED (ערך בלבד) |
customData | אובייקט | אופציונלי blob נתונים ספציפי לאפליקציה המוגדר על ידי האפליקציה המקבלת |
שגיאה: הטעינה בוטלה
נשלחה כשבקשת הטעינה בוטלה (התקבלה בקשת טעינה שנייה).
שם | תיאור | התיאור |
---|---|---|
requestId | מספר שלם | מזהה הבקשה שגרמה לשגיאה הזו |
סוג | מחרוזת | LOAD_CANCELLED (ערך בלבד) |
customData | אובייקט | אופציונלי blob נתונים ספציפי לאפליקציה המוגדר על ידי האפליקציה המקבלת |
שגיאה: בקשה לא תקינה
נשלחת כשהבקשה לא תקינה (סוג בקשה לא ידוע, לדוגמה).
שם | תיאור | התיאור |
---|---|---|
requestId | מספר שלם | מזהה הבקשה שגרמה לשגיאה הזו |
סוג | מחרוזת | INVALID_REQUEST (ערך בלבד) |
סיבה | Enum (מחרוזת) | ערכים:
|
customData | אובייקט | אופציונלי blob נתונים ספציפי לאפליקציה המוגדר על ידי האפליקציה המקבלת |
סטטוס מדיה
נשלח אחרי שינוי מצב או לאחר בקשה לסטטוס מדיה. יישלחו רק אובייקטי MediaStatus שהשתנו או התבקשו.
שם | תיאור | התיאור |
---|---|---|
requestId | מספר שלם | מזהה שמשמש לקישור בין תגובת הסטטוס הזו לבקשה שממנה הגיעה, או 0 אם הודעת הסטטוס היא ספונטנית (לא הופעלה על ידי בקשה של שולח). אפליקציות השולח ייצרו מזהי בקשה ייחודיים על ידי בחירה במספר אקראי והגדלתו כל הזמן (הם לא ישתמשו ב-0). |
סוג | מחרוזת | MEDIA_STATUS (ערך בלבד) |
סטטוס | MediaStatus[] | מערך של אובייקטים של סטטוס מדיה. הערה: רכיב המדיה ב-MediaStatus יוחזר רק אם הוא השתנה. |
customData | אובייקט | אופציונלי blob נתונים ספציפי לאפליקציה המוגדר על ידי האפליקציה המקבלת |