chrome.mediaGalleries

תיאור

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

הרשאות

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

    בוליאני

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

  • 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

    אובייקט

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

  • סוג

    מחרוזת

    מתאר את הפורמט של הקונטיינר או הקודק של הסטרים, למשל mp3 או h264.

Methods

addGalleryWatch()

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

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

פרמטרים

החזרות

  • ‫Chrome 116 ואילך

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

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[]>

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

פרמטרים

  • פרטים

    ‫MediaFileSystemsDetails אופציונלי

  • callback

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

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

    (mediaFileSystems: DOMFileSystem[]) => void

    • mediaFileSystems

      DOMFileSystem[]

החזרות

  • Promise<DOMFileSystem[]>

    ‫Chrome 116 ואילך

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

getMetadata()

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

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

פרמטרים

החזרות

  • Promise<MediaMetadata>

    ‫Chrome 116 ואילך

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

removeGalleryWatch()

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

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

פרמטרים

  • galleryId

    מחרוזת

אירועים

onGalleryChanged

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

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

פרמטרים