chrome.desktopCapture

説明

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

権限

desktopCapture

DesktopCaptureSourceType

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

列挙型

"画面"

「window」

"タブ"

"audio"

SelfCapturePreferenceEnum

Chrome 107 以降

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

列挙型

"include"

「exclude」

SystemAudioPreferenceEnum

Chrome 105 以降

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

列挙型

"include"

「exclude」

メソッド

cancelChooseDesktopMedia()

chrome.desktopCapture.cancelChooseDesktopMedia(
  desktopMediaRequestId: number,
)

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

パラメータ

  • desktopMediaRequestId

    数値

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

chooseDesktopMedia()

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

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

パラメータ

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

  • targetTab

    タブ (省略可)

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

  • callback

    関数

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

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

    • streamId

      文字列

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

    • オプション

      オブジェクト

      Chrome 57 以降

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

      • canRequestAudioTrack

        ブール値

        「audio」の場合は trueがパラメータ ソースに含まれており、エンドユーザーが [音声を共有する] チェックボックスをオフにしていない選択します。それ以外の場合は false です。この場合は、getUserMedia の呼び出しを通じて音声ストリームを要求すべきではありません。

戻り値

  • 数値

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