chrome.desktopCapture

Описание

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

Разрешения

desktopCapture

Типы

DesktopCaptureSourceType

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

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

"экран"

"окно"

"вкладка"

"аудио"

SelfCapturePreferenceEnum

Хром 107+

Зеркала SelfCapturePreferenceEnum .

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

"включать"

"исключать"

SystemAudioPreferenceEnum

Хром 105+

Зеркала SystemAudioPreferenceEnum .

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

"включать"

"исключать"

Методы

cancelChooseDesktopMedia()

chrome.desktopCapture.cancelChooseDesktopMedia(
  desktopMediaRequestId: number,
)

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

Параметры

  • рабочий столMediaRequestId

    число

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

chooseDesktopMedia()

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

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

Параметры

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

  • цельTab

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

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

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

    функция

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

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

    • идентификатор потока

      нить

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

    • параметры

      объект

      Хром 57+

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

      • canRequestAudioTrack

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

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

Возврат

  • число

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