chrome.mediaGalleries

תיאור

יש להשתמש ב-API chrome.mediaGalleries כדי לגשת לקובצי מדיה (אודיו, תמונות, וידאו) מהדיסקים המקומיים של המשתמש (בהסכמת המשתמש).

הרשאות

mediaGalleries

סוגים

AddGalleryWatchResult

תכונות

  • galleryId

    מחרוזת

  • הצלחה

    boolean

GalleryChangeDetails

תכונות

  • galleryId

    מחרוזת

    מזהה את הגלריה ששונתה.

  • הסוג של אירוע השינוי.

GalleryChangeType

טיפוסים בני מנייה (enum)

"contents_ changed"
תוכן הגלריה השתנה.

"watch_dropped"
השעון הוסר כי המכשיר נותק, כי הרשאת הגלריה הוסרה או בגלל כל סיבה אחרת.

GetMediaFileSystemsInteractivity

טיפוסים בני מנייה (enum)

"לא"
אין לבצע פעולה באופן אינטראקטיבי.

"כן"
יש לבקש מהמשתמש/ת לנהל גלריות מדיה מורשות.

"if_needed"
צריך לבקש מהמשתמש לנהל את הגלריות המותרות לשימוש רק אם קבוצת ההחזרה הייתה ריקה.

GetMetadataType

טיפוסים בני מנייה (enum)

"all"
אחזור סוג ה-MIME, תגי המטא-נתונים והתמונות המצורפות.

"mimeTypeAndTags"
אחזר רק את סוג ה-mime ואת תגי המטא-נתונים.

"mimeTypeOnly"
אחזור סוג ה-MIME בלבד.

MediaFileSystemMetadata

תכונות

  • deviceId

    מחרוזת אופציונלי

    אם גלריית המדיה נמצאת במכשיר נשלף, זהו מזהה ייחודי של המכשיר כשהמכשיר במצב אונליין.

  • galleryId

    מחרוזת

    מזהה ייחודי וקבוע של גלריית המדיה.

  • isAvailable

    boolean

    True אם המכשיר זמין כרגע.

  • isMediaDevice

    boolean

    הערך הוא True אם המכשיר שבו נמצאת גלריית המדיה זוהה כמכשיר מדיה, כלומר במכשיר PTP או MTP או ספריית DCIM.

  • isRemovable

    boolean

    הערך הוא True אם גלריית המדיה נמצאת במכשיר נשלף.

  • name

    מחרוזת

    שם מערכת הקבצים.

MediaFileSystemsDetails

תכונות

  • אינטראקטיבי

    GetMediaFileSystemsInteractivity אופציונלי

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

MediaMetadata

תכונות

  • album

    מחרוזת אופציונלי

    מוגדר לאודיו ולווידאו.

  • artist

    מחרוזת אופציונלי

  • attachedImages

    כתם[]

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

  • תגובה

    מחרוזת אופציונלי

  • זכויות יוצרים

    מחרוזת אופציונלי

  • דיסק

    מספר אופציונלי

  • משך

    מספר אופציונלי

    מוגדר לאודיו ולווידאו. תוך שניות.

  • ז'אנר

    מחרוזת אופציונלי

  • גובה

    מספר אופציונלי

    מוגדר לווידאו. בפיקסלים.

  • language

    מחרוזת אופציונלי

  • mimeType

    מחרוזת

    הדפדפן מחלץ את סוג ה-mime.

  • rawTags

    StreamInfo[]

    כל המטא-נתונים בקובץ המדיה. אם מדובר בפורמטים עם מספר שידורים, הסדר של השידורים יישמר. המטא-נתונים של הקונטיינר הם הרכיב הראשון.

  • סבב

    מספר אופציונלי

    מוגדר לווידאו. במעלות.

  • title

    מחרוזת אופציונלי

  • 'מסלול'

    מספר אופציונלי

  • רוחב

    מספר אופציונלי

MediaMetadataOptions

תכונות

  • metadataType

    GetMetadataType אופציונלי

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

StreamInfo

תכונות

  • תגים

    אובייקט

    מילון תגים ללא סינון למחרוזת->מחרוזת.

  • סוג

    מחרוזת

    מתאר את הפורמט של מאגר או קודק של זרם, למשל "mp3", "h264".

שיטות

addGalleryWatch()

הבטחה 
chrome.mediaGalleries.addGalleryWatch(
  galleryId: string,
  callback?: function,
)

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

פרמטרים

החזרות

  • Chrome 116 ומעלה

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

addUserSelectedFolder()

chrome.mediaGalleries.addUserSelectedFolder(
  callback: function,
)

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

פרמטרים

  • קריאה חוזרת (callback)

    פונקציה

    הפרמטר callback נראה כך: 

    (mediaFileSystems: DOMFileSystem[],selectedFileSystemName: string)=>void

    • mediaFileSystems

      DOMFileSystem[]

    • selectedFileSystemName

      מחרוזת

getMediaFileSystemMetadata()

chrome.mediaGalleries.getMediaFileSystemMetadata(
  mediaFileSystem: DOMFileSystem,
)

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

פרמטרים

  • mediaFileSystem

    DOMFileSystem

החזרות

getMediaFileSystems()

הבטחה 
chrome.mediaGalleries.getMediaFileSystems(
  details?: MediaFileSystemsDetails,
  callback?: function,
)

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

פרמטרים

  • פרטים

    MediaFileSystemsDetails אופציונלי

  • קריאה חוזרת (callback)

    פונקציה אופציונלי

    הפרמטר callback נראה כך: 

    (mediaFileSystems: DOMFileSystem[])=>void

    • mediaFileSystems

      DOMFileSystem[]

החזרות

  • Promise<DOMFileSystem[]>

    Chrome 116 ומעלה

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

getMetadata()

הבטחה 
chrome.mediaGalleries.getMetadata(
  mediaFile: Blob,
  options?: MediaMetadataOptions,
  callback?: function,
)

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

פרמטרים

  • mediaFile

    כתם

  • אפשרויות

    MediaMetadataOptions אופציונלי

  • קריאה חוזרת (callback)

    פונקציה אופציונלי

    הפרמטר callback נראה כך: 

    (metadata: MediaMetadata)=>void

החזרות

  • Promise<MediaMetadata>

    Chrome 116 ומעלה

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

removeGalleryWatch()

chrome.mediaGalleries.removeGalleryWatch(
  galleryId: string,
)

הסרת שעון בגלריה עם מזהה הגלריה שצוין.

פרמטרים

  • galleryId

    מחרוזת

אירועים

onGalleryChanged

chrome.mediaGalleries.onGalleryChanged.addListener(
  callback: function,
)

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

פרמטרים