chrome.desktopCapture

คำอธิบาย

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

สิทธิ์

desktopCapture

ประเภท

DesktopCaptureSourceType

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

ค่าแจกแจง

"หน้าจอ"

"window"

"tab"

"audio"

SelfCapturePreferenceEnum

Chrome 107 ขึ้นไป

กระจก SelfCapturePreferenceEnum

ค่าแจกแจง

"รวม"

"exclude"

SystemAudioPreferenceEnum

Chrome 105 ขึ้นไป

กระจก SystemAudioPreferenceEnum

ค่าแจกแจง

"รวม"

"exclude"

WindowAudioPreferenceEnum

Chrome 140 ขึ้นไป

กระจก WindowAudioPreferenceEnum

ค่าแจกแจง

"system"

"window"

"exclude"

เมธอด

cancelChooseDesktopMedia()

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

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

พารามิเตอร์

  • desktopMediaRequestId

    ตัวเลข

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

chooseDesktopMedia()

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

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

พารามิเตอร์

  • แหล่งที่มา

    DesktopCaptureSourceType[]

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

  • targetTab

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

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

  • callback

    ฟังก์ชัน

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

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

    • streamId

      สตริง

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

    • ตัวเลือก

      ออบเจ็กต์

      Chrome 57 ขึ้นไป

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

      • canRequestAudioTrack

        บูลีน

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

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

  • ตัวเลข

    รหัสที่ส่งไปยัง cancelChooseDesktopMedia() ได้ในกรณีที่ต้องยกเลิกพรอมต์