Compartilhar via


CommonCallAdapter interface

interface do Adaptador de CallComposite.

Extends

Propriedades herdadas

sendRealTimeText

Enviar texto em tempo real

Métodos

joinCall(boolean)

Ingresse a chamada com o microfone inicialmente ativado/desativado.

joinCall(JoinCallOptions)

Participe da chamada com o saco de opções para definir o estado inicial do microfone/câmera ao entrar na chamada true = liga o dispositivo ao entrar na chamada false = desliga o dispositivo ao entrar na chamada 'keep'/undefined = reter o estado de pré-chamada dos dispositivos

startCall(CommunicationIdentifier[], StartCallOptions)

Inicie a chamada.

startCall(string[], StartCallOptions)

Inicie a chamada.

Métodos herdados

addParticipant(CommunicationUserIdentifier)
addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

Adicione um participante à chamada.

askDevicePermission(PermissionConstraints)

Peça permissões de dispositivos.

createStreamView(string, VideoStreamOptions)

Crie o modo de exibição html para um fluxo.

createTogetherModeStreamView(TogetherModeStreamOptions)

Crie o modo de exibição html para um fluxo.

dispose()

Descartar a composição

disposeLocalVideoStreamView()

Descartar a visualização html para um fluxo de vídeo local

disposeRemoteVideoStreamView(string)

Descartar a visualização html para um fluxo de vídeo remoto

disposeScreenShareStreamView(string)

Descartar a visualização html para um fluxo de compartilhamento de tela

disposeStreamView(string, VideoStreamOptions)

Descarte o modo de exibição html para um fluxo.

disposeTogetherModeStreamView()

Descarte o modo de exibição html para um fluxo.

forbidAudio(string[])

Proibir o áudio dos participantes da reunião do Teams por suas IDs de usuário.

forbidOthersAudio()

Proibir o áudio da reunião do Teams.

forbidOthersVideo()

Proibir vídeo de reunião do Teams.

forbidVideo(string[])

Proibir o vídeo dos participantes da reunião do Teams por suas IDs de usuário.

getState()

Obter o estado atual

holdCall()

Segura a chamada.

leaveCall(boolean)

Deixe a chamada

lowerHand()

mão inferior para o usuário atual

mute()

Ativar mudo do usuário atual durante a chamada ou desabilitar o microfone localmente

muteAllRemoteParticipants()

Silenciar todos os participantes

muteParticipant(string)

Silenciar um participante

