chrome. העברה. מדיה. מדיה
מייצג פריט מדיה שנטען לאפליקציית המקבל.
יצרן
מדיה
new Media(sessionId, mediaSessionId)
פרמטר |
|
---|---|
sessionId |
מחרוזת מזהה הסשן. |
mediaSessionId |
מספר מזהה המדיה. |
תכונות
activeTrackIds
מערך מספרים nullable
רשימת המזהים המתאימים לטראקים הפעילים.
breakStatus
(לא ריק chrome.cast.media.BreakStatus או לא מוגדר)
סטטוס ההפסקה שמופעלת במכשיר המקבל. השדה הזה יוגדר כשהמקבל מבצע הפסקה, ריק כשהפסקה לא פועלת, אבל נמצא בתוכן, ולא מוגדר אם התוכן לא מכיל הפסקות.
currentItemId
מספר ריק
מזהה הפריט של הפריט שהיה פעיל בתור (ייתכן שהוא לא פועל) במועד שבו התרחש השינוי בסטטוס המדיה.
currentTime
מספר
המיקום הנוכחי של ההפעלה, בשניות מאז תחילת המדיה.
החבר הזה מתעדכן רק באופן קבוע, כך שהערך שלו בדרך כלל לא עדכני. אפשר להשתמש בשיטה getEstimatedTime
כדי לקבל הערכה של
מיקום ההפעלה האמיתי על סמך המידע האחרון שדווח על ידי
המקבל.
- הוצא משימוש
- במקום זאת, יש להשתמש ב-getCurrentTime.
customData
אובייקט null
נתונים מותאמים אישית שהוגדרו על ידי האפליקציה המקבלת.
idleReason
nullable chrome.cast.media.IdleReason
הסיבה לאי-פעילות אם הנמען יודע.
items
מערך nullable מערך של chrome.cast.media.QueueItem שאינו ריק
מערך של פריטים ממוינים בתור.
liveSeekableRange
(לא ריק chrome.cast.media.LiveSeekableRange או לא מוגדר)
טווח ניתן לחיפוש של שידור חי או אירוע. מתבצע שימוש בזמן מדיה יחסי בשניות. היא לא תהיה מוגדרת לשידורי VOD.
loadingItemId
מספר ריק
מזהה הפריט של הפריט שנטען כרגע במכשיר המקבל. אם לא מתבצעת טעינה של אף פריט, הערך יהיה null.
media
הערך ריק chrome.cast.media.MediaInfo
תיאור המדיה.
mediaSessionId
מספר
מזהה את פריט המדיה.
playbackRate
מספר
קצב ההפעלה. 1.0 מייצג הפעלה רגילה.
playerState
non-null chrome.cast.media.PlayerState
מצב הנגן.
preloadedItemId
מספר ריק
המזהה של הפריט הבא, זמין רק אם הוא נטען מראש. ניתן לטעון מראש את פריטי המדיה של המקבל ולשמור אותם במטמון באופן זמני בזיכרון, כך שכאשר הם ייטענו מאוחר יותר, התהליך יהיה מהיר יותר (כי אין צורך לאחזר את המדיה מהרשת).
queueData
(לא ריק chrome.cast.media.QueueData או לא מוגדר)
נתוני תור.
repeatMode
non-null chrome.cast.media.RepeatMode
מצב החזרה להפעלת התור.
sessionId
מחרוזת
מזהה את הסשן שמארח את המדיה.
supportedMediaCommands
non-null Array of non-null chrome.cast.media.MediaCommand
פקודות המדיה שבהן תומך נגן המדיה.
videoInfo
(לא ריק chrome.cast.media.VideoInformation או לא מוגדר)
פרטי הסרטון.
עוצמת קול
chrome.cast.Volume לא ריק
עוצמת הקול של זרם המדיה. volume.level ו-Volume.muted תמיד יהיו מוגדרים.
שיטות
addUpdateListener
addUpdateListener(listener)
הוספת האזנה מופעלת כאשר הסטטוס של המדיה משתנה. שינויים במאפיינים הבאים יפעילו את המאזין: currentTime, עוצמת קול, מטא-נתונים, playRate, PlayerState, customData. קריאה מוצלחת לשיטת getStatus של המדיה תפעיל גם היא את ה-listener.
פרמטר |
|
---|---|
listener |
function(boolean) ה-listener שיש להוסיף. הפרמטר מציין אם אובייקט המדיה עדיין חי. |
editTracksInfo
editTracksInfo(editTracksInfoRequest, successCallback, errorCallback)
'משנה את סגנון רצועות הטקסט' או את הסטטוס של רצועות הטקסט. אם מזהה ה-TrackId לא תואם למזהי ה-trackId הקיימים, הבקשה כולה תיכשל והסטטוס לא ישתנה.
פרמטר |
|
---|---|
editTracksInfoRequest |
chrome.cast.media.EditTracksInfoRequest הערך לא יכול להיות ריק. |
successCallback |
function() הקמפיין הופעל בהצלחה. |
errorCallback |
function(non-null chrome.cast.Error) הופעלה בגלל שגיאה. השגיאות האפשריות הן OFFSET, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR ו-extensions_MISSING. |
getEstimatedBreakClipTime
getEstimatedBreakClipTime() returns (number or undefined)
הערכה של המיקום הנוכחי של קליפ ההפסקה על סמך המידע האחרון שדווח על ידי המקבל.
- החזרות
-
(number or undefined)
הערכה של המיקום הנוכחי בקליפ של ההפסקה בשניות מאז תחילת המדיה. הפונקציה מחזירה את הערך 'לא מוגדר' אם breakStatus או currentBreakClipTime לא מוגדרים כאשר הפסקה אינה מופעלת.
getEstimatedBreakTime
getEstimatedBreakTime() returns (number or undefined)
הערכה של מיקום ההפסקה הנוכחי על סמך המידע האחרון שדווח על ידי המקבל.
- החזרות
-
(number or undefined)
הערכה של מיקום ההפסקה הנוכחי, בשניות, מאז הפעלת המדיה. הפונקציה מחזירה את הערך 'לא מוגדר' אם breakStatus או currentBreakTime לא הוגדרו (כשהפסקה לא מופעלת).
getEstimatedLiveSeekableRange
getEstimatedLiveSeekableRange() returns (chrome.cast.media.LiveSeekableRange or undefined)
הערכה של ההתחלה של LiveSeekableRange בשניות על סמך המידע האחרון שדווח על ידי המקבל.
- החזרות
-
(non-null chrome.cast.media.LiveSeekableRange or undefined)
אומדן של LiveSeekableRange הנוכחי. הערך 'לא מוגדר' יוחזר אם התוכן liveSeekableRange, liveSeekableRange.start או LiveSeekableRange.end לא מוגדרים כשהתוכן לא פעיל.
getEstimatedTime
getEditTime() מחזיר מספר
הערכה של מיקום ההפעלה הנוכחי על סמך המידע האחרון שדווח על ידי המקבל.
- החזרות
-
number
הערכה של מיקום ההפעלה הנוכחי, בשניות, מאז תחילת המדיה.
getStatus
getStatus(getStatusRequest, successCallback, errorCallback)
קבלת הסטטוס של פריט המדיה מהאפליקציה המקבל.
לצד ה-eventCallback הנתון, כל מאזינים של עדכון מדיה שנוספו יופעלו גם כשהסטטוס יתקבל מהאפליקציה של המקבל. במקום להפעיל את השיטה הזו כדי לבדוק את סטטוס המדיה, כדאי באפליקציות להסתמך על ההפעלה האוטומטית של מאזינים לעדכון מדיה בכל פעם שהמדיה משתנה.
פרמטר |
|
---|---|
getStatusRequest |
chrome.cast.media.GetStatusRequest בקשת הסטטוס האופציונלית. |
successCallback |
function() מופעלת כשהסטטוס מתקבל מהאפליקציה של המקבל. |
errorCallback |
function(non-null chrome.cast.Error) הופעלה בגלל שגיאה. השגיאות האפשריות הן OFFSET, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR ו-extensions_MISSING. |
השהיה
pause(pauseRequest, SuccessCallback, errorCallback)
השהיית פריט המדיה.
פרמטר |
|
---|---|
pauseRequest |
|
successCallback |
function() הקמפיין הופעל בהצלחה. |
errorCallback |
function(non-null chrome.cast.Error) הופעלה בגלל שגיאה. הבקשה להשהיית המדיה. השגיאות האפשריות הן גלובוס, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR ו-extensions_MISSING. |
הפעלה, פליי
play(playRequest, youCallback, errorCallback)
הפעלת פריט המדיה.
פרמטר |
|
---|---|
playRequest |
הבקשה האופציונלית להפעלת מדיה. |
successCallback |
function() הקמפיין הופעל בהצלחה. |
errorCallback |
function(non-null chrome.cast.Error) הופעלה בגלל שגיאה. השגיאות האפשריות הן OFFSET, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR ו-extensions_MISSING. |
queueAppendItem
queueAppendItem(item, successCallback, errorCallback)
מצרף פריט מדיה חדש לסוף התור.
פרמטר |
|
---|---|
פריט |
הפריט שצריך לצרף לסוף 'הבאים בתור'. הערך לא יכול להיות ריק. |
successCallback |
function() הקמפיין הופעל בהצלחה. |
errorCallback |
function(non-null chrome.cast.Error) הופעלה בגלל שגיאה. השגיאות האפשריות הן OFFSET, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR ו-extensions_MISSING. |
queueInsertItems
queueInsertItems(queueInsertItemsRequest, successCallback, errorCallback)
הוספת רשימה של פריטי מדיה חדשים לתור.
פרמטר |
|
---|---|
queueInsertItemsRequest |
chrome.cast.media.QueueInsertItemsRequest בקשה להוסיף פריטי מדיה לתור המדיה. הערך לא יכול להיות ריק. |
successCallback |
function() הקמפיין הופעל בהצלחה. |
errorCallback |
function(non-null chrome.cast.Error) הופעלה בגלל שגיאה. השגיאות האפשריות הן OFFSET, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR ו-extensions_MISSING. |
queueJumpToItem
queueJumpToItem(itemId, successCallback, errorCallback)
הפעלת הפריט עם itemId בתור.
אם itemId לא נמצא בתור, בין אם הוא לא היה שם במקור או כי הוא הוסר על ידי שולח אחר לפני הקריאה לפונקציה הזו, הפונקציה הזו תחזור בשקט בלי לשלוח בקשה למקבל.
פרמטר |
|
---|---|
itemId |
מספר המזהה של הפריט שאליו יש לעבור. |
successCallback |
function() הקמפיין הופעל בהצלחה. |
errorCallback |
function(non-null chrome.cast.Error) הופעלה בגלל שגיאה. השגיאות האפשריות הן OFFSET, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR ו-extensions_MISSING. |
queueMoveItemToNewIndex
queueMoveItemToNewIndex(itemId, newIndex, successCallback, errorCallback)
מעביר את הפריט עם itemId כך שימוקם במיקום newIndex בתור.
אם itemId לא נמצא בתור, בין אם הוא לא היה שם במקור או כי הוא הוסר על ידי שולח אחר לפני הקריאה לפונקציה הזו, הפונקציה הזו תחזור בשקט בלי לשלוח בקשה למקבל.
הפרמטר errorCallback יופעל אם הערך של הפרמטר newIndex יהיה שלילי. עם זאת, אם הפרמטר newIndex גולש מכיוון שהוא צוין בטעות או שהתור כווץ על ידי שולח אחר, הפריט יועבר לסוף התור.
פרמטר |
|
---|---|
itemId |
מספר המזהה של הפריט שרוצים להעביר. |
newIndex |
מספר האינדקס החדש של הפריט. |
successCallback |
function() הקמפיין הופעל בהצלחה. |
errorCallback |
function(non-null chrome.cast.Error) הופעלה בגלל שגיאה. השגיאות האפשריות הן OFFSET, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR ו-extensions_MISSING. |
queueNext
queueNext(successCallback, errorCallback)
מעבר לפריט הבא בתור.
פרמטר |
|
---|---|
successCallback |
function() הקמפיין הופעל בהצלחה. |
errorCallback |
function(non-null chrome.cast.Error) הופעלה בגלל שגיאה. השגיאות האפשריות הן OFFSET, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR ו-extensions_MISSING. |
queuePrev
queuePrev(successCallback, errorCallback)
מעבר לפריט הקודם בתור.
פרמטר |
|
---|---|
successCallback |
function() הקמפיין הופעל בהצלחה. |
errorCallback |
function(non-null chrome.cast.Error) הופעלה בגלל שגיאה. השגיאות האפשריות הן OFFSET, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR ו-extensions_MISSING. |
queueRemoveItem
queueRemoveItem(itemId, successCallback, errorCallback)
הסרת הפריט עם itemId מהתור.
אם itemId לא נמצא בתור, בין אם הוא לא היה שם במקור או כי הוא הוסר על ידי שולח אחר לפני הקריאה לפונקציה הזו, הפונקציה הזו תחזור בשקט בלי לשלוח בקשה למקבל.
פרמטר |
|
---|---|
itemId |
מספר המזהה של הפריט שיש להסיר. |
successCallback |
function() הקמפיין הופעל בהצלחה. |
errorCallback |
function(non-null chrome.cast.Error) הופעלה בגלל שגיאה. השגיאות האפשריות הן OFFSET, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR ו-extensions_MISSING. |
queueReorderItems
queueReorderItems(queueReorderItemsRequest, successCallback, errorCallback)
שינוי הסדר של רשימת פריטי המדיה בתור.
פרמטר |
|
---|---|
queueReorderItemsRequest |
chrome.cast.media.QueueReorderItemsRequest בקשה לשינוי סדר הפריטים בתור המדיה. הערך לא יכול להיות ריק. |
successCallback |
function() הקמפיין הופעל בהצלחה. |
errorCallback |
function(non-null chrome.cast.Error) הופעלה בגלל שגיאה. השגיאות האפשריות הן OFFSET, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR ו-extensions_MISSING. |
queueSetRepeatMode
queueSetRepeatMode(repeatMode, successCallback, errorCallback)
מגדיר את מצב החזרה של התור.
פרמטר |
|
---|---|
repeatMode |
האלגוריתם לבחירת הפריט הבא כשהפריט הנוכחי מסתיים. הערך לא יכול להיות ריק. |
successCallback |
function() הקמפיין הופעל בהצלחה. |
errorCallback |
function(non-null chrome.cast.Error) הופעלה בגלל שגיאה. השגיאות האפשריות הן OFFSET, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR ו-extensions_MISSING. |
queueUpdateItems
queueUpdateItems(queueUpdateItemsRequest, successCallback, errorCallback)
עדכון המאפיינים של תור המדיה, למשל מצב חזרה ומאפיינים של הפריטים הקיימים בתור המדיה.
פרמטר |
|
---|---|
queueUpdateItemsRequest |
chrome.cast.media.QueueUpdateItemsRequest בקשה לעדכון המאפיינים של תור המדיה. הערך לא יכול להיות ריק. |
successCallback |
function() הקמפיין הופעל בהצלחה. |
errorCallback |
function(non-null chrome.cast.Error) הופעלה בגלל שגיאה. השגיאות האפשריות הן OFFSET, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR ו-extensions_MISSING. |
removeUpdateListener
removeUpdateListener(listener)
מסיר פריט האזנה שנוסף בעבר למדיה הזו.
פרמטר |
|
---|---|
listener |
function(boolean) ה-listener שיש להסיר. |
הרץ
search(seekRequest, youCallback, errorCallback)
מחפש את פריט המדיה.
פרמטר |
|
---|---|
seekRequest |
הבקשה לחיפוש מדיה. הערך לא יכול להיות ריק. |
successCallback |
function() הקמפיין הופעל בהצלחה. |
errorCallback |
function(non-null chrome.cast.Error) הופעלה בגלל שגיאה. השגיאות האפשריות הן OFFSET, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR ו-extensions_MISSING. |
setVolume
setVolume(volumeRequest, successCallback, errorCallback)
מגדיר את עוצמת הקול של זרם המדיה. יש להגדיר לפחות אפשרות אחת של volumeRequest.level או בשדה volumeRequest.muted. שינוי מצב ההשתקה לא משפיע על רמת עוצמת הקול, ולהיפך.
פרמטר |
|
---|---|
volumeRequest |
chrome.cast.media.VolumeRequest הבקשה להגדרת נפח. הערך לא יכול להיות ריק. |
successCallback |
function() הקמפיין הופעל בהצלחה. |
errorCallback |
function(non-null chrome.cast.Error) הופעלה בגלל שגיאה. השגיאות האפשריות הן OFFSET, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR ו-extensions_MISSING. |
עצירת ביניים
stop(stopRequest, youCallback, errorCallback)
לחיצה על הלחצן תעצור את נגן המדיה.
פרמטר |
|
---|---|
stopRequest |
בקשת הפסקה. |
successCallback |
function() הקמפיין הופעל בהצלחה. |
errorCallback |
function(non-null chrome.cast.Error) הופעלה בגלל שגיאה. השגיאות האפשריות הן OFFSET, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR ו-extensions_MISSING. |
supportsCommand
SupportCommand(command) מחזיר בוליאני
המדיניות הזו קובעת אם נגן המדיה תומך בפקודת מדיה נתונה.
פרמטר |
|
---|---|
מקש Command |
chrome.cast.media.MediaCommand הפקודה לביצוע השאילתה. הערך לא יכול להיות ריק. |
- החזרות
-
boolean
True אם הנגן תומך בפקודה.