מחלקה: QueueLoadRequestData

יצרן

QueueLoadRequestData

new QueueLoadRequestData(items)

פרמטר

items

מערך של cast.framework.messages.QueueItem שאינו null

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

הערך לא יכול להיות ריק.

מורחב
cast.framework.messages.RequestData

תכונות

currentTime

(מספר או לא מוגדר)

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

customData

(אובייקט לא null או לא מוגדר)

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

עבר בירושה
cast.framework.messages.RequestData#customData

items

מערך לא-null של cast.framework.messages.QueueItem שאינו ריק

מערך של פריטים בתור. הוא ממוין (הרכיב הראשון יופעל ראשון).

mediaSessionId

(מספר או לא מוגדר)

המזהה של סשן המדיה שעליו חלה הבקשה.

עבר בירושה
cast.framework.messages.RequestData#mediaSessionId

repeatMode

(cast.framework.messages.RepeatMode או לא מוגדר)

ההתנהגות של התור אחרי שכל הפריטים הופעלו.

requestId

מספר

מזהה הבקשה, משמש להתאמת הבקשה/התגובה.

עבר בירושה
cast.framework.messages.RequestData#requestId

sequenceNumber

(מספר או לא מוגדר)

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

עבר בירושה
cast.framework.messages.RequestData#sequenceNumber

startIndex

(מספר או לא מוגדר)

האינדקס של הפריט במערך הפריטים שחייב להיות הפריט הנוכחי הראשון (הפריט שיופעל ראשון). חשוב לשים לב שזה האינדקס של המערך (מתחיל ב-0) ולא מזהה הפריט (מכיוון שהוא לא ידוע עד ליצירת התור). אם הערך של ReturnMode הוא REPEAT_OFF ההפעלה תסתיים כשהפריט האחרון במערך יופעל (הרכיבים שלפני ה-startIndex לא יופעלו). האפשרות הזו יכולה להיות שימושית לתרחישי המשך שבהם המשתמש כבר השתמש באפליקציית השולח ובאמצע מחליט להעביר (cast). כך, אפליקציית השולח לא צריכה למפות בין המיקום של התור המקומי לבין המיקום המרוחק, או לשמור בקשת QUEUE_UPDATE אחת נוספת.