TeamsCall interface

Pacote:

@azure/communication-calling

Representa uma chamada do Teams.

Extends

CallCommon

Propriedades

info	Obtenha informações sobre esta chamada do Teams.

Propriedades herdadas

callEndReason	Contendo código/subCódigo indicando como essa chamada terminou.
callerInfo	Informações do chamador se essa chamada estiver de entrada.
direction	Obtenha a direção da chamada, seja de entrada ou saída.
id	Obtenha a ID exclusiva para esta chamada.
isIncomingAudioMuted	Se o usuário local silenciou o áudio de entrada.
isLocalVideoStarted	Se o vídeo local está ativado.
isMuted	Se o usuário local está mudo, local ou remotamente.
isScreenSharingOn	Se o compartilhamento de tela está ativado.
kind	Obtenha o tipo de objeto de chamada.
lobby	Obtenha o lobby da reunião do Teams.
localAudioStreams	Coleção de fluxos de áudio locais que estão sendo enviados para outros participantes em uma chamada.
localVideoStreams	Coleção de fluxos de vídeo locais sendo enviados para outros participantes em uma chamada.
remoteAudioStreams	Coleção de fluxos de áudio remotos que estão sendo recebidos da chamada.
remoteParticipants	Coleção de participantes remotos nesta chamada. No caso de chamadas com participantes de centenas ou mais, somente os participantes ativos de mídia estão presentes nesta coleção.
role	Obtenha a função do usuário local na Chamada.
state	Obtenha o estado desta chamada.
totalParticipantCount	Contagem do número total de participantes nesta chamada.
transferorInfo	Iniciador de transferência em caso de cenários de transferência/encaminhamento.

Métodos

addParticipant(PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier, AddTeamsParticipantOptions)	Adicione um participante.
removeParticipant(PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | UnknownIdentifier)	Remova um participante dessa chamada.

Métodos herdados

