Partilhar via


CallWithChatAdapter interface

interface do adaptador de CallWithChatComposto.

Extends

Propriedades Herdadas

forbidAudio

Proíbe áudio para os IDs de usuário especificados.

forbidOthersAudio

proíbe o áudio para participantes da reunião do Teams, exceto o usuário local.

forbidOthersVideo

proíbe vídeo para participantes da reunião do Teams, exceto o usuário local.

forbidVideo

Proíbe vídeo para os IDs de usuário especificados.

permitAudio

Permite áudio para os IDs de usuário especificados.

permitOthersAudio

permite áudio para participantes da reunião do Teams, exceto o usuário local.

permitOthersVideo

permite vídeo para participantes da reunião do Teams, exceto o usuário local.

permitVideo

Permite vídeo para os IDs de usuário especificados.

sendDtmfTone

Enviar tom DTMF para outro participante da chamada em chamadas 1:1

sendRealTimeText

Enviar texto em tempo real

Métodos Herdados

addParticipant(CommunicationUserIdentifier)
addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

Adiciona um novo 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 togethermode.

deleteMessage(string)

Exclua uma mensagem no thread.

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 a exibição html para um fluxo togethermode.

downloadResourceToCache(ResourceDetails)
fetchInitialData()

Buscar o estado inicial para o adaptador de bate-papo.

Executa a busca mínima necessária para os métodos ChatComposite e API.

getState()

Obter o estado atual

holdCall()

Coloca a chamada em um localhold.

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

leaveCall(boolean)

Saia da chamada.

loadPreviousChatMessages(number)

Carregue mais mensagens anteriores no histórico de conversas de chat.

lowerHand()

Mão inferior para o usuário local.

mute()

Silencie o usuário atual durante a chamada ou desative o microfone localmente.

muteAllRemoteParticipants()

Silenciar um participante

muteParticipant(string)

Silenciar um participante

