Call interface

Pacote:

@azure/communication-calling

Representa uma chamada.

Extends

CallCommon

Propriedades

info	Obtenha informações sobre esta Chamada.

Propriedades Herdadas

callEndReason	Contendo código/subcódigo indicando como esta chamada terminou.
callerInfo	Informações do chamador se esta chamada estiver chegando.
direction	Obtenha a direção da chamada, seja ela de entrada ou de saída.
id	Obtenha o ID exclusivo 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 a partilha de ecrã está ativada.
kind	Obtenha o tipo de objeto de chamada.
lobby	Obtenha o lobby de reuniões do Teams.
localAudioStreams	Recolha de fluxos de áudio locais que estão a ser enviados para outros participantes numa chamada.
localVideoStreams	Recolha de fluxos de vídeo locais que estão a ser enviados a outros participantes numa 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 cem ou mais, apenas 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.

Métodos

addParticipant(CommunicationUserIdentifier | MicrosoftTeamsUserIdentifier)	Adicione um participante a esta Chamada.
addParticipant(CommunicationUserIdentifier, AddCommunicationUserOptions)	Adicione um participante a esta Chamada.
addParticipant(MicrosoftTeamsAppIdentifier | UnknownIdentifier)	Adicione um aplicativo do Teams a esta chamada.
addParticipant(MicrosoftTeamsUserIdentifier, AddMicrosoftTeamsUserOptions)	Adicione um participante a esta Chamada.
addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)	Adicione um participante a esta Chamada.
removeParticipant(CommunicationIdentifier)	Remova um participante desta Chamada.

Métodos Herdados