dispose()
feature<TFeature>(CallFeatureFactory<TFeature>)	Recupera um objeto Feature inicializado e memorando com a API estendida. Verifique o objeto Features.* para obter todos os recursos de chamada estendida disponíveis neste pacote, exemplo: const call: Call = ...; call.feature(Features.Recording).isRecordingActive; call.feature(Features.Captions).startCaptions('en-us')
hangUp(HangUpOptions)	Desligue a chamada.
hold()	Coloque esta chamada em espera.
mute()	Mudo microfone local.
muteAllRemoteParticipants()	Silencie todos os participantes remotos.
muteIncomingAudio()	Ativar mudo de áudio de entrada.
off("callerInfoChanged", PropertyChangedEvent)	Função Cancelar assinatura para evento alterado de informações do chamador.
off("idChanged", PropertyChangedEvent)	Função Cancelar assinatura do evento idChanged.
off("isIncomingAudioMutedChanged", PropertyChangedEvent)	Função Subscribe para o evento isIncomingAudioMutedChanged.
off("isLocalVideoStartedChanged", PropertyChangedEvent)	Função Cancelar assinatura do evento isLocalVideoStartedChanged.
off("isMutedChanged", PropertyChangedEvent)	Função de assinatura do evento isMutedChanged.
off("isScreenSharingOnChanged", PropertyChangedEvent)	Função Cancelar assinatura do evento isScreenSharingChanged.
off("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)	Função Cancelar assinatura do evento localAudioStreamsUpdated.
off("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)	Função Cancelar assinatura do evento localVideoStreamsUpdated.
off("mutedByOthers", PropertyChangedEvent)	Função Cancelar assinatura do evento mutedByOthers.
off("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)	Função Cancelar assinatura do evento remoteAudioStreamsUpdated.
off("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)	Função Cancelar assinatura do evento remoteParticipantsUpdated.
off("roleChanged", PropertyChangedEvent)	Cancelar a assinatura da função de evento roleChanged.
off("stateChanged", PropertyChangedEvent)	Função Cancelar assinatura do evento stateChanged.
off("totalParticipantCountChanged", PropertyChangedEvent)	função de cancelamento da assinatura do evento totalParticipantCountChanged.
off("transferorInfoChanged", PropertyChangedEvent)	Função Cancelar assinatura para evento alterado de informações do chamador.
on("callerInfoChanged", PropertyChangedEvent)	Função de assinatura para evento alterado de informações do chamador.
on("idChanged", PropertyChangedEvent)	Função de assinatura do evento idChanged.
on("isIncomingAudioMutedChanged", PropertyChangedEvent)	Função Subscribe para o evento isIncomingAudioMutedChanged.
on("isLocalVideoStartedChanged", PropertyChangedEvent)	Função Subscribe para o evento isLocalVideoStartedChanged.
on("isMutedChanged", PropertyChangedEvent)	Função de assinatura do evento isMutedChanged.
on("isScreenSharingOnChanged", PropertyChangedEvent)	Função Subscribe para o evento isScreenSharingChanged.
on("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)	Função de assinatura do evento localAudioStreamsUpdated.
on("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)	Função de assinatura do evento localVideoStreamsUpdated.
on("mutedByOthers", PropertyChangedEvent)	Função Subscribe para evento mutedByOthers.
on("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)	Função de assinatura do evento remoteAudioStreamsUpdated.
on("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)	Função de assinatura do evento remoteParticipantsUpdated.
on("roleChanged", PropertyChangedEvent)	Função Subscribe para evento roleChanged.
on("stateChanged", PropertyChangedEvent)	Função de assinatura do evento stateChanged.
on("totalParticipantCountChanged", PropertyChangedEvent)	Função de assinatura do evento totalParticipantCountChanged.
on("transferorInfoChanged", PropertyChangedEvent)	Função de assinatura para evento alterado de informações do chamador.
resume()	Retome essa chamada se ela estiver no estado 'LocalHold'.
sendDtmf(DtmfTone)	Enviar tom DTMF.
setConstraints(CallConstraints)	Definir restrições de chamada. Esse método define as restrições máximas com base nos valores fornecidos. As restrições aplicadas finais serão menores ou iguais aos valores fornecidos aqui para esse método. Se o valor 0 for fornecido, nenhuma restrição será aplicada a essa restrição. Se o valor indefinido for fornecido, o valor anterior usado será usado para essa restrição.
startAudio(LocalAudioStream)	Inicie o áudio na chamada com áudio personalizado. A origem LocalAudioStream deve ser um MediaStream.
startScreenSharing()	Comece a enviar fluxo de compartilhamento de tela em uma chamada. O navegador solicitará a seleção da tela, do aplicativo ou da guia do navegador. Não há suporte para o envio de fluxo de compartilhamento de tela no iOS nem no Android. O fluxo de compartilhamento de tela de entrada tem suporte no iOS e no Android.
startScreenSharing(LocalVideoStream)	Comece a enviar fluxo de compartilhamento de tela bruta em uma chamada. Não há suporte para o envio de compartilhamento de tela bruta no iOS nem no Android. Há suporte para o compartilhamento de tela bruta de entrada no iOS e no Android.
startVideo(LocalVideoStream)	Comece a enviar fluxo de vídeo na chamada. Os participantes remotos na chamada receberão seu fluxo de vídeo para que possam renderizá-lo em suas interfaces do usuário.
stopAudio()	Interrompa o áudio personalizado na chamada e alterne para o dispositivo de áudio padrão do Gerenciador de Dispositivos.
stopScreenSharing()	Interrompa o compartilhamento de tela local.
stopScreenSharing(LocalVideoStream)	Interrompa o compartilhamento de tela local.
stopVideo(LocalVideoStream)	Pare de enviar fluxo de vídeo na chamada. Deve passar o mesmo objeto LocalVideoStream que foi usado para iniciar o vídeo na API CallAgent.startCall(), CallAgent.join() API, IncomingCall.accept() ou API Call.startVideo().
unmute()	Desativar o microfone local.
unmuteIncomingAudio()	Desativar o áudio de entrada.

Detalhes da propriedade

info

Obtenha informações sobre esta chamada do Teams.

info: TeamsCallInfo

Valor da propriedade

TeamsCallInfo

Detalhes das propriedades herdadas

callEndReason

Contendo código/subCódigo indicando como essa chamada terminou.

callEndReason?: CallEndReason

Valor da propriedade

CallEndReason

herdado decallCommon.callEndReason

callerInfo

Informações do chamador se essa chamada estiver de entrada.

callerInfo: CallerInfo

Valor da propriedade

CallerInfo

herdado decallCommon.callerInfo

direction

Obtenha a direção da chamada, seja de entrada ou saída.

direction: CallDirection

Valor da propriedade

CallDirection

herdado do callcommon.direction

id

Obtenha a ID exclusiva para esta chamada.

id: string

Valor da propriedade

string

herdado deCallCommon.id

isIncomingAudioMuted

Se o usuário local silenciou o áudio de entrada.

isIncomingAudioMuted: boolean

Valor da propriedade

boolean

herdado deCallCommon.isIncomingAudioMuted

isLocalVideoStarted

Se o vídeo local está ativado.

isLocalVideoStarted: boolean

Valor da propriedade

boolean

Herdado deCallCommon.isLocalVideoStarted

isMuted

Se o usuário local está mudo, local ou remotamente.

isMuted: boolean

Valor da propriedade

boolean

herdado deCallCommon.isMuted

isScreenSharingOn

Se o compartilhamento de tela está ativado.

isScreenSharingOn: boolean

Valor da propriedade

boolean

herdado deCallCommon.isScreenSharingOn

kind

Obtenha o tipo de objeto de chamada.

kind: CallKind

Valor da propriedade

CallKind

herdado deCallCommon.kind

lobby

Obtenha o lobby da reunião do Teams.

lobby: Lobby

Valor da propriedade

Lobby

herdado doCallCommon.lobby

localAudioStreams

Coleção de fluxos de áudio locais que estão sendo enviados para outros participantes em uma chamada.

localAudioStreams: readonly LocalAudioStream[]

Valor da propriedade

readonly LocalAudioStream[]

herdado de CallCommon.localAudioStreams

localVideoStreams

Coleção de fluxos de vídeo locais sendo enviados para outros participantes em uma chamada.

localVideoStreams: readonly LocalVideoStream[]

Valor da propriedade

readonly LocalVideoStream[]

Herdado deCallCommon.localVideoStreams

remoteAudioStreams

Coleção de fluxos de áudio remotos que estão sendo recebidos da chamada.

remoteAudioStreams: readonly RemoteAudioStream[]

Valor da propriedade

readonly RemoteAudioStream[]

herdado de CallCommon.remoteAudioStreams

remoteParticipants

Coleção de participantes remotos nesta chamada. No caso de chamadas com participantes de centenas ou mais, somente os participantes ativos de mídia estão presentes nesta coleção.

remoteParticipants: readonly RemoteParticipant[]

Valor da propriedade

readonly RemoteParticipant[]

herdado de CallCommon.remoteParticipants

role

Obtenha a função do usuário local na Chamada.

role: ParticipantRole

Valor da propriedade

ParticipantRole

Herdado deCallCommon.role

state

Obtenha o estado desta chamada.

state: CallState

Valor da propriedade

CallState

herdado doCallCommon.state

totalParticipantCount

Observação

Este API é uma versão beta fornecida como versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Contagem do número total de participantes nesta chamada.

totalParticipantCount: number

Valor da propriedade

number

herdado deCallCommon.totalParticipantCount

transferorInfo

Observação

Este API é uma versão beta fornecida como versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Iniciador de transferência em caso de cenários de transferência/encaminhamento.

transferorInfo?: CallerInfo

Valor da propriedade

CallerInfo

herdado de CallCommon.transferorInfo

Detalhes do método

addParticipant(PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier, AddTeamsParticipantOptions)

Observação

Este API é uma versão beta fornecida como versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Adicione um participante.

function addParticipant(participant: PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier, options?: AddTeamsParticipantOptions): RemoteParticipant

Parâmetros

participant

PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier

Participante a ser adicionado

options

AddTeamsParticipantOptions

AddTeamsParticipantOptions

Retornos

RemoteParticipant

removeParticipant(PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | UnknownIdentifier)

Remova um participante dessa chamada.

function removeParticipant(participant: PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | UnknownIdentifier): Promise<void>

Parâmetros

participant

PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | UnknownIdentifier

o participante a ser removido.

Retornos

Promise<void>

Detalhes do método herdado

dispose()

function dispose()

Herdado deCallCommon.dispose

feature<TFeature>(CallFeatureFactory<TFeature>)

Recupera um objeto Feature inicializado e memorando com a API estendida. Verifique o objeto Features.* para obter todos os recursos de chamada estendida disponíveis neste pacote, exemplo:

const call: Call = ...;
call.feature(Features.Recording).isRecordingActive;
call.feature(Features.Captions).startCaptions('en-us')

function feature<TFeature>(factory: CallFeatureFactory<TFeature>): TFeature

Parâmetros

factory

CallFeatureFactory<TFeature>

A fábrica do construtor de recursos de chamada que fornece uma API estendida.

Retornos

TFeature

herdado deCallCommon.feature

hangUp(HangUpOptions)

Desligue a chamada.

function hangUp(options?: HangUpOptions): Promise<void>

Parâmetros

options

HangUpOptions

Opções de HangUp.

Retornos

Promise<void>

Herdado doCallCommon.hangUp

hold()

Coloque esta chamada em espera.

function hold(): Promise<void>

Retornos

Promise<void>

Herdado deCallCommon.hold

mute()

Mudo microfone local.

function mute(): Promise<void>

Retornos

Promise<void>

herdado de callcommon.mute

muteAllRemoteParticipants()

Silencie todos os participantes remotos.

function muteAllRemoteParticipants(): Promise<void>

Retornos

Promise<void>

Herdado deCallCommon.muteAllRemoteParticipants

muteIncomingAudio()

Ativar mudo de áudio de entrada.

function muteIncomingAudio(): Promise<void>

Retornos

Promise<void>

herdado de CallCommon.muteIncomingAudio

off("callerInfoChanged", PropertyChangedEvent)

Observação

Este API é uma versão beta fornecida como versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Função Cancelar assinatura para evento alterado de informações do chamador.

function off(event: "callerInfoChanged", listener: PropertyChangedEvent)

Parâmetros

event

"callerInfoChanged"

listener

PropertyChangedEvent

herdado doCallCommon.off

off("idChanged", PropertyChangedEvent)

Função Cancelar assinatura do evento idChanged.

function off(event: "idChanged", listener: PropertyChangedEvent)

Parâmetros

event

"idChanged"

nome do evento.

listener

PropertyChangedEvent

fn de retorno de chamada que foi usado para assinar este evento.

herdado doCallCommon.off

off("isIncomingAudioMutedChanged", PropertyChangedEvent)

Função Subscribe para o evento isIncomingAudioMutedChanged.

function off(event: "isIncomingAudioMutedChanged", listener: PropertyChangedEvent)

Parâmetros

event

"isIncomingAudioMutedChanged"

nome do evento.

listener

PropertyChangedEvent

fn de retorno de chamada que será chamado quando o valor dessa propriedade for alterado.

herdado doCallCommon.off

off("isLocalVideoStartedChanged", PropertyChangedEvent)

Função Cancelar assinatura do evento isLocalVideoStartedChanged.

function off(event: "isLocalVideoStartedChanged", listener: PropertyChangedEvent)

Parâmetros

event

"isLocalVideoStartedChanged"

nome do evento.

listener

PropertyChangedEvent

fn de retorno de chamada que será chamado quando o valor dessa propriedade for alterado.

herdado doCallCommon.off

off("isMutedChanged", PropertyChangedEvent)

Função de assinatura do evento isMutedChanged.

function off(event: "isMutedChanged", listener: PropertyChangedEvent)

Parâmetros

event

"isMutedChanged"

nome do evento.

listener

PropertyChangedEvent

fn de retorno de chamada que será chamado quando o valor dessa propriedade for alterado.

herdado doCallCommon.off

off("isScreenSharingOnChanged", PropertyChangedEvent)

Função Cancelar assinatura do evento isScreenSharingChanged.

function off(event: "isScreenSharingOnChanged", listener: PropertyChangedEvent)

Parâmetros

event

"isScreenSharingOnChanged"

nome do evento.

listener

PropertyChangedEvent

fn de retorno de chamada que foi usado para assinar este evento.

herdado doCallCommon.off

off("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)

Função Cancelar assinatura do evento localAudioStreamsUpdated.

function off(event: "localAudioStreamsUpdated", listener: CollectionUpdatedEvent<LocalAudioStream>)

Parâmetros

event

"localAudioStreamsUpdated"

nome do evento.

listener

CollectionUpdatedEvent<LocalAudioStream>

fn de retorno de chamada que foi usado para assinar este evento.

herdado doCallCommon.off

off("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)

Função Cancelar assinatura do evento localVideoStreamsUpdated.

function off(event: "localVideoStreamsUpdated", listener: CollectionUpdatedEvent<LocalVideoStream>)

Parâmetros

event

"localVideoStreamsUpdated"

nome do evento.

listener

CollectionUpdatedEvent<LocalVideoStream>

fn de retorno de chamada que foi usado para assinar este evento.

herdado doCallCommon.off

off("mutedByOthers", PropertyChangedEvent)

Função Cancelar assinatura do evento mutedByOthers.

function off(event: "mutedByOthers", listener: PropertyChangedEvent)

Parâmetros

event

"mutedByOthers"

nome do evento.

listener

PropertyChangedEvent

fn de retorno de chamada que foi usado para cancelar a assinatura deste evento.

herdado doCallCommon.off

off("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)

Função Cancelar assinatura do evento remoteAudioStreamsUpdated.

function off(event: "remoteAudioStreamsUpdated", listener: CollectionUpdatedEvent<RemoteAudioStream>)

Parâmetros

event

"remoteAudioStreamsUpdated"

nome do evento.

listener

CollectionUpdatedEvent<RemoteAudioStream>

fn de retorno de chamada que foi usado para assinar este evento.

herdado doCallCommon.off

off("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)

Função Cancelar assinatura do evento remoteParticipantsUpdated.

function off(event: "remoteParticipantsUpdated", listener: CollectionUpdatedEvent<RemoteParticipant>)

Parâmetros

event

"remoteParticipantsUpdated"

nome do evento.

listener

CollectionUpdatedEvent<RemoteParticipant>

fn de retorno de chamada que foi usado para assinar este evento.

herdado doCallCommon.off

off("roleChanged", PropertyChangedEvent)

Cancelar a assinatura da função de evento roleChanged.

function off(event: "roleChanged", listener: PropertyChangedEvent)

Parâmetros

event

"roleChanged"

nome do evento.

listener

PropertyChangedEvent

fn de retorno de chamada que foi usado para assinar este evento.

herdado doCallCommon.off

off("stateChanged", PropertyChangedEvent)

Função Cancelar assinatura do evento stateChanged.

function off(event: "stateChanged", listener: PropertyChangedEvent)

Parâmetros

event

"stateChanged"

nome do evento.

listener

PropertyChangedEvent

fn de retorno de chamada que foi usado para assinar este evento.

herdado doCallCommon.off

off("totalParticipantCountChanged", PropertyChangedEvent)

Observação

Este API é uma versão beta fornecida como versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

função de cancelamento da assinatura do evento totalParticipantCountChanged.

function off(event: "totalParticipantCountChanged", listener: PropertyChangedEvent)

Parâmetros

event

"totalParticipantCountChanged"

nome do evento.

listener

PropertyChangedEvent

fn de retorno de chamada que será chamado quando a contagem de participantes for alterada.

herdado doCallCommon.off

off("transferorInfoChanged", PropertyChangedEvent)

Observação

Este API é uma versão beta fornecida como versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Função Cancelar assinatura para evento alterado de informações do chamador.

function off(event: "transferorInfoChanged", listener: PropertyChangedEvent)

Parâmetros

event

"transferorInfoChanged"

listener

PropertyChangedEvent

herdado doCallCommon.off

on("callerInfoChanged", PropertyChangedEvent)

Observação

Este API é uma versão beta fornecida como versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Função de assinatura para evento alterado de informações do chamador.

function on(event: "callerInfoChanged", listener: PropertyChangedEvent)

Parâmetros

event

"callerInfoChanged"

listener

PropertyChangedEvent

herdado deCallCommon.on

on("idChanged", PropertyChangedEvent)

Função de assinatura do evento idChanged.

function on(event: "idChanged", listener: PropertyChangedEvent)

Parâmetros

event

"idChanged"

nome do evento.

listener

PropertyChangedEvent

fn de retorno de chamada que será chamado quando o valor dessa propriedade for alterado.

herdado deCallCommon.on

on("isIncomingAudioMutedChanged", PropertyChangedEvent)

Função Subscribe para o evento isIncomingAudioMutedChanged.

function on(event: "isIncomingAudioMutedChanged", listener: PropertyChangedEvent)

Parâmetros

event

"isIncomingAudioMutedChanged"

nome do evento.

listener

PropertyChangedEvent

fn de retorno de chamada que será chamado quando o valor dessa propriedade for alterado.

herdado deCallCommon.on

on("isLocalVideoStartedChanged", PropertyChangedEvent)

Função Subscribe para o evento isLocalVideoStartedChanged.

function on(event: "isLocalVideoStartedChanged", listener: PropertyChangedEvent)

Parâmetros

event

"isLocalVideoStartedChanged"

nome do evento.

listener

PropertyChangedEvent

fn de retorno de chamada que será chamado quando o valor dessa propriedade for alterado.

herdado deCallCommon.on

on("isMutedChanged", PropertyChangedEvent)

Função de assinatura do evento isMutedChanged.

function on(event: "isMutedChanged", listener: PropertyChangedEvent)

Parâmetros

event

"isMutedChanged"

nome do evento.

listener

PropertyChangedEvent

fn de retorno de chamada que será chamado quando o valor dessa propriedade for alterado.

herdado deCallCommon.on

on("isScreenSharingOnChanged", PropertyChangedEvent)

Função Subscribe para o evento isScreenSharingChanged.

function on(event: "isScreenSharingOnChanged", listener: PropertyChangedEvent)

Parâmetros

event

"isScreenSharingOnChanged"

nome do evento.

listener

PropertyChangedEvent

fn de retorno de chamada que será chamado quando o valor dessa propriedade for alterado.

herdado deCallCommon.on

on("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)

Função de assinatura do evento localAudioStreamsUpdated.

function on(event: "localAudioStreamsUpdated", listener: CollectionUpdatedEvent<LocalAudioStream>)

Parâmetros

event

"localAudioStreamsUpdated"

nome do evento.

listener

CollectionUpdatedEvent<LocalAudioStream>

fn de retorno de chamada que será chamado quando essa coleção for alterada, ela passará matrizes de elementos adicionados e removidos.

herdado deCallCommon.on

on("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)

Função de assinatura do evento localVideoStreamsUpdated.

function on(event: "localVideoStreamsUpdated", listener: CollectionUpdatedEvent<LocalVideoStream>)

Parâmetros

event

"localVideoStreamsUpdated"

nome do evento.

listener

CollectionUpdatedEvent<LocalVideoStream>

fn de retorno de chamada que será chamado quando essa coleção for alterada, ela passará matrizes de elementos adicionados e removidos.

herdado deCallCommon.on

on("mutedByOthers", PropertyChangedEvent)

Função Subscribe para evento mutedByOthers.

function on(event: "mutedByOthers", listener: PropertyChangedEvent)

Parâmetros

event

"mutedByOthers"

nome do evento.

listener

PropertyChangedEvent

fn de retorno de chamada que foi usado para assinar este evento.

herdado deCallCommon.on

on("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)

Função de assinatura do evento remoteAudioStreamsUpdated.

function on(event: "remoteAudioStreamsUpdated", listener: CollectionUpdatedEvent<RemoteAudioStream>)

Parâmetros

event

"remoteAudioStreamsUpdated"

nome do evento.

listener

CollectionUpdatedEvent<RemoteAudioStream>

fn de retorno de chamada que será chamado quando essa coleção for alterada, ela passará matrizes de elementos adicionados e removidos.

herdado deCallCommon.on

on("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)

Função de assinatura do evento remoteParticipantsUpdated.

function on(event: "remoteParticipantsUpdated", listener: CollectionUpdatedEvent<RemoteParticipant>)

Parâmetros

event

"remoteParticipantsUpdated"

nome do evento.

listener

CollectionUpdatedEvent<RemoteParticipant>

fn de retorno de chamada que será chamado quando essa coleção for alterada, ela passará matrizes de elementos adicionados e removidos.

herdado deCallCommon.on

on("roleChanged", PropertyChangedEvent)

Função Subscribe para evento roleChanged.

function on(event: "roleChanged", listener: PropertyChangedEvent)

Parâmetros

event

"roleChanged"

nome do evento.

listener

PropertyChangedEvent

fn de retorno de chamada que será chamado quando o valor dessa propriedade for alterado.

herdado deCallCommon.on

on("stateChanged", PropertyChangedEvent)

Função de assinatura do evento stateChanged.

function on(event: "stateChanged", listener: PropertyChangedEvent)

Parâmetros

event

"stateChanged"

nome do evento.

listener

PropertyChangedEvent

fn de retorno de chamada que será chamado quando o valor dessa propriedade for alterado.

herdado deCallCommon.on

on("totalParticipantCountChanged", PropertyChangedEvent)

Observação

Este API é uma versão beta fornecida como versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Função de assinatura do evento totalParticipantCountChanged.

function on(event: "totalParticipantCountChanged", listener: PropertyChangedEvent)

Parâmetros

event

"totalParticipantCountChanged"

nome do evento.

listener

PropertyChangedEvent

fn de retorno de chamada que será chamado quando a contagem de participantes for alterada.

herdado deCallCommon.on

on("transferorInfoChanged", PropertyChangedEvent)

Observação

Este API é uma versão beta fornecida como versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Função de assinatura para evento alterado de informações do chamador.

function on(event: "transferorInfoChanged", listener: PropertyChangedEvent)

Parâmetros

event

"transferorInfoChanged"

listener

PropertyChangedEvent

herdado deCallCommon.on

resume()

Retome essa chamada se ela estiver no estado 'LocalHold'.

function resume(): Promise<void>

Retornos

Promise<void>

Herdado deCallCommon.resume

sendDtmf(DtmfTone)

Enviar tom DTMF.

function sendDtmf(dtmfTone: DtmfTone): Promise<void>

Parâmetros

dtmfTone

DtmfTone

Retornos

Promise<void>

herdado doCallCommon.sendDtmf

setConstraints(CallConstraints)

Definir restrições de chamada. Esse método define as restrições máximas com base nos valores fornecidos. As restrições aplicadas finais serão menores ou iguais aos valores fornecidos aqui para esse método. Se o valor 0 for fornecido, nenhuma restrição será aplicada a essa restrição. Se o valor indefinido for fornecido, o valor anterior usado será usado para essa restrição.

function setConstraints(constraints: CallConstraints): Promise<void>

Parâmetros

constraints

CallConstraints

Objeto que representa as restrições de chamada a serem definidas

Retornos

Promise<void>

Herdado deCallCommon.setConstraints

startAudio(LocalAudioStream)

Inicie o áudio na chamada com áudio personalizado. A origem LocalAudioStream deve ser um MediaStream.

function startAudio(localAudioStream: LocalAudioStream): Promise<void>

Parâmetros

localAudioStream

LocalAudioStream

Retornos

Promise<void>

herdado de CallCommon.startAudio

startScreenSharing()

• Comece a enviar fluxo de compartilhamento de tela em uma chamada. O navegador solicitará a seleção da tela, do aplicativo ou da guia do navegador.
• Não há suporte para o envio de fluxo de compartilhamento de tela no iOS nem no Android.
• O fluxo de compartilhamento de tela de entrada tem suporte no iOS e no Android.

function startScreenSharing(): Promise<void>

Retornos

Promise<void>

herdado de CallCommon.startScreenSharing

startScreenSharing(LocalVideoStream)

Observação

Este API é uma versão beta fornecida como versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

• Comece a enviar fluxo de compartilhamento de tela bruta em uma chamada.
• Não há suporte para o envio de compartilhamento de tela bruta no iOS nem no Android.
• Há suporte para o compartilhamento de tela bruta de entrada no iOS e no Android.

function startScreenSharing(localVideoStream: LocalVideoStream): Promise<void>

Parâmetros

localVideoStream

LocalVideoStream

Representa um fluxo de compartilhamento de tela bruta local que usa um MediaStream no construtor.

Retornos

Promise<void>

herdado de CallCommon.startScreenSharing

startVideo(LocalVideoStream)

Comece a enviar fluxo de vídeo na chamada. Os participantes remotos na chamada receberão seu fluxo de vídeo para que possam renderizá-lo em suas interfaces do usuário.

function startVideo(localVideoStream: LocalVideoStream): Promise<void>

Parâmetros

localVideoStream

LocalVideoStream

Representa um fluxo de vídeo local que usa uma fonte de câmera no construtor.

Retornos

Promise<void>

Herdado deCallCommon.startVideo

stopAudio()

Interrompa o áudio personalizado na chamada e alterne para o dispositivo de áudio padrão do Gerenciador de Dispositivos.

function stopAudio()

herdado de CallCommon.stopAudio

stopScreenSharing()

Interrompa o compartilhamento de tela local.

function stopScreenSharing(): Promise<void>

Retornos

Promise<void>

herdado de CallCommon.stopScreenSharing

stopScreenSharing(LocalVideoStream)

Observação

Este API é uma versão beta fornecida como versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Interrompa o compartilhamento de tela local.

function stopScreenSharing(localVideoStream: LocalVideoStream): Promise<void>

Parâmetros

localVideoStream

LocalVideoStream

O fluxo de compartilhamento de tela local para interromper o streaming.

Retornos

Promise<void>

herdado de CallCommon.stopScreenSharing

stopVideo(LocalVideoStream)

Pare de enviar fluxo de vídeo na chamada. Deve passar o mesmo objeto LocalVideoStream que foi usado para iniciar o vídeo na API CallAgent.startCall(), CallAgent.join() API, IncomingCall.accept() ou API Call.startVideo().

function stopVideo(localVideoStream: LocalVideoStream): Promise<void>

Parâmetros

localVideoStream

LocalVideoStream

O fluxo de vídeo local para interromper o streaming.

Retornos

Promise<void>

herdado doCallCommon.stopVideo

unmute()

Desativar o microfone local.

function unmute(): Promise<void>

Retornos

Promise<void>

Herdado deCallCommon.unmute

unmuteIncomingAudio()

Desativar o áudio de entrada.

function unmuteIncomingAudio(): Promise<void>

Retornos

Promise<void>

herdado deCallCommon.unmuteIncomingAudio