chrome.mediaGalleries

תיאור

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

הרשאות

mediaGalleries

זמינות

ChromeOS בלבד

סוגים

AddGalleryWatchResult

מאפיינים

  • galleryId

    מחרוזת

  • הצלחה

    בוליאני

GalleryChangeDetails

מאפיינים

  • galleryId

    מחרוזת

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

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

GalleryChangeType

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

‫"contents_changed"
התוכן של הגלריה השתנה.

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

GetMediaFileSystemsInteractivity

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

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

"yes"
בקשה מהמשתמש לנהל את גלריות המדיה המורשות.

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

GetMetadataType

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

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

‫"mimeTypeAndTags"
אחזור רק של סוג ה-MIME ותגי המטא-נתונים.

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

MediaFileSystemMetadata

מאפיינים

  • deviceId

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

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

  • galleryId

    מחרוזת

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

  • isAvailable

    בוליאני

    אם המכשיר זמין כרגע, התנאי מתקיים.

  • isMediaDevice

    בוליאני

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

  • isRemovable

    בוליאני

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

  • שם

    מחרוזת

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

MediaFileSystemsDetails

מאפיינים

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

    GetMediaFileSystemsInteractivity אופציונלי

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

MediaMetadata

מאפיינים

  • album

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

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

  • artist

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

  • attachedImages

    Blob[]‎

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

  • תגובה

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

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

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

  • דיסק

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

  • משך

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

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

  • ז'אנר

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

  • גובה

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

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

  • language

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

  • mimeType

    מחרוזת

    סוג ה-MIME שהדפדפן זיהה.

  • rawTags

    StreamInfo[]

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

  • סיבוב

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

    מוגדר לסרטון. במעלות.

  • title

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

  • טראק

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

  • רוחב

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

MediaMetadataOptions

מאפיינים

  • metadataType

    ‫GetMetadataType אופציונלי

    מציין איזו קבוצת משנה של המטא-נתונים לאחזר. אם האפשרות הזו לא מוגדרת, ברירת המחדל היא "all".

StreamInfo

מאפיינים

  • tags

    אובייקט

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

  • סוג

    מחרוזת

    מתאר את הפורמט של מאגר הנתונים או ה-codec של הסטרימינג, למשל "mp3",‏ "h264".

Methods

addGalleryWatch()

Promise 
chrome.mediaGalleries.addGalleryWatch(
  galleryId: string,
  callback?: function,
): Promise<AddGalleryWatchResult>

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

פרמטרים

החזרות

  • ‫Chrome מגרסה 116 ואילך

    הבטחות נתמכות רק ב-Manifest V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callbacks).

addUserSelectedFolder()

chrome.mediaGalleries.addUserSelectedFolder(
  callback: function,
): void

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

פרמטרים

  • callback

    פונקציה

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

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

    • mediaFileSystems

      DOMFileSystem[]‎

    • selectedFileSystemName

      מחרוזת

getMediaFileSystemMetadata()

chrome.mediaGalleries.getMediaFileSystemMetadata(
  mediaFileSystem: DOMFileSystem,
): MediaFileSystemMetadata | undefined

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

פרמטרים

  • mediaFileSystem

    DOMFileSystem

החזרות

getMediaFileSystems()

Promise 
chrome.mediaGalleries.getMediaFileSystems(
  details?: MediaFileSystemsDetails,
  callback?: function,
): Promise<DOMFileSystem[]>

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

פרמטרים

  • פרטים

    ‫MediaFileSystemsDetails אופציונלי

  • callback

    function optional

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

    (mediaFileSystems: DOMFileSystem[]) => void

    • mediaFileSystems

      DOMFileSystem[]‎

החזרות

  • Promise<DOMFileSystem[]>

    ‫Chrome מגרסה 116 ואילך

    הבטחות נתמכות רק ב-Manifest V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callbacks).

getMetadata()

Promise 
chrome.mediaGalleries.getMetadata(
  mediaFile: Blob,
  options?: MediaMetadataOptions,
  callback?: function,
): Promise<MediaMetadata>

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

פרמטרים

החזרות

  • Promise<MediaMetadata>

    ‫Chrome מגרסה 116 ואילך

    הבטחות נתמכות רק ב-Manifest V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callbacks).

removeGalleryWatch()

chrome.mediaGalleries.removeGalleryWatch(
  galleryId: string,
): void

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

פרמטרים

  • galleryId

    מחרוזת

אירועים

onGalleryChanged

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

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

פרמטרים