chrome.desktopCapture

説明

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

権限

desktopCapture

型

DesktopCaptureSourceType

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

Enum

"screen"

"window"

"audio"

SelfCapturePreferenceEnum

Chrome 107 以降

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

Enum

"include"

SystemAudioPreferenceEnum

Chrome 105 以降

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

Enum

"include"

Methods

cancelChooseDesktopMedia()

chrome.desktopCapture.cancelChooseDesktopMedia(
  desktopMediaRequestId: number,
)

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

パラメータ

  • desktopMediaRequestId

    数値

    ChooseDesktopMedia() から返される ID

chooseDesktopMedia()

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

指定したソースセットを使用して、パソコンのメディア選択ツールの UI を表示します。

パラメータ

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

  • targetTab

    タブ （省略可）

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

  • callback

    機能

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

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

    • streamId

      文字列

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

    • オプション

      オブジェクト

      Chrome 57 以降

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

      • canRequestAudioTrack

        boolean

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

戻り値

  • 数値

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