browser.desktopCapture

คำอธิบาย

Desktop Capture API จะจับภาพเนื้อหาของหน้าจอ หน้าต่างแต่ละหน้าต่าง หรือแท็บแต่ละแท็บ

สิทธิ์

desktopCapture

ประเภท

DesktopCaptureSourceType

Enum ที่ใช้กำหนดชุดแหล่งที่มาของสื่อบนเดสก์ท็อปที่ใช้ใน chooseDesktopMedia()

ค่าแจกแจง

"screen"

"window"

"tab"

"audio"

SelfCapturePreferenceEnum

Chrome 107 ขึ้นไป browser.* ตั้งแต่ Chrome 148

มิเรอร์ SelfCapturePreferenceEnum

ค่าแจกแจง

"include"

"exclude"

SystemAudioPreferenceEnum

Chrome 105 ขึ้นไป browser.* ตั้งแต่ Chrome 148

มิเรอร์ SystemAudioPreferenceEnum

ค่าแจกแจง

"include"

"exclude"

WindowAudioPreferenceEnum

Chrome 140 ขึ้นไป browser.* ตั้งแต่ Chrome 148

สอดคล้องกับ WindowAudioPreferenceEnum

ค่าแจกแจง

"system"

"window"

"exclude"

เมธอด

cancelChooseDesktopMedia()

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

ซ่อนกล่องโต้ตอบเครื่องมือเลือกสื่อบนเดสก์ท็อปที่แสดงโดย chooseDesktopMedia()

พารามิเตอร์

  • desktopMediaRequestId

    ตัวเลข

    รหัสที่แสดงผลโดย chooseDesktopMedia()

chooseDesktopMedia()

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

แสดง UI ของเครื่องมือเลือกสื่อบนเดสก์ท็อปพร้อมชุดแหล่งที่มาที่ระบุ

พารามิเตอร์

  • แหล่งที่มา

    ชุดแหล่งข้อมูลที่ควรแสดงต่อผู้ใช้ ลำดับแหล่งที่มาในชุดจะกำหนดลำดับแท็บในเครื่องมือเลือก

  • targetTab

    Tab ไม่บังคับ

    แท็บที่ไม่บังคับซึ่งสร้างสตรีมไว้ หากไม่ได้ระบุไว้ ส่วนขยายที่เรียกใช้จะใช้สตรีมที่ได้เท่านั้น สตรีมจะใช้ได้เฉพาะกับเฟรมในแท็บที่ระบุซึ่งมีต้นทางด้านความปลอดภัยตรงกับ tab.url ต้นทางของแท็บต้องเป็นต้นทางที่ปลอดภัย เช่น HTTPS

  • callback

    ฟังก์ชัน

    พารามิเตอร์ callback จะมีลักษณะดังนี้

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

    • streamId

      สตริง

      สตริงทึบแสงที่ส่งไปยัง getUserMedia() API เพื่อสร้างสตรีมสื่อที่สอดคล้องกับแหล่งที่มาที่ผู้ใช้เลือกได้ หากผู้ใช้ไม่ได้เลือกแหล่งที่มาใดๆ (เช่น ยกเลิกข้อความแจ้ง) ระบบจะเรียกใช้ Callback ด้วย streamId ที่ว่างเปล่า streamId ที่สร้างขึ้นจะใช้ได้เพียงครั้งเดียวและจะหมดอายุหลังจากผ่านไป 2-3 วินาทีหากไม่ได้ใช้

    • ตัวเลือก

      ออบเจ็กต์

      Chrome 57 ขึ้นไป browser.* ตั้งแต่ Chrome 148

      มีพร็อพเพอร์ตี้ที่อธิบายสตรีม

      • canRequestAudioTrack

        บูลีน

        เป็นจริงหากมี "เสียง" รวมอยู่ในแหล่งที่มาของพารามิเตอร์ และผู้ใช้ปลายทางไม่ได้ยกเลิกการเลือกช่องทำเครื่องหมาย "แชร์เสียง" หรือเป็นเท็จ และในกรณีนี้ ไม่ควรขอสตรีมเสียงผ่านการเรียก getUserMedia

การคืนสินค้า

  • ตัวเลข

    รหัสที่สามารถส่งไปยัง cancelChooseDesktopMedia() ในกรณีที่ต้องยกเลิกข้อความแจ้ง