chrome.desktopCapture

Descrição

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

Permissões

desktopCapture

Tipos

DesktopCaptureSourceType

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

Enumeração

"tela"

"janela"

"guia"

"áudio"

SelfCapturePreferenceEnum

Chrome 107 ou versão mais recente

Espelha SelfCapturePreferenceEnum.

Enumeração

"incluir"

"excluir"

SystemAudioPreferenceEnum

Chrome 105 ou mais recente

Espelha SystemAudioPreferenceEnum.

Enumeração

"incluir"

"excluir"

Métodos

cancelChooseDesktopMedia()

chrome.desktopCapture.cancelChooseDesktopMedia(
  desktopMediaRequestId: number,
)

Oculta a caixa de diálogo do seletor de mídia da área de trabalho 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 da área de trabalho com o conjunto especificado de fontes.

Parâmetros

  • Conjunto de origens que serão mostradas ao usuário. A ordem das origens no conjunto determina a ordem da tabulação no seletor.

  • targetTab

    Guia opcional

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

  • callback

    função

    O parâmetro callback tem esta aparência: 

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

    • streamId

      string

      Uma string opaca que pode ser transmitida à API getUserMedia() para gerar um stream de mídia correspondente à origem selecionada pelo usuário. Se o usuário não selecionou nenhuma origem (ou seja, cancelou a solicitação), o callback será chamado com um streamId vazio. O streamId criado pode ser usado apenas uma vez e expira após alguns segundos quando não é usado.

    • opções

      objeto

      Chrome 57 ou superior

      Contém propriedades que descrevem o stream.

      • canRequestAudioTrack

        booleano

        Verdadeiro se "áudio" está incluído nas origens de parâmetros, e o usuário final não desmarca a opção "Compartilhar áudio" caixa de seleção. Caso contrário, é "false" e, nesse caso, não é possível solicitar o stream de áudio com a chamada "getUserMedia".

Retorna

  • number

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