chrome.desktopCapture

Enum

Enum

Enum

Parameters

• desktopMediaRequestId

  number

  Id returned by chooseDesktopMedia()

Parameters

• sources

  DesktopCaptureSourceType[]

  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.