dispose()
feature<TFeature>(CallFeatureFactory<TFeature>)	Recupera um objeto Feature inicializado e memorizado com API estendida. Verifique o objeto Features.* para todos os recursos de chamada estendida disponíveis neste pacote, por exemplo: const call: Call = ...; call.feature(Features.Recording).isRecordingActive; call.feature(Features.Captions).startCaptions('en-us')
hangUp(HangUpOptions)	Desligue a chamada.
hold()	Suspenda esta chamada.
mute()	Silencie o microfone local.
muteAllRemoteParticipants()	Silencie todos os participantes remotos.
muteIncomingAudio()	Silencie o áudio recebido.
off("idChanged", PropertyChangedEvent)	Função de cancelamento de inscrição para o evento idChanged.
off("isIncomingAudioMutedChanged", PropertyChangedEvent)	Função de assinatura para o evento isIncomingAudioMutedChanged.
off("isLocalVideoStartedChanged", PropertyChangedEvent)	Função de cancelamento de inscrição para o evento isLocalVideoStartedChanged.
off("isMutedChanged", PropertyChangedEvent)	Função Subscribe para o evento isMutedChanged.
off("isScreenSharingOnChanged", PropertyChangedEvent)	Função de cancelamento de inscrição para o evento isScreenSharingChanged.
off("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)	Função de cancelamento de inscrição para o evento localAudioStreamsUpdated.
off("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)	Função de cancelamento de inscrição para o evento localVideoStreamsUpdated.
off("mutedByOthers", PropertyChangedEvent)	Função de cancelamento de inscrição para o evento mutedByOthers.
off("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)	Função de cancelamento de inscrição para o evento remoteAudioStreamsUpdated.
off("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)	Função de cancelamento de inscrição para o evento remoteParticipantsUpdated.
off("roleChanged", PropertyChangedEvent)	Função de cancelamento de inscrição para o evento roleChanged.
off("stateChanged", PropertyChangedEvent)	Função de cancelamento de inscrição para o evento stateChanged.
off("totalParticipantCountChanged", PropertyChangedEvent)	Função de cancelamento de inscrição para o evento totalParticipantCountChanged.
on("idChanged", PropertyChangedEvent)	Função Subscribe para o evento idChanged.
on("isIncomingAudioMutedChanged", PropertyChangedEvent)	Função de assinatura para o evento isIncomingAudioMutedChanged.
on("isLocalVideoStartedChanged", PropertyChangedEvent)	Função Subscribe para o evento isLocalVideoStartedChanged.
on("isMutedChanged", PropertyChangedEvent)	Função Subscribe para o evento isMutedChanged.
on("isScreenSharingOnChanged", PropertyChangedEvent)	Função de assinatura para o evento isScreenSharingChanged.
on("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)	Função de inscrição para o evento localAudioStreamsUpdated.
on("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)	Função de inscrição para o evento localVideoStreamsUpdated.
on("mutedByOthers", PropertyChangedEvent)	Função Subscribe para o evento mutedByOthers.
on("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)	Função de assinatura para o evento remoteAudioStreamsUpdated.
on("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)	Função de inscrição para o evento remoteParticipantsUpdated.
on("roleChanged", PropertyChangedEvent)	Função Subscribe para o evento roleChanged.
on("stateChanged", PropertyChangedEvent)	Função Subscribe para o evento stateChanged.
on("totalParticipantCountChanged", PropertyChangedEvent)	Função de inscrição para o evento totalParticipantCountChanged.
resume()	Retome esta chamada se estiver no estado 'LocalHold'.
sendDtmf(DtmfTone)	Envie o tom DTMF.
setConstraints(CallConstraints)	Defina restrições de chamada. Este método define as restrições máximas de com base nos valores fornecidos. As restrições finais aplicadas serão menores ou iguais aos valores fornecidos aqui para este método. Se o valor 0 for fornecido, nenhuma restrição será aplicada para 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 fonte 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. O envio de fluxo de compartilhamento de tela não é compatível com iOS nem Android. O fluxo de compartilhamento de tela de entrada é compatível com iOS e Android.
startScreenSharing(LocalVideoStream)	Comece a enviar fluxo de compartilhamento de tela bruto em uma chamada. O envio de compartilhamento de tela bruto não é suportado no iOS nem no Android. O compartilhamento de tela bruto de entrada é suportado no iOS e Android.
startVideo(LocalVideoStream)	Comece a enviar fluxo de vídeo na chamada. Os participantes remotos da chamada receberão seu fluxo de vídeo para que possam renderizá-lo em suas interfaces do usuário.
stopAudio()	Pare o áudio personalizado na chamada e mude para o dispositivo de áudio padrão do Gerenciador de dispositivos.
stopScreenSharing()	Pare o compartilhamento de tela local.
stopScreenSharing(LocalVideoStream)	Pare 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(), API CallAgent.join(), API IncomingCall.accept() ou API Call.startVideo().
unmute()	Desative o mudo do microfone local.
unmuteIncomingAudio()	Desative o som recebido.

Detalhes de Propriedade

info

Obtenha informações sobre esta Chamada.

info: CallInfo

Valor de Propriedade

CallInfo

Detalhes da Propriedade Herdada

callEndReason

Contendo código/subcódigo indicando como esta chamada terminou.

callEndReason?: CallEndReason

Valor de Propriedade

CallEndReason

herdado de CallCommon.callEndReason

callerInfo

Informações do chamador se esta chamada estiver chegando.

callerInfo: CallerInfo

Valor de Propriedade

CallerInfo

herdado de CallCommon.callerInfo

direction

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

direction: CallDirection

Valor de Propriedade

CallDirection

herdado deCallCommon.direction

id

Obtenha o ID exclusivo para esta chamada.

id: string

Valor de Propriedade

string

herdado deCallCommon.id

isIncomingAudioMuted

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

isIncomingAudioMuted: boolean

Valor de Propriedade

boolean

herdado deCallCommon.isIncomingAudioMuted

isLocalVideoStarted

Se o vídeo local está ativado.

isLocalVideoStarted: boolean

Valor de Propriedade

boolean

herdado deCallCommon.isLocalVideoStarted

isMuted

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

isMuted: boolean

Valor de Propriedade

boolean

herdado deCallCommon.isMuted

isScreenSharingOn

Se a partilha de ecrã está ativada.

isScreenSharingOn: boolean

Valor de Propriedade

boolean

herdado deCallCommon.isScreenSharingOn

kind

Obtenha o tipo de objeto de chamada.

kind: CallKind

Valor de Propriedade

CallKind

herdado deCallCommon.kind

lobby

Obtenha o lobby de reuniões do Teams.

lobby: Lobby

Valor de Propriedade

Lobby

herdado deCallCommon.lobby

localAudioStreams

Recolha de fluxos de áudio locais que estão a ser enviados para outros participantes numa chamada.

localAudioStreams: readonly LocalAudioStream[]

Valor de Propriedade

readonly LocalAudioStream[]

herdado deCallCommon.localAudioStreams

localVideoStreams

Recolha de fluxos de vídeo locais que estão a ser enviados a outros participantes numa chamada.

localVideoStreams: readonly LocalVideoStream[]

Valor de 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 de Propriedade

readonly RemoteAudioStream[]

herdado de CallCommon.remoteAudioStreams

remoteParticipants

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

remoteParticipants: readonly RemoteParticipant[]

Valor de Propriedade

readonly RemoteParticipant[]

herdado deCallCommon.remoteParticipants

role

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

role: ParticipantRole

Valor de Propriedade

ParticipantRole

herdado de CallCommon.role

state

Obtenha o estado desta chamada.

state: CallState

Valor de Propriedade

CallState

herdado deCallCommon.state

totalParticipantCount

Nota

Este API está em Beta e é fornecido como pré-visualização para os programadores, podendo ser alterado com base nos comentários que recebermos. Não utilize esta API num ambiente de produção.

Contagem do número total de participantes nesta chamada.

totalParticipantCount: number

Valor de Propriedade

number

herdado deCallCommon.totalParticipantCount

Detalhes de Método

addParticipant(CommunicationUserIdentifier | MicrosoftTeamsUserIdentifier)

Adicione um participante a esta Chamada.

function addParticipant(identifier: CommunicationUserIdentifier | MicrosoftTeamsUserIdentifier): RemoteParticipant

Parâmetros

identifier

CommunicationUserIdentifier | MicrosoftTeamsUserIdentifier

O identificador do participante a adicionar.

Devoluções

RemoteParticipant

O objeto RemoteParticipant associado ao participante adicionado com êxito.

addParticipant(CommunicationUserIdentifier, AddCommunicationUserOptions)

Nota

Este API está em Beta e é fornecido como pré-visualização para os programadores, podendo ser alterado com base nos comentários que recebermos. Não utilize esta API num ambiente de produção.

Adicione um participante a esta Chamada.

function addParticipant(identifier: CommunicationUserIdentifier, options?: AddCommunicationUserOptions): RemoteParticipant

Parâmetros

identifier

CommunicationUserIdentifier

O identificador do participante a adicionar.

options

AddCommunicationUserOptions

Opções adicionais para gerenciar a chamada.

Devoluções

RemoteParticipant

O objeto RemoteParticipant associado ao participante adicionado com êxito.

addParticipant(MicrosoftTeamsAppIdentifier | UnknownIdentifier)

Nota

Este API está em Beta e é fornecido como pré-visualização para os programadores, podendo ser alterado com base nos comentários que recebermos. Não utilize esta API num ambiente de produção.

Adicione um aplicativo do Teams a esta chamada.

function addParticipant(identifier: MicrosoftTeamsAppIdentifier | UnknownIdentifier): RemoteParticipant

Parâmetros

identifier

MicrosoftTeamsAppIdentifier | UnknownIdentifier

O identificador do aplicativo Teams a ser adicionado.

Devoluções

RemoteParticipant

O objeto RemoteParticipant associado ao aplicativo Teams adicionado com êxito.

addParticipant(MicrosoftTeamsUserIdentifier, AddMicrosoftTeamsUserOptions)

Nota

Este API está em Beta e é fornecido como pré-visualização para os programadores, podendo ser alterado com base nos comentários que recebermos. Não utilize esta API num ambiente de produção.

Adicione um participante a esta Chamada.

function addParticipant(identifier: MicrosoftTeamsUserIdentifier, options: AddMicrosoftTeamsUserOptions): RemoteParticipant

Parâmetros

identifier

MicrosoftTeamsUserIdentifier

O identificador do participante a adicionar.

options

AddMicrosoftTeamsUserOptions

Opções adicionais para gerenciar a chamada.

Devoluções

RemoteParticipant

O objeto RemoteParticipant associado ao participante adicionado com êxito.

addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

Adicione um participante a esta Chamada.

function addParticipant(identifier: PhoneNumberIdentifier, options?: AddPhoneNumberOptions): RemoteParticipant

Parâmetros

identifier

PhoneNumberIdentifier

O identificador do participante a adicionar.

options

AddPhoneNumberOptions

Opções adicionais para gerenciar a chamada PSTN. Por exemplo, definir o número de telefone da ID do chamador em uma chamada PSTN.

Devoluções

RemoteParticipant

O objeto RemoteParticipant associado ao participante adicionado com êxito.

removeParticipant(CommunicationIdentifier)

Remova um participante desta Chamada.

function removeParticipant(identifier: CommunicationIdentifier): Promise<void>

Parâmetros

identifier

CommunicationIdentifier

O identificador do participante a remover.

Devoluções

Promise<void>

Detalhes do Método Herdado

dispose()

function dispose()

herdado deCallCommon.dispose

feature<TFeature>(CallFeatureFactory<TFeature>)

Recupera um objeto Feature inicializado e memorizado com API estendida. Verifique o objeto Features.* para todos os recursos de chamada estendida disponíveis neste pacote, por 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 para o construtor de recurso de chamada que fornece uma API estendida.

Devoluções

TFeature

herdado de CallCommon.feature

hangUp(HangUpOptions)

Desligue a chamada.

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

Parâmetros

options

HangUpOptions

Opções de desligamento.

Devoluções

Promise<void>

herdado deCallCommon.hangUp

hold()

Suspenda esta chamada.

function hold(): Promise<void>

Devoluções

Promise<void>

herdado deCallCommon.hold

mute()

Silencie o microfone local.

function mute(): Promise<void>

Devoluções

Promise<void>

herdado de CallCommon.mute

muteAllRemoteParticipants()

Silencie todos os participantes remotos.

function muteAllRemoteParticipants(): Promise<void>

Devoluções

Promise<void>

herdado deCallCommon.muteAllRemoteParticipants

muteIncomingAudio()

Silencie o áudio recebido.

function muteIncomingAudio(): Promise<void>

Devoluções

Promise<void>

herdado deCallCommon.muteIncomingAudio

off("idChanged", PropertyChangedEvent)

Função de cancelamento de inscrição para o evento idChanged.

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

Parâmetros

event

"idChanged"

nome do evento.

listener

PropertyChangedEvent

retorno de chamada fn que foi usado para se inscrever neste evento.

herdado deCallCommon.off

off("isIncomingAudioMutedChanged", PropertyChangedEvent)

Função de assinatura para o evento isIncomingAudioMutedChanged.

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

Parâmetros

event

"isIncomingAudioMutedChanged"

nome do evento.

listener

PropertyChangedEvent

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

herdado deCallCommon.off

off("isLocalVideoStartedChanged", PropertyChangedEvent)

Função de cancelamento de inscrição para o evento isLocalVideoStartedChanged.

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

Parâmetros

event

"isLocalVideoStartedChanged"

nome do evento.

listener

PropertyChangedEvent

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

herdado deCallCommon.off

off("isMutedChanged", PropertyChangedEvent)

Função Subscribe para o evento isMutedChanged.

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

Parâmetros

event

"isMutedChanged"

nome do evento.

listener

PropertyChangedEvent

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

herdado deCallCommon.off

off("isScreenSharingOnChanged", PropertyChangedEvent)

Função de cancelamento de inscrição para o evento isScreenSharingChanged.

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

Parâmetros

event

"isScreenSharingOnChanged"

nome do evento.

listener

PropertyChangedEvent

retorno de chamada fn que foi usado para se inscrever neste evento.

herdado deCallCommon.off

off("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)

Função de cancelamento de inscrição para o evento localAudioStreamsUpdated.

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

Parâmetros

event

"localAudioStreamsUpdated"

nome do evento.

listener

CollectionUpdatedEvent<LocalAudioStream>

retorno de chamada fn que foi usado para se inscrever neste evento.

herdado deCallCommon.off

off("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)

Função de cancelamento de inscrição para o evento localVideoStreamsUpdated.

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

Parâmetros

event

"localVideoStreamsUpdated"

nome do evento.

listener

CollectionUpdatedEvent<LocalVideoStream>

retorno de chamada fn que foi usado para se inscrever neste evento.

herdado deCallCommon.off

off("mutedByOthers", PropertyChangedEvent)

Função de cancelamento de inscrição para o evento mutedByOthers.

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

Parâmetros

event

"mutedByOthers"

nome do evento.

listener

PropertyChangedEvent

retorno de chamada fn que foi usado para cancelar a inscrição neste evento.

herdado deCallCommon.off

off("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)

Função de cancelamento de inscrição para o evento remoteAudioStreamsUpdated.

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

Parâmetros

event

"remoteAudioStreamsUpdated"

nome do evento.

listener

CollectionUpdatedEvent<RemoteAudioStream>

retorno de chamada fn que foi usado para se inscrever neste evento.

herdado deCallCommon.off

off("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)

Função de cancelamento de inscrição para o evento remoteParticipantsUpdated.

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

Parâmetros

event

"remoteParticipantsUpdated"

nome do evento.

listener

CollectionUpdatedEvent<RemoteParticipant>

retorno de chamada fn que foi usado para se inscrever neste evento.

herdado deCallCommon.off

off("roleChanged", PropertyChangedEvent)

Função de cancelamento de inscrição para o evento roleChanged.

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

Parâmetros

event

"roleChanged"

nome do evento.

listener

PropertyChangedEvent

retorno de chamada fn que foi usado para se inscrever neste evento.

herdado deCallCommon.off

off("stateChanged", PropertyChangedEvent)

Função de cancelamento de inscrição para o evento stateChanged.

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

Parâmetros

event

"stateChanged"

nome do evento.

listener

PropertyChangedEvent

retorno de chamada fn que foi usado para se inscrever neste evento.

herdado deCallCommon.off

off("totalParticipantCountChanged", PropertyChangedEvent)

Nota

Este API está em Beta e é fornecido como pré-visualização para os programadores, podendo ser alterado com base nos comentários que recebermos. Não utilize esta API num ambiente de produção.

Função de cancelamento de inscrição para o evento totalParticipantCountChanged.

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

Parâmetros

event

"totalParticipantCountChanged"

nome do evento.

listener

PropertyChangedEvent

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

herdado deCallCommon.off

on("idChanged", PropertyChangedEvent)

Função Subscribe para o evento idChanged.

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

Parâmetros

event

"idChanged"

nome do evento.

listener

PropertyChangedEvent

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

herdado deCallCommon.on

on("isIncomingAudioMutedChanged", PropertyChangedEvent)

Função de assinatura para o evento isIncomingAudioMutedChanged.

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

Parâmetros

event

"isIncomingAudioMutedChanged"

nome do evento.

listener

PropertyChangedEvent

retorno de chamada fn 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

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

herdado deCallCommon.on

on("isMutedChanged", PropertyChangedEvent)

Função Subscribe para o evento isMutedChanged.

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

Parâmetros

event

"isMutedChanged"

nome do evento.

listener

PropertyChangedEvent

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

herdado deCallCommon.on

on("isScreenSharingOnChanged", PropertyChangedEvent)

Função de assinatura para o evento isScreenSharingChanged.

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

Parâmetros

event

"isScreenSharingOnChanged"

nome do evento.

listener

PropertyChangedEvent

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

herdado deCallCommon.on

on("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)

Função de inscrição para o evento localAudioStreamsUpdated.

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

Parâmetros

event

"localAudioStreamsUpdated"

nome do evento.

listener

CollectionUpdatedEvent<LocalAudioStream>

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

herdado deCallCommon.on

on("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)

Função de inscrição para o evento localVideoStreamsUpdated.

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

Parâmetros

event

"localVideoStreamsUpdated"

nome do evento.

listener

CollectionUpdatedEvent<LocalVideoStream>

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

herdado deCallCommon.on

on("mutedByOthers", PropertyChangedEvent)

Função Subscribe para o evento mutedByOthers.

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

Parâmetros

event

"mutedByOthers"

nome do evento.

listener

PropertyChangedEvent

retorno de chamada fn que foi usado para se inscrever neste evento.

herdado deCallCommon.on

on("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)

Função de assinatura para o evento remoteAudioStreamsUpdated.

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

Parâmetros

event

"remoteAudioStreamsUpdated"

nome do evento.

listener

CollectionUpdatedEvent<RemoteAudioStream>

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

herdado deCallCommon.on

on("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)

Função de inscrição para o evento remoteParticipantsUpdated.

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

Parâmetros

event

"remoteParticipantsUpdated"

nome do evento.

listener

CollectionUpdatedEvent<RemoteParticipant>

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

herdado deCallCommon.on

on("roleChanged", PropertyChangedEvent)

Função Subscribe para o evento roleChanged.

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

Parâmetros

event

"roleChanged"

nome do evento.

listener

PropertyChangedEvent

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

herdado deCallCommon.on

on("stateChanged", PropertyChangedEvent)

Função Subscribe para o evento stateChanged.

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

Parâmetros

event

"stateChanged"

nome do evento.

listener

PropertyChangedEvent

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

herdado deCallCommon.on

on("totalParticipantCountChanged", PropertyChangedEvent)

Nota

Este API está em Beta e é fornecido como pré-visualização para os programadores, podendo ser alterado com base nos comentários que recebermos. Não utilize esta API num ambiente de produção.

Função de inscrição para o evento totalParticipantCountChanged.

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

Parâmetros

event

"totalParticipantCountChanged"

nome do evento.

listener

PropertyChangedEvent

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

herdado deCallCommon.on

resume()

Retome esta chamada se estiver no estado 'LocalHold'.

function resume(): Promise<void>

Devoluções

Promise<void>

herdado deCallCommon.resume

sendDtmf(DtmfTone)

Envie o tom DTMF.

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

Parâmetros

dtmfTone

DtmfTone

Devoluções

Promise<void>

herdado deCallCommon.sendDtmf

setConstraints(CallConstraints)

Defina restrições de chamada. Este método define as restrições máximas de com base nos valores fornecidos. As restrições finais aplicadas serão menores ou iguais aos valores fornecidos aqui para este método. Se o valor 0 for fornecido, nenhuma restrição será aplicada para 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

Devoluções

Promise<void>

herdado de CallCommon.setConstraints

startAudio(LocalAudioStream)

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

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

Parâmetros

localAudioStream

LocalAudioStream

Devoluções

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.
• O envio de fluxo de compartilhamento de tela não é compatível com iOS nem Android.
• O fluxo de compartilhamento de tela de entrada é compatível com iOS e Android.

function startScreenSharing(): Promise<void>

Devoluções

Promise<void>

herdado de CallCommon.startScreenSharing

startScreenSharing(LocalVideoStream)

Nota

Este API está em Beta e é fornecido como pré-visualização para os programadores, podendo ser alterado com base nos comentários que recebermos. Não utilize esta API num ambiente de produção.

• Comece a enviar fluxo de compartilhamento de tela bruto em uma chamada.
• O envio de compartilhamento de tela bruto não é suportado no iOS nem no Android.
• O compartilhamento de tela bruto de entrada é suportado no iOS e Android.

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

Parâmetros

localVideoStream

LocalVideoStream

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

Devoluções

Promise<void>

herdado de CallCommon.startScreenSharing

startVideo(LocalVideoStream)

Comece a enviar fluxo de vídeo na chamada. Os participantes remotos da 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.

Devoluções

Promise<void>

herdado deCallCommon.startVideo

stopAudio()

Pare o áudio personalizado na chamada e mude para o dispositivo de áudio padrão do Gerenciador de dispositivos.

function stopAudio()

herdado de CallCommon.stopAudio

stopScreenSharing()

Pare o compartilhamento de tela local.

function stopScreenSharing(): Promise<void>

Devoluções

Promise<void>

herdado de CallCommon.stopScreenSharing

stopScreenSharing(LocalVideoStream)

Nota

Este API está em Beta e é fornecido como pré-visualização para os programadores, podendo ser alterado com base nos comentários que recebermos. Não utilize esta API num ambiente de produção.

Pare 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.

Devoluções

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(), API 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 parar o streaming.

Devoluções

Promise<void>

herdado de CallCommon.stopVideo

unmute()

Desative o mudo do microfone local.

function unmute(): Promise<void>

Devoluções

Promise<void>

herdado de CallCommon.unmute

unmuteIncomingAudio()

Desative o som recebido.

function unmuteIncomingAudio(): Promise<void>

Devoluções

Promise<void>

herdado deCallCommon.unmuteIncomingAudio