CallAdapter interface
- Extends
Propriedades herdadas
| send |
Enviar texto em tempo real |
Métodos
| join |
Ingresse a chamada com o microfone inicialmente ativado/desativado. |
| join |
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 |
| start |
Inicie a chamada. |
| start |
Inicie a chamada. |
Métodos herdados
| add |
|
| add |
Adicione um participante à chamada. |
| ask |
Peça permissões de dispositivos. |
| create |
Crie o modo de exibição html para um fluxo. |
| create |
Crie o modo de exibição html para um fluxo. |
| dispose() | Descartar a composição |
| dispose |
Descartar a visualização html para um fluxo de vídeo local |
| dispose |
Descartar a visualização html para um fluxo de vídeo remoto |
| dispose |
Descartar a visualização html para um fluxo de compartilhamento de tela |
| dispose |
Descarte o modo de exibição html para um fluxo. |
| dispose |
Descarte o modo de exibição html para um fluxo. |
| forbid |
Proibir o áudio dos participantes da reunião do Teams por suas IDs de usuário. |
| forbid |
Proibir o áudio da reunião do Teams. |
| forbid |
Proibir vídeo de reunião do Teams. |
| forbid |
Proibir o vídeo dos participantes da reunião do Teams por suas IDs de usuário. |
| get |
Obter o estado atual |
| hold |
Segura a chamada. |
| leave |
Deixe a chamada |
| lower |
mão inferior para o usuário atual |
| mute() | Ativar mudo do usuário atual durante a chamada ou desabilitar o microfone localmente |
| mute |
Silenciar todos os participantes |
| mute |
Silenciar um participante |
| off("breakout |
Função de cancelamento de assinatura para o evento 'breakoutRoomsUpdated'. |
| off("call |
Função Cancelar assinatura do evento 'callEnded'. |
| off("call |
Cancelar a assinatura da função para o evento 'callIdChanged'. |
| off("capabilities |
Função de cancelamento de assinatura para o evento 'capabilitiesChanged'. |
| off("captions |
Função de cancelamento de assinatura para o evento 'captionsReceived'. |
| off("diagnostic |
Cancelar a assinatura da função para o evento 'diagnosticChanged'. |
| off("display |
Desinscreva a função para o evento 'displayNameChanged'. |
| off("error", (e: Adapter |
Cancelar a função de assinatura do evento 'error'. |
| off("is |
Função de cancelamento de assinatura para o evento 'isCaptionLanguageChanged'. |
| off("is |
Função de cancelamento de assinatura para o evento 'isCaptionsActiveChanged'. |
| off("is |
Função Cancelar assinatura do evento 'isLocalScreenSharingActiveChanged'. |
| off("is |
Função Cancelar assinatura do evento 'isMutedChanged'. |
| off("is |
Função Cancelar assinatura do evento 'isSpeakingChanged'. |
| off("is |
Função de cancelamento de assinatura para o evento 'isSpokenLanguageChanged'. |
| off("muted |
Função de cancelamento de assinatura para o evento 'mutedByOthers'. |
| off("participants |
Função Cancelar assinatura do evento 'participantsJoined'. |
| off("participants |
Função Cancelar assinatura do evento 'participantsLeft'. |
| off("real |
Função de cancelamento de assinatura para o evento 'realTimeTextReceived'. |
| off("role |
Função de cancelamento de assinatura para o evento 'roleChanged'. |
| off("selected |
Função Cancelar assinatura do evento 'selectedMicrophoneChanged'. |
| off("selected |
Desinscreva a função para o evento 'selectedSpeakerChanged'. |
| off("spotlight |
Função de cancelamento de assinatura para o evento 'spotlightChanged'. |
| off("transfer |
Função de cancelamento de assinatura para o evento 'transferRequested'. |
| off |
Cancela a assinatura do manipulador para eventos stateChanged. |
| on("breakout |
Função de inscrição para o evento 'breakoutRoomsUpdated'. |
| on("call |
Função de assinatura do evento 'callEnded'. |
| on("call |
Função Subscribe para o evento 'callIdChanged'. |
| on("capabilities |
Subscribe para o evento 'capabilitiesChanged'. |
| on("captions |
Função de assinatura para o evento 'captionsReceived'. |
| on("diagnostic |
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("display |
Função Subscribe para o evento 'displayNameChanged'. |
| on("error", (e: Adapter |
Assinar a função para o evento 'error'. |
| on("is |
Função de assinatura para o evento 'isCaptionLanguageChanged'. |
| on("is |
Função de assinatura para o evento 'isCaptionsActiveChanged'. |
| on("is |
Assinar a função para o evento 'isLocalScreenSharingActiveChanged'. |
| on("is |
Função Subscribe para o evento 'isMutedChanged'. |
| on("is |
Função Subscribe para o evento 'isSpeakingChanged'. |
| on("is |
Subscribe para o evento 'isSpokenLanguageChanged'. |
| on("muted |
Função de assinatura para o evento 'mutedByOthers'. |
| on("participants |
Assinar a função para o evento 'participantsJoined'. |
| on("participants |
Função Subscribe para o evento 'participantsLeft'. |
| on("real |
Função de assinatura para o evento 'realTimeTextReceived'. |
| on("role |
Subscribe para o evento 'roleChanged'. |
| on("selected |
Assinar a função para o evento 'selectedMicrophoneChanged'. Esse evento é acionado sempre que o usuário seleciona um novo dispositivo de microfone. |
| on("selected |
Assinar a função para o evento 'selectedSpeakerChanged'. Esse evento é acionado sempre que o usuário seleciona um novo dispositivo de alto-falante. |
| on("spotlight |
Função de inscrição para o evento 'spotlightChanged'. |
| on("transfer |
Função de assinatura para o evento 'transferRequested'. |
| on |
Enviar emoji de reação |
| on |
Assina o manipulador para eventos stateChanged. |
| permit |
Permitir áudio dos participantes da reunião do Teams por suas IDs de usuário. |
| permit |
Permitir áudio de reunião do Teams. |
| permit |
Permitir vídeo de reunião do Teams. |
| permit |
Permitir áudio dos participantes da reunião do Teams por suas IDs de usuário. |
| query |
Consultar dispositivos de câmera disponíveis. |
| query |
Consultar dispositivos de microfone disponíveis. |
| query |
Consulte os dispositivos de alto-falante disponíveis. |
| raise |
Levante a mão para o usuário atual |
| remove |
Remova um participante da chamada. |
| remove |
Remova um participante da chamada. |
| resume |
Retoma a chamada de um |
| return |
Retorno à chamada de origem da sala de descanso |
| send |
enviar o tom dtmf para outro participante em uma chamada PSTN 1:1 |
| set |
Defina a câmera a ser usada na chamada. |
| set |
Função para definir o idioma da legenda |
| set |
Defina o microfone a ser usado na chamada. |
| set |
Defina o alto-falante a ser usado na chamada. |
| set |
Função para definir o idioma falado |
| set |
Recalcule as posições dos bancos para o modo juntos. |
| start |
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 |
| start |
Função para iniciar legendas |
| start |
Inicie o efeito de supressão de ruído. |
| start |
Comece a compartilhar a tela durante uma chamada. |
| start |
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. |
| start |
Modo Iniciar Juntos. |
| start |
Inicie o efeito de fundo do vídeo. |
| stop |
Pare todos os holofotes |
| stop |
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 |
| stop |
Função para parar legendas |
| stop |
Pare o efeito de supressão de ruído. |
| stop |
Parar de compartilhar a tela |
| stop |
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. |
| stop |
Pare o efeito de fundo do vídeo. |
| submit |
Enviar o resultado da pesquisa de fim de chamada |
| unmute() | Desativar o usuário atual durante a chamada ou habilitar o microfone localmente |
| update |
Substitua as imagens do seletor de plano de fundo para o efeito de substituição do plano de fundo. |
| update |
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 deCommonCallAdapter.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): undefined | Call
Parâmetros
- microphoneOn
-
boolean
Se o microfone está habilitado inicialmente
Retornos
undefined | Call
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): undefined | Call
Parâmetros
- options
- JoinCallOptions
parâmetro para ativar / desativar / usar o microfone / câmera inicialmente.
Retornos
undefined | Call
startCall(CommunicationIdentifier[], StartCallOptions)
Inicie a chamada.
function startCall(participants: CommunicationIdentifier[], options?: StartCallOptions): undefined | Call
Parâmetros
- participants
Um array de <xref:%40azure%2Fcommunication-common%23CommunicationIdentifier> a ser chamado
- options
- StartCallOptions
Retornos
undefined | Call
startCall(string[], StartCallOptions)
Inicie a chamada.
function startCall(participants: string[], options?: StartCallOptions): undefined | Call
Parâmetros
- participants
-
string[]
Uma matriz de IDs de participante para ingressar
- options
- StartCallOptions
Retornos
undefined | Call
Detalhes do método herdado
addParticipant(CommunicationUserIdentifier)
function addParticipant(participant: CommunicationUserIdentifier): Promise<void>
Parâmetros
- participant
- CommunicationUserIdentifier
Retornos
Promise<void>
Herdado deCommonCallAdapter.addParticipant
addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)
Adicione um participante à chamada.
function addParticipant(participant: PhoneNumberIdentifier, options?: AddPhoneNumberOptions): Promise<void>
Parâmetros
- participant
- PhoneNumberIdentifier
- options
- AddPhoneNumberOptions
Retornos
Promise<void>
Herdado deCommonCallAdapter.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 deCommonCallAdapter.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 deCommonCallAdapter.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
Promise<void | TogetherModeStreamViewResult>
Comentários
Esse método é implementado para composição
dispose()
disposeLocalVideoStreamView()
Descartar a visualização html para um fluxo de vídeo local
function disposeLocalVideoStreamView(): Promise<void>
Retornos
Promise<void>
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>
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
disposeStreamView(string, VideoStreamOptions)
Aviso
Essa API foi preterida.
Use disposeRemoteVideoStreamView, disposeLocalVideoStreamView and disposeRemoteVideoStreamView instead.
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 deCommonCallAdapter.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
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 deCommonCallAdapter.forbidAudio
forbidOthersAudio()
Proibir o áudio da reunião do Teams.
function forbidOthersAudio(): Promise<void>
Retornos
Promise<void>
Herdado deCommonCallAdapter.forbidOthersAudio
forbidOthersVideo()
Proibir vídeo de reunião do Teams.
function forbidOthersVideo(): Promise<void>
Retornos
Promise<void>
Herdado deCommonCallAdapter.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 deCommonCallAdapter.forbidVideo
getState()
Obter o estado atual
function getState(): CallAdapterState
Retornos
Herdado deCommonCallAdapter.getState
holdCall()
Segura a chamada.
function holdCall(): Promise<void>
Retornos
Promise<void>
Herdado deCommonCallAdapter.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 deCommonCallAdapter.leaveCall
lowerHand()
mão inferior para o usuário atual
function lowerHand(): Promise<void>
Retornos
Promise<void>
Herdado deCommonCallAdapter.lowerHand
mute()
Ativar mudo do usuário atual durante a chamada ou desabilitar o microfone localmente
function mute(): Promise<void>
Retornos
Promise<void>
Herdado deCommonCallAdapter.mute
muteAllRemoteParticipants()
Silenciar todos os participantes
function muteAllRemoteParticipants(): Promise<void>
Retornos
Promise<void>
muteParticipant(string)
Silenciar um participante
function muteParticipant(userId: string): Promise<void>
Parâmetros
- userId
-
string
ID do participante para silenciar
Retornos
Promise<void>
Herdado deCommonCallAdapter.muteParticipant
off("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)
Função de cancelamento de assinatura para o evento 'breakoutRoomsUpdated'.
function off(event: "breakoutRoomsUpdated", listener: BreakoutRoomsUpdatedListener)
Parâmetros
- event
-
"breakoutRoomsUpdated"
- listener
- BreakoutRoomsUpdatedListener
herdado deCommonCallAdapter.off
off("callEnded", CallEndedListener)
Função Cancelar assinatura do evento 'callEnded'.
function off(event: "callEnded", listener: CallEndedListener)
Parâmetros
- event
-
"callEnded"
- listener
- CallEndedListener
herdado deCommonCallAdapter.off
off("callIdChanged", CallIdChangedListener)
Cancelar a assinatura da função para o evento 'callIdChanged'.
function off(event: "callIdChanged", listener: CallIdChangedListener)
Parâmetros
- event
-
"callIdChanged"
- listener
- CallIdChangedListener
herdado deCommonCallAdapter.off
off("capabilitiesChanged", CapabilitiesChangedListener)
Função de cancelamento de assinatura para o evento 'capabilitiesChanged'.
function off(event: "capabilitiesChanged", listener: CapabilitiesChangedListener)
Parâmetros
- event
-
"capabilitiesChanged"
- listener
- CapabilitiesChangedListener
herdado deCommonCallAdapter.off
off("captionsReceived", CaptionsReceivedListener)
Função de cancelamento de assinatura para o evento 'captionsReceived'.
function off(event: "captionsReceived", listener: CaptionsReceivedListener)
Parâmetros
- event
-
"captionsReceived"
- listener
- CaptionsReceivedListener
herdado deCommonCallAdapter.off
off("diagnosticChanged", DiagnosticChangedEventListner)
Cancelar a assinatura da função para o evento 'diagnosticChanged'.
function off(event: "diagnosticChanged", listener: DiagnosticChangedEventListner)
Parâmetros
- event
-
"diagnosticChanged"
- listener
- DiagnosticChangedEventListner
herdado deCommonCallAdapter.off
off("displayNameChanged", DisplayNameChangedListener)
Desinscreva a função para o evento 'displayNameChanged'.
function off(event: "displayNameChanged", listener: DisplayNameChangedListener)
Parâmetros
- event
-
"displayNameChanged"
- listener
- DisplayNameChangedListener
herdado deCommonCallAdapter.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 deCommonCallAdapter.off
off("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)
Função de cancelamento de assinatura para o evento 'isCaptionLanguageChanged'.
function off(event: "isCaptionLanguageChanged", listener: IsCaptionLanguageChangedListener)
Parâmetros
- event
-
"isCaptionLanguageChanged"
- listener
- IsCaptionLanguageChangedListener
herdado deCommonCallAdapter.off
off("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)
Função de cancelamento de assinatura para o evento 'isCaptionsActiveChanged'.
function off(event: "isCaptionsActiveChanged", listener: IsCaptionsActiveChangedListener)
Parâmetros
- event
-
"isCaptionsActiveChanged"
- listener
- IsCaptionsActiveChangedListener
herdado deCommonCallAdapter.off
off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)
Função Cancelar assinatura do evento 'isLocalScreenSharingActiveChanged'.
function off(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)
Parâmetros
- event
-
"isLocalScreenSharingActiveChanged"
herdado deCommonCallAdapter.off
off("isMutedChanged", IsMutedChangedListener)
Função Cancelar assinatura do evento 'isMutedChanged'.
function off(event: "isMutedChanged", listener: IsMutedChangedListener)
Parâmetros
- event
-
"isMutedChanged"
- listener
- IsMutedChangedListener
herdado deCommonCallAdapter.off
off("isSpeakingChanged", IsSpeakingChangedListener)
Função Cancelar assinatura do evento 'isSpeakingChanged'.
function off(event: "isSpeakingChanged", listener: IsSpeakingChangedListener)
Parâmetros
- event
-
"isSpeakingChanged"
- listener
- IsSpeakingChangedListener
herdado deCommonCallAdapter.off
off("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)
Função de cancelamento de assinatura para o evento 'isSpokenLanguageChanged'.
function off(event: "isSpokenLanguageChanged", listener: IsSpokenLanguageChangedListener)
Parâmetros
- event
-
"isSpokenLanguageChanged"
- listener
- IsSpokenLanguageChangedListener
herdado deCommonCallAdapter.off
off("mutedByOthers", PropertyChangedEvent)
Função de cancelamento de assinatura para o evento 'mutedByOthers'.
function off(event: "mutedByOthers", listener: PropertyChangedEvent)
Parâmetros
- event
-
"mutedByOthers"
- listener
- PropertyChangedEvent
herdado deCommonCallAdapter.off
off("participantsJoined", ParticipantsJoinedListener)
Função Cancelar assinatura do evento 'participantsJoined'.
function off(event: "participantsJoined", listener: ParticipantsJoinedListener)
Parâmetros
- event
-
"participantsJoined"
- listener
- ParticipantsJoinedListener
herdado deCommonCallAdapter.off
off("participantsLeft", ParticipantsLeftListener)
Função Cancelar assinatura do evento 'participantsLeft'.
function off(event: "participantsLeft", listener: ParticipantsLeftListener)
Parâmetros
- event
-
"participantsLeft"
- listener
- ParticipantsLeftListener
herdado deCommonCallAdapter.off
off("realTimeTextReceived", RealTimeTextReceivedListener)
Função de cancelamento de assinatura para o evento 'realTimeTextReceived'.
function off(event: "realTimeTextReceived", listener: RealTimeTextReceivedListener)
Parâmetros
- event
-
"realTimeTextReceived"
- listener
- RealTimeTextReceivedListener
herdado deCommonCallAdapter.off
off("roleChanged", PropertyChangedEvent)
Função de cancelamento de assinatura para o evento 'roleChanged'.
function off(event: "roleChanged", listener: PropertyChangedEvent)
Parâmetros
- event
-
"roleChanged"
- listener
- PropertyChangedEvent
herdado deCommonCallAdapter.off
off("selectedMicrophoneChanged", PropertyChangedEvent)
Função Cancelar assinatura do evento 'selectedMicrophoneChanged'.
function off(event: "selectedMicrophoneChanged", listener: PropertyChangedEvent)
Parâmetros
- event
-
"selectedMicrophoneChanged"
- listener
- PropertyChangedEvent
herdado deCommonCallAdapter.off
off("selectedSpeakerChanged", PropertyChangedEvent)
Desinscreva a função para o evento 'selectedSpeakerChanged'.
function off(event: "selectedSpeakerChanged", listener: PropertyChangedEvent)
Parâmetros
- event
-
"selectedSpeakerChanged"
- listener
- PropertyChangedEvent
herdado deCommonCallAdapter.off
off("spotlightChanged", SpotlightChangedListener)
Função de cancelamento de assinatura para o evento 'spotlightChanged'.
function off(event: "spotlightChanged", listener: SpotlightChangedListener)
Parâmetros
- event
-
"spotlightChanged"
- listener
- SpotlightChangedListener
herdado deCommonCallAdapter.off
off("transferAccepted", TransferAcceptedListener)
Função de cancelamento de assinatura para o evento 'transferRequested'.
function off(event: "transferAccepted", listener: TransferAcceptedListener)
Parâmetros
- event
-
"transferAccepted"
- listener
- TransferAcceptedListener
herdado deCommonCallAdapter.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 deCommonCallAdapter.offStateChange
on("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)
Função de inscrição para o evento 'breakoutRoomsUpdated'.
function on(event: "breakoutRoomsUpdated", listener: BreakoutRoomsUpdatedListener)
Parâmetros
- event
-
"breakoutRoomsUpdated"
- listener
- BreakoutRoomsUpdatedListener
Herdado deCommonCallAdapter.on
on("callEnded", CallEndedListener)
Função de assinatura do evento 'callEnded'.
function on(event: "callEnded", listener: CallEndedListener)
Parâmetros
- event
-
"callEnded"
- listener
- CallEndedListener
Herdado deCommonCallAdapter.on
on("callIdChanged", CallIdChangedListener)
Função Subscribe para o evento 'callIdChanged'.
function on(event: "callIdChanged", listener: CallIdChangedListener)
Parâmetros
- event
-
"callIdChanged"
- listener
- CallIdChangedListener
Comentários
O evento será disparado quando callId do usuário atual for alterado.
Herdado deCommonCallAdapter.on
on("capabilitiesChanged", CapabilitiesChangedListener)
Subscribe para o evento 'capabilitiesChanged'.
function on(event: "capabilitiesChanged", listener: CapabilitiesChangedListener)
Parâmetros
- event
-
"capabilitiesChanged"
- listener
- CapabilitiesChangedListener
Herdado deCommonCallAdapter.on
on("captionsReceived", CaptionsReceivedListener)
Função de assinatura para o evento 'captionsReceived'.
function on(event: "captionsReceived", listener: CaptionsReceivedListener)
Parâmetros
- event
-
"captionsReceived"
- listener
- CaptionsReceivedListener
Herdado deCommonCallAdapter.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"
- listener
- DiagnosticChangedEventListner
Herdado deCommonCallAdapter.on
on("displayNameChanged", DisplayNameChangedListener)
Função Subscribe para o evento 'displayNameChanged'.
function on(event: "displayNameChanged", listener: DisplayNameChangedListener)
Parâmetros
- event
-
"displayNameChanged"
- listener
- DisplayNameChangedListener
Herdado deCommonCallAdapter.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 deCommonCallAdapter.on
on("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)
Função de assinatura para o evento 'isCaptionLanguageChanged'.
function on(event: "isCaptionLanguageChanged", listener: IsCaptionLanguageChangedListener)
Parâmetros
- event
-
"isCaptionLanguageChanged"
- listener
- IsCaptionLanguageChangedListener
Herdado deCommonCallAdapter.on
on("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)
Função de assinatura para o evento 'isCaptionsActiveChanged'.
function on(event: "isCaptionsActiveChanged", listener: IsCaptionsActiveChangedListener)
Parâmetros
- event
-
"isCaptionsActiveChanged"
- listener
- IsCaptionsActiveChangedListener
Herdado deCommonCallAdapter.on
on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)
Assinar a função para o evento 'isLocalScreenSharingActiveChanged'.
function on(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)
Parâmetros
- event
-
"isLocalScreenSharingActiveChanged"
Herdado deCommonCallAdapter.on
on("isMutedChanged", IsMutedChangedListener)
Função Subscribe para o evento 'isMutedChanged'.
function on(event: "isMutedChanged", listener: IsMutedChangedListener)
Parâmetros
- event
-
"isMutedChanged"
- listener
- IsMutedChangedListener
Comentários
O evento será disparado sempre que o usuário atual ou o estado de mudo do usuário remoto forem alterados
Herdado deCommonCallAdapter.on
on("isSpeakingChanged", IsSpeakingChangedListener)
Função Subscribe para o evento 'isSpeakingChanged'.
function on(event: "isSpeakingChanged", listener: IsSpeakingChangedListener)
Parâmetros
- event
-
"isSpeakingChanged"
- listener
- IsSpeakingChangedListener
Herdado deCommonCallAdapter.on
on("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)
Subscribe para o evento 'isSpokenLanguageChanged'.
function on(event: "isSpokenLanguageChanged", listener: IsSpokenLanguageChangedListener)
Parâmetros
- event
-
"isSpokenLanguageChanged"
- listener
- IsSpokenLanguageChangedListener
Herdado deCommonCallAdapter.on
on("mutedByOthers", PropertyChangedEvent)
Função de assinatura para o evento 'mutedByOthers'.
function on(event: "mutedByOthers", listener: PropertyChangedEvent)
Parâmetros
- event
-
"mutedByOthers"
- listener
- PropertyChangedEvent
Herdado deCommonCallAdapter.on
on("participantsJoined", ParticipantsJoinedListener)
Assinar a função para o evento 'participantsJoined'.
function on(event: "participantsJoined", listener: ParticipantsJoinedListener)
Parâmetros
- event
-
"participantsJoined"
- listener
- ParticipantsJoinedListener
Herdado deCommonCallAdapter.on
on("participantsLeft", ParticipantsLeftListener)
Função Subscribe para o evento 'participantsLeft'.
function on(event: "participantsLeft", listener: ParticipantsLeftListener)
Parâmetros
- event
-
"participantsLeft"
- listener
- ParticipantsLeftListener
Herdado deCommonCallAdapter.on
on("realTimeTextReceived", RealTimeTextReceivedListener)
Função de assinatura para o evento 'realTimeTextReceived'.
function on(event: "realTimeTextReceived", listener: RealTimeTextReceivedListener)
Parâmetros
- event
-
"realTimeTextReceived"
- listener
- RealTimeTextReceivedListener
Herdado deCommonCallAdapter.on
on("roleChanged", PropertyChangedEvent)
Subscribe para o evento 'roleChanged'.
function on(event: "roleChanged", listener: PropertyChangedEvent)
Parâmetros
- event
-
"roleChanged"
- listener
- PropertyChangedEvent
Herdado deCommonCallAdapter.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"
- listener
- PropertyChangedEvent
Herdado deCommonCallAdapter.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"
- listener
- PropertyChangedEvent
Herdado deCommonCallAdapter.on
on("spotlightChanged", SpotlightChangedListener)
Função de inscrição para o evento 'spotlightChanged'.
function on(event: "spotlightChanged", listener: SpotlightChangedListener)
Parâmetros
- event
-
"spotlightChanged"
- listener
- SpotlightChangedListener
Herdado deCommonCallAdapter.on
on("transferAccepted", TransferAcceptedListener)
Função de assinatura para o evento 'transferRequested'.
function on(event: "transferAccepted", listener: TransferAcceptedListener)
Parâmetros
- event
-
"transferAccepted"
- listener
- TransferAcceptedListener
Herdado deCommonCallAdapter.on
onReactionClick(Reaction)
Enviar emoji de reação
function onReactionClick(reaction: Reaction): Promise<void>
Parâmetros
- reaction
- Reaction
Retornos
Promise<void>
Herdado deCommonCallAdapter.onReactionClick
onStateChange((state: CallAdapterState) => void)
Assina o manipulador para eventos stateChanged.
function onStateChange(handler: (state: CallAdapterState) => void)
Parâmetros
- handler
-
(state: CallAdapterState) => void
herdado deCommonCallAdapter.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 deCommonCallAdapter.permitAudio
permitOthersAudio()
Permitir áudio de reunião do Teams.
function permitOthersAudio(): Promise<void>
Retornos
Promise<void>
Herdado deCommonCallAdapter.permitOthersAudio
permitOthersVideo()
Permitir vídeo de reunião do Teams.
function permitOthersVideo(): Promise<void>
Retornos
Promise<void>
Herdado deCommonCallAdapter.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 deCommonCallAdapter.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 deCommonCallAdapter.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 deCommonCallAdapter.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 deCommonCallAdapter.querySpeakers
raiseHand()
Levante a mão para o usuário atual
function raiseHand(): Promise<void>
Retornos
Promise<void>
Herdado deCommonCallAdapter.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 deCommonCallAdapter.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 deCommonCallAdapter.removeParticipant
resumeCall()
Retoma a chamada de um LocalHold estado.
function resumeCall(): Promise<void>
Retornos
Promise<void>
Herdado deCommonCallAdapter.resumeCall
returnFromBreakoutRoom()
Retorno à chamada de origem da sala de descanso
function returnFromBreakoutRoom(): Promise<void>
Retornos
Promise<void>
Herdado deCommonCallAdapter.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 deCommonCallAdapter.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 deCommonCallAdapter.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 deCommonCallAdapter.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 deCommonCallAdapter.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>
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 deCommonCallAdapter.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
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 deCommonCallAdapter.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 deCommonCallAdapter.startCaptions
startNoiseSuppressionEffect()
Inicie o efeito de supressão de ruído.
function startNoiseSuppressionEffect(): Promise<void>
Retornos
Promise<void>
startScreenShare()
Comece a compartilhar a tela durante uma chamada.
function startScreenShare(): Promise<void>
Retornos
Promise<void>
Herdado deCommonCallAdapter.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 deCommonCallAdapter.startSpotlight
startTogetherMode()
Modo Iniciar Juntos.
function startTogetherMode(): Promise<void>
Retornos
Promise<void>
Herdado deCommonCallAdapter.startTogetherMode
startVideoBackgroundEffect(VideoBackgroundEffect)
Inicie o efeito de fundo do vídeo.
function startVideoBackgroundEffect(videoBackgroundEffect: VideoBackgroundEffect): Promise<void>
Parâmetros
- videoBackgroundEffect
- VideoBackgroundEffect
Retornos
Promise<void>
stopAllSpotlight()
Pare todos os holofotes
function stopAllSpotlight(): Promise<void>
Retornos
Promise<void>
Herdado deCommonCallAdapter.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 deCommonCallAdapter.stopCamera
stopCaptions(StopCaptionsAdapterOptions)
Função para parar legendas
function stopCaptions(options?: StopCaptionsAdapterOptions): Promise<void>
Parâmetros
- options
- StopCaptionsAdapterOptions
Retornos
Promise<void>
Herdado deCommonCallAdapter.stopCaptions
stopNoiseSuppressionEffect()
Pare o efeito de supressão de ruído.
function stopNoiseSuppressionEffect(): Promise<void>
Retornos
Promise<void>
stopScreenShare()
Parar de compartilhar a tela
function stopScreenShare(): Promise<void>
Retornos
Promise<void>
Herdado deCommonCallAdapter.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 deCommonCallAdapter.stopSpotlight
stopVideoBackgroundEffects()
Pare o efeito de fundo do vídeo.
function stopVideoBackgroundEffects(): Promise<void>
Retornos
Promise<void>
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 deCommonCallAdapter.submitSurvey
unmute()
Desativar o usuário atual durante a chamada ou habilitar o microfone localmente
function unmute(): Promise<void>
Retornos
Promise<void>
Herdado deCommonCallAdapter.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
Matriz de imagens de fundo personalizadas.
updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)
Atualize o efeito de plano de fundo do vídeo selecionado.
function updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect)
Parâmetros
- selectedVideoBackground
- VideoBackgroundEffect
Herdado deCommonCallAdapter.updateSelectedVideoBackgroundEffect