chrome.devtools.performance

說明

使用 chrome.devtools.recorder API 自訂開發人員工具中的「錄音工具」面板。

如要瞭解如何使用開發人員工具 API，請參閱「開發人員工具 API 摘要」一文。

可用性

Chrome 105 以上版本

概念和用法

chrome.devtools.performance API 可讓開發人員與 Chrome 開發人員工具中效能面板面板的錄製功能互動。你可以使用這個 API 在錄製開始或停止時收到通知。

目前有兩個事件：

  • onProfilingStarted：「Performance」面板開始記錄成效資料時，會觸發此事件。
  • onProfilingStopped：當「Performance」面板停止記錄成效資料時，會觸發此事件。 將目前堆疊追蹤與 cre 建立關聯的立場 這兩個事件都沒有任何相關聯的參數。

開發人員可藉由監聽這些事件，建立能回應「Performance」(效能) 面板中記錄狀態的擴充功能，以便在剖析效能時提供額外的自動化動作。

範例

這就是運用 API 來監聽狀態更新的資訊


chrome.devtools.performance.onProfilingStarted.addListener(() => {
  // Profiling started listener implementation
});

chrome.devtools.performance.onProfilingStopped.addListener(() => {
  // Profiling stopped listener implementation
})

類型

RecorderExtensionPlugin

「錄音工具」面板會叫用的外掛程式介面，以自訂「錄音工具」面板。

屬性

  • 重播

    void

    Chrome 112 以上版本

    允許擴充功能導入自訂重播功能。

    replay 函式如下所示： 

    (recording: object) => {...}

  • stringify

    void

    將「錄音工具」面板格式的錄音檔轉換為字串。

    stringify 函式如下所示： 

    (recording: object) => {...}

  • stringifyStep

    void

    將「錄音工具」面板格式的錄製步驟轉換為字串。

    stringifyStep 函式如下所示： 

    (step: object) => {...}

RecorderView

Chrome 112 以上版本

代表要嵌入「錄音工具」面板中的擴充功能所建立的檢視畫面。

屬性

  • onHidden

    事件<functionvoid>

    檢視畫面隱藏時觸發。

    onHidden.addListener 函式如下所示： 

    (callback: function) => {...}

    • 回呼

      函式

      callback 參數如下所示： 

      () => void

  • onShown

    事件<functionvoid>

    在顯示檢視畫面時觸發。

    onShown.addListener 函式如下所示： 

    (callback: function) => {...}

    • 回呼

      函式

      callback 參數如下所示： 

      () => void

  • 顯示

    void

    表示擴充功能想要在「錄音工具」面板中顯示這個檢視畫面。

    show 函式如下所示： 

    () => {...}

方法

createView()

Chrome 112 以上版本 
chrome.devtools.recorder.createView(
  title: string,
  pagePath: string,
)

建立可處理重播的檢視畫面。這個檢視畫面會嵌入「錄音工具」面板。

參數

  • title

    字串

    顯示在開發人員工具工具列中的擴充功能圖示旁邊的標題。

  • pagePath

    字串

    面板 HTML 網頁相對於擴充功能目錄的路徑。

傳回

registerRecorderExtensionPlugin()

chrome.devtools.recorder.registerRecorderExtensionPlugin(
  plugin: RecorderExtensionPlugin,
  name: string,
  mediaType: string,
)

註冊「錄音工具」擴充功能外掛程式。

參數

  • 實作 RecorderExtensionPlugin 介面的執行個體。

  • 名稱

    字串

    外掛程式的名稱。

  • mediaType

    字串

    外掛程式產生的字串內容媒體類型。