chrome.desktopCapture

คำอธิบาย

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

สิทธิ์

desktopCapture

ประเภท

DesktopCaptureSourceType

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

ค่าแจกแจง

"หน้าจอ"

"window"

"tab"

"เสียง"

SelfCapturePreferenceEnum

Chrome เวอร์ชัน 107 ขึ้นไป

มิเรอร์ SelfCapturePreferenceEnum

ค่าแจกแจง

"รวม"

"exclude"

SystemAudioPreferenceEnum

Chrome 105 ขึ้นไป

มิเรอร์ SystemAudioPreferenceEnum

ค่าแจกแจง

"รวม"

"exclude"

เมธอด

cancelChooseDesktopMedia()

chrome.desktopCapture.cancelChooseDesktopMedia(
  desktopMediaRequestId: number,
)

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

พารามิเตอร์

  • desktopMediaRequestId

    ตัวเลข

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

chooseDesktopMedia()

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

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

พารามิเตอร์

  • แหล่งที่มา

    DesktopCaptureSourceType[]

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

  • targetTab

    Tab ไม่บังคับ

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

  • Callback

    ฟังก์ชัน

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

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

    • streamId

      สตริง

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

    • ตัวเลือก

      ออบเจ็กต์

      Chrome 57 ขึ้นไป

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

      • canRequestAudioTrack

        boolean

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

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

  • ตัวเลข

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