מחלקה: TextTracksManager

‪cast.framework.TextTracksManager

class   static

ניהול רצועות טקסט.

מקפיצה את הודעות השגיאה (Throws)

non-null Error אם נעשה שימוש ישיר ב-constructor. הגישה אל TextTracksManager צריכה להתבצע רק באמצעות קריאה ל-cast.framework.PlayerManager#getTextTracksManager.

Methods

addTracks

addTracks(tracks)

הוספת טראקים של טקסט לרשימה.

פרמטר
רצועות	מערך של cast.framework.messages.Track שאינם null הערך לא יכול להיות null.

מקפיצה את הודעות השגיאה (Throws)

non-null Error אם הרצועות לא זמינות, או אם trackId לא ייחודי, או אם מוסיפים רצועות שאינן טקסט.

createTrack

‫createTrack()‎ מחזירה cast.framework.messages.Track

יוצר טראק טקסט.

מקפיצה את הודעות השגיאה (Throws)

non-null Error אם הכלי לניהול טראקים לא זמין.

החזרות

non-null cast.framework.messages.Track 

getActiveIds

‫getActiveIds()‎ מחזירה מערך של מספרים

מקבל את כל מזהי הטקסט הפעילים.

החזרות

non-null Array of number 

getActiveTracks

‫getActiveTracks()‎ מחזירה מערך של cast.framework.messages.Track שאינם null

מקבל את כל רצועות הטקסט הפעילות.

החזרות

non-null Array of non-null cast.framework.messages.Track 

getTextTracksStyle

getTextTracksStyle() returns (cast.framework.messages.TextTrackStyle or undefined)

מחזירה את הסגנון הנוכחי של רצועת הטקסט.

החזרות

(non-null cast.framework.messages.TextTrackStyle or undefined) 

getTrackById

‫getTrackById(id)‎ מחזירה cast.framework.messages.Track

מחזירה את רצועת הטקסט לפי מזהה.

פרמטר
id [מזהה]	number

מקפיצה את הודעות השגיאה (Throws)

‫non-null Error אם המזהה לא זמין או לא תקין.

החזרות

nullable cast.framework.messages.Track 

getTracks

getTracks() returns Array of non-null cast.framework.messages.Track

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

החזרות

non-null Array of non-null cast.framework.messages.Track 

getTracksByLanguage

getTracksByLanguage(language) returns Array of non-null cast.framework.messages.Track

מחזירה את רצועות הטקסט לפי שפה.

פרמטר
language	מחרוזת תג שפה בהתאם ל-RFC 5646.

מקפיצה את הודעות השגיאה (Throws)

non-null Error אם השפה לא זמינה.

החזרות

non-null Array of non-null cast.framework.messages.Track 

setActiveByIds

setActiveByIds(newIds)

הגדרת מסלולי טקסט כפעילים לפי מזהה.

פרמטר
newIds	מערך של מספרים מזהי רצועות הטקסט שיופעלו. כדי לנקות את רכיבי textTrack, צריך להגדיר את הערך כמערך ריק או כ-null. הערך יכול להיות null.

מקפיצה את הודעות השגיאה (Throws)

‫non-null Error אם המזהה לא תקין.

setActiveByLanguage

setActiveByLanguage(language)

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

פרמטר
language	מחרוזת תג שפה בהתאם ל-RFC 5646.

מקפיצה את הודעות השגיאה (Throws)

non-null Error אם השפה לא זמינה או לא תקינה.

setTextTrackStyle

setTextTrackStyle(style)

הגדרת הסגנון של רצועת הטקסט.

פרמטר
סגנון	cast.framework.messages.TextTrackStyle הערך לא יכול להיות null.

מקפיצה את הודעות השגיאה (Throws)

non-null Error אם הכלי לניהול טראקים לא זמין.