browser.desktopCapture

説明

画面キャプチャ API は、画面、個々のウィンドウ、個々のタブのコンテンツをキャプチャします。

権限

desktopCapture

型

DesktopCaptureSourceType

chooseDesktopMedia() で使用されるデスクトップ メディアソースのセットを定義するために使用される列挙型。

列挙型

"screen"

"window"

「タブ」

"audio"

SelfCapturePreferenceEnum

Chrome 107 以降 Chrome 148 以降の browser.*

SelfCapturePreferenceEnum をミラーリングします。

列挙型

"include"

"exclude"

SystemAudioPreferenceEnum

Chrome 105 以降 Chrome 148 以降の browser.*

SystemAudioPreferenceEnum をミラーリングします。

列挙型

"include"

"exclude"

WindowAudioPreferenceEnum

Chrome 140 以降 Chrome 148 以降の browser.*

WindowAudioPreferenceEnum をミラーリングします。

列挙型

"system"

"window"

"exclude"

メソッド

cancelChooseDesktopMedia()

browser.desktopCapture.cancelChooseDesktopMedia(
  desktopMediaRequestId: number,
)
: void

chooseDesktopMedia() によって表示されるデスクトップ メディアの選択ダイアログを非表示にします。

パラメータ

  • desktopMediaRequestId

    数値

    chooseDesktopMedia() によって返される ID

chooseDesktopMedia()

browser.desktopCapture.chooseDesktopMedia(
  sources: DesktopCaptureSourceType[],
  targetTab?: Tab,
  callback: function,
)
: number

指定されたソースセットを含むデスクトップ メディアの選択 UI を表示します。

パラメータ

  • ユーザーに表示するソースのセット。セット内のソースの順序によって、選択ツールのタブの順序が決まります。

  • targetTab

    タブ 省略可

    ストリームが作成されるオプションのタブ。指定しない場合、結果のストリームは呼び出し元の拡張機能でのみ使用できます。このストリームは、セキュリティ オリジンが tab.url と一致する、指定されたタブ内のフレームでのみ使用できます。タブのオリジンは、HTTPS などの安全なオリジンである必要があります。

  • callback

    関数

    callback パラメータは次のようになります。

    (streamId: string, options: object) => void

    • streamId

      文字列

      getUserMedia() API に渡して、ユーザーが選択したソースに対応するメディア ストリームを生成できる不透明な文字列。ユーザーがソースを選択しなかった場合(プロンプトをキャンセルした場合など)、コールバックは空の streamId で呼び出されます。作成された streamId は 1 回のみ使用できます。使用しない場合は数秒後に期限切れになります。

    • オプション

      オブジェクト

      Chrome 57 以降 Chrome 148 以降の browser.*

      ストリームを記述するプロパティが含まれます。

      • canRequestAudioTrack

        ブール値

        パラメータ ソースに「audio」が含まれており、エンドユーザーが [音声を共有] チェックボックスをオフにしていない場合は true。それ以外の場合は false。この場合、getUserMedia 呼び出しで音声ストリームをリクエストしないでください。

戻り値

  • 数値

    プロンプトをキャンセルする必要がある場合に cancelChooseDesktopMedia() に渡すことができる ID。