CallWithChatAdapterManagement interface
Funcionalidade para gerenciar a chamada atual com chat.
Propriedades
| forbid |
Proíbe áudio para os IDs de usuário especificados. |
| forbid |
proíbe áudio para participantes de reuniões do Teams, exceto o usuário local. |
| forbid |
proíbe o vídeo para participantes da reunião do Teams, exceto o usuário local. |
| forbid |
Proíbe vídeo para os IDs de usuário especificados. |
| permit |
Permite áudio para os IDs de usuário especificados. |
| permit |
permite áudio para participantes da reunião do Teams, exceto o usuário local. |
| permit |
permite vídeo para participantes da reunião do Teams, exceto o usuário local. |
| permit |
Permite vídeo para os IDs de usuário especificados. |
| send |
Enviar tom DTMF para outro participante da chamada em chamadas 1:1 |
| send |
Enviar texto em tempo real |
Métodos
| add |
|
| add |
Adiciona um novo Participante à chamada. |
| ask |
Peça permissões de dispositivos. |
| create |
Crie o modo de exibição html para um fluxo. |
| create |
Crie a visualização html para um fluxo togethermode. |
| delete |
Exclua uma mensagem no thread. |
| dispose |
Descartar a visualização html para um fluxo de vídeo local |
| dispose |
Descartar a visualização html para um fluxo de vídeo remoto |
| dispose |
Descartar a visualização html para um fluxo de compartilhamento de tela |
| dispose |
Descarte o modo de exibição html para um fluxo. |
| dispose |
Descarte a visualização html para um fluxo togethermode. |
| download |
|
| fetch |
Buscar o estado inicial para o adaptador de Chat. Executa a busca mínima necessária para métodos de ChatComposite e API. |
| hold |
Coloca a chamada em um localhold. |
| join |
Ingresse a chamada com o microfone inicialmente ativado/desativado. |
| join |
Participe da chamada com o saco de opções para definir o estado inicial do microfone/câmera ao entrar na chamada true = liga o dispositivo ao entrar na chamada false = desliga o dispositivo ao entrar na chamada 'keep'/undefined = reter o estado de pré-chamada dos dispositivos |
| leave |
Deixe a chamada. |
| load |
Carregue mais mensagens anteriores no histórico de threads de chat. |
| lower |
Mão inferior para usuário local. |
| mute() | Silencie o usuário atual durante a chamada ou desabilite o microfone localmente. |
| mute |
Silenciar um participante |
| mute |
Silenciar um participante |
| on |
Envie a reação à reunião em andamento. |
| query |
Consultar dispositivos de câmera disponíveis. |
| query |
Consultar dispositivos de microfone disponíveis. |
| query |
Consultar dispositivos de microfone disponíveis. |
| raise |
Levante a mão para o usuário local. |
| remove |
Remova um participante da chamada. |
| remove |
Remova um participante de uma chamada. |
| remove |
|
| resume |
Retoma a chamada de um estado LocalHold. |
| return |
Retorno à chamada de origem da sala de descanso |
| send |
Envie uma mensagem no thread. |
| send |
Envie um recibo de leitura para uma mensagem. |
| send |
Enviar indicador de digitação no thread. |
| set |
Defina a câmera a ser usada na chamada. |
| set |
Função para definir o idioma da legenda |
| set |
Defina o microfone a ser usado na chamada. |
| set |
Defina o alto-falante a ser usado na chamada. |
| set |
Função para definir o idioma falado |
| set |
Recalcule as posições dos bancos para o modo juntos. |
| start |
Inicie a chamada. |
| start |
Inicie a chamada. |
| start |
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. |
| start |
Função para iniciar legendas |
| start |
Inicie o efeito de supressão de ruído. |
| start |
Comece a compartilhar a tela durante uma chamada. |
| start |
Iniciar destaque |
| start |
Modo de início em conjunto. |
| start |
Inicie o efeito de fundo do vídeo. |
| stop |
Pare todos os holofotes |
| stop |
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. |
| stop |
Função para parar legendas |
| stop |
Inicie o efeito de supressão de ruído. |
| stop |
Pare de compartilhar a tela. |
| stop |
Pare de holofotes |
| stop |
Pare o efeito de fundo do vídeo. |
| submit |
Enviar o resultado da pesquisa de fim de chamada |
| unmute() | Desative o usuário atual durante a chamada ou habilite o microfone localmente. |
| update |
Substitua as imagens do seletor de plano de fundo para o efeito de substituição do plano de fundo. |
| update |
Atualize um conteúdo de mensagem. |
| update |
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
- participant
- CommunicationUserIdentifier
Retornos
Promise<void>
addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)
Adiciona um novo Participante à chamada.
function addParticipant(participant: PhoneNumberIdentifier, options?: AddPhoneNumberOptions): Promise<void>
Parâmetros
- participant
- PhoneNumberIdentifier
- options
- AddPhoneNumberOptions
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
Promise<void | TogetherModeStreamViewResult>
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
- options
- SendMessageOptions
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
- options
- StartCallOptions
Retornos
undefined | Call
startCall(string[], StartCallOptions)
Inicie a chamada.
function startCall(participants: string[], options?: StartCallOptions): undefined | Call
Parâmetros
- participants
-
string[]
Uma matriz de IDs de participante para ingressar
- options
- StartCallOptions
Retornos
undefined | Call
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
- options
- StopCaptionsAdapterOptions
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
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