chrome.desktopCapture

Descrição

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

Permissões

desktopCapture

Tipos

DesktopCaptureSourceType

Enum usado para definir o conjunto de fontes de mídia de computador usadas em chooseDesktopMedia().

Enumeração

"screen"

"window"

"tab"

"audio"

SelfCapturePreferenceEnum

Chrome 107 e versões mais recentes

Espelha SelfCapturePreferenceEnum.

Enumeração

"include"

"exclude"

SystemAudioPreferenceEnum

Chrome 105 e versões mais recentes

Espelha SystemAudioPreferenceEnum.

Enumeração

"include"

"exclude"

Métodos

cancelChooseDesktopMedia()

chrome.desktopCapture.cancelChooseDesktopMedia(
  desktopMediaRequestId: number,
)

Oculta a caixa de diálogo do seletor de mídia para computador mostrada por chooseDesktopMedia().

Parâmetros

  • desktopMediaRequestId

    number

    ID retornado por chooseDesktopMedia()

chooseDesktopMedia()

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

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

Parâmetros

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

  • targetTab

    Guia opcional

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

  • callback

    função

    O parâmetro callback tem este formato: 

    (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 à origem selecionada pelo usuário. Se o usuário não selecionar nenhuma fonte (ou seja, cancelar a solicitação), o callback será chamado com uma streamId vazia. O streamId criado só pode ser usado uma vez e expira após alguns segundos se não for usado.

    • opções

      objeto

      Chrome 57 ou mais recente

      Contém propriedades que descrevem o stream.

      • canRequestAudioTrack

        booleano

        Verdadeiro se "áudio" estiver incluído nas fontes de parâmetros e o usuário final não desmarcar a caixa de seleção "Compartilhar áudio". Caso contrário, é falso. Nesse caso, não é necessário pedir o stream de áudio pela chamada getUserMedia.

Retorna

  • number

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