chrome.mediaGalleries

說明

使用 chrome.mediaGalleries API 存取使用者本機磁碟中的媒體檔案 (音訊、圖片、影片),但須取得使用者同意。

權限

mediaGalleries

可用性

僅適用於 ChromeOS

類型

AddGalleryWatchResult

屬性

  • galleryId

    字串

  • 成功

    布林值

GalleryChangeDetails

屬性

  • galleryId

    字串

    用於識別修改後的相片庫。

  • 變更事件類型。

GalleryChangeType

列舉

"contents_changed"
藝廊內容已變更。

「watch_dropped」
由於裝置已卸載、相片庫權限已移除或其他原因,監控作業已取消。

GetMediaFileSystemsInteractivity

列舉

"no"
不以互動方式執行。

「yes」
要求使用者管理允許的媒體庫。

"if_needed"
只有在傳回的集合為空時,才要求使用者管理允許的相片庫。

GetMetadataType

列舉

"all"
擷取 MIME 類型、中繼資料標記和附加圖片。

"mimeTypeAndTags"
僅擷取 MIME 類型和中繼資料標記。

"mimeTypeOnly"
僅擷取 MIME 類型。

MediaFileSystemMetadata

屬性

  • deviceId

    字串 選填

    如果媒體庫位於卸除式裝置上,則為裝置連上網路時的專屬 ID。

  • galleryId

    字串

    媒體庫的永久專屬 ID。

  • isAvailable

    布林值

    如果裝置目前可用,則為 True。

  • isMediaDevice

    布林值

    如果媒體庫所在的裝置偵測為媒體裝置,則為 True。例如 PTP 或 MTP 裝置,或存在 DCIM 目錄。

  • isRemovable

    布林值

    如果媒體庫位於卸除式裝置上,則為 True。

  • 名稱

    字串

    檔案系統的名稱。

MediaFileSystemsDetails

屬性

  • 是否在傳回允許的集合前,提示使用者授予其他媒體相簿的權限。預設為靜音。如果傳遞的值為「yes」,或應用程式未獲授予任何媒體庫的存取權,且傳遞的值為「if_needed」,系統就會顯示媒體庫設定對話方塊。

MediaMetadata

屬性

  • 專輯

    字串 選填

    為音訊和影片定義。

  • 藝術家

    字串 選填

  • attachedImages

    Blob[]

    媒體檔案中繼資料內嵌的圖片。通常用於專輯封面或影片縮圖。

  • 則留言

    字串 選填

  • 字串 選填

  • disc

    數字 選填

  • 時間長度

    數字 選填

    為音訊和影片定義。以秒為單位。

  • 類型

    字串 選填

  • 高度

    數字 選填

    為影片定義。以像素為單位。

  • language

    字串 選填

  • mimeType

    字串

    瀏覽器偵測到的 MIME 類型。

  • rawTags

    媒體檔案中的所有中繼資料。如果格式有多個串流,系統會保留串流順序。容器中繼資料是第一個元素。

  • 輪替

    數字 選填

    為影片定義。單位為度。

  • title

    字串 選填

  • 追蹤

    數字 選填

  • 寬度

    數字 選填

MediaMetadataOptions

屬性

  • metadataType

    指定要擷取的中繼資料子集。如果省略這個選項,預設值為「all」。

StreamInfo

屬性

  • 標記

    物件

    串流標記的未篩選字串->字串字典。

  • 類型

    字串

    描述容器格式或串流轉碼器,例如「mp3」、「h264」。

方法

addGalleryWatch()

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

為指定 ID 的錶面圖庫新增錶面。接著,系統會觸發指定的回呼,並傳回成功或失敗結果。

參數

傳回

  • Chrome 116 以上版本

    Promise 僅適用於 Manifest V3 以上版本,其他平台則須使用回呼。

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

    函式 選填

    callback 參數如下:

    (mediaFileSystems: DOMFileSystem[]) => void

    • mediaFileSystems

      DOMFileSystem[]

傳回

  • Promise<DOMFileSystem[]>

    Chrome 116 以上版本

    Promise 僅適用於 Manifest V3 以上版本,其他平台則須使用回呼。

getMetadata()

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

取得媒體檔案的媒體專屬中繼資料。這項功能適用於媒體庫中的檔案,以及其他 DOM 檔案系統。

參數

傳回

  • Promise<MediaMetadata>

    Chrome 116 以上版本

    Promise 僅適用於 Manifest V3 以上版本,其他平台則須使用回呼。

removeGalleryWatch()

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

移除指定 ID 的錶面圖庫。

參數

  • galleryId

    字串

事件

onGalleryChanged

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

媒體庫變更或媒體庫監控作業遭捨棄時,就會觸發這個事件。

參數