chrome.desktopCapture

คำอธิบาย

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

สิทธิ์

desktopCapture

ประเภท

DesktopCaptureSourceType

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

ค่าแจกแจง

"screen"

"window"

"tab"

"audio"

SelfCapturePreferenceEnum

Chrome 107 ขึ้นไป

กระจก SelfCapturePreferenceEnum

ค่าแจกแจง

"include"

"exclude"

SystemAudioPreferenceEnum

Chrome 105 ขึ้นไป

แสดงผล SystemAudioPreferenceEnum

ค่าแจกแจง

"include"

"exclude"

WindowAudioPreferenceEnum

รอดำเนินการ

กระจกเงา WindowAudioPreferenceEnum

ค่าแจกแจง

"system"

"window"

"exclude"

เมธอด

cancelChooseDesktopMedia()

chrome.desktopCapture.cancelChooseDesktopMedia(
  desktopMediaRequestId: number,
)

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

พารามิเตอร์

  • desktopMediaRequestId

    ตัวเลข

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

chooseDesktopMedia()

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

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

พารามิเตอร์

  • แหล่งที่มา

    DesktopCaptureSourceType[]

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

  • targetTab

    แท็บ ไม่บังคับ

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

  • callback

    ฟังก์ชัน

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

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

    • streamId

      สตริง

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

    • ตัวเลือก

      ออบเจ็กต์

      Chrome 57 ขึ้นไป

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

      • canRequestAudioTrack

        บูลีน

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

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

  • ตัวเลข

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