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

Enum utilisé pour définir l'ensemble de sources multimédias pour ordinateur utilisé dans chooseDesktopMedia().

Énumération

"screen"

"window"

"tab"

"audio"

SelfCapturePreferenceEnum

Chrome 107 ou version ultérieure

Reflète SelfCapturePreferenceEnum.

Énumération

"include"

"exclude"

SystemAudioPreferenceEnum

Chrome 105 ou version ultérieure

Refléte SystemAudioPreferenceEnum.

Énumération

"include"

"exclude"

Méthodes

cancelChooseDesktopMedia()

chrome.desktopCapture.cancelChooseDesktopMedia(
  desktopMediaRequestId: number,
)

Masque la boîte de dialogue de sélecteur de fichiers multimédias pour ordinateur qui s'affiche avec chooseDesktopMedia().

Paramètres

  • desktopMediaRequestId

    Nombre

    ID renvoyé par chooseDesktopMedia()

chooseDesktopMedia()

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

Affiche l'interface utilisateur du sélecteur multimédia 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 elle n'est pas spécifiée, le flux généré ne peut être utilisé que par l'extension appelante. Le flux ne peut être utilisé que par les cadres de l'onglet donné dont l'origine de sécurité correspond à tab.url. L'origine de l'onglet doit être une origine sécurisée, par exemple HTTPS.

  • rappel

    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 un 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 que l'utilisateur final ne décoche pas la case "Partager l'audio". Sinon, la valeur est false. Dans ce cas, vous ne devez pas demander de flux audio via l'appel getUserMedia.

Renvoie

  • Nombre

    ID pouvant être transmis à cancelChooseDesktopMedia() au cas où l'invite doit être annulée.