browser.desktopCapture

Descrição

A API Desktop Capture captura o conteúdo da tela, de janelas individuais ou de guias individuais.

Permissões

desktopCapture

Tipos

DesktopCaptureSourceType

Tipo enumerado usado para definir o conjunto de origens de mídia para computador usadas em chooseDesktopMedia().

Enumeração

"screen"

"window"

"tab"

"audio"

SelfCapturePreferenceEnum

Chrome 107+ browser.* desde o Chrome 148

Espelha SelfCapturePreferenceEnum.

Enumeração

"include"

"exclude"

SystemAudioPreferenceEnum

Chrome 105+ browser.* desde o Chrome 148

Espelha SystemAudioPreferenceEnum.

Enumeração

"include"

"exclude"

WindowAudioPreferenceEnum

Chrome 140+ browser.* desde o Chrome 148

Espelha WindowAudioPreferenceEnum.

Enumeração

"system"

"window"

"exclude"

Métodos

cancelChooseDesktopMedia()

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

Oculta a caixa de diálogo do seletor de mídia da área de trabalho mostrada por chooseDesktopMedia().

Parâmetros

  • desktopMediaRequestId

    número

    ID retornado por chooseDesktopMedia()

chooseDesktopMedia()

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

Mostra a interface do seletor de mídia para computador com o conjunto de fontes especificado.

Parâmetros

  • Conjunto de fontes que devem ser mostradas ao usuário. A ordem das fontes no conjunto decide a ordem das guias no seletor.

  • targetTab

    Guia opcional

    Guia opcional para a qual o stream é criado. Se não for especificado, o stream resultante só poderá ser usado pela extensão de chamada. O stream só pode ser usado por frames na guia em questão que tenham a mesma origem de segurança de tab.url. A origem da guia precisa ser segura, por exemplo, HTTPS.

  • callback

    função

    O parâmetro callback é semelhante a: 

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

    • streamId

      string

      Uma string opaca que pode ser transmitida para a API getUserMedia() para gerar um stream de mídia que corresponde à fonte selecionada pelo usuário. Se o usuário não selecionar nenhuma fonte (ou seja, cancelar o prompt), o callback será chamado com um streamId vazio. O streamId criado só pode ser usado uma vez e expira após alguns segundos se não for utilizado.

    • opções

      objeto

      Chrome 57+ browser.* desde o Chrome 148

      Contém propriedades que descrevem o stream.

      • canRequestAudioTrack

        booleano

        Verdadeiro se "audio" estiver incluído nas fontes de parâmetro e o usuário final não desmarcar a caixa de seleção "Compartilhar áudio". Caso contrário, será "false", e, nesse caso, não será possível solicitar um stream de áudio pela chamada getUserMedia.

Retorna

  • número

    Um ID que pode ser transmitido para cancelChooseDesktopMedia() caso o comando precise ser cancelado.