chrome.desktopCapture

설명

Desktop Capture API는 화면, 개별 창 또는 개별 탭의 콘텐츠를 캡처합니다.

권한

desktopCapture

유형

DesktopCaptureSourceType

chooseDesktopMedia()에 사용되는 데스크톱 미디어 소스 집합을 정의하는 데 사용되는 enum입니다.

열거형

"화면"

'window'

'탭'

'audio'

SelfCapturePreferenceEnum

Chrome 107 이상

SelfCapturePreferenceEnum을 미러링합니다.

열거형

'include'

'제외'

SystemAudioPreferenceEnum

Chrome 105 이상

SystemAudioPreferenceEnum을 미러링합니다.

열거형

'include'

'제외'

메서드

cancelChooseDesktopMedia()

chrome.desktopCapture.cancelChooseDesktopMedia(
  desktopMediaRequestId: number,
)

chooseDesktopMedia()로 표시된 데스크톱 미디어 선택 도구 대화상자를 숨깁니다.

매개변수

  • desktopMediaRequestId

    숫자

    chooseDesktopMedia()에서 반환된 ID

chooseDesktopMedia()

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

지정된 소스 세트가 포함된 데스크톱 미디어 선택 도구 UI를 표시합니다.

매개변수

  • 사용자에게 표시되어야 하는 소스 집합입니다. 세트의 소스 순서에 따라 선택 도구의 탭 순서가 결정됩니다.

  • targetTab

    탭 선택사항

    스트림이 생성되는 탭(선택사항) 지정하지 않으면 결과 스트림은 호출하는 확장 프로그램에서만 사용할 수 있습니다. 이 스트림은 보안 출처가 tab.url와 일치하는 지정된 탭의 프레임에서만 사용할 수 있습니다. 탭의 출처는 HTTPS와 같은 보안 출처여야 합니다.

  • 콜백

    함수

    callback 매개변수는 다음과 같습니다. 

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

    • streamId

      문자열

      getUserMedia() API에 전달하여 사용자가 선택한 소스에 해당하는 미디어 스트림을 생성할 수 있는 불투명 문자열입니다. 사용자가 소스를 선택하지 않은 경우 (즉, 메시지를 취소한 경우) 콜백이 빈 streamId를 사용하여 호출됩니다. 생성된 streamId는 한 번만 사용할 수 있으며 사용하지 않으면 몇 초 후에 만료됩니다.

    • 옵션

      객체

      Chrome 57 이상

      스트림을 설명하는 속성을 포함합니다.

      • canRequestAudioTrack

        부울

        '오디오'가 매개변수 소스에 포함되어 있고 최종 사용자가 '오디오 공유' 체크박스를 선택 해제하지 않은 경우 true입니다. 그 외의 경우에는 false이며 이 경우 getUserMedia 호출을 통해 오디오 스트림을 요청해서는 안 됩니다.

반환 값

  • 숫자

    메시지를 취소해야 하는 경우 cancelChooseDesktopMedia()에 전달할 수 있는 ID입니다.