מחלקה: QueueBase

cast.framework.QueueBase

class   סטטי

הטמעה בסיסית של תור.

יצרן

QueueBase

חדש QueueBase()

שיטות

fetchItems

fetchItems(itemId, nextCount, prevCount) returns (non-null Array of non-null cast.framework.messages.QueueItem or non-null Promise containing non-null Array of non-null cast.framework.messages.QueueItem)

מאחזרת חלון של פריטים, ומשתמש ב-itemID שצוין כהפניה. השיטה הזאת נקראת על ידי MediaManager כאשר יש בה צורך בפריטים נוספים בתור, לרוב שנובעים מבקשת שולח. אם nextCount או prevCount מוגדרים, הפונקציה fetchItems תחזיר פריטים רק אחרי או לפני הפריט הרלוונטי. אם גם nextCount וגם prevCount מוגדרים, יוחזר חלון של פריטים שכוללים את itemId.

פרמטר
itemId	מספר המזהה של פריט ההפניה.
nextCount	מספר מספר הפריטים אחרי פריט ההפניה.
prevCount	מספר מספר הפריטים לפני פריט הייחוס.

החזרות

(non-null Array of non-null cast.framework.messages.QueueItem or non-null Promise containing non-null Array of non-null cast.framework.messages.QueueItem) 

initialize

startize(requestData) returns (cast.framework.messages.QueueData או הבטחה שאינה null שמכילה את ה-cast.framework.messages.QueueData עם ערך null)

הפעלת התור עם requestData. השיחה תקושר כשהמקבל יקבל בקשת cast.framework.messages.Command.LOAD חדשה. אם ההגדרה הזו מוחזרת או נמצאת בסטטוס null, הטמעת ברירת המחדל של התור תיצור תור שמבוסס על queueData.items או על פריט המדיה היחיד בנתוני הבקשה LOAD.

פרמטר
requestData	cast.framework.messages.LoadRequestData הערך לא יכול להיות ריק.

החזרות

(nullable cast.framework.messages.QueueData or non-null Promise containing nullable cast.framework.messages.QueueData) 

nextItems

nextItems(itemId) returns (nullable Array of non-null cast.framework.messages.QueueItem or non-null Promise containing nullable Array of non-null cast.framework.messages.QueueItem)

מחזירה את כל הפריטים בתור אחרי itemID. קוראים לזה MediaManager.

פרמטר
itemId	אופציונלי מספר המזהה של פריט ההפניה.

החזרות

(nullable Array of non-null cast.framework.messages.QueueItem or non-null Promise containing nullable Array of non-null cast.framework.messages.QueueItem) 

onCurrentItemIdChanged

onCurrentItemIdChanged(itemId)

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

פרמטר
itemId	מספר המזהה הייחודי של הפריט.

onItemsInserted

onItemsInserted(items, insertBefore)

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

פרמטר
items	מערך של cast.framework.messages.QueueItem שאינו null הפריטים שנוספו. הערך לא יכול להיות ריק.
insertBefore	אופציונלי מספר המזהה של הפריט שנמצא מיד אחרי הרשימה שהוכנסה. אם לא הוזן מזהה, הרשימה שהוכנסה מצורפת לסוף התור.

onItemsRemoved

onItemsRemoved(itemIds)

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

פרמטר
itemIds	מערך מספרים המזהים של הפריטים שהוסרו. הערך לא יכול להיות ריק.

onItemsReordered

onItemsReordered(items, insertBefore)

קריאה חוזרת (callback) שמציינת שהפריטים הבאים הוזמנו מחדש.

פרמטר
items	מערך של cast.framework.messages.QueueItem שאינו null המזהים של הפריטים שהוזמנו מחדש. הערך לא יכול להיות ריק.
insertBefore	אופציונלי מספר המזהה של הפריט שנמצא מיד אחרי הרשימה שסדרת מחדש. אם לא מזינים insertBefore, הרשימה שסדרת מחדש תתווסף לסוף התור.

כדאי לעיין גם בפרטים הבאים

cast.framework.messages.QueueReorderRequestData#itemIds לפרטים נוספים.

prevItems

prevItems(itemId) returns (nullable Array of non-null cast.framework.messages.QueueItem or non-null Promise containing nullable Array of non-null cast.framework.messages.QueueItem)

הפונקציה מחזירה את כל הפריטים לפני itemID. קוראים לכך על ידי MediaManager.

פרמטר
itemId	אופציונלי מספר המזהה של פריט ההפניה.

החזרות

(nullable Array of non-null cast.framework.messages.QueueItem or non-null Promise containing nullable Array of non-null cast.framework.messages.QueueItem) 

מיון נתונים (shuffle)

shuffle() returns (nullable מערך של cast.framework.messages.QueueItem או הבטחה שאינה אפסית שמכילה מערך של nullable מערך של cast.framework.messages.QueueItem שאינו null)

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

החזרות

(nullable Array of non-null cast.framework.messages.QueueItem or non-null Promise containing nullable Array of non-null cast.framework.messages.QueueItem) 

להפעיל בסדר אקראי

unshuffle() returns (nullable Array of non-null cast.framework.messages.QueueItem או non-null Promise המכיל מערך ריק של null cast.framework.messages.QueueItem)

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

החזרות

(nullable Array of non-null cast.framework.messages.QueueItem or non-null Promise containing nullable Array of non-null cast.framework.messages.QueueItem)