Welcome What's new in Chrome extensions API reference Samples
Welcome What's new in Chrome extensions API reference Samples

chrome.desktopCapture

  • Description

    Desktop Capture API that can be used to capture content of screen, individual windows or tabs.

  • Permissions
    desktopCapture
    This permission triggers a warning.

Summary

Types

DesktopCaptureSourceType

Enum used to define set of desktop media sources used in chooseDesktopMedia().

Enum

"screen"

"window"

"tab"

"audio"

SelfCapturePreferenceEnum

Chrome 107+

Mirrors SelfCapturePreferenceEnum.

Enum

"include"

"exclude"

SystemAudioPreferenceEnum

Chrome 105+

Mirrors SystemAudioPreferenceEnum.

Enum

"include"

"exclude"

Methods

cancelChooseDesktopMedia

chrome.desktopCapture.cancelChooseDesktopMedia(
  desktopMediaRequestId: number,
)

Hides desktop media picker dialog shown by chooseDesktopMedia().

Parameters

  • desktopMediaRequestId

    number

    Id returned by chooseDesktopMedia()

chooseDesktopMedia

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

Shows desktop media picker UI with the specified set of sources.

Parameters

  • Set of sources that should be shown to the user. The sources order in the set decides the tab order in the picker.

  • targetTab

    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.

  • callback

    function

    The callback parameter looks like: (streamId: string, options: object) => void

    • streamId

      string

      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 empty streamId. The created streamId can be used only once and expires after a few seconds when it is not used.

    • options

      object

      Chrome 57+

      Contains properties that describe the stream.

      • canRequestAudioTrack

        boolean

        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

  • number

    An id that can be passed to cancelChooseDesktopMedia() in case the prompt need to be canceled.

This site uses cookies to deliver and enhance the quality of its services and to analyze traffic. If you agree, cookies are also used to serve advertising and to personalize the content and advertisements that you see. Learn more about our use of cookies.