Compartilhar via


CallWithChatAdapterManagement interface

Funcionalidade para gerenciar a chamada atual com chat.

Propriedades

forbidAudio

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

forbidOthersAudio

proíbe áudio para participantes de reuniões do Teams, exceto o usuário local.

forbidOthersVideo

proíbe o 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

addParticipant(CommunicationUserIdentifier)
addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

Adiciona um novo Participante à chamada.

askDevicePermission(PermissionConstraints)

Peça permissões de dispositivos.

createStreamView(string, VideoStreamOptions)

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

createTogetherModeStreamView(TogetherModeStreamOptions)

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

deleteMessage(string)

Exclua uma mensagem no thread.

disposeLocalVideoStreamView()

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

disposeRemoteVideoStreamView(string)

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

disposeScreenShareStreamView(string)

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

disposeStreamView(string, VideoStreamOptions)

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

disposeTogetherModeStreamView()

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

downloadResourceToCache(ResourceDetails)
fetchInitialData()

Buscar o estado inicial para o adaptador de Chat.

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

holdCall()

Coloca a chamada em um localhold.

joinCall(boolean)

Ingresse a chamada com o microfone inicialmente ativado/desativado.

joinCall(JoinCallOptions)

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

leaveCall(boolean)

Deixe a chamada.

loadPreviousChatMessages(number)

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

lowerHand()

Mão inferior para usuário local.

mute()

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

muteAllRemoteParticipants()

Silenciar um participante

muteParticipant(string)

Silenciar um participante

onReactionClick(Reaction)

Envie a reação à reunião em andamento.

queryCameras()

Consultar dispositivos de câmera disponíveis.

queryMicrophones()

Consultar dispositivos de microfone disponíveis.

querySpeakers()

Consultar dispositivos de microfone disponíveis.

raiseHand()

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

removeParticipant(CommunicationIdentifier)

Remova um participante da chamada.

removeParticipant(string)

Remova um participante de uma chamada.

removeResourceFromCache(ResourceDetails)
resumeCall()

Retoma a chamada de um estado LocalHold.

returnFromBreakoutRoom()

Retorno à chamada de origem da sala de descanso

sendMessage(string, SendMessageOptions)

Envie uma mensagem no thread.

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 a ser usada na chamada.

setCaptionLanguage(string)

Função para definir o idioma da legenda

setMicrophone(AudioDeviceInfo)

Defina o microfone a ser usado na chamada.

setSpeaker(AudioDeviceInfo)

Defina o alto-falante a ser usado na chamada.

setSpokenLanguage(string)

Função para definir o idioma falado

setTogetherModeSceneSize(number, number)

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

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

Inicie a chamada.

startCall(string[], StartCallOptions)

Inicie a chamada.

startCamera(VideoStreamOptions)

Inicie a câmera.

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 compartilhar a tela durante uma chamada.

startSpotlight(string[])

Iniciar destaque

startTogetherMode()

Modo de início em 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)

Função para parar legendas

stopNoiseSuppressionEffect()

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

stopScreenShare()

Pare de compartilhar a tela.

stopSpotlight(string[])

Pare de holofotes

stopVideoBackgroundEffects()

Pare o efeito de fundo do vídeo.

submitSurvey(CallSurvey)

Enviar o resultado da pesquisa de fim de chamada

unmute()

Desative o usuário atual durante a chamada ou habilite o microfone localmente.

updateBackgroundPickerImages(VideoBackgroundImage[])

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

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

Atualize um conteúdo de mensagem.

updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)

Atualizar o efeito de plano de fundo do vídeo selecionado

Detalhes da propriedade

forbidAudio

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

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

Valor da propriedade

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

forbidOthersAudio

proíbe áudio para participantes de reuniões do Teams, exceto o usuário local.

forbidOthersAudio: () => Promise<void>

Valor da propriedade

() => Promise<void>

forbidOthersVideo

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

forbidOthersVideo: () => Promise<void>

Valor da propriedade

() => Promise<void>

forbidVideo

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

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

Valor da propriedade

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

permitAudio

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

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

Valor da propriedade

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

permitOthersAudio

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

permitOthersAudio: () => Promise<void>

Valor da propriedade

() => Promise<void>

permitOthersVideo

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

permitOthersVideo: () => Promise<void>

Valor da propriedade

() => Promise<void>

permitVideo

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

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

Valor da propriedade

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

sendDtmfTone

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

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

Valor da propriedade

(dtmfTone: DtmfTone) => Promise<void>

sendRealTimeText

Enviar texto em tempo real

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

Valor da propriedade

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

Detalhes do método

addParticipant(CommunicationUserIdentifier)

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

Parâmetros

Retornos

Promise<void>

addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

Adiciona um novo Participante à chamada.

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

Parâmetros

participant
PhoneNumberIdentifier

Retornos

Promise<void>

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.

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.

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>

Retornos

Comentários

Esse método é implementado para composição

deleteMessage(string)

Exclua uma mensagem no thread.

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

Parâmetros

messageId

string

Retornos

Promise<void>

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)

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.

disposeTogetherModeStreamView()

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

function disposeTogetherModeStreamView(): Promise<void>

Retornos

Promise<void>

Comentários

Esse método é implementado para composição

downloadResourceToCache(ResourceDetails)

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

Parâmetros

resourceDetails
ResourceDetails

Retornos

Promise<void>

fetchInitialData()

Buscar o estado inicial para o adaptador de Chat.

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

function fetchInitialData(): Promise<void>

Retornos

Promise<void>

holdCall()

Coloca a chamada em um localhold.

function holdCall(): Promise<void>

Retornos

Promise<void>

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

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>

loadPreviousChatMessages(number)

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

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

Parâmetros

messagesToLoad

number

Retornos

Promise<boolean>

Comentários

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

lowerHand()

Mão inferior para usuário local.

function lowerHand(): Promise<void>

Retornos

Promise<void>

mute()

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

function mute(): Promise<void>

Retornos

Promise<void>

muteAllRemoteParticipants()

Silenciar um participante

function muteAllRemoteParticipants(): Promise<void>

Retornos

Promise<void>

muteParticipant(string)

Silenciar um participante

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

Parâmetros

userId

string

Retornos

Promise<void>

onReactionClick(Reaction)

Envie a reação à reunião em andamento.

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

Parâmetros

reaction
Reaction

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

Retornos

Promise<void>

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

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

querySpeakers()

Consultar dispositivos de microfone 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()

raiseHand()

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

function raiseHand(): Promise<void>

Retornos

Promise<void>

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>

removeParticipant(string)

Remova um participante de uma chamada.

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

Parâmetros

userId

string

UserId do participante a ser removido.

Retornos

Promise<void>

removeResourceFromCache(ResourceDetails)

function removeResourceFromCache(resourceDetails: ResourceDetails)

Parâmetros

resourceDetails
ResourceDetails

resumeCall()

Retoma a chamada de um estado LocalHold.

function resumeCall(): Promise<void>

Retornos

Promise<void>

returnFromBreakoutRoom()

Retorno à chamada de origem da sala de descanso

function returnFromBreakoutRoom(): Promise<void>

Retornos

Promise<void>

sendMessage(string, SendMessageOptions)

Envie uma mensagem no thread.

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

Parâmetros

content

string

Retornos

Promise<void>

sendReadReceipt(string)

Envie um recibo de leitura para uma mensagem.

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

Parâmetros

chatMessageId

string

Retornos

Promise<void>

sendTypingIndicator()

Enviar indicador de digitação no thread.

function sendTypingIndicator(): Promise<void>

Retornos

Promise<void>

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>

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>

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>

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>

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

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)[]

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

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

Retornos

undefined | Call

startCamera(VideoStreamOptions)

Inicie a câmera.

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>

Retornos

Promise<void>

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>

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>

startSpotlight(string[])

Iniciar destaque

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

Parâmetros

userIds

string[]

Retornos

Promise<void>

startTogetherMode()

Modo de início em conjunto.

function startTogetherMode(): Promise<void>

Retornos

Promise<void>

Comentários

Esse método é implementado para composição

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>

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>

Retornos

Promise<void>

stopCaptions(StopCaptionsAdapterOptions)

Função para parar legendas

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

Parâmetros

Retornos

Promise<void>

stopNoiseSuppressionEffect()

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

function stopNoiseSuppressionEffect(): Promise<void>

Retornos

Promise<void>

stopScreenShare()

Pare de compartilhar a tela.

function stopScreenShare(): Promise<void>

Retornos

Promise<void>

stopSpotlight(string[])

Pare de holofotes

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

Parâmetros

userIds

string[]

Retornos

Promise<void>

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>

unmute()

Desative o usuário atual durante a chamada ou habilite o microfone localmente.

function unmute(): Promise<void>

Retornos

Promise<void>

updateBackgroundPickerImages(VideoBackgroundImage[])

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

function updateBackgroundPickerImages(backgroundImages: VideoBackgroundImage[])

Parâmetros

backgroundImages

VideoBackgroundImage[]

Matriz de imagens de fundo personalizadas.

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

Atualize um conteúdo de mensagem.

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

Parâmetros

messageId

string

content

string

options

Record<string, string>

Retornos

Promise<void>

updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)

Atualizar o efeito de plano de fundo do vídeo selecionado

function updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect)

Parâmetros

selectedVideoBackground
VideoBackgroundEffect