chrome.desktopCapture

дата обновления: 2026-09-25 robots: noindex

Описание

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

Разрешения

desktopCapture

Типы

DesktopCaptureSourceType

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

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

"экран"

"окно"

"вкладка"

"аудио"

SelfCapturePreferenceEnum

Chrome 107+

Зеркала SelfCapturePreferenceEnum .

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

"включать"

"исключать"

SystemAudioPreferenceEnum

Chrome 105+

Зеркала SystemAudioPreferenceEnum .

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

"включать"

"исключать"

WindowAudioPreferenceEnum

Chrome 140+

Mirrors WindowAudioPreferenceEnum .

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

"система"

"окно"

"исключать"

Методы

cancelChooseDesktopMedia()

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

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

Параметры

  • desktopMediaRequestId

    число

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

chooseDesktopMedia()

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

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

Параметры

  • источники

    DesktopCaptureSourceType []

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

  • целевая вкладка

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

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

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

    функция

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

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

    • streamId

      нить

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

    • параметры

      объект

      Chrome 57+

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

      • canRequestAudioTrack

        логический

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

Возвраты

  • число

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