chrome.desktopCapture

refresh date: 2026-09-25 robots: noindex

Deskripsi

Desktop Capture API merekam konten layar, jendela tertentu, atau tab tertentu.

Izin

desktopCapture

Jenis

DesktopCaptureSourceType

Enum yang digunakan untuk menentukan kumpulan sumber media desktop yang digunakan di chooseDesktopMedia().

Enum

"screen"

"window"

"tab"

"audio"

SelfCapturePreferenceEnum

Chrome 107+

Mencerminkan SelfCapturePreferenceEnum.

Enum

"include"

"exclude"

SystemAudioPreferenceEnum

Chrome 105+

Mencerminkan SystemAudioPreferenceEnum.

Enum

"include"

"exclude"

WindowAudioPreferenceEnum

Chrome 140+

Mencerminkan WindowAudioPreferenceEnum.

Enum

"system"

"window"

"exclude"

Metode

cancelChooseDesktopMedia()

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

Menyembunyikan dialog pemilih media desktop yang ditampilkan oleh chooseDesktopMedia().

Parameter

  • desktopMediaRequestId

    angka

    ID yang ditampilkan oleh chooseDesktopMedia()

chooseDesktopMedia()

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

Menampilkan UI pemilih media desktop dengan kumpulan sumber yang ditentukan.

Parameter

  • Kumpulan sumber yang akan ditampilkan kepada pengguna. Urutan sumber dalam set menentukan urutan tab di alat pilih.

  • targetTab

    Tab opsional

    Tab opsional tempat aliran data dibuat. Jika tidak ditentukan, aliran data yang dihasilkan hanya dapat digunakan oleh ekstensi yang memanggil. Streaming hanya dapat digunakan oleh frame di tab tertentu yang origin keamanannya cocok dengan tab.url. Origin tab harus berupa origin yang aman, misalnya HTTPS.

  • callback

    fungsi

    Parameter callback terlihat seperti: 

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

    • streamId

      string

      String buram yang dapat diteruskan ke getUserMedia() API untuk menghasilkan streaming media yang sesuai dengan sumber yang dipilih oleh pengguna. Jika pengguna tidak memilih sumber apa pun (yaitu membatalkan dialog), callback akan dipanggil dengan streamId kosong. streamId yang dibuat hanya dapat digunakan sekali dan akan berakhir setelah beberapa detik jika tidak digunakan.

    • opsi

      objek

      Chrome 57+

      Berisi properti yang mendeskripsikan aliran data.

      • canRequestAudioTrack

        boolean

        True jika "audio" disertakan dalam sumber parameter, dan pengguna akhir tidak menghapus centang pada kotak "Bagikan audio". Jika tidak, nilai akan salah, dan dalam hal ini, Anda tidak boleh meminta streaming audio melalui panggilan getUserMedia.

Hasil

  • angka

    ID yang dapat diteruskan ke cancelChooseDesktopMedia() jika dialog perlu dibatalkan.