chrome.desktopCapture
- Description
Desktop Capture API that can be used to capture content of screen, individual windows or tabs.
- Permissions
desktopCapture
Summary
- Types
- Methods
chrome.desktopCapture.cancelChooseDesktopMedia(desktopMediaRequestId: number)
chrome.desktopCapture.chooseDesktopMedia(sources: DesktopCaptureSourceType[], targetTab?: tabs.Tab, callback: function): number
Types
DesktopCaptureSourceType
Enum used to define set of desktop media sources used in chooseDesktopMedia().
Enum
"screen"
, "window"
, "tab"
, or "audio"
Methods
cancelChooseDesktopMedia
chrome.desktopCapture.cancelChooseDesktopMedia(desktopMediaRequestId: number)
Hides desktop media picker dialog shown by chooseDesktopMedia().
Parameters
- desktopMediaRequestIdnumber
Id returned by chooseDesktopMedia()
chooseDesktopMedia
chrome.desktopCapture.chooseDesktopMedia(sources: DesktopCaptureSourceType[], targetTab?: tabs.Tab, callback: function): number
Shows desktop media picker UI with the specified set of sources.
Parameters
- sources
Set of sources that should be shown to the user. The sources order in the set decides the tab order in the picker.
- targetTabtabs.Tab optional
Optional tab for which the stream is created. If not specified then the resulting stream can be used only by the calling extension. The stream can only be used by frames in the given tab whose security origin matches
tab.url
. The tab's origin must be a secure origin, e.g. HTTPS. - callbackfunction
The callback parameter should be a function that looks like this:
(streamId: string, options: object) => {...}
- streamIdstring
An opaque string that can be passed to
getUserMedia()
API to generate media stream that corresponds to the source selected by the user. If user didn't select any source (i.e. canceled the prompt) then the callback is called with an emptystreamId
. The createdstreamId
can be used only once and expires after a few seconds when it is not used. - optionsobject
Contains properties that describe the stream.
- canRequestAudioTrackboolean
True if "audio" is included in parameter sources, and the end user does not uncheck the "Share audio" checkbox. Otherwise false, and in this case, one should not ask for audio stream through getUserMedia call.
Returns
- returnsnumber
An id that can be passed to cancelChooseDesktopMedia() in case the prompt need to be canceled.