chrome.desktopCapture

Opis

Interfejs Desktop Capture API przechwytuje zawartość ekranu, poszczególnych okien lub poszczególnych kart.

Uprawnienia

desktopCapture

Typy

DesktopCaptureSourceType

Wyliczenie używane do definiowania zestawu źródeł multimediów na komputerze używanych w funkcji chooseDesktopMedia().

Typ wyliczeniowy

„screen”

„window”

„tab”

"audio"

SelfCapturePreferenceEnum

Chrome 107 lub nowsza

Lustra SelfCapturePreferenceEnum.

Typ wyliczeniowy

„include”

„exclude”

SystemAudioPreferenceEnum

Chrome 105 lub nowszy

Odpowiada wartości SystemAudioPreferenceEnum.

Typ wyliczeniowy

„include”

„exclude”

WindowAudioPreferenceEnum

Chrome 140+

Odzwierciedla WindowAudioPreferenceEnum.

Typ wyliczeniowy

„system”

„window”

„exclude”

Metody

cancelChooseDesktopMedia()

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

Ukrywa okno wyboru mediów na komputerze, które jest wyświetlane przez funkcję chooseDesktopMedia().

Parametry

  • desktopMediaRequestId

    liczba

    Identyfikator zwrócony przez chooseDesktopMedia()

chooseDesktopMedia()

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

Wyświetla interfejs wyboru mediów na komputerze z określonym zestawem źródeł.

Parametry

  • Zestaw źródeł, które powinny być wyświetlane użytkownikowi. Kolejność źródeł w zestawie decyduje o kolejności kart w selektorze.

  • targetTab

    Tab opcjonalny

    Opcjonalna karta, dla której tworzony jest strumień. Jeśli nie zostanie określony, wynikowy strumień może być używany tylko przez wywołujące rozszerzenie. Strumień może być używany tylko przez ramki na danej karcie, których źródło zabezpieczeń pasuje do tab.url. Źródło karty musi być bezpieczne, np. HTTPS.

  • callback

    funkcja

    Parametr callback wygląda tak:

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

    • streamId

      ciąg znaków

      Nieprzezroczysty ciąg znaków, który można przekazać do interfejsu getUserMedia() API, aby wygenerować strumień multimediów odpowiadający źródłu wybranemu przez użytkownika. Jeśli użytkownik nie wybierze żadnego źródła (czyli anuluje prompt), wywołanie zwrotne zostanie wywołane z pustym parametrem streamId. Utworzony streamId można użyć tylko raz. Jeśli nie zostanie użyty, wygaśnie po kilku sekundach.

    • Opcje

      obiekt

      Chrome w wersji 57 lub nowszej

      Zawiera właściwości opisujące strumień.

      • canRequestAudioTrack

        Wartość logiczna

        Wartość „prawda”, jeśli „audio” jest uwzględnione w źródłach parametrów, a użytkownik nie odznaczy pola wyboru „Udostępnij dźwięk”. W przeciwnym razie wartość to false. W takim przypadku nie należy prosić o strumień audio za pomocą wywołania getUserMedia.

Zwroty

  • liczba

    Identyfikator, który można przekazać do funkcji cancelChooseDesktopMedia(), jeśli trzeba anulować prośbę.