chrome.desktopCapture

Opis

Interfejs API Desktop Capture umożliwia przechwytywanie zawartości ekranu, poszczególnych okien lub kart.

Uprawnienia

desktopCapture

Typy

DesktopCaptureSourceType

Typ enumeracji służący do definiowania zestawu źródeł multimediów na komputer używanego w funkcji chooseDesktopMedia().

Typ wyliczeniowy

„screen”

„window”

„tab”

"audio"

SelfCapturePreferenceEnum

Chrome 107+

Odzwierciedla SelfCapturePreferenceEnum.

Typ wyliczeniowy

„include”

"exclude"

SystemAudioPreferenceEnum

Chrome w wersji 105 lub nowszej

Odzwierciedla SystemAudioPreferenceEnum.

Typ wyliczeniowy

„include”

"exclude"

WindowAudioPreferenceEnum

Oczekuje

Odzwierciedla WindowAudioPreferenceEnum.

Typ wyliczeniowy

„system”

„window”

"exclude"

Metody

cancelChooseDesktopMedia()

chrome.desktopCapture.cancelChooseDesktopMedia(
  desktopMediaRequestId: number,
)

Ukrywa okno wyboru multimediów na komputerze wyświetlane przez funkcję chooseDesktopMedia().

Parametry

  • desktopMediaRequestId

    liczba

    Identyfikator zwracany przez chooseDesktopMedia()

chooseDesktopMedia()

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

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

Parametry

  • Zbiór źródeł, które powinny być wyświetlane użytkownikowi. Kolejność źródeł w zbiorze określa kolejność kart w oknie wyboru.

  • targetTab

    Karta opcjonalna

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

  • callback

    funkcja

    Parametr callback ma postać:

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

    • streamId

      ciąg znaków

      Nieprzejrzysty ciąg znaków, który można przekazać do interfejsu API getUserMedia() w celu wygenerowania strumienia multimediów odpowiadającego źródłu wybranemu przez użytkownika. Jeśli użytkownik nie wybrał żadnego źródła (czyli anulował prompt), wywołanie funkcji zwrotnej zostanie wywołane z pustym parametrem streamId. Utworzonego streamId można użyć tylko raz. Wygasa ono po kilku sekundach, jeśli nie zostanie użyte.

    • Opcje

      obiekt

      Chrome 57 lub nowszy

      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ść jest fałszywa i w takim przypadku nie należy prosić o strumień audio za pomocą wywołania getUserMedia.

Zwroty

  • liczba

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