off("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)

Função de cancelamento de assinatura para o evento 'breakoutRoomsUpdated'.

off("callEnded", CallEndedListener)

Função Cancelar assinatura do evento 'callEnded'.

off("callIdChanged", CallIdChangedListener)

Cancelar a assinatura da função para o evento 'callIdChanged'.

off("capabilitiesChanged", CapabilitiesChangedListener)

Função de cancelamento de assinatura para o evento 'capabilitiesChanged'.

off("captionsReceived", CaptionsReceivedListener)

Função de cancelamento de assinatura para o evento 'captionsReceived'.

off("diagnosticChanged", DiagnosticChangedEventListner)

Cancelar a assinatura da função para o evento 'diagnosticChanged'.

off("displayNameChanged", DisplayNameChangedListener)

Desinscreva a função para o evento 'displayNameChanged'.

off("error", (e: AdapterError) => void)

Cancelar a função de assinatura do evento 'error'.

off("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)

Função de cancelamento de assinatura para o evento 'isCaptionLanguageChanged'.

off("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)

Função de cancelamento de assinatura para o evento 'isCaptionsActiveChanged'.

off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

Função Cancelar assinatura do evento 'isLocalScreenSharingActiveChanged'.

off("isMutedChanged", IsMutedChangedListener)

Função Cancelar assinatura do evento 'isMutedChanged'.

off("isSpeakingChanged", IsSpeakingChangedListener)

Função Cancelar assinatura do evento 'isSpeakingChanged'.

off("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)

Função de cancelamento de assinatura para o evento 'isSpokenLanguageChanged'.

off("mutedByOthers", PropertyChangedEvent)

Função de cancelamento de assinatura para o evento 'mutedByOthers'.

off("participantsJoined", ParticipantsJoinedListener)

Função Cancelar assinatura do evento 'participantsJoined'.

off("participantsLeft", ParticipantsLeftListener)

Função Cancelar assinatura do evento 'participantsLeft'.

off("realTimeTextReceived", RealTimeTextReceivedListener)

Função de cancelamento de assinatura para o evento 'realTimeTextReceived'.

off("roleChanged", PropertyChangedEvent)

Função de cancelamento de assinatura para o evento 'roleChanged'.

off("selectedMicrophoneChanged", PropertyChangedEvent)

Função Cancelar assinatura do evento 'selectedMicrophoneChanged'.

off("selectedSpeakerChanged", PropertyChangedEvent)

Desinscreva a função para o evento 'selectedSpeakerChanged'.

off("spotlightChanged", SpotlightChangedListener)

Função de cancelamento de assinatura para o evento 'spotlightChanged'.

off("transferAccepted", TransferAcceptedListener)

Função de cancelamento de assinatura para o evento 'transferRequested'.

offStateChange((state: CallAdapterState) => void)

Cancela a assinatura do manipulador para eventos stateChanged.

on("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)

Função de inscrição para o evento 'breakoutRoomsUpdated'.

on("callEnded", CallEndedListener)

Função de assinatura do evento 'callEnded'.

on("callIdChanged", CallIdChangedListener)

Função Subscribe para o evento 'callIdChanged'.

on("capabilitiesChanged", CapabilitiesChangedListener)

Subscribe para o evento 'capabilitiesChanged'.

on("captionsReceived", CaptionsReceivedListener)

Função de assinatura para o evento 'captionsReceived'.

on("diagnosticChanged", DiagnosticChangedEventListner)

Função de assinatura do evento 'diagnosticChanged'.

Esse evento é acionado sempre que há uma alteração no diagnóstico voltado para o usuário sobre a chamada em andamento.

on("displayNameChanged", DisplayNameChangedListener)

Função Subscribe para o evento 'displayNameChanged'.

on("error", (e: AdapterError) => void)

Assinar a função para o evento 'error'.

on("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)

Função de assinatura para o evento 'isCaptionLanguageChanged'.

on("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)

Função de assinatura para o evento 'isCaptionsActiveChanged'.

on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

Assinar a função para o evento 'isLocalScreenSharingActiveChanged'.

on("isMutedChanged", IsMutedChangedListener)

Função Subscribe para o evento 'isMutedChanged'.

on("isSpeakingChanged", IsSpeakingChangedListener)

Função Subscribe para o evento 'isSpeakingChanged'.

on("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)

Subscribe para o evento 'isSpokenLanguageChanged'.

on("mutedByOthers", PropertyChangedEvent)

Função de assinatura para o evento 'mutedByOthers'.

on("participantsJoined", ParticipantsJoinedListener)

Assinar a função para o evento 'participantsJoined'.

on("participantsLeft", ParticipantsLeftListener)

Função Subscribe para o evento 'participantsLeft'.

on("realTimeTextReceived", RealTimeTextReceivedListener)

Função de assinatura para o evento 'realTimeTextReceived'.

on("roleChanged", PropertyChangedEvent)

Subscribe para o evento 'roleChanged'.

on("selectedMicrophoneChanged", PropertyChangedEvent)

Assinar a função para o evento 'selectedMicrophoneChanged'.

Esse evento é acionado sempre que o usuário seleciona um novo dispositivo de microfone.

on("selectedSpeakerChanged", PropertyChangedEvent)

Assinar a função para o evento 'selectedSpeakerChanged'.

Esse evento é acionado sempre que o usuário seleciona um novo dispositivo de alto-falante.

on("spotlightChanged", SpotlightChangedListener)

Função de inscrição para o evento 'spotlightChanged'.

on("transferAccepted", TransferAcceptedListener)

Função de assinatura para o evento 'transferRequested'.

onReactionClick(Reaction)

Enviar emoji de reação

onStateChange((state: CallAdapterState) => void)

Assina o manipulador para eventos stateChanged.

permitAudio(string[])

Permitir áudio dos participantes da reunião do Teams por suas IDs de usuário.

permitOthersAudio()

Permitir áudio de reunião do Teams.

permitOthersVideo()

Permitir vídeo de reunião do Teams.

permitVideo(string[])

Permitir áudio dos participantes da reunião do Teams por suas IDs de usuário.

queryCameras()

Consultar dispositivos de câmera disponíveis.

queryMicrophones()

Consultar dispositivos de microfone disponíveis.

querySpeakers()

Consulte os dispositivos de alto-falante disponíveis.

raiseHand()

Levante a mão para o usuário atual

removeParticipant(CommunicationIdentifier)

Remova um participante da chamada.

removeParticipant(string)

Remova um participante da chamada.

resumeCall()

Retoma a chamada de um LocalHold estado.

returnFromBreakoutRoom()

Retorno à chamada de origem da sala de descanso

sendDtmfTone(DtmfTone)

enviar o tom dtmf para outro participante em uma chamada PSTN 1:1

setCamera(VideoDeviceInfo, VideoStreamOptions)

Defina a câmera a ser usada na chamada.

setCaptionLanguage(string)

Função para definir o idioma da legenda

setMicrophone(AudioDeviceInfo)

Defina o microfone a ser usado na chamada.

setSpeaker(AudioDeviceInfo)

Defina o alto-falante a ser usado na chamada.

setSpokenLanguage(string)

Função para definir o idioma falado

setTogetherModeSceneSize(number, number)

Recalcule as posições dos bancos para o modo juntos.

startCamera(VideoStreamOptions)

Iniciar a câmera Este método começará a renderizar um modo de exibição de câmera local quando a chamada não estiver ativa

startCaptions(StartCaptionsAdapterOptions)

Função para iniciar legendas

startNoiseSuppressionEffect()

Inicie o efeito de supressão de ruído.

startScreenShare()

Comece a compartilhar a tela durante uma chamada.

startSpotlight(string[])

Inicie o destaque para participantes locais e remotos por seus IDs de usuário. Se nenhuma matriz de IDs de usuário for passada, a ação será executada no participante local.

startTogetherMode()

Modo Iniciar Juntos.

startVideoBackgroundEffect(VideoBackgroundEffect)

Inicie o efeito de fundo do vídeo.

stopAllSpotlight()

Pare todos os holofotes

stopCamera()

Parar a câmera Este método interromperá a renderização de uma exibição de câmera local quando a chamada não estiver ativa

stopCaptions(StopCaptionsAdapterOptions)

Função para parar legendas

stopNoiseSuppressionEffect()

Pare o efeito de supressão de ruído.

stopScreenShare()

Parar de compartilhar a tela

stopSpotlight(string[])

Pare de destacar participantes locais e remotos por seus IDs de usuário. Se nenhuma matriz de IDs de usuário for passada, a ação será executada no participante local.

stopVideoBackgroundEffects()

Pare o efeito de fundo do vídeo.

submitSurvey(CallSurvey)

Enviar o resultado da pesquisa de fim de chamada

unmute()

Desativar o usuário atual durante a chamada ou habilitar o microfone localmente

updateBackgroundPickerImages(VideoBackgroundImage[])

Substitua as imagens do seletor de plano de fundo para o efeito de substituição do plano de fundo.

updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)

Atualize o efeito de plano de fundo do vídeo selecionado.

Detalhes das propriedades herdadas

sendRealTimeText

Enviar texto em tempo real

sendRealTimeText: (text: string, isFinalized: boolean) => Promise<void>

Valor da propriedade

(text: string, isFinalized: boolean) => Promise<void>

Herdado deCallAdapterCallOperations.sendRealTimeText

Detalhes do método

joinCall(boolean)

Aviso

Essa API foi preterida.

Use joinCall(options?:JoinCallOptions) instead.

Ingresse a chamada com o microfone inicialmente ativado/desativado.

function joinCall(microphoneOn?: boolean)

Parâmetros

microphoneOn

boolean

Se o microfone está habilitado inicialmente

joinCall(JoinCallOptions)

Participe da chamada com o saco de opções para definir o estado inicial do microfone/câmera ao entrar na chamada true = liga o dispositivo ao entrar na chamada false = desliga o dispositivo ao entrar na chamada 'keep'/undefined = reter o estado de pré-chamada dos dispositivos

function joinCall(options?: JoinCallOptions)

Parâmetros

options
JoinCallOptions

parâmetro para ativar / desativar / usar o microfone / câmera inicialmente.

startCall(CommunicationIdentifier[], StartCallOptions)

Inicie a chamada.

function startCall(participants: CommunicationIdentifier[], options?: StartCallOptions)

Parâmetros

participants

CommunicationIdentifier[]

Um array de <xref:%40azure%2Fcommunication-common%23CommunicationIdentifier> a ser chamado

startCall(string[], StartCallOptions)

Inicie a chamada.

function startCall(participants: string[], options?: StartCallOptions)

Parâmetros

participants

string[]

Uma matriz de IDs de participante para ingressar

Detalhes do método herdado

addParticipant(CommunicationUserIdentifier)

function addParticipant(participant: CommunicationUserIdentifier): Promise<void>

Parâmetros

Retornos

Promise<void>

Herdado deCallAdapterCallOperations.addParticipant

addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

Adicione um participante à chamada.

function addParticipant(participant: PhoneNumberIdentifier, options?: AddPhoneNumberOptions): Promise<void>

Parâmetros

participant
PhoneNumberIdentifier

Retornos

Promise<void>

Herdado deCallAdapterCallOperations.addParticipant

askDevicePermission(PermissionConstraints)

Peça permissões de dispositivos.

function askDevicePermission(constrain: PermissionConstraints): Promise<DeviceAccess>

Parâmetros

constrain
PermissionConstraints

Definir restrições para acessar dispositivos locais <xref:%40azure%2Fcommunication-calling%23PermissionConstraints>

Retornos

Promise<DeviceAccess>

Comentários

A janela de permissão do navegador será exibida se as permissões ainda não forem concedidas

Herdado deCallAdapterDeviceManagement.askDevicePermission

createStreamView(string, VideoStreamOptions)

Crie o modo de exibição html para um fluxo.

function createStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void | CreateVideoStreamViewResult>

Parâmetros

remoteUserId

string

ID do participante a ser renderizado, deixe-a indefinida para criar o modo de exibição da câmera local

options
VideoStreamOptions

Opções para controlar como os fluxos de vídeo são renderizados <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Retornos

Promise<void | CreateVideoStreamViewResult>

Comentários

Esse método é implementado para composição

herdado deCallAdapterCallOperations.createStreamView

createTogetherModeStreamView(TogetherModeStreamOptions)

Crie o modo de exibição html para um fluxo.

function createTogetherModeStreamView(options?: TogetherModeStreamOptions): Promise<void | TogetherModeStreamViewResult>

Parâmetros

options
TogetherModeStreamOptions

Opções para controlar como os fluxos de vídeo são renderizados <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Retornos

Comentários

Esse método é implementado para composição

Herdado deCallAdapterCallOperations.createTogetherModeStreamView

dispose()

Descartar a composição

function dispose()

Herdado deDisposable_2.dispose

disposeLocalVideoStreamView()

Descartar a visualização html para um fluxo de vídeo local

function disposeLocalVideoStreamView(): Promise<void>

Retornos

Promise<void>

Herdado deCallAdapterCallOperations.disposeLocalVideoStreamView

disposeRemoteVideoStreamView(string)

Descartar a visualização html para um fluxo de vídeo remoto

function disposeRemoteVideoStreamView(remoteUserId: string): Promise<void>

Parâmetros

remoteUserId

string

ID do participante a ser descartado

Retornos

Promise<void>

Herdado deCallAdapterCallOperations.disposeRemoteVideoStreamView

disposeScreenShareStreamView(string)

Descartar a visualização html para um fluxo de compartilhamento de tela

function disposeScreenShareStreamView(remoteUserId: string): Promise<void>

Parâmetros

remoteUserId

string

ID do participante para o qual descartar a exibição de fluxo de compartilhamento de tela.

Retornos

Promise<void>

Comentários

Este método é implementado para compostos

Herdado deCallAdapterCallOperations.disposeScreenShareStreamView

disposeStreamView(string, VideoStreamOptions)

Descarte o modo de exibição html para um fluxo.

function disposeStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void>

Parâmetros

remoteUserId

string

Id do participante a ser renderizado, deixe-o indefinido para descartar a exibição da câmera local

options
VideoStreamOptions

Opções para controlar como os fluxos de vídeo são renderizados <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Retornos

Promise<void>

Comentários

Esse método é implementado para composição

Herdado deCallAdapterCallOperations.disposeStreamView

disposeTogetherModeStreamView()

Descarte o modo de exibição html para um fluxo.

function disposeTogetherModeStreamView(): Promise<void>

Retornos

Promise<void>

Comentários

Esse método é implementado para composição

Herdado deCallAdapterCallOperations.disposeTogetherModeStreamView

forbidAudio(string[])

Proibir o áudio dos participantes da reunião do Teams por suas IDs de usuário.

function forbidAudio(userIds: string[]): Promise<void>

Parâmetros

userIds

string[]

Retornos

Promise<void>

Herdado deCallAdapterCallOperations.forbidAudio

forbidOthersAudio()

Proibir o áudio da reunião do Teams.

function forbidOthersAudio(): Promise<void>

Retornos

Promise<void>

Herdado deCallAdapterCallOperations.forbidOthersAudio

forbidOthersVideo()

Proibir vídeo de reunião do Teams.

function forbidOthersVideo(): Promise<void>

Retornos

Promise<void>

Herdado deCallAdapterCallOperations.forbidOthersVideo

forbidVideo(string[])

Proibir o vídeo dos participantes da reunião do Teams por suas IDs de usuário.

function forbidVideo(userIds: string[]): Promise<void>

Parâmetros

userIds

string[]

Retornos

Promise<void>

Herdado deCallAdapterCallOperations.forbidVideo

getState()

Obter o estado atual

function getState(): CallAdapterState

Retornos

Herdado deAdapterState.getState

holdCall()

Segura a chamada.

function holdCall(): Promise<void>

Retornos

Promise<void>

Herdado deCallAdapterCallOperations.holdCall

leaveCall(boolean)

Deixe a chamada

function leaveCall(forEveryone?: boolean): Promise<void>

Parâmetros

forEveryone

boolean

Se todos os participantes devem ser removidos

Retornos

Promise<void>

herdado deCallAdapterCallOperations.leaveCall

lowerHand()

mão inferior para o usuário atual

function lowerHand(): Promise<void>

Retornos

Promise<void>

Herdado deCallAdapterCallOperations.lowerHand

mute()

Ativar mudo do usuário atual durante a chamada ou desabilitar o microfone localmente

function mute(): Promise<void>

Retornos

Promise<void>

Herdado deCallAdapterCallOperations.mute

muteAllRemoteParticipants()

Silenciar todos os participantes

function muteAllRemoteParticipants(): Promise<void>

Retornos

Promise<void>

Herdado deCallAdapterCallOperations.muteAllRemoteParticipants

muteParticipant(string)

Silenciar um participante

function muteParticipant(userId: string): Promise<void>

Parâmetros

userId

string

ID do participante para silenciar

Retornos

Promise<void>

Herdado deCallAdapterCallOperations.muteParticipant

off("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)

Função de cancelamento de assinatura para o evento 'breakoutRoomsUpdated'.

function off(event: "breakoutRoomsUpdated", listener: BreakoutRoomsUpdatedListener)

Parâmetros

event

"breakoutRoomsUpdated"

Herdado deCallAdapterSubscribers.off

off("callEnded", CallEndedListener)

Função Cancelar assinatura do evento 'callEnded'.

function off(event: "callEnded", listener: CallEndedListener)

Parâmetros

event

"callEnded"

Herdado deCallAdapterSubscribers.off

off("callIdChanged", CallIdChangedListener)

Cancelar a assinatura da função para o evento 'callIdChanged'.

function off(event: "callIdChanged", listener: CallIdChangedListener)

Parâmetros

event

"callIdChanged"

Herdado deCallAdapterSubscribers.off

off("capabilitiesChanged", CapabilitiesChangedListener)

Função de cancelamento de assinatura para o evento 'capabilitiesChanged'.

function off(event: "capabilitiesChanged", listener: CapabilitiesChangedListener)

Parâmetros

event

"capabilitiesChanged"

Herdado deCallAdapterSubscribers.off

off("captionsReceived", CaptionsReceivedListener)

Função de cancelamento de assinatura para o evento 'captionsReceived'.

function off(event: "captionsReceived", listener: CaptionsReceivedListener)

Parâmetros

event

"captionsReceived"

Herdado deCallAdapterSubscribers.off

off("diagnosticChanged", DiagnosticChangedEventListner)

Cancelar a assinatura da função para o evento 'diagnosticChanged'.

function off(event: "diagnosticChanged", listener: DiagnosticChangedEventListner)

Parâmetros

event

"diagnosticChanged"

Herdado deCallAdapterSubscribers.off

off("displayNameChanged", DisplayNameChangedListener)

Desinscreva a função para o evento 'displayNameChanged'.

function off(event: "displayNameChanged", listener: DisplayNameChangedListener)

Parâmetros

event

"displayNameChanged"

Herdado deCallAdapterSubscribers.off

off("error", (e: AdapterError) => void)

Cancelar a função de assinatura do evento 'error'.

function off(event: "error", listener: (e: AdapterError) => void)

Parâmetros

event

"error"

listener

(e: AdapterError) => void

Herdado deCallAdapterSubscribers.off

off("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)

Função de cancelamento de assinatura para o evento 'isCaptionLanguageChanged'.

function off(event: "isCaptionLanguageChanged", listener: IsCaptionLanguageChangedListener)

Parâmetros

event

"isCaptionLanguageChanged"

Herdado deCallAdapterSubscribers.off

off("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)

Função de cancelamento de assinatura para o evento 'isCaptionsActiveChanged'.

function off(event: "isCaptionsActiveChanged", listener: IsCaptionsActiveChangedListener)

Parâmetros

event

"isCaptionsActiveChanged"

Herdado deCallAdapterSubscribers.off

off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

Função Cancelar assinatura do evento 'isLocalScreenSharingActiveChanged'.

function off(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)

Parâmetros

event

"isLocalScreenSharingActiveChanged"

Herdado deCallAdapterSubscribers.off

off("isMutedChanged", IsMutedChangedListener)

Função Cancelar assinatura do evento 'isMutedChanged'.

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

Parâmetros

event

"isMutedChanged"

Herdado deCallAdapterSubscribers.off

off("isSpeakingChanged", IsSpeakingChangedListener)

Função Cancelar assinatura do evento 'isSpeakingChanged'.

function off(event: "isSpeakingChanged", listener: IsSpeakingChangedListener)

Parâmetros

event

"isSpeakingChanged"

Herdado deCallAdapterSubscribers.off

off("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)

Função de cancelamento de assinatura para o evento 'isSpokenLanguageChanged'.

function off(event: "isSpokenLanguageChanged", listener: IsSpokenLanguageChangedListener)

Parâmetros

event

"isSpokenLanguageChanged"

Herdado deCallAdapterSubscribers.off

off("mutedByOthers", PropertyChangedEvent)

Função de cancelamento de assinatura para o evento 'mutedByOthers'.

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

Parâmetros

event

"mutedByOthers"

Herdado deCallAdapterSubscribers.off

off("participantsJoined", ParticipantsJoinedListener)

Função Cancelar assinatura do evento 'participantsJoined'.

function off(event: "participantsJoined", listener: ParticipantsJoinedListener)

Parâmetros

event

"participantsJoined"

Herdado deCallAdapterSubscribers.off

off("participantsLeft", ParticipantsLeftListener)

Função Cancelar assinatura do evento 'participantsLeft'.

function off(event: "participantsLeft", listener: ParticipantsLeftListener)

Parâmetros

event

"participantsLeft"

Herdado deCallAdapterSubscribers.off

off("realTimeTextReceived", RealTimeTextReceivedListener)

Função de cancelamento de assinatura para o evento 'realTimeTextReceived'.

function off(event: "realTimeTextReceived", listener: RealTimeTextReceivedListener)

Parâmetros

event

"realTimeTextReceived"

Herdado deCallAdapterSubscribers.off

off("roleChanged", PropertyChangedEvent)

Função de cancelamento de assinatura para o evento 'roleChanged'.

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

Parâmetros

event

"roleChanged"

Herdado deCallAdapterSubscribers.off

off("selectedMicrophoneChanged", PropertyChangedEvent)

Função Cancelar assinatura do evento 'selectedMicrophoneChanged'.

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

Parâmetros

event

"selectedMicrophoneChanged"

Herdado deCallAdapterSubscribers.off

off("selectedSpeakerChanged", PropertyChangedEvent)

Desinscreva a função para o evento 'selectedSpeakerChanged'.

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

Parâmetros

event

"selectedSpeakerChanged"

Herdado deCallAdapterSubscribers.off

off("spotlightChanged", SpotlightChangedListener)

Função de cancelamento de assinatura para o evento 'spotlightChanged'.

function off(event: "spotlightChanged", listener: SpotlightChangedListener)

Parâmetros

event

"spotlightChanged"

Herdado deCallAdapterSubscribers.off

off("transferAccepted", TransferAcceptedListener)

Função de cancelamento de assinatura para o evento 'transferRequested'.

function off(event: "transferAccepted", listener: TransferAcceptedListener)

Parâmetros

event

"transferAccepted"

Herdado deCallAdapterSubscribers.off

offStateChange((state: CallAdapterState) => void)

Cancela a assinatura do manipulador para eventos stateChanged.

function offStateChange(handler: (state: CallAdapterState) => void)

Parâmetros

handler

(state: CallAdapterState) => void

Herdado deAdapterState.offStateChange

on("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)

Função de inscrição para o evento 'breakoutRoomsUpdated'.

function on(event: "breakoutRoomsUpdated", listener: BreakoutRoomsUpdatedListener)

Parâmetros

event

"breakoutRoomsUpdated"

Herdado deCallAdapterSubscribers.on

on("callEnded", CallEndedListener)

Função de assinatura do evento 'callEnded'.

function on(event: "callEnded", listener: CallEndedListener)

Parâmetros

event

"callEnded"

Herdado deCallAdapterSubscribers.on

on("callIdChanged", CallIdChangedListener)

Função Subscribe para o evento 'callIdChanged'.

function on(event: "callIdChanged", listener: CallIdChangedListener)

Parâmetros

event

"callIdChanged"

Comentários

O evento será disparado quando callId do usuário atual for alterado.

Herdado deCallAdapterSubscribers.on

on("capabilitiesChanged", CapabilitiesChangedListener)

Subscribe para o evento 'capabilitiesChanged'.

function on(event: "capabilitiesChanged", listener: CapabilitiesChangedListener)

Parâmetros

event

"capabilitiesChanged"

Herdado deCallAdapterSubscribers.on

on("captionsReceived", CaptionsReceivedListener)

Função de assinatura para o evento 'captionsReceived'.

function on(event: "captionsReceived", listener: CaptionsReceivedListener)

Parâmetros

event

"captionsReceived"

Herdado deCallAdapterSubscribers.on

on("diagnosticChanged", DiagnosticChangedEventListner)

Função de assinatura do evento 'diagnosticChanged'.

Esse evento é acionado sempre que há uma alteração no diagnóstico voltado para o usuário sobre a chamada em andamento.

function on(event: "diagnosticChanged", listener: DiagnosticChangedEventListner)

Parâmetros

event

"diagnosticChanged"

Herdado deCallAdapterSubscribers.on

on("displayNameChanged", DisplayNameChangedListener)

Função Subscribe para o evento 'displayNameChanged'.

function on(event: "displayNameChanged", listener: DisplayNameChangedListener)

Parâmetros

event

"displayNameChanged"

Herdado deCallAdapterSubscribers.on

on("error", (e: AdapterError) => void)

Assinar a função para o evento 'error'.

function on(event: "error", listener: (e: AdapterError) => void)

Parâmetros

event

"error"

listener

(e: AdapterError) => void

Herdado deCallAdapterSubscribers.on

on("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)

Função de assinatura para o evento 'isCaptionLanguageChanged'.

function on(event: "isCaptionLanguageChanged", listener: IsCaptionLanguageChangedListener)

Parâmetros

event

"isCaptionLanguageChanged"

Herdado deCallAdapterSubscribers.on

on("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)

Função de assinatura para o evento 'isCaptionsActiveChanged'.

function on(event: "isCaptionsActiveChanged", listener: IsCaptionsActiveChangedListener)

Parâmetros

event

"isCaptionsActiveChanged"

Herdado deCallAdapterSubscribers.on

on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

Assinar a função para o evento 'isLocalScreenSharingActiveChanged'.

function on(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)

Parâmetros

event

"isLocalScreenSharingActiveChanged"

Herdado deCallAdapterSubscribers.on

on("isMutedChanged", IsMutedChangedListener)

Função Subscribe para o evento 'isMutedChanged'.

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

Parâmetros

event

"isMutedChanged"

Comentários

O evento será disparado sempre que o usuário atual ou o estado de mudo do usuário remoto forem alterados

Herdado deCallAdapterSubscribers.on

on("isSpeakingChanged", IsSpeakingChangedListener)

Função Subscribe para o evento 'isSpeakingChanged'.

function on(event: "isSpeakingChanged", listener: IsSpeakingChangedListener)

Parâmetros

event

"isSpeakingChanged"

Herdado deCallAdapterSubscribers.on

on("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)

Subscribe para o evento 'isSpokenLanguageChanged'.

function on(event: "isSpokenLanguageChanged", listener: IsSpokenLanguageChangedListener)

Parâmetros

event

"isSpokenLanguageChanged"

Herdado deCallAdapterSubscribers.on

on("mutedByOthers", PropertyChangedEvent)

Função de assinatura para o evento 'mutedByOthers'.

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

Parâmetros

event

"mutedByOthers"

Herdado deCallAdapterSubscribers.on

on("participantsJoined", ParticipantsJoinedListener)

Assinar a função para o evento 'participantsJoined'.

function on(event: "participantsJoined", listener: ParticipantsJoinedListener)

Parâmetros

event

"participantsJoined"

Herdado deCallAdapterSubscribers.on

on("participantsLeft", ParticipantsLeftListener)

Função Subscribe para o evento 'participantsLeft'.

function on(event: "participantsLeft", listener: ParticipantsLeftListener)

Parâmetros

event

"participantsLeft"

Herdado deCallAdapterSubscribers.on

on("realTimeTextReceived", RealTimeTextReceivedListener)

Função de assinatura para o evento 'realTimeTextReceived'.

function on(event: "realTimeTextReceived", listener: RealTimeTextReceivedListener)

Parâmetros

event

"realTimeTextReceived"

Herdado deCallAdapterSubscribers.on

on("roleChanged", PropertyChangedEvent)

Subscribe para o evento 'roleChanged'.

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

Parâmetros

event

"roleChanged"

Herdado deCallAdapterSubscribers.on

on("selectedMicrophoneChanged", PropertyChangedEvent)

Assinar a função para o evento 'selectedMicrophoneChanged'.

Esse evento é acionado sempre que o usuário seleciona um novo dispositivo de microfone.

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

Parâmetros

event

"selectedMicrophoneChanged"

Herdado deCallAdapterSubscribers.on

on("selectedSpeakerChanged", PropertyChangedEvent)

Assinar a função para o evento 'selectedSpeakerChanged'.

Esse evento é acionado sempre que o usuário seleciona um novo dispositivo de alto-falante.

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

Parâmetros

event

"selectedSpeakerChanged"

Herdado deCallAdapterSubscribers.on

on("spotlightChanged", SpotlightChangedListener)

Função de inscrição para o evento 'spotlightChanged'.

function on(event: "spotlightChanged", listener: SpotlightChangedListener)

Parâmetros

event

"spotlightChanged"

Herdado deCallAdapterSubscribers.on

on("transferAccepted", TransferAcceptedListener)

Função de assinatura para o evento 'transferRequested'.

function on(event: "transferAccepted", listener: TransferAcceptedListener)

Parâmetros

event

"transferAccepted"

Herdado deCallAdapterSubscribers.on

onReactionClick(Reaction)

Enviar emoji de reação

function onReactionClick(reaction: Reaction): Promise<void>

Parâmetros

reaction
Reaction

Retornos

Promise<void>

Herdado deCallAdapterCallOperations.onReactionClick

onStateChange((state: CallAdapterState) => void)

Assina o manipulador para eventos stateChanged.

function onStateChange(handler: (state: CallAdapterState) => void)

Parâmetros

handler

(state: CallAdapterState) => void

Herdado deAdapterState.onStateChange

permitAudio(string[])

Permitir áudio dos participantes da reunião do Teams por suas IDs de usuário.

function permitAudio(userIds: string[]): Promise<void>

Parâmetros

userIds

string[]

Retornos

Promise<void>

Herdado deCallAdapterCallOperations.permitAudio

permitOthersAudio()

Permitir áudio de reunião do Teams.

function permitOthersAudio(): Promise<void>

Retornos

Promise<void>

Herdado deCallAdapterCallOperations.permitOthersAudio

permitOthersVideo()

Permitir vídeo de reunião do Teams.

function permitOthersVideo(): Promise<void>

Retornos

Promise<void>

Herdado deCallAdapterCallOperations.permitOthersVideo

permitVideo(string[])

Permitir áudio dos participantes da reunião do Teams por suas IDs de usuário.

function permitVideo(userIds: string[]): Promise<void>

Parâmetros

userIds

string[]

Retornos

Promise<void>

Herdado deCallAdapterCallOperations.permitVideo

queryCameras()

Consultar dispositivos de câmera disponíveis.

function queryCameras(): Promise<VideoDeviceInfo[]>

Retornos

Promise<VideoDeviceInfo[]>

Uma matriz de entidades de informações do dispositivo de vídeo <xref:%40azure%2Fcommunication-calling%23VideoDeviceInfo>

Comentários

Esse método deve ser chamado após askDevicePermission()

Herdado deCallAdapterDeviceManagement.queryCameras

queryMicrophones()

Consultar dispositivos de microfone disponíveis.

function queryMicrophones(): Promise<AudioDeviceInfo[]>

Retornos

Promise<AudioDeviceInfo[]>

Uma matriz de entidades de informações do dispositivo de áudio <xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo>

Comentários

Esse método deve ser chamado após askDevicePermission()

Herdado deCallAdapterDeviceManagement.queryMicrophones

querySpeakers()

Consulte os dispositivos de alto-falante disponíveis.

function querySpeakers(): Promise<AudioDeviceInfo[]>

Retornos

Promise<AudioDeviceInfo[]>

Uma matriz de entidades de informações do dispositivo de áudio <xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo>

Comentários

Esse método deve ser chamado após askDevicePermission()

Herdado deCallAdapterDeviceManagement.querySpeakers

raiseHand()

Levante a mão para o usuário atual

function raiseHand(): Promise<void>

Retornos

Promise<void>

Herdado deCallAdapterCallOperations.raiseHand

removeParticipant(CommunicationIdentifier)

Remova um participante da chamada.

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

Parâmetros

participant
CommunicationIdentifier

<xref:%40azure%2Fcommunication-common%23CommunicationIdentifier> do participante a ser removido

Retornos

Promise<void>

Herdado deCallAdapterCallOperations.removeParticipant

removeParticipant(string)

Remova um participante da chamada.

function removeParticipant(userId: string): Promise<void>

Parâmetros

userId

string

ID do participante a ser removido

Retornos

Promise<void>

Herdado deCallAdapterCallOperations.removeParticipant

resumeCall()

Retoma a chamada de um LocalHold estado.

function resumeCall(): Promise<void>

Retornos

Promise<void>

Herdado deCallAdapterCallOperations.resumeCall

returnFromBreakoutRoom()

Retorno à chamada de origem da sala de descanso

function returnFromBreakoutRoom(): Promise<void>

Retornos

Promise<void>

Herdado deCallAdapterCallOperations.returnFromBreakoutRoom

sendDtmfTone(DtmfTone)

enviar o tom dtmf para outro participante em uma chamada PSTN 1:1

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

Parâmetros

dtmfTone
DtmfTone

Retornos

Promise<void>

Herdado deCallAdapterCallOperations.sendDtmfTone

setCamera(VideoDeviceInfo, VideoStreamOptions)

Defina a câmera a ser usada na chamada.

function setCamera(sourceInfo: VideoDeviceInfo, options?: VideoStreamOptions): Promise<void>

Parâmetros

sourceInfo
VideoDeviceInfo

Dispositivo de câmera para escolher, escolha um retornado por queryCameras

options
VideoStreamOptions

Opções para controlar como o fluxo de câmera é renderizado <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Retornos

Promise<void>

Herdado deCallAdapterDeviceManagement.setCamera

setCaptionLanguage(string)

Função para definir o idioma da legenda

function setCaptionLanguage(language: string): Promise<void>

Parâmetros

language

string

Idioma definido para legenda

Retornos

Promise<void>

Herdado deCallAdapterCallOperations.setCaptionLanguage

setMicrophone(AudioDeviceInfo)

Defina o microfone a ser usado na chamada.

function setMicrophone(sourceInfo: AudioDeviceInfo): Promise<void>

Parâmetros

sourceInfo
AudioDeviceInfo

Dispositivo de microfone para escolher, escolha um retornado por queryMicrophones

Retornos

Promise<void>

Herdado deCallAdapterDeviceManagement.setMicrophone

setSpeaker(AudioDeviceInfo)

Defina o alto-falante a ser usado na chamada.

function setSpeaker(sourceInfo: AudioDeviceInfo): Promise<void>

Parâmetros

sourceInfo
AudioDeviceInfo

Dispositivo de alto-falante para escolher, escolha um retornado por querySpeakers

Retornos

Promise<void>

Herdado deCallAdapterDeviceManagement.setSpeaker

setSpokenLanguage(string)

Função para definir o idioma falado

function setSpokenLanguage(language: string): Promise<void>

Parâmetros

language

string

Linguagem falada

Retornos

Promise<void>

Herdado deCallAdapterCallOperations.setSpokenLanguage

setTogetherModeSceneSize(number, number)

Recalcule as posições dos bancos para o modo juntos.

function setTogetherModeSceneSize(width: number, height: number)

Parâmetros

width

number

Largura do contêiner

height

number

Altura do recipiente

Comentários

Esse método é implementado para composição

Herdado deCallAdapterCallOperations.setTogetherModeSceneSize

startCamera(VideoStreamOptions)

Iniciar a câmera Este método começará a renderizar um modo de exibição de câmera local quando a chamada não estiver ativa

function startCamera(options?: VideoStreamOptions): Promise<void>

Parâmetros

options
VideoStreamOptions

Opções para controlar como os fluxos de vídeo são renderizados <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Retornos

Promise<void>

Herdado deCallAdapterCallOperations.startCamera

startCaptions(StartCaptionsAdapterOptions)

Função para iniciar legendas

function startCaptions(options?: StartCaptionsAdapterOptions): Promise<void>

Parâmetros

options
StartCaptionsAdapterOptions

Opções para legendas iniciais

Retornos

Promise<void>

Herdado deCallAdapterCallOperations.startCaptions

startNoiseSuppressionEffect()

Inicie o efeito de supressão de ruído.

function startNoiseSuppressionEffect(): Promise<void>

Retornos

Promise<void>

Herdado deCallAdapterCallOperations.startNoiseSuppressionEffect

startScreenShare()

Comece a compartilhar a tela durante uma chamada.

function startScreenShare(): Promise<void>

Retornos

Promise<void>

Herdado deCallAdapterCallOperations.startScreenShare

startSpotlight(string[])

Inicie o destaque para participantes locais e remotos por seus IDs de usuário. Se nenhuma matriz de IDs de usuário for passada, a ação será executada no participante local.

function startSpotlight(userIds?: string[]): Promise<void>

Parâmetros

userIds

string[]

Retornos

Promise<void>

Herdado deCallAdapterCallOperations.startSpotlight

startTogetherMode()

Modo Iniciar Juntos.

function startTogetherMode(): Promise<void>

Retornos

Promise<void>

Herdado deCallAdapterCallOperations.startTogetherMode

startVideoBackgroundEffect(VideoBackgroundEffect)

Inicie o efeito de fundo do vídeo.

function startVideoBackgroundEffect(videoBackgroundEffect: VideoBackgroundEffect): Promise<void>

Parâmetros

videoBackgroundEffect
VideoBackgroundEffect

Retornos

Promise<void>

Herdado deCallAdapterCallOperations.startVideoBackgroundEffect

stopAllSpotlight()

Pare todos os holofotes

function stopAllSpotlight(): Promise<void>

Retornos

Promise<void>

Herdado deCallAdapterCallOperations.stopAllSpotlight

stopCamera()

Parar a câmera Este método interromperá a renderização de uma exibição de câmera local quando a chamada não estiver ativa

function stopCamera(): Promise<void>

Retornos

Promise<void>

Herdado deCallAdapterCallOperations.stopCamera

stopCaptions(StopCaptionsAdapterOptions)

Função para parar legendas

function stopCaptions(options?: StopCaptionsAdapterOptions): Promise<void>

Parâmetros

Retornos

Promise<void>

Herdado deCallAdapterCallOperations.stopCaptions

stopNoiseSuppressionEffect()

Pare o efeito de supressão de ruído.

function stopNoiseSuppressionEffect(): Promise<void>

Retornos

Promise<void>

Herdado deCallAdapterCallOperations.stopNoiseSuppressionEffect

stopScreenShare()

Parar de compartilhar a tela

function stopScreenShare(): Promise<void>

Retornos

Promise<void>

herdado deCallAdapterCallOperations.stopScreenShare

stopSpotlight(string[])

Pare de destacar participantes locais e remotos por seus IDs de usuário. Se nenhuma matriz de IDs de usuário for passada, a ação será executada no participante local.

function stopSpotlight(userIds?: string[]): Promise<void>

Parâmetros

userIds

string[]

Retornos

Promise<void>

Herdado deCallAdapterCallOperations.stopSpotlight

stopVideoBackgroundEffects()

Pare o efeito de fundo do vídeo.

function stopVideoBackgroundEffects(): Promise<void>

Retornos

Promise<void>

Herdado deCallAdapterCallOperations.stopVideoBackgroundEffects

submitSurvey(CallSurvey)

Enviar o resultado da pesquisa de fim de chamada

function submitSurvey(survey: CallSurvey): Promise<undefined | CallSurveyResponse>

Parâmetros

survey
CallSurvey

Retornos

Promise<undefined | CallSurveyResponse>

Herdado deCallAdapterCallOperations.submitSurvey

unmute()

Desativar o usuário atual durante a chamada ou habilitar o microfone localmente

function unmute(): Promise<void>

Retornos

Promise<void>

Herdado deCallAdapterCallOperations.unmute

updateBackgroundPickerImages(VideoBackgroundImage[])

Substitua as imagens do seletor de plano de fundo para o efeito de substituição do plano de fundo.

function updateBackgroundPickerImages(backgroundImages: VideoBackgroundImage[])

Parâmetros

backgroundImages

VideoBackgroundImage[]

Matriz de imagens de fundo personalizadas.

Herdado deCallAdapterCallOperations.updateBackgroundPickerImages

updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)

Atualize o efeito de plano de fundo do vídeo selecionado.

function updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect)

Parâmetros

selectedVideoBackground
VideoBackgroundEffect

Herdado deCallAdapterCallOperations.updateSelectedVideoBackgroundEffect