מחלקה: CastReceiverOptions

יצרן

CastReceiverOptions

new CastReceiverOptions()

מאפיינים

adBreakPreloadTime

(מספר או undefined)

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

customNamespaces

non-null Object with non-null cast.framework.system.MessageType properties

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

disableIdleTimeout

(ערך בוליאני או undefined)

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

enforceSupportedCommands

קבוע

בוליאני

אם הערך הוא True, כל פקודת מדיה שלא מופיעה במיפוי של supportedCommands תגרום לשגיאה. הערך של cast.framework.messages.ErrorReason יהיה NOT_SUPPORTED. ערך ברירת המחדל הוא False, שמאפשר לבצע פקודות מדיה בלי לבדוק את המפה.

localSenderId

(מחרוזת או לא מוגדר)

מזהה השולח שמשמש לבקשות מקומיות. ערך ברירת המחדל הוא 'local'.

maxInactivity

(מספר או undefined)

משך הזמן המקסימלי בשניות לפני סגירת חיבור שולחן לא פעיל. הגדרת הערך הזה מאפשרת לשלוח הודעת דופק כדי לשמור על החיבור פעיל. השימוש ב-TCP מאפשר לזהות שולחים שלא מגיבים מהר יותר מאשר בדרך כלל. הערך המינימלי הוא 5 שניות. לא מוגדר ערך מקסימלי, אבל בדרך כלל עוברות כמה דקות עד שפסק הזמן של TCP בפלטפורמה נכנס לתוקף. ערך ברירת המחדל הוא 10 שניות.

mediaElement

(non-null HTMLMediaElement or undefined)

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

playbackConfig

(non-null cast.framework.PlaybackConfig or undefined)

הגדרת הפעלה עם פרמטרים מותאמים אישית.

playWatchedBreak

(ערך בוליאני או undefined)

אם הערך הוא true, הפסקה שנתפרה בצד הלקוח תופעל גם אם כבר צפו בה.

preferredPlaybackRate

(מספר או undefined)

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

preferredTextLanguage

(מחרוזת או לא מוגדר)

השפה שבה יש להשתמש בטקסט אם בבקשת הטעינה לא מצוין טקסט פעיל.

רשימת סרטונים

(non-null cast.framework.QueueBase or undefined)

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

shakaVariant

(non-null cast.framework.ShakaVariant or undefined)

איזו גרסה של Shaka Player צריך לטעון. מגדירים את הערך ל-cast.framework.ShakaVariant.DEBUG כדי לטעון גרסת build לניפוי באגים.

shakaVersion

(מחרוזת או לא מוגדר)

גרסת Shaka בפורמט MAJOR.MINOR.PATCH או MAJOR.MINOR.PATCH-SUFFIX לדוגמה, '4.15.35' (ברירת המחדל הנוכחית).

הגרסאות הנתמכות הן >=4.15.35 <5.0.0. גרסאות שיצאו משימוש אבל עדיין תואמות הן גרסאות 2.5.6 ומעלה וגרסאות 4.15.35 ומטה.

הערה: לא מומלץ להשתמש בגרסאות של Shaka Player שקודמות לגרסת ברירת המחדל, כי הרבה באגים תוקנו בגרסאות האחרונות. אפשר לציין כאן גרסאות חדשות יותר כדי להצטרף לתיקונים או לתכונות נוספים שעדיין לא זמינים כברירת מחדל. עם זאת, חשוב לדעת שבגרסאות עתידיות של Web Receiver SDK יכול להיות שיחול שינוי בטווח הגרסאות הנתמכות, ושימוש בגרסה אחרת מזו שצוינה כאן יהיה חובה. צריך להשתמש בדגל הזה רק כאמצעי זמני, ובהתאם להנחיות של צוות התמיכה של Cast. (https://developers.google.com/cast/support) השימוש הוא באחריותכם בלבד.

skipMplLoad

(ערך בוליאני או undefined)

אם הערך הוא true, המקלט לא יכול לטעון את נגן ה-MPL.

skipPlayersLoad

(ערך בוליאני או undefined)

אם הערך הוא true, המקבל לא יכול לטעון את הספריות של MPL או Shaka Player. שווה להגדרת skipMplLoad ו-skipShakaLoad לערך true.

skipShakaLoad

(ערך בוליאני או undefined)

אם הערך הוא True, המקלט לא יכול לטעון את Shaka Player.

statusText

(מחרוזת או לא מוגדר)

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

supportedCommands

(מספר או undefined)

ביט-מסק של פקודות מדיה שהאפליקציה תומכת בהן. תמיד צריך לתמוך בפעולות LOAD,‏ PLAY,‏ STOP ו-GET_STATUS. אם הערך הזה לא סופק, המערכת תניח שגם הפעולות PAUSE,‏ SEEK,‏ STREAM_VOLUME,‏ STREAM_MUTE,‏ EDIT_TRACKS ו-PLAYBACK_RATE נתמכות.

ראה גם
cast.framework.messages.Command

uiConfig

(non-null cast.framework.ui.UiConfig or undefined)

הגדרת ממשק המשתמש.

useLegacyDashSupport

(ערך בוליאני או undefined)

אם true, צריך להשתמש ב-MPL לתוכן DASH.

useShakaForHls

(ערך בוליאני או undefined)

אם משתמשים ב-true, צריך להשתמש ב-Shaka Player לתוכן HLS. ברירת המחדל היא false.

הערה: Shaka Player לא מוגדר כברירת המחדל לתוכן HLS כי עדיין חסרות בו תכונות, וכי אנחנו רוצים לוודא שהוא יעיל ותואם באופן נרחב למקלטי HLS לפני שנגדיר אותו כברירת המחדל. אם תבחרו להשתמש ב-Shaka Player ל-HLS לפני ההשקה הרשמית, נבקש מכם לדווח על כל בעיה שתיתקלו בה. ‫(https://developers.google.com/cast/support) לפני ההשקה המלאה של Shaka Player ל-HLS, אנחנו לא מתחייבים לגבי התאימות של Shaka Player ל-HLS, ויכול להיות שנמליץ לך להחזיר את הדגל הזה להגדרת ברירת המחדל שלו אם תיתקל בבעיות משמעותיות.

versionCode

(מספר או undefined)

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