Partilhar via


TeamsCallAdapter interface

Uma interface de adaptador específica para a identidade do Teams que estende CommonCallAdapter.

Extends

Propriedades Herdadas

sendRealTimeText

Enviar texto em tempo real

Métodos

joinCall(boolean)

Participe da chamada com o microfone inicialmente ligado/desligado.

joinCall(JoinCallOptions)

Junte-se à chamada com o saco de opções para definir o estado inicial do microfone/câmara ao aderir à chamada true = ligar o dispositivo ao aderir à chamada false = desligar o dispositivo ao aderir à chamada 'manter'/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 a visualização html para um fluxo.

createTogetherModeStreamView(TogetherModeStreamOptions)

Crie a visualização html para um fluxo.

dispose()

Elimine o composto

disposeLocalVideoStreamView()

Eliminar a vista html para um fluxo de vídeo local

disposeRemoteVideoStreamView(string)

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

disposeScreenShareStreamView(string)

Eliminar a vista html para um fluxo de partilha de ecrã

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 seus 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 vídeos de participantes da reunião do Teams por seus IDs de usuário.

getState()

Obter o estado atual

holdCall()

Mantém a chamada.

leaveCall(boolean)

Saia da chamada

lowerHand()

Mão inferior para o usuário atual

mute()

Silenciar o usuário atual durante a chamada ou desativar o microfone localmente

muteAllRemoteParticipants()

Silenciar todos os participantes

muteParticipant(string)

Silenciar um participante

