chrome.desktopCapture

Описание

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

Разрешения

desktopCapture

Типы

DesktopCaptureSourceType

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

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

"экран"

"окно"

"вкладка"

"аудио"

SelfCapturePreferenceEnum

Хром 107+

Зеркала SelfCapturePreferenceEnum .

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

"включать"

"исключать"

SystemAudioPreferenceEnum

Хром 105+

Зеркала SystemAudioPreferenceEnum .

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

"включать"

"исключать"

WindowAudioPreferenceEnum

Хром 140+

Зеркала WindowAudioPreferenceEnum .

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

"система"

"окно"

"исключать"

Методы

cancelChooseDesktopMedia()

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

Скрывает диалоговое окно выбора медиафайлов на рабочем столе, отображаемое с помощью chooseDesktopMedia().

Параметры

  • desktopMediaRequestId

    число

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

chooseDesktopMedia()

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

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

Параметры

  • источники

    DesktopCaptureSourceType []

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

  • targetTab

    Вкладка необязательна

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

  • перезвонить

    функция

    Параметр callback выглядит так: 

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

    • streamId

      нить

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

    • параметры

      объект

      Хром 57+

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

      • canRequestAudioTrack

        булев

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

Возврат

  • число

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