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