browser.desktopCapture

Descripción

La API de Captura del escritorio captura el contenido de la pantalla, las ventanas individuales o las pestañas individuales.

Permisos

desktopCapture

Tipos

DesktopCaptureSourceType

Es la enumeración que se usa para definir el conjunto de fuentes de contenido multimedia de escritorio que se usan en chooseDesktopMedia().

Enum

"screen"

"window"

"tab"

"audio"

SelfCapturePreferenceEnum

Chrome 107 y versiones posteriores browser.* desde Chrome 148

Duplica SelfCapturePreferenceEnum.

Enum

"include"

"exclude"

SystemAudioPreferenceEnum

Chrome 105 y versiones posteriores browser.* desde Chrome 148

Duplica SystemAudioPreferenceEnum.

Enum

"include"

"exclude"

WindowAudioPreferenceEnum

Chrome 140 y versiones posteriores browser.* desde Chrome 148

Duplica WindowAudioPreferenceEnum.

Enum

"system"

"window"

"exclude"

Métodos

cancelChooseDesktopMedia()

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

Oculta el diálogo del selector de contenido multimedia de escritorio que muestra chooseDesktopMedia().

Parámetros

  • desktopMediaRequestId

    número

    ID que muestra chooseDesktopMedia()

chooseDesktopMedia()

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

Muestra la IU del selector de contenido multimedia de escritorio con el conjunto de fuentes especificado.

Parámetros

  • Es el conjunto de fuentes que se deben mostrar al usuario. El orden de las fuentes en el conjunto determina el orden de las pestañas en el selector.

  • targetTab

    Pestaña opcional

    Pestaña opcional para la que se crea la transmisión. Si no se especifica, la extensión que realiza la llamada solo puede usar la transmisión resultante. Solo los marcos de la pestaña determinada cuyo origen de seguridad coincida con tab.url pueden usar la transmisión. El origen de la pestaña debe ser seguro, p.ej., HTTPS.

  • callback

    función

    El parámetro callback se ve de la siguiente manera: 

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

    • streamId

      string

      Es una cadena opaca que se puede pasar a la API de getUserMedia() para generar un flujo de contenido multimedia que corresponda a la fuente seleccionada por el usuario. Si el usuario no seleccionó ninguna fuente (es decir, canceló el mensaje), se llama a la devolución de llamada con un streamId vacío. El streamId creado solo se puede usar una vez y vence después de unos segundos si no se usa.

    • opciones

      objeto

      Chrome 57 y versiones posteriores browser.* desde Chrome 148

      Contiene propiedades que describen la transmisión.

      • canRequestAudioTrack

        booleano

        Es verdadero si se incluye "audio" en las fuentes de parámetros y el usuario final no desmarca la casilla de verificación "Compartir audio". De lo contrario, será falso y, en este caso, no se debe solicitar la transmisión de audio a través de la llamada getUserMedia.

Muestra

  • número

    Es un ID que se puede pasar a cancelChooseDesktopMedia() en caso de que se deba cancelar la solicitud.