chrome.desktopCapture

Description

L'API Desktop Capture capture le contenu de l'écran, de fenêtres individuelles ou d'onglets individuels.

Autorisations

desktopCapture

Types

DesktopCaptureSourceType

Énumération utilisée pour définir l'ensemble des sources multimédias de bureau utilisées dans chooseDesktopMedia().

Énumération

"screen"

"window"

"tab"

"audio"

SelfCapturePreferenceEnum

Chrome 107 et versions ultérieures

Miroirs SelfCapturePreferenceEnum.

Énumération

"include"

"exclude"

SystemAudioPreferenceEnum

Chrome 105 et versions ultérieures

Miroirs SystemAudioPreferenceEnum.

Énumération

"include"

"exclude"

WindowAudioPreferenceEnum

Chrome 140 et versions ultérieures

Miroirs WindowAudioPreferenceEnum.

Énumération

"system"

"window"

"exclude"

Méthodes

cancelChooseDesktopMedia()

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

Masque la boîte de dialogue du sélecteur de fichiers multimédias du bureau affichée par chooseDesktopMedia().

Paramètres

  • desktopMediaRequestId

    Total

    ID renvoyé par chooseDesktopMedia()

chooseDesktopMedia()

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

Affiche l'UI du sélecteur de fichiers multimédias pour ordinateur avec l'ensemble de sources spécifié.

Paramètres

  • Ensemble de sources à afficher à l'utilisateur. L'ordre des sources dans l'ensemble détermine l'ordre des onglets dans le sélecteur.

  • targetTab

    Onglet (facultatif)

    Onglet facultatif pour lequel le flux est créé. Si aucune valeur n'est spécifiée, le flux résultant ne peut être utilisé que par l'extension appelante. Le flux ne peut être utilisé que par les frames de l'onglet donné dont l'origine de sécurité correspond à tab.url. L'origine de l'onglet doit être sécurisée (HTTPS, par exemple).

  • callback

    fonction

    Le paramètre callback se présente comme suit : 

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

    • streamId

      chaîne

      Chaîne opaque pouvant être transmise à l'API getUserMedia() pour générer le flux multimédia correspondant à la source sélectionnée par l'utilisateur. Si l'utilisateur n'a sélectionné aucune source (c'est-à-dire qu'il a annulé l'invite), le rappel est appelé avec un streamId vide. Le streamId créé ne peut être utilisé qu'une seule fois et expire au bout de quelques secondes s'il n'est pas utilisé.

    • options

      objet

      Chrome 57 et versions ultérieures

      Contient des propriétés qui décrivent le flux.

      • canRequestAudioTrack

        booléen

        "True" si "audio" est inclus dans les sources de paramètres et si l'utilisateur final ne décoche pas la case "Partager l'audio". Sinon, la valeur est "false". Dans ce cas, il ne faut pas demander de flux audio via l'appel getUserMedia.

Renvoie

  • Total

    ID pouvant être transmis à cancelChooseDesktopMedia() si l'invite doit être annulée.