browser.desktopCapture

Описание

API трансляции экрана позволяет записывать содержимое экрана, отдельных окон или вкладок.

Разрешения

desktopCapture

Типы

DesktopCaptureSourceType

Перечисление, используемое для определения набора источников медиаконтента для компьютеров, используемых в chooseDesktopMedia().

Перечисление

"screen"

"window"

"tab"

"audio"

SelfCapturePreferenceEnum

Chrome 107+ browser.* начиная с Chrome 148

Дублирует SelfCapturePreferenceEnum.

Перечисление

"include"

"exclude"

SystemAudioPreferenceEnum

Chrome 105+ browser.* начиная с Chrome 148

Соответствует SystemAudioPreferenceEnum.

Перечисление

"include"

"exclude"

WindowAudioPreferenceEnum

Chrome 140+ browser.* начиная с Chrome 148

Дублирует WindowAudioPreferenceEnum.

Перечисление

"system"

"window"

"exclude"

Методы

cancelChooseDesktopMedia()

browser.desktopCapture.cancelChooseDesktopMedia(
  desktopMediaRequestId: number,
): void

Скрывает диалоговое окно инструмента выбора медиа на рабочем столе, которое показывается функцией chooseDesktopMedia().

Параметры

  • desktopMediaRequestId

    число

    Идентификатор, возвращенный chooseDesktopMedia()

chooseDesktopMedia()

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

Показывает интерфейс инструмента выбора медиа для компьютеров с указанным набором источников.

Параметры

  • Источники

    DesktopCaptureSourceType[]

    Набор источников, которые должны быть показаны пользователю. Порядок источников в наборе определяет порядок вкладок в окне выбора.

  • targetTab

    Tab необязательный

    Необязательная вкладка, для которой создается поток. Если не указано, то результирующий поток может использоваться только вызывающим расширением. Поток может использоваться только фреймами на указанной вкладке, источник безопасности которых совпадает с tab.url. Источник вкладки должен быть безопасным, например HTTPS.

  • обратный вызов

    function

    Параметр callback выглядит следующим образом: 

    (streamId: string, options: object) => void

    • streamId

      string

      Непрозрачная строка, которую можно передать в API getUserMedia(), чтобы сгенерировать медиапоток, соответствующий источнику, выбранному пользователем. Если пользователь не выбрал источник (например, закрыл окно), обратный вызов будет выполнен с пустым значением streamId. Созданный streamId можно использовать только один раз. Если он не будет использован, то срок его действия истечет через несколько секунд.

    • Параметры

      Объект

      Chrome 57 и более поздние версии browser.* начиная с Chrome 148

      Содержит свойства, описывающие поток.

      • canRequestAudioTrack

        Логическое значение

        True, если "audio" включено в источники параметров и конечный пользователь не снял флажок "Поделиться аудио". В противном случае возвращается значение false, и тогда не следует запрашивать аудиопоток через вызов getUserMedia.

Возвраты

  • число

    Идентификатор, который можно передать в cancelChooseDesktopMedia(), если нужно отменить запрос.