off("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)

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

off("callEnded", CallEndedListener)

Função de cancelamento de inscrição para o evento 'callEnded'.

off("callIdChanged", CallIdChangedListener)

Função de cancelamento de inscrição para o evento 'callIdChanged'.

off("capabilitiesChanged", CapabilitiesChangedListener)

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

off("captionsReceived", CaptionsReceivedListener)

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

off("diagnosticChanged", DiagnosticChangedEventListner)

Função de cancelamento de inscrição para o evento 'diagnosticChanged'.

off("displayNameChanged", DisplayNameChangedListener)

Função de cancelamento de inscrição para o evento 'displayNameChanged'.

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

Função de cancelamento de inscrição para o evento 'error'.

off("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)

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

off("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)

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

off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

Função de cancelamento de inscrição para o evento 'isLocalScreenSharingActiveChanged'.

off("isMutedChanged", IsMutedChangedListener)

Função de cancelamento de inscrição para o evento 'isMutedChanged'.

off("isSpeakingChanged", IsSpeakingChangedListener)

Função de cancelamento de inscrição para o evento 'isSpeakingChanged'.

off("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)

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

off("mutedByOthers", PropertyChangedEvent)

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

off("participantsJoined", ParticipantsJoinedListener)

Função de cancelamento de inscrição para o evento 'participantesParticipou'.

off("participantsLeft", ParticipantsLeftListener)

Função de cancelamento de inscrição para o evento 'participantsLeft'.

off("realTimeTextReceived", RealTimeTextReceivedListener)

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

off("roleChanged", PropertyChangedEvent)

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

off("selectedMicrophoneChanged", PropertyChangedEvent)

Função de cancelamento de inscrição para o evento 'selectedMicrophoneChanged'.

off("selectedSpeakerChanged", PropertyChangedEvent)

Função de cancelamento de inscrição para o evento 'selectedSpeakerChanged'.

off("spotlightChanged", SpotlightChangedListener)

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

off("transferAccepted", TransferAcceptedListener)

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

offStateChange((state: CallAdapterState) => void)

Cancela a inscrição do manipulador para eventos stateChanged.

on("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)

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

on("callEnded", CallEndedListener)

Função de subscrição para o evento 'callEnded'.

on("callIdChanged", CallIdChangedListener)

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

on("capabilitiesChanged", CapabilitiesChangedListener)

Função de subscrição para o evento 'capabilitiesChanged'.

on("captionsReceived", CaptionsReceivedListener)

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

on("diagnosticChanged", DiagnosticChangedEventListner)

Função de subscrição para o 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 de subscrição para o evento 'displayNameChanged'.

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

Função de subscrição para o evento 'error'.

on("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)

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

on("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)

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

on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

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

on("isMutedChanged", IsMutedChangedListener)

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

on("isSpeakingChanged", IsSpeakingChangedListener)

Subscrever função para o evento 'isSpeakingChanged'.

on("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)

Assine a função 'isSpokenLanguageChanged' evento.

on("mutedByOthers", PropertyChangedEvent)

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

on("participantsJoined", ParticipantsJoinedListener)

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

on("participantsLeft", ParticipantsLeftListener)

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

on("realTimeTextReceived", RealTimeTextReceivedListener)

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

on("roleChanged", PropertyChangedEvent)

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

on("selectedMicrophoneChanged", PropertyChangedEvent)

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

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

on("selectedSpeakerChanged", PropertyChangedEvent)

Função de inscriçã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 subscrição para o evento 'transferRequested'.

onReactionClick(Reaction)

Enviar emoji de reação

onStateChange((state: CallAdapterState) => void)

Inscreve o manipulador em eventos stateChanged.

permitAudio(string[])

Permitir que os participantes da reunião do Teams sejam áudio por seus IDs de usuário.

permitOthersAudio()

Permitir áudio de reunião do Teams.

permitOthersVideo()

Permitir vídeo de reunião do Teams.

permitVideo(string[])

Permitir que os participantes da reunião do Teams sejam áudio por seus IDs de usuário.

queryCameras()

Consulta de dispositivos de câmara disponíveis.

queryMicrophones()

Consulta de dispositivos de microfone disponíveis.

querySpeakers()

Consulta de 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()

Chamada de retorno à origem da sala de breakout

sendDtmfTone(DtmfTone)

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

setCamera(VideoDeviceInfo, VideoStreamOptions)

Defina a câmera para usar 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 a linguagem falada

setTogetherModeSceneSize(number, number)

Recalcule as posições sentadas para o modo em conjunto.

startCamera(VideoStreamOptions)

Iniciar a câmara Este método começará a renderizar uma vista de câmara 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 partilhar o ecrã 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âmara Este método irá parar de renderizar uma vista de câmara local quando a chamada não estiver ativa

stopCaptions(StopCaptionsAdapterOptions)

Diversão para parar legendas

stopNoiseSuppressionEffect()

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

stopScreenShare()

Parar de partilhar o ecrã

stopSpotlight(string[])

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

stopVideoBackgroundEffects()

Pare o efeito de fundo do vídeo.

submitSurvey(CallSurvey)

Enviar o resultado da pesquisa de fim de chamada

unmute()

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

updateBackgroundPickerImages(VideoBackgroundImage[])

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

updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)

Atualize o efeito de fundo de vídeo selecionado.

Detalhes da Propriedade Herdada

sendRealTimeText

Enviar texto em tempo real

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

Valor de Propriedade

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

Herdado deCommonCallAdapter.sendRealTimeText

Detalhes de Método

joinCall(boolean)

Aviso

Esta API foi preterida.

Use joinCall(options?:JoinCallOptions) instead.

Participe da chamada com o microfone inicialmente ligado/desligado.

function joinCall(microphoneOn?: boolean): undefined | TeamsCall

Parâmetros

microphoneOn

boolean

Se o microfone está inicialmente ativado

Devoluções

undefined | TeamsCall

joinCall(JoinCallOptions)

Junte-se à chamada com o saco de opções para definir o estado inicial do microfone/câmara ao aderir à chamada true = ligar o dispositivo ao aderir à chamada false = desligar o dispositivo ao aderir à chamada 'manter'/undefined = reter o estado de pré-chamada dos dispositivos

function joinCall(options?: JoinCallOptions): undefined | TeamsCall

Parâmetros

options
JoinCallOptions

param para definir microfone / câmera inicialmente on / off.

Devoluções

undefined | TeamsCall

startCall(CommunicationIdentifier[], StartCallOptions)

Inicie a chamada.

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

Parâmetros

participants

CommunicationIdentifier[]

Uma matriz de <xref:%40azure%2Fcommunication-common%23CommunicationIdentifier> a ser chamada

Devoluções

undefined | TeamsCall

startCall(string[], StartCallOptions)

Inicie a chamada.

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

Parâmetros

participants

string[]

Uma matriz de ids de participante para participar

Devoluções

undefined | TeamsCall

Detalhes do Método Herdado

addParticipant(CommunicationUserIdentifier)

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

Parâmetros

Devoluções

Promise<void>

Herdado deCommonCallAdapter.addParticipant

addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

Adicione um participante à chamada.

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

Parâmetros

participant
PhoneNumberIdentifier

Devoluções

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>

Devoluções

Promise<DeviceAccess>

Observações

A janela de permissão do navegador aparecerá se as permissões ainda não tiverem sido concedidas

herdado de CommonCallAdapter.askDevicePermission

createStreamView(string, VideoStreamOptions)

Crie a visualização html para um fluxo.

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

Parâmetros

remoteUserId

string

Id do participante a renderizar, deixe-o indefinido para criar a visualizaçã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>

Devoluções

Promise<void | CreateVideoStreamViewResult>

Observações

Este método é implementado para compósitos

herdado de CommonCallAdapter.createStreamView

createTogetherModeStreamView(TogetherModeStreamOptions)

Crie a visualizaçã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>

Devoluções

Observações

Este método é implementado para compósitos

Herdado deCommonCallAdapter.createTogetherModeStreamView

dispose()

Elimine o composto

function dispose()

herdado deCommonCallAdapter.dispose

disposeLocalVideoStreamView()

Eliminar a vista html para um fluxo de vídeo local

function disposeLocalVideoStreamView(): Promise<void>

Devoluções

Promise<void>

Herdado deCommonCallAdapter.disposeLocalVideoStreamView

disposeRemoteVideoStreamView(string)

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

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

Parâmetros

remoteUserId

string

Identificação do participante a dispor

Devoluções

Promise<void>

Herdado deCommonCallAdapter.disposeRemoteVideoStreamView

disposeScreenShareStreamView(string)

Eliminar a vista html para um fluxo de partilha de ecrã

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

Parâmetros

remoteUserId

string

Id do participante para descartar a visualização de fluxo de compartilhamento de tela.

Devoluções

Promise<void>

Observações

Este método é implementado para composto

Herdado deCommonCallAdapter.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 renderizar, deixe-o indefinido para descartar a visã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>

Devoluções

Promise<void>

Observações

Este método é implementado para compósitos

herdado de CommonCallAdapter.disposeStreamView

disposeTogetherModeStreamView()

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

function disposeTogetherModeStreamView(): Promise<void>

Devoluções

Promise<void>

Observações

Este método é implementado para compósitos

Herdado deCommonCallAdapter.disposeTogetherModeStreamView

forbidAudio(string[])

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

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

Parâmetros

userIds

string[]

Devoluções

Promise<void>

Herdado deCommonCallAdapter.forbidAudio

forbidOthersAudio()

Proibir o áudio da reunião do Teams.

function forbidOthersAudio(): Promise<void>

Devoluções

Promise<void>

Herdado deCommonCallAdapter.forbidOthersAudio

forbidOthersVideo()

Proibir vídeo de reunião do Teams.

function forbidOthersVideo(): Promise<void>

Devoluções

Promise<void>

Herdado deCommonCallAdapter.forbidOthersVideo

forbidVideo(string[])

Proibir vídeos de participantes da reunião do Teams por seus IDs de usuário.

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

Parâmetros

userIds

string[]

Devoluções

Promise<void>

Herdado deCommonCallAdapter.forbidVideo

getState()

Obter o estado atual

function getState(): CallAdapterState

Devoluções

herdado de CommonCallAdapter.getState

holdCall()

Mantém a chamada.

function holdCall(): Promise<void>

Devoluções

Promise<void>

Herdado deCommonCallAdapter.holdCall

leaveCall(boolean)

Saia da chamada

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

Parâmetros

forEveryone

boolean

Se todos os participantes devem ser removidos ao sair

Devoluções

Promise<void>

herdado de CommonCallAdapter.leaveCall

lowerHand()

Mão inferior para o usuário atual

function lowerHand(): Promise<void>

Devoluções

Promise<void>

Herdado deCommonCallAdapter.lowerHand

mute()

Silenciar o usuário atual durante a chamada ou desativar o microfone localmente

function mute(): Promise<void>

Devoluções

Promise<void>

herdado de CommonCallAdapter.mute

muteAllRemoteParticipants()

Silenciar todos os participantes

function muteAllRemoteParticipants(): Promise<void>

Devoluções

Promise<void>

Herdado deCommonCallAdapter.muteAllRemoteParticipants

muteParticipant(string)

Silenciar um participante

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

Parâmetros

userId

string

Id do participante a silenciar

Devoluções

Promise<void>

Herdado deCommonCallAdapter.muteParticipant

off("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)

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

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

Parâmetros

event

"breakoutRoomsUpdated"

herdado de CommonCallAdapter.off

off("callEnded", CallEndedListener)

Função de cancelamento de inscrição para o evento 'callEnded'.

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

Parâmetros

event

"callEnded"

herdado de CommonCallAdapter.off

off("callIdChanged", CallIdChangedListener)

Função de cancelamento de inscrição para o evento 'callIdChanged'.

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

Parâmetros

event

"callIdChanged"

herdado de CommonCallAdapter.off

off("capabilitiesChanged", CapabilitiesChangedListener)

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

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

Parâmetros

event

"capabilitiesChanged"

herdado de CommonCallAdapter.off

off("captionsReceived", CaptionsReceivedListener)

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

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

Parâmetros

event

"captionsReceived"

herdado de CommonCallAdapter.off

off("diagnosticChanged", DiagnosticChangedEventListner)

Função de cancelamento de inscrição para o evento 'diagnosticChanged'.

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

Parâmetros

event

"diagnosticChanged"

herdado de CommonCallAdapter.off

off("displayNameChanged", DisplayNameChangedListener)

Função de cancelamento de inscrição para o evento 'displayNameChanged'.

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

Parâmetros

event

"displayNameChanged"

herdado de CommonCallAdapter.off

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

Função de cancelamento de inscrição para o evento 'error'.

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

Parâmetros

event

"error"

listener

(e: AdapterError) => void

herdado de CommonCallAdapter.off

off("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)

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

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

Parâmetros

event

"isCaptionLanguageChanged"

herdado de CommonCallAdapter.off

off("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)

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

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

Parâmetros

event

"isCaptionsActiveChanged"

herdado de CommonCallAdapter.off

off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

Função de cancelamento de inscrição para o evento 'isLocalScreenSharingActiveChanged'.

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

Parâmetros

event

"isLocalScreenSharingActiveChanged"

herdado de CommonCallAdapter.off

off("isMutedChanged", IsMutedChangedListener)

Função de cancelamento de inscrição para o evento 'isMutedChanged'.

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

Parâmetros

event

"isMutedChanged"

herdado de CommonCallAdapter.off

off("isSpeakingChanged", IsSpeakingChangedListener)

Função de cancelamento de inscrição para o evento 'isSpeakingChanged'.

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

Parâmetros

event

"isSpeakingChanged"

herdado de CommonCallAdapter.off

off("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)

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

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

Parâmetros

event

"isSpokenLanguageChanged"

herdado de CommonCallAdapter.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"

herdado de CommonCallAdapter.off

off("participantsJoined", ParticipantsJoinedListener)

Função de cancelamento de inscrição para o evento 'participantesParticipou'.

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

Parâmetros

event

"participantsJoined"

herdado de CommonCallAdapter.off

off("participantsLeft", ParticipantsLeftListener)

Função de cancelamento de inscrição para o evento 'participantsLeft'.

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

Parâmetros

event

"participantsLeft"

herdado de CommonCallAdapter.off

off("realTimeTextReceived", RealTimeTextReceivedListener)

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

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

Parâmetros

event

"realTimeTextReceived"

herdado de CommonCallAdapter.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"

herdado de CommonCallAdapter.off

off("selectedMicrophoneChanged", PropertyChangedEvent)

Função de cancelamento de inscrição para o evento 'selectedMicrophoneChanged'.

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

Parâmetros

event

"selectedMicrophoneChanged"

herdado de CommonCallAdapter.off

off("selectedSpeakerChanged", PropertyChangedEvent)

Função de cancelamento de inscrição para o evento 'selectedSpeakerChanged'.

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

Parâmetros

event

"selectedSpeakerChanged"

herdado de CommonCallAdapter.off

off("spotlightChanged", SpotlightChangedListener)

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

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

Parâmetros

event

"spotlightChanged"

herdado de CommonCallAdapter.off

off("transferAccepted", TransferAcceptedListener)

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

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

Parâmetros

event

"transferAccepted"

herdado de CommonCallAdapter.off

offStateChange((state: CallAdapterState) => void)

Cancela a inscrição do manipulador para eventos stateChanged.

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

Parâmetros

handler

(state: CallAdapterState) => void

herdado de CommonCallAdapter.offStateChange

on("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)

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

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

Parâmetros

event

"breakoutRoomsUpdated"

herdado de CommonCallAdapter.on

on("callEnded", CallEndedListener)

Função de subscrição para o evento 'callEnded'.

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

Parâmetros

event

"callEnded"

herdado de CommonCallAdapter.on

on("callIdChanged", CallIdChangedListener)

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

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

Parâmetros

event

"callIdChanged"

Observações

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

herdado de CommonCallAdapter.on

on("capabilitiesChanged", CapabilitiesChangedListener)

Função de subscrição para o evento 'capabilitiesChanged'.

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

Parâmetros

event

"capabilitiesChanged"

herdado de CommonCallAdapter.on

on("captionsReceived", CaptionsReceivedListener)

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

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

Parâmetros

event

"captionsReceived"

herdado de CommonCallAdapter.on

on("diagnosticChanged", DiagnosticChangedEventListner)

Função de subscrição para o 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 de CommonCallAdapter.on

on("displayNameChanged", DisplayNameChangedListener)

Função de subscrição para o evento 'displayNameChanged'.

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

Parâmetros

event

"displayNameChanged"

herdado de CommonCallAdapter.on

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

Função de subscrição para o evento 'error'.

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

Parâmetros

event

"error"

listener

(e: AdapterError) => void

herdado de CommonCallAdapter.on

on("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)

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

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

Parâmetros

event

"isCaptionLanguageChanged"

herdado de CommonCallAdapter.on

on("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)

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

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

Parâmetros

event

"isCaptionsActiveChanged"

herdado de CommonCallAdapter.on

on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

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

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

Parâmetros

event

"isLocalScreenSharingActiveChanged"

herdado de CommonCallAdapter.on

on("isMutedChanged", IsMutedChangedListener)

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

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

Parâmetros

event

"isMutedChanged"

Observações

O evento será acionado sempre que o estado de silenciamento do usuário atual ou do usuário remoto for alterado

herdado de CommonCallAdapter.on

on("isSpeakingChanged", IsSpeakingChangedListener)

Subscrever função para o evento 'isSpeakingChanged'.

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

Parâmetros

event

"isSpeakingChanged"

herdado de CommonCallAdapter.on

on("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)

Assine a função 'isSpokenLanguageChanged' evento.

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

Parâmetros

event

"isSpokenLanguageChanged"

herdado de CommonCallAdapter.on

on("mutedByOthers", PropertyChangedEvent)

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

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

Parâmetros

event

"mutedByOthers"

herdado de CommonCallAdapter.on

on("participantsJoined", ParticipantsJoinedListener)

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

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

Parâmetros

event

"participantsJoined"

herdado de CommonCallAdapter.on

on("participantsLeft", ParticipantsLeftListener)

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

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

Parâmetros

event

"participantsLeft"

herdado de CommonCallAdapter.on

on("realTimeTextReceived", RealTimeTextReceivedListener)

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

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

Parâmetros

event

"realTimeTextReceived"

herdado de CommonCallAdapter.on

on("roleChanged", PropertyChangedEvent)

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

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

Parâmetros

event

"roleChanged"

herdado de CommonCallAdapter.on

on("selectedMicrophoneChanged", PropertyChangedEvent)

Função de inscriçã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 de CommonCallAdapter.on

on("selectedSpeakerChanged", PropertyChangedEvent)

Função de inscriçã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 de CommonCallAdapter.on

on("spotlightChanged", SpotlightChangedListener)

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

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

Parâmetros

event

"spotlightChanged"

herdado de CommonCallAdapter.on

on("transferAccepted", TransferAcceptedListener)

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

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

Parâmetros

event

"transferAccepted"

herdado de CommonCallAdapter.on

onReactionClick(Reaction)

Enviar emoji de reação

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

Parâmetros

reaction
Reaction

Devoluções

Promise<void>

Herdado deCommonCallAdapter.onReactionClick

onStateChange((state: CallAdapterState) => void)

Inscreve o manipulador em eventos stateChanged.

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

Parâmetros

handler

(state: CallAdapterState) => void

herdado de CommonCallAdapter.onStateChange

permitAudio(string[])

Permitir que os participantes da reunião do Teams sejam áudio por seus IDs de usuário.

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

Parâmetros

userIds

string[]

Devoluções

Promise<void>

Herdado deCommonCallAdapter.permitAudio

permitOthersAudio()

Permitir áudio de reunião do Teams.

function permitOthersAudio(): Promise<void>

Devoluções

Promise<void>

Herdado deCommonCallAdapter.permitOthersAudio

permitOthersVideo()

Permitir vídeo de reunião do Teams.

function permitOthersVideo(): Promise<void>

Devoluções

Promise<void>

Herdado deCommonCallAdapter.permitOthersVideo

permitVideo(string[])

Permitir que os participantes da reunião do Teams sejam áudio por seus IDs de usuário.

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

Parâmetros

userIds

string[]

Devoluções

Promise<void>

Herdado deCommonCallAdapter.permitVideo

queryCameras()

Consulta de dispositivos de câmara disponíveis.

function queryCameras(): Promise<VideoDeviceInfo[]>

Devoluções

Promise<VideoDeviceInfo[]>

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

Observações

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

herdado de CommonCallAdapter.queryCameras

queryMicrophones()

Consulta de dispositivos de microfone disponíveis.

function queryMicrophones(): Promise<AudioDeviceInfo[]>

Devoluções

Promise<AudioDeviceInfo[]>

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

Observações

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

herdado de CommonCallAdapter.queryMicrophones

querySpeakers()

Consulta de dispositivos de alto-falante disponíveis.

function querySpeakers(): Promise<AudioDeviceInfo[]>

Devoluções

Promise<AudioDeviceInfo[]>

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

Observações

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

herdado de CommonCallAdapter.querySpeakers

raiseHand()

Levante a mão para o usuário atual

function raiseHand(): Promise<void>

Devoluções

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 remover

Devoluções

Promise<void>

herdado de CommonCallAdapter.removeParticipant

removeParticipant(string)

Remova um participante da chamada.

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

Parâmetros

userId

string

ID do participante a ser removido

Devoluções

Promise<void>

herdado de CommonCallAdapter.removeParticipant

resumeCall()

Retoma a chamada de um LocalHold estado.

function resumeCall(): Promise<void>

Devoluções

Promise<void>

Herdado deCommonCallAdapter.resumeCall

returnFromBreakoutRoom()

Chamada de retorno à origem da sala de breakout

function returnFromBreakoutRoom(): Promise<void>

Devoluções

Promise<void>

Herdado deCommonCallAdapter.returnFromBreakoutRoom

sendDtmfTone(DtmfTone)

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

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

Parâmetros

dtmfTone
DtmfTone

Devoluções

Promise<void>

Herdado deCommonCallAdapter.sendDtmfTone

setCamera(VideoDeviceInfo, VideoStreamOptions)

Defina a câmera para usar 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 da câmera é renderizado <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Devoluções

Promise<void>

herdado de CommonCallAdapter.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

Devoluções

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

Devoluções

Promise<void>

herdado de CommonCallAdapter.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

Devoluções

Promise<void>

herdado de CommonCallAdapter.setSpeaker

setSpokenLanguage(string)

Função para definir a linguagem falada

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

Parâmetros

language

string

Língua falada

Devoluções

Promise<void>

Herdado deCommonCallAdapter.setSpokenLanguage

setTogetherModeSceneSize(number, number)

Recalcule as posições sentadas para o modo em conjunto.

function setTogetherModeSceneSize(width: number, height: number)

Parâmetros

width

number

Largura do contentor

height

number

Altura do contentor

Observações

Este método é implementado para compósitos

Herdado deCommonCallAdapter.setTogetherModeSceneSize

startCamera(VideoStreamOptions)

Iniciar a câmara Este método começará a renderizar uma vista de câmara 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>

Devoluções

Promise<void>

herdado de CommonCallAdapter.startCamera

startCaptions(StartCaptionsAdapterOptions)

Função para iniciar legendas

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

Parâmetros

options
StartCaptionsAdapterOptions

Opções para legendas de início

Devoluções

Promise<void>

Herdado deCommonCallAdapter.startCaptions

startNoiseSuppressionEffect()

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

function startNoiseSuppressionEffect(): Promise<void>

Devoluções

Promise<void>

Herdado deCommonCallAdapter.startNoiseSuppressionEffect

startScreenShare()

Comece a partilhar o ecrã durante uma chamada.

function startScreenShare(): Promise<void>

Devoluções

Promise<void>

herdado de CommonCallAdapter.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[]

Devoluções

Promise<void>

Herdado deCommonCallAdapter.startSpotlight

startTogetherMode()

Modo Iniciar Juntos.

function startTogetherMode(): Promise<void>

Devoluções

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

Devoluções

Promise<void>

Herdado deCommonCallAdapter.startVideoBackgroundEffect

stopAllSpotlight()

Pare todos os holofotes

function stopAllSpotlight(): Promise<void>

Devoluções

Promise<void>

Herdado deCommonCallAdapter.stopAllSpotlight

stopCamera()

Parar a câmara Este método irá parar de renderizar uma vista de câmara local quando a chamada não estiver ativa

function stopCamera(): Promise<void>

Devoluções

Promise<void>

herdado de CommonCallAdapter.stopCamera

stopCaptions(StopCaptionsAdapterOptions)

Diversão para parar legendas

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

Parâmetros

Devoluções

Promise<void>

Herdado deCommonCallAdapter.stopCaptions

stopNoiseSuppressionEffect()

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

function stopNoiseSuppressionEffect(): Promise<void>

Devoluções

Promise<void>

Herdado deCommonCallAdapter.stopNoiseSuppressionEffect

stopScreenShare()

Parar de partilhar o ecrã

function stopScreenShare(): Promise<void>

Devoluções

Promise<void>

herdado de CommonCallAdapter.stopScreenShare

stopSpotlight(string[])

Pare 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 stopSpotlight(userIds?: string[]): Promise<void>

Parâmetros

userIds

string[]

Devoluções

Promise<void>

Herdado deCommonCallAdapter.stopSpotlight

stopVideoBackgroundEffects()

Pare o efeito de fundo do vídeo.

function stopVideoBackgroundEffects(): Promise<void>

Devoluções

Promise<void>

Herdado deCommonCallAdapter.stopVideoBackgroundEffects

submitSurvey(CallSurvey)

Enviar o resultado da pesquisa de fim de chamada

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

Parâmetros

survey
CallSurvey

Devoluções

Promise<undefined | CallSurveyResponse>

Herdado deCommonCallAdapter.submitSurvey

unmute()

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

function unmute(): Promise<void>

Devoluções

Promise<void>

herdado de CommonCallAdapter.unmute

updateBackgroundPickerImages(VideoBackgroundImage[])

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

function updateBackgroundPickerImages(backgroundImages: VideoBackgroundImage[])

Parâmetros

backgroundImages

VideoBackgroundImage[]

Matriz de imagens de fundo personalizadas.

Herdado deCommonCallAdapter.updateBackgroundPickerImages

updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)

Atualize o efeito de fundo de vídeo selecionado.

function updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect)

Parâmetros

selectedVideoBackground
VideoBackgroundEffect

Herdado deCommonCallAdapter.updateSelectedVideoBackgroundEffect