off("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)
off("callEnded", CallEndedListener)
off("callError", (e: AdapterError) => void)
off("callIdChanged", CallIdChangedListener)
off("callParticipantsJoined", ParticipantsJoinedListener)
off("callParticipantsLeft", ParticipantsLeftListener)
off("capabilitiesChanged", CapabilitiesChangedListener)
off("captionsReceived", CaptionsReceivedListener)
off("chatError", (e: AdapterError) => void)
off("chatInitialized", ChatInitializedListener)
off("chatParticipantsAdded", ParticipantsAddedListener)
off("chatParticipantsRemoved", ParticipantsRemovedListener)
off("displayNameChanged", DisplayNameChangedListener)
off("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)
off("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)
off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)
off("isMutedChanged", IsMutedChangedListener)
off("isSpeakingChanged", IsSpeakingChangedListener)
off("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)
off("messageDeleted", MessageReceivedListener)
off("messageEdited", MessageReceivedListener)
off("messageRead", MessageReadListener)
off("messageReceived", MessageReceivedListener)
off("messageSent", MessageReceivedListener)
off("realTimeTextReceived", RealTimeTextReceivedListener)
off("selectedMicrophoneChanged", PropertyChangedEvent)
off("selectedSpeakerChanged", PropertyChangedEvent)
off("spotlightChanged", SpotlightChangedListener)
offStateChange((state: CallWithChatAdapterState) => void)

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

on("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)
on("callEnded", CallEndedListener)
on("callError", (e: AdapterError) => void)
on("callIdChanged", CallIdChangedListener)
on("callParticipantsJoined", ParticipantsJoinedListener)
on("callParticipantsLeft", ParticipantsLeftListener)
on("capabilitiesChanged", CapabilitiesChangedListener)
on("captionsReceived", CaptionsReceivedListener)
on("chatError", (e: AdapterError) => void)
on("chatInitialized", ChatInitializedListener)
on("chatParticipantsAdded", ParticipantsAddedListener)
on("chatParticipantsRemoved", ParticipantsRemovedListener)
on("displayNameChanged", DisplayNameChangedListener)
on("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)
on("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)
on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)
on("isMutedChanged", IsMutedChangedListener)
on("isSpeakingChanged", IsSpeakingChangedListener)
on("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)
on("messageDeleted", MessageReceivedListener)
on("messageEdited", MessageReceivedListener)
on("messageRead", MessageReadListener)
on("messageReceived", MessageReceivedListener)
on("messageSent", MessageReceivedListener)
on("realTimeTextReceived", RealTimeTextReceivedListener)
on("selectedMicrophoneChanged", PropertyChangedEvent)
on("selectedSpeakerChanged", PropertyChangedEvent)
on("spotlightChanged", SpotlightChangedListener)
onReactionClick(Reaction)

Enviar Reação para a reunião em curso.

onStateChange((state: CallWithChatAdapterState) => void)

Inscreve o manipulador em eventos stateChanged.

queryCameras()

Consulta de dispositivos de câmara disponíveis.

queryMicrophones()

Consulta de dispositivos de microfone disponíveis.

querySpeakers()

Consulta de dispositivos de microfone disponíveis.

raiseHand()

Levante a mão para o usuário local.

removeParticipant(CommunicationIdentifier)

Remova um participante da chamada.

removeParticipant(string)

Remover um participante de uma Chamada.

removeResourceFromCache(ResourceDetails)
resumeCall()

Retoma a chamada de um estado LocalHold.

returnFromBreakoutRoom()

Chamada de retorno à origem da sala de breakout

sendMessage(string, SendMessageOptions)

Envie uma mensagem no tópico.

sendReadReceipt(string)

Envie um recibo de leitura para uma mensagem.

sendTypingIndicator()

Enviar indicador de digitação no thread.

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.

startCall((CommunicationUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], StartCallOptions)

Inicie a chamada.

startCall(string[], StartCallOptions)

Inicie a chamada.

startCamera(VideoStreamOptions)

Inicie a câmara.

Esse método começará a renderizar uma 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 partilhar o ecrã durante uma chamada.

startSpotlight(string[])

Comece em destaque

startTogetherMode()

Iniciar o modo de conjunto.

startVideoBackgroundEffect(VideoBackgroundEffect)

Inicie o efeito de fundo do vídeo.

stopAllSpotlight()

Pare todos os holofotes

stopCamera()

Pare a câmera.

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

stopCaptions(StopCaptionsAdapterOptions)

Diversão para parar legendas

stopNoiseSuppressionEffect()

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

stopScreenShare()

Pare de compartilhar a tela.

stopSpotlight(string[])

Pare o holofote

stopVideoBackgroundEffects()

Pare o efeito de fundo do vídeo.

submitSurvey(CallSurvey)

Enviar o resultado da pesquisa de fim de chamada

unmute()

Desative o mudo do usuário atual durante a chamada ou ative 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.

updateMessage(string, string, Record<string, string>)

Atualizar o conteúdo de uma mensagem.

updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)

Atualizar o efeito de fundo de vídeo selecionado

Detalhes da Propriedade Herdada

forbidAudio

Proíbe áudio para os IDs de usuário especificados.

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

Valor de Propriedade

(userIds: string[]) => Promise<void>

Herdado deCallWithChatAdapterManagement.forbidAudio

forbidOthersAudio

proíbe o áudio para participantes da reunião do Teams, exceto o usuário local.

forbidOthersAudio: () => Promise<void>

Valor de Propriedade

() => Promise<void>

Herdado deCallWithChatAdapterManagement.forbidOthersAudio

forbidOthersVideo

proíbe vídeo para participantes da reunião do Teams, exceto o usuário local.

forbidOthersVideo: () => Promise<void>

Valor de Propriedade

() => Promise<void>

Herdado deCallWithChatAdapterManagement.forbidOthersVideo

forbidVideo

Proíbe vídeo para os IDs de usuário especificados.

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

Valor de Propriedade

(userIds: string[]) => Promise<void>

Herdado deCallWithChatAdapterManagement.forbidVideo

permitAudio

Permite áudio para os IDs de usuário especificados.

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

Valor de Propriedade

(userIds: string[]) => Promise<void>

Herdado deCallWithChatAdapterManagement.permitAudio

permitOthersAudio

permite áudio para participantes da reunião do Teams, exceto o usuário local.

permitOthersAudio: () => Promise<void>

Valor de Propriedade

() => Promise<void>

Herdado deCallWithChatAdapterManagement.permitOthersAudio

permitOthersVideo

permite vídeo para participantes da reunião do Teams, exceto o usuário local.

permitOthersVideo: () => Promise<void>

Valor de Propriedade

() => Promise<void>

Herdado deCallWithChatAdapterManagement.permitOthersVideo

permitVideo

Permite vídeo para os IDs de usuário especificados.

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

Valor de Propriedade

(userIds: string[]) => Promise<void>

Herdado deCallWithChatAdapterManagement.permitVideo

sendDtmfTone

Enviar tom DTMF para outro participante da chamada em chamadas 1:1

public sendDtmfTone: (dtmfTone: DtmfTone) => Promise<void>

Valor de Propriedade

(dtmfTone: DtmfTone) => Promise<void>

Herdado deCallWithChatAdapterManagement.sendDtmfTone

sendRealTimeText

Enviar texto em tempo real

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

Valor de Propriedade

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

Herdado deCallWithChatAdapterManagement.sendRealTimeText

Detalhes do Método Herdado

addParticipant(CommunicationUserIdentifier)

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

Parâmetros

Devoluções

Promise<void>

Herdado deCallWithChatAdapterManagement.addParticipant

addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

Adiciona um novo Participante à chamada.

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

Parâmetros

participant
PhoneNumberIdentifier

Devoluções

Promise<void>

Herdado deCallWithChatAdapterManagement.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 CallWithChatAdapterManagement.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ósito.

herdado de CallWithChatAdapterManagement.createStreamView

createTogetherModeStreamView(TogetherModeStreamOptions)

Crie a visualização html para um fluxo togethermode.

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 deCallWithChatAdapterManagement.createTogetherModeStreamView

deleteMessage(string)

Exclua uma mensagem no thread.

function deleteMessage(messageId: string): Promise<void>

Parâmetros

messageId

string

Devoluções

Promise<void>

herdado de CallWithChatAdapterManagement.deleteMessage

dispose()

Elimine o composto

function dispose()

Herdado deDisposable_2.dispose

disposeLocalVideoStreamView()

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

function disposeLocalVideoStreamView(): Promise<void>

Devoluções

Promise<void>

Herdado deCallWithChatAdapterManagement.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 deCallWithChatAdapterManagement.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 deCallWithChatAdapterManagement.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ósito.

herdado de CallWithChatAdapterManagement.disposeStreamView

disposeTogetherModeStreamView()

Descarte a exibição html para um fluxo togethermode.

function disposeTogetherModeStreamView(): Promise<void>

Devoluções

Promise<void>

Observações

Este método é implementado para compósitos

Herdado deCallWithChatAdapterManagement.disposeTogetherModeStreamView

downloadResourceToCache(ResourceDetails)

function downloadResourceToCache(resourceDetails: ResourceDetails): Promise<void>

Parâmetros

resourceDetails
ResourceDetails

Devoluções

Promise<void>

Herdado deCallWithChatAdapterManagement.downloadResourceToCache

fetchInitialData()

Buscar o estado inicial para o adaptador de bate-papo.

Executa a busca mínima necessária para os métodos ChatComposite e API.

function fetchInitialData(): Promise<void>

Devoluções

Promise<void>

herdado de CallWithChatAdapterManagement.fetchInitialData

getState()

Obter o estado atual

function getState(): CallWithChatAdapterState

Devoluções

herdado de AdapterState.getState

holdCall()

Coloca a chamada em um localhold.

function holdCall(): Promise<void>

Devoluções

Promise<void>

Herdado deCallWithChatAdapterManagement.holdCall

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 | Call

Parâmetros

microphoneOn

boolean

Se o microfone está inicialmente ativado

Devoluções

undefined | Call

herdado deCallWithChatAdapterManagement.joinCall

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 | Call

Parâmetros

options
JoinCallOptions

param para definir microfone / câmera inicialmente on / off / use o estado de pré-chamada.

Devoluções

undefined | Call

herdado deCallWithChatAdapterManagement.joinCall

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 deCallWithChatAdapterManagement.leaveCall

loadPreviousChatMessages(number)

Carregue mais mensagens anteriores no histórico de conversas de chat.

function loadPreviousChatMessages(messagesToLoad: number): Promise<boolean>

Parâmetros

messagesToLoad

number

Devoluções

Promise<boolean>

Observações

Este método é geralmente usado para controlar a busca incremental/rolagem infinita.

herdado deCallWithChatAdapterManagement.loadPreviousChatMessages

lowerHand()

Mão inferior para o usuário local.

function lowerHand(): Promise<void>

Devoluções

Promise<void>

Herdado deCallWithChatAdapterManagement.lowerHand

mute()

Silencie o usuário atual durante a chamada ou desative o microfone localmente.

function mute(): Promise<void>

Devoluções

Promise<void>

herdado de CallWithChatAdapterManagement.mute

muteAllRemoteParticipants()

Silenciar um participante

function muteAllRemoteParticipants(): Promise<void>

Devoluções

Promise<void>

Herdado deCallWithChatAdapterManagement.muteAllRemoteParticipants

muteParticipant(string)

Silenciar um participante

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

Parâmetros

userId

string

Devoluções

Promise<void>

Herdado deCallWithChatAdapterManagement.muteParticipant

off("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)

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

Parâmetros

event

"breakoutRoomsUpdated"

herdado deCallWithChatAdapterSubscriptions.off

off("callEnded", CallEndedListener)

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

Parâmetros

event

"callEnded"

herdado deCallWithChatAdapterSubscriptions.off

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

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

Parâmetros

event

"callError"

listener

(e: AdapterError) => void

herdado deCallWithChatAdapterSubscriptions.off

off("callIdChanged", CallIdChangedListener)

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

Parâmetros

event

"callIdChanged"

herdado deCallWithChatAdapterSubscriptions.off

off("callParticipantsJoined", ParticipantsJoinedListener)

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

Parâmetros

event

"callParticipantsJoined"

herdado deCallWithChatAdapterSubscriptions.off

off("callParticipantsLeft", ParticipantsLeftListener)

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

Parâmetros

event

"callParticipantsLeft"

herdado deCallWithChatAdapterSubscriptions.off

off("capabilitiesChanged", CapabilitiesChangedListener)

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

Parâmetros

event

"capabilitiesChanged"

herdado deCallWithChatAdapterSubscriptions.off

off("captionsReceived", CaptionsReceivedListener)

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

Parâmetros

event

"captionsReceived"

herdado deCallWithChatAdapterSubscriptions.off

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

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

Parâmetros

event

"chatError"

listener

(e: AdapterError) => void

herdado deCallWithChatAdapterSubscriptions.off

off("chatInitialized", ChatInitializedListener)

function off(event: "chatInitialized", listener: ChatInitializedListener)

Parâmetros

event

"chatInitialized"

herdado deCallWithChatAdapterSubscriptions.off

off("chatParticipantsAdded", ParticipantsAddedListener)

function off(event: "chatParticipantsAdded", listener: ParticipantsAddedListener)

Parâmetros

event

"chatParticipantsAdded"

herdado deCallWithChatAdapterSubscriptions.off

off("chatParticipantsRemoved", ParticipantsRemovedListener)

function off(event: "chatParticipantsRemoved", listener: ParticipantsRemovedListener)

Parâmetros

event

"chatParticipantsRemoved"

herdado deCallWithChatAdapterSubscriptions.off

off("displayNameChanged", DisplayNameChangedListener)

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

Parâmetros

event

"displayNameChanged"

herdado deCallWithChatAdapterSubscriptions.off

off("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)

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

Parâmetros

event

"isCaptionLanguageChanged"

herdado deCallWithChatAdapterSubscriptions.off

off("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)

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

Parâmetros

event

"isCaptionsActiveChanged"

herdado deCallWithChatAdapterSubscriptions.off

off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

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

Parâmetros

event

"isLocalScreenSharingActiveChanged"

herdado deCallWithChatAdapterSubscriptions.off

off("isMutedChanged", IsMutedChangedListener)

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

Parâmetros

event

"isMutedChanged"

herdado deCallWithChatAdapterSubscriptions.off

off("isSpeakingChanged", IsSpeakingChangedListener)

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

Parâmetros

event

"isSpeakingChanged"

herdado deCallWithChatAdapterSubscriptions.off

off("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)

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

Parâmetros

event

"isSpokenLanguageChanged"

herdado deCallWithChatAdapterSubscriptions.off

off("messageDeleted", MessageReceivedListener)

function off(event: "messageDeleted", listener: MessageReceivedListener)

Parâmetros

event

"messageDeleted"

herdado deCallWithChatAdapterSubscriptions.off

off("messageEdited", MessageReceivedListener)

function off(event: "messageEdited", listener: MessageReceivedListener)

Parâmetros

event

"messageEdited"

herdado deCallWithChatAdapterSubscriptions.off

off("messageRead", MessageReadListener)

function off(event: "messageRead", listener: MessageReadListener)

Parâmetros

event

"messageRead"

herdado deCallWithChatAdapterSubscriptions.off

off("messageReceived", MessageReceivedListener)

function off(event: "messageReceived", listener: MessageReceivedListener)

Parâmetros

event

"messageReceived"

herdado deCallWithChatAdapterSubscriptions.off

off("messageSent", MessageReceivedListener)

function off(event: "messageSent", listener: MessageReceivedListener)

Parâmetros

event

"messageSent"

herdado deCallWithChatAdapterSubscriptions.off

off("realTimeTextReceived", RealTimeTextReceivedListener)

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

Parâmetros

event

"realTimeTextReceived"

herdado deCallWithChatAdapterSubscriptions.off

off("selectedMicrophoneChanged", PropertyChangedEvent)

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

Parâmetros

event

"selectedMicrophoneChanged"

herdado deCallWithChatAdapterSubscriptions.off

off("selectedSpeakerChanged", PropertyChangedEvent)

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

Parâmetros

event

"selectedSpeakerChanged"

herdado deCallWithChatAdapterSubscriptions.off

off("spotlightChanged", SpotlightChangedListener)

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

Parâmetros

event

"spotlightChanged"

herdado deCallWithChatAdapterSubscriptions.off

offStateChange((state: CallWithChatAdapterState) => void)

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

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

Parâmetros

handler

(state: CallWithChatAdapterState) => void

herdado de AdapterState.offStateChange

on("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)

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

Parâmetros

event

"breakoutRoomsUpdated"

herdado deCallWithChatAdapterSubscriptions.on

on("callEnded", CallEndedListener)

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

Parâmetros

event

"callEnded"

herdado deCallWithChatAdapterSubscriptions.on

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

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

Parâmetros

event

"callError"

listener

(e: AdapterError) => void

herdado deCallWithChatAdapterSubscriptions.on

on("callIdChanged", CallIdChangedListener)

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

Parâmetros

event

"callIdChanged"

herdado deCallWithChatAdapterSubscriptions.on

on("callParticipantsJoined", ParticipantsJoinedListener)

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

Parâmetros

event

"callParticipantsJoined"

herdado deCallWithChatAdapterSubscriptions.on

on("callParticipantsLeft", ParticipantsLeftListener)

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

Parâmetros

event

"callParticipantsLeft"

herdado deCallWithChatAdapterSubscriptions.on

on("capabilitiesChanged", CapabilitiesChangedListener)

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

Parâmetros

event

"capabilitiesChanged"

herdado deCallWithChatAdapterSubscriptions.on

on("captionsReceived", CaptionsReceivedListener)

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

Parâmetros

event

"captionsReceived"

herdado deCallWithChatAdapterSubscriptions.on

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

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

Parâmetros

event

"chatError"

listener

(e: AdapterError) => void

herdado deCallWithChatAdapterSubscriptions.on

on("chatInitialized", ChatInitializedListener)

function on(event: "chatInitialized", listener: ChatInitializedListener)

Parâmetros

event

"chatInitialized"

herdado deCallWithChatAdapterSubscriptions.on

on("chatParticipantsAdded", ParticipantsAddedListener)

function on(event: "chatParticipantsAdded", listener: ParticipantsAddedListener)

Parâmetros

event

"chatParticipantsAdded"

herdado deCallWithChatAdapterSubscriptions.on

on("chatParticipantsRemoved", ParticipantsRemovedListener)

function on(event: "chatParticipantsRemoved", listener: ParticipantsRemovedListener)

Parâmetros

event

"chatParticipantsRemoved"

herdado deCallWithChatAdapterSubscriptions.on

on("displayNameChanged", DisplayNameChangedListener)

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

Parâmetros

event

"displayNameChanged"

herdado deCallWithChatAdapterSubscriptions.on

on("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)

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

Parâmetros

event

"isCaptionLanguageChanged"

herdado deCallWithChatAdapterSubscriptions.on

on("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)

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

Parâmetros

event

"isCaptionsActiveChanged"

herdado deCallWithChatAdapterSubscriptions.on

on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

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

Parâmetros

event

"isLocalScreenSharingActiveChanged"

herdado deCallWithChatAdapterSubscriptions.on

on("isMutedChanged", IsMutedChangedListener)

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

Parâmetros

event

"isMutedChanged"

herdado deCallWithChatAdapterSubscriptions.on

on("isSpeakingChanged", IsSpeakingChangedListener)

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

Parâmetros

event

"isSpeakingChanged"

herdado deCallWithChatAdapterSubscriptions.on

on("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)

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

Parâmetros

event

"isSpokenLanguageChanged"

herdado deCallWithChatAdapterSubscriptions.on

on("messageDeleted", MessageReceivedListener)

function on(event: "messageDeleted", listener: MessageReceivedListener)

Parâmetros

event

"messageDeleted"

herdado deCallWithChatAdapterSubscriptions.on

on("messageEdited", MessageReceivedListener)

function on(event: "messageEdited", listener: MessageReceivedListener)

Parâmetros

event

"messageEdited"

herdado deCallWithChatAdapterSubscriptions.on

on("messageRead", MessageReadListener)

function on(event: "messageRead", listener: MessageReadListener)

Parâmetros

event

"messageRead"

herdado deCallWithChatAdapterSubscriptions.on

on("messageReceived", MessageReceivedListener)

function on(event: "messageReceived", listener: MessageReceivedListener)

Parâmetros

event

"messageReceived"

herdado deCallWithChatAdapterSubscriptions.on

on("messageSent", MessageReceivedListener)

function on(event: "messageSent", listener: MessageReceivedListener)

Parâmetros

event

"messageSent"

herdado deCallWithChatAdapterSubscriptions.on

on("realTimeTextReceived", RealTimeTextReceivedListener)

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

Parâmetros

event

"realTimeTextReceived"

herdado deCallWithChatAdapterSubscriptions.on

on("selectedMicrophoneChanged", PropertyChangedEvent)

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

Parâmetros

event

"selectedMicrophoneChanged"

herdado deCallWithChatAdapterSubscriptions.on

on("selectedSpeakerChanged", PropertyChangedEvent)

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

Parâmetros

event

"selectedSpeakerChanged"

herdado deCallWithChatAdapterSubscriptions.on

on("spotlightChanged", SpotlightChangedListener)

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

Parâmetros

event

"spotlightChanged"

herdado deCallWithChatAdapterSubscriptions.on

onReactionClick(Reaction)

Enviar Reação para a reunião em curso.

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

Parâmetros

reaction
Reaction

Um valor do tipo <xref:%40azure%2Fcommunication-calling%23Reaction>

Devoluções

Promise<void>

Herdado deCallWithChatAdapterManagement.onReactionClick

onStateChange((state: CallWithChatAdapterState) => void)

Inscreve o manipulador em eventos stateChanged.

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

Parâmetros

handler

(state: CallWithChatAdapterState) => void

herdado de AdapterState.onStateChange

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 deCallWithChatAdapterManagement.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 CallWithChatAdapterManagement.queryMicrophones

querySpeakers()

Consulta de dispositivos de microfone 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 doCallWithChatAdapterManagement.querySpeakers

raiseHand()

Levante a mão para o usuário local.

function raiseHand(): Promise<void>

Devoluções

Promise<void>

Herdado deCallWithChatAdapterManagement.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 CallWithChatAdapterManagement.removeParticipant

removeParticipant(string)

Remover um participante de uma Chamada.

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

Parâmetros

userId

string

UserId do participante a remover.

Devoluções

Promise<void>

herdado de CallWithChatAdapterManagement.removeParticipant

removeResourceFromCache(ResourceDetails)

function removeResourceFromCache(resourceDetails: ResourceDetails)

Parâmetros

resourceDetails
ResourceDetails

Herdado deCallWithChatAdapterManagement.removeResourceFromCache

resumeCall()

Retoma a chamada de um estado LocalHold.

function resumeCall(): Promise<void>

Devoluções

Promise<void>

Herdado deCallWithChatAdapterManagement.resumeCall

returnFromBreakoutRoom()

Chamada de retorno à origem da sala de breakout

function returnFromBreakoutRoom(): Promise<void>

Devoluções

Promise<void>

Herdado deCallWithChatAdapterManagement.returnFromBreakoutRoom

sendMessage(string, SendMessageOptions)

Envie uma mensagem no tópico.

function sendMessage(content: string, options?: SendMessageOptions): Promise<void>

Parâmetros

content

string

Devoluções

Promise<void>

herdado de CallWithChatAdapterManagement.sendMessage

sendReadReceipt(string)

Envie um recibo de leitura para uma mensagem.

function sendReadReceipt(chatMessageId: string): Promise<void>

Parâmetros

chatMessageId

string

Devoluções

Promise<void>

herdado de CallWithChatAdapterManagement.sendReadReceipt

sendTypingIndicator()

Enviar indicador de digitação no thread.

function sendTypingIndicator(): Promise<void>

Devoluções

Promise<void>

herdado de CallWithChatAdapterManagement.sendTypingIndicator

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 CallWithChatAdapterManagement.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 deCallWithChatAdapterManagement.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 CallWithChatAdapterManagement.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 CallWithChatAdapterManagement.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 deCallWithChatAdapterManagement.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 deCallWithChatAdapterManagement.setTogetherModeSceneSize

startCall((CommunicationUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], StartCallOptions)

Inicie a chamada.

function startCall(participants: (CommunicationUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], options?: StartCallOptions): undefined | Call

Parâmetros

participants

(CommunicationUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[]

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

Devoluções

undefined | Call

herdado doCallWithChatAdapterManagement.startCall

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 participar

Devoluções

undefined | Call

herdado doCallWithChatAdapterManagement.startCall

startCamera(VideoStreamOptions)

Inicie a câmara.

Esse método começará a renderizar uma 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>

Devoluções

Promise<void>

herdado de CallWithChatAdapterManagement.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 deCallWithChatAdapterManagement.startCaptions

startNoiseSuppressionEffect()

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

function startNoiseSuppressionEffect(): Promise<void>

Devoluções

Promise<void>

Herdado deCallWithChatAdapterManagement.startNoiseSuppressionEffect

startScreenShare()

Comece a partilhar o ecrã durante uma chamada.

function startScreenShare(): Promise<void>

Devoluções

Promise<void>

herdado de CallWithChatAdapterManagement.startScreenShare

startSpotlight(string[])

Comece em destaque

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

Parâmetros

userIds

string[]

Devoluções

Promise<void>

Herdado deCallWithChatAdapterManagement.startSpotlight

startTogetherMode()

Iniciar o modo de conjunto.

function startTogetherMode(): Promise<void>

Devoluções

Promise<void>

Observações

Este método é implementado para compósitos

Herdado deCallWithChatAdapterManagement.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 deCallWithChatAdapterManagement.startVideoBackgroundEffect

stopAllSpotlight()

Pare todos os holofotes

function stopAllSpotlight(): Promise<void>

Devoluções

Promise<void>

Herdado deCallWithChatAdapterManagement.stopAllSpotlight

stopCamera()

Pare a câmera.

Esse 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>

Devoluções

Promise<void>

herdado de CallWithChatAdapterManagement.stopCamera

stopCaptions(StopCaptionsAdapterOptions)

Diversão para parar legendas

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

Parâmetros

Devoluções

Promise<void>

Herdado deCallWithChatAdapterManagement.stopCaptions

stopNoiseSuppressionEffect()

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

function stopNoiseSuppressionEffect(): Promise<void>

Devoluções

Promise<void>

Herdado deCallWithChatAdapterManagement.stopNoiseSuppressionEffect

stopScreenShare()

Pare de compartilhar a tela.

function stopScreenShare(): Promise<void>

Devoluções

Promise<void>

herdado de CallWithChatAdapterManagement.stopScreenShare

stopSpotlight(string[])

Pare o holofote

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

Parâmetros

userIds

string[]

Devoluções

Promise<void>

Herdado deCallWithChatAdapterManagement.stopSpotlight

stopVideoBackgroundEffects()

Pare o efeito de fundo do vídeo.

function stopVideoBackgroundEffects(): Promise<void>

Devoluções

Promise<void>

Herdado deCallWithChatAdapterManagement.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 deCallWithChatAdapterManagement.submitSurvey

unmute()

Desative o mudo do usuário atual durante a chamada ou ative o microfone localmente.

function unmute(): Promise<void>

Devoluções

Promise<void>

herdado de CallWithChatAdapterManagement.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 deCallWithChatAdapterManagement.updateBackgroundPickerImages

updateMessage(string, string, Record<string, string>)

Atualizar o conteúdo de uma mensagem.

function updateMessage(messageId: string, content: string, options?: Record<string, string>): Promise<void>

Parâmetros

messageId

string

content

string

options

Record<string, string>

Devoluções

Promise<void>

herdado de CallWithChatAdapterManagement.updateMessage

updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)

Atualizar o efeito de fundo de vídeo selecionado

function updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect)

Parâmetros

selectedVideoBackground
VideoBackgroundEffect

Herdado deCallWithChatAdapterManagement.updateSelectedVideoBackgroundEffect