説明
Desktop Capture API は、画面、個々のウィンドウ、個々のタブのコンテンツをキャプチャします。
権限
desktopCapture型
DesktopCaptureSourceType
chooseDesktopMedia() で使用されるデスクトップ メディアソースのセットを定義するために使用される列挙型。
列挙型
"screen"
"window"
"tab"
"audio"
列挙型
"include"
"exclude"
列挙型
"include"
"exclude"
列挙型
"system"
"window"
"exclude"
メソッド
cancelChooseDesktopMedia()
chrome.desktopCapture.cancelChooseDesktopMedia(
desktopMediaRequestId: number,
): void
chooseDesktopMedia() によって表示されるデスクトップ メディア選択ツール ダイアログを非表示にします。
パラメータ
-
desktopMediaRequestId
数値
chooseDesktopMedia() によって返される ID
chooseDesktopMedia()
chrome.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+ストリームを記述するプロパティが含まれています。
-
canRequestAudioTrack
ブール値
パラメータ ソースに「音声」が含まれており、エンドユーザーが [音声を共有] チェックボックスをオフにしていない場合は true。それ以外の場合は false。この場合、getUserMedia 呼び出しで音声ストリームをリクエストしてはなりません。
-
-
戻り値
-
数値
プロンプトをキャンセルする必要がある場合に cancelChooseDesktopMedia() に渡すことができる ID。