chrome.mediaGalleries

說明

在使用者同意的情況下，使用 chrome.mediaGalleries API 存取使用者本機磁碟中的媒體檔案 (音訊、圖片、影片)。

權限

mediaGalleries

類型

AddGalleryWatchResult

屬性

  • galleryId

    字串

  • 成功

    布林值

GalleryChangeDetails

屬性

  • galleryId

    字串

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

  • 變更事件的類型。

GalleryChangeType

列舉

"contents_changed"
圖片庫內容已變更。

"watch_dropped"
由於裝置已卸離、相片庫權限已遭移除或其他原因，因此已捨棄手錶。

GetMediaFileSystemsInteractivity

列舉

"no"
請勿以互動方式採取行動。

「yes」
請使用者管理您允許的媒體圖庫。

"if_needed"
只有在返回集為空白時，才要求使用者管理允許的圖片庫。

GetMetadataType

列舉

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

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

"mimeTypeOnly"
只擷取 MIME 類型。

MediaFileSystemMetadata

屬性

  • deviceId

    string optional

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

  • galleryId

    字串

    媒體庫的永久專屬 ID。

  • 可以使用

    布林值

    如果裝置目前可用，則為「是」。

  • isMediaDevice

    布林值

    如果系統偵測到媒體庫的裝置為媒體裝置，則為 True。即 PTP 或 MTP 裝置，或有 DCIM 目錄。

  • isRemovable

    布林值

    如果媒體庫位於卸除式裝置上，則為「是」。

  • 名稱

    字串

    檔案系統的名稱。

MediaFileSystemsDetails

屬性

  • 是否在傳回允許的組合前，提示使用者授權存取其他媒體庫。預設為無聲。如果值是「yes」或應用程式尚未獲得媒體圖片庫的存取權，以及值「if_needed」，系統便會顯示媒體庫設定對話方塊。

MediaMetadata

屬性

  • 專輯

    string optional

    為音訊和視訊定義。

  • 藝術家

    string optional

  • attachedImages

    水滴 []

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

  • 則留言

    string optional

  • 版權

    string optional

  • disc

    編號 選填

  • 時間長度

    編號 選填

    為音訊和視訊定義。以秒為單位。

  • 類型

    string optional

  • 高度

    編號 選填

    已針對影片定義。以像素為單位。

  • language

    string optional

  • mimeType

    字串

    瀏覽器抓取 MIME 類型。

  • rawTags

    StreamInfo[]

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

  • 旋轉

    編號 選填

    已針對影片定義。以度為單位。

  • title

    string optional

  • 追蹤

    編號 選填

  • 寬度

    編號 選填

MediaMetadataOptions

屬性

  • metadataType

    GetMetadataType 選用

    指定要擷取的中繼資料子集。預設為「all」此選項會顯示。

StreamInfo

屬性

  • 標記

    物件

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

  • 類型

    字串

    說明串流的容器或轉碼器格式，例如「mp3」、「h264」。

方法

addGalleryWatch()

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

使用指定圖片庫 ID 為圖片庫新增圖片庫手錶。接著，系統會觸發指定的回呼，並傳送成功或失敗的結果。

參數

傳回

  • Promise<AddGalleryWatchResult>

    Chrome 116 以上版本

    Promise 僅適用於 Manifest V3 及以上版本，其他平台需要使用回呼。

addUserSelectedFolder()

chrome.mediaGalleries.addUserSelectedFolder(
  callback: function,
)

向使用者顯示目錄挑選器，並將所選目錄新增為圖片庫。如果使用者取消挑選器，則您選取的 FileSystemName 會是空白。需要使用者手勢才能顯示對話方塊。如果沒有使用者手勢，系統會照常執行回呼，就像使用者取消一樣。

參數

  • 回呼

    函式

    callback 參數如下所示： 

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

    • mediaFileSystems

      DOMFileSystem[]

    • selectedFileSystemName

      字串

getMediaFileSystemMetadata()

chrome.mediaGalleries.getMediaFileSystemMetadata(
  mediaFileSystem: DOMFileSystem,
)

取得特定媒體檔案系統的相關中繼資料。

參數

  • mediaFileSystem

    DOMFileSystem

傳回

getMediaFileSystems()

Promise 
chrome.mediaGalleries.getMediaFileSystems(
  details?: MediaFileSystemsDetails,
  callback?: function,
)

取得這個使用者代理程式中設定的媒體庫。如果未設定或可用，回呼會收到一個空陣列。

參數

  • 詳細資料

    MediaFileSystemsDetails 選用

  • 回呼

    函式 選用

    callback 參數如下所示： 

    (mediaFileSystems: DOMFileSystem[]) => void

    • mediaFileSystems

      DOMFileSystem[]

傳回

  • Promise<DOMFileSystem[]>

    Chrome 116 以上版本

    Promise 僅適用於 Manifest V3 及以上版本，其他平台需要使用回呼。

getMetadata()

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

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

參數

傳回

  • Promise<MediaMetadata>

    Chrome 116 以上版本

    Promise 僅適用於 Manifest V3 及以上版本，其他平台需要使用回呼。

removeGalleryWatch()

chrome.mediaGalleries.removeGalleryWatch(
  galleryId: string,
)

移除包含指定圖片庫 ID 的圖片庫手錶。

參數

  • galleryId

    字串

活動

onGalleryChanged

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

在媒體庫變更或圖庫手錶掉落時觸發。

參數