CallAdapterCallOperations interface

Pacote:

@azure/communication-react

Funcionalidade para gerenciar a chamada atual.

Propriedades

sendRealTimeText

Enviar texto em tempo real

Métodos

addParticipant(CommunicationUserIdentifier)
addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)	Adicione um participante à chamada.
createStreamView(string, VideoStreamOptions)	Crie o modo de exibição html para um fluxo.
createTogetherModeStreamView(TogetherModeStreamOptions)	Crie o modo de exibição html para um fluxo.
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 o modo de exibição html para um fluxo.
forbidAudio(string[])	Proibir o áudio dos participantes da reunião do Teams por suas 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 o vídeo dos participantes da reunião do Teams por suas IDs de usuário.
holdCall()	Segura a chamada.
leaveCall(boolean)	Deixe a chamada
lowerHand()	mão inferior para o usuário atual
mute()	Ativar mudo do usuário atual durante a chamada ou desabilitar o microfone localmente
muteAllRemoteParticipants()	Silenciar todos os participantes
muteParticipant(string)	Silenciar um participante
onReactionClick(Reaction)	Enviar emoji de reação
permitAudio(string[])	Permitir áudio dos participantes da reunião do Teams por suas IDs de usuário.
permitOthersAudio()	Permitir áudio de reunião do Teams.
permitOthersVideo()	Permitir vídeo de reunião do Teams.
permitVideo(string[])	Permitir áudio dos participantes da reunião do Teams por suas IDs de usuário.
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()	Retorno à chamada de origem da sala de descanso
sendDtmfTone(DtmfTone)	enviar o tom dtmf para outro participante em uma chamada PSTN 1:1
setCaptionLanguage(string)	Função para definir o idioma da legenda
setSpokenLanguage(string)	Função para definir o idioma falado
setTogetherModeSceneSize(number, number)	Recalcule as posições dos bancos para o modo juntos.
startCamera(VideoStreamOptions)	Iniciar a câmera Este método começará a renderizar um modo de exibição de câmera local quando a chamada não estiver ativa
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[])	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âmera Este 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()	Pare o efeito de supressão de ruído.
stopScreenShare()	Parar de compartilhar a tela
stopSpotlight(string[])	Pare de destacar participantes locais e remotos por seus IDs de usuário. Se nenhuma matriz de IDs de usuário for passada, a ação será executada no participante local.
stopVideoBackgroundEffects()	Pare o efeito de fundo do vídeo.
submitSurvey(CallSurvey)	Enviar o resultado da pesquisa de fim de chamada
unmute()	Desativar o usuário atual durante a chamada ou habilitar o microfone localmente
updateBackgroundPickerImages(VideoBackgroundImage[])	Substitua as imagens do seletor de plano de fundo para o efeito de substituição do plano de fundo.
updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)	Atualize o efeito de plano de fundo do vídeo selecionado.

Detalhes da propriedade

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)

Adicione um participante à chamada.

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

Parâmetros

participant

PhoneNumberIdentifier

options

AddPhoneNumberOptions

Retornos

Promise<void>

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

function createTogetherModeStreamView(options?: TogetherModeStreamOptions): Promise<void | TogetherModeStreamViewResult>

Parâmetros

options

TogetherModeStreamOptions

Opções para controlar como os fluxos de vídeo são renderizados <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Retornos

Promise<void | TogetherModeStreamViewResult>

Comentários

Esse método é implementado para composição

disposeLocalVideoStreamView()

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

function disposeLocalVideoStreamView(): Promise<void>

Retornos

Promise<void>

disposeRemoteVideoStreamView(string)

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

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

Parâmetros

remoteUserId

string

ID do participante a ser descartado

Retornos

Promise<void>

disposeScreenShareStreamView(string)

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

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

Parâmetros

remoteUserId

string

ID do participante para o qual descartar a exibição de fluxo de compartilhamento de tela.

Retornos

Promise<void>

Comentários

Este método é implementado para compostos

disposeStreamView(string, VideoStreamOptions)

Aviso

Essa API foi preterida.

Use disposeRemoteVideoStreamView, disposeLocalVideoStreamView and disposeRemoteVideoStreamView instead.

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

function disposeStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void>

Parâmetros

remoteUserId

string

Id do participante a ser renderizado, deixe-o indefinido para descartar a exibição da câmera local

options

VideoStreamOptions

Opções para controlar como os fluxos de vídeo são renderizados <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Retornos

Promise<void>

Comentários

Esse método é implementado para composição

disposeTogetherModeStreamView()

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

function disposeTogetherModeStreamView(): Promise<void>

Retornos

Promise<void>

Comentários

Esse método é implementado para composição

forbidAudio(string[])

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

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

Parâmetros

userIds

string[]

Retornos

Promise<void>

forbidOthersAudio()

Proibir o áudio da reunião do Teams.

function forbidOthersAudio(): Promise<void>

Retornos

Promise<void>

forbidOthersVideo()

Proibir vídeo de reunião do Teams.

function forbidOthersVideo(): Promise<void>

Retornos

Promise<void>

forbidVideo(string[])

Proibir o vídeo dos participantes da reunião do Teams por suas IDs de usuário.

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

Parâmetros

userIds

string[]

Retornos

Promise<void>

holdCall()

Segura a chamada.

function holdCall(): Promise<void>

Retornos

Promise<void>

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>

lowerHand()

mão inferior para o usuário atual

function lowerHand(): Promise<void>

Retornos

Promise<void>

mute()

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

function mute(): Promise<void>

Retornos

Promise<void>

muteAllRemoteParticipants()

Silenciar todos os participantes

function muteAllRemoteParticipants(): Promise<void>

Retornos

Promise<void>

muteParticipant(string)

Silenciar um participante

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

Parâmetros

userId

string

ID do participante para silenciar

Retornos

Promise<void>

onReactionClick(Reaction)

Enviar emoji de reação

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

Parâmetros

reaction

Reaction

Retornos

Promise<void>

permitAudio(string[])

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

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

Parâmetros

userIds

string[]

Retornos

Promise<void>

permitOthersAudio()

Permitir áudio de reunião do Teams.

function permitOthersAudio(): Promise<void>

Retornos

Promise<void>

permitOthersVideo()

Permitir vídeo de reunião do Teams.

function permitOthersVideo(): Promise<void>

Retornos

Promise<void>

permitVideo(string[])

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

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

Parâmetros

userIds

string[]

Retornos

Promise<void>

raiseHand()

Levante a mão para o usuário atual

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 da chamada.

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

Parâmetros

userId

string

ID do participante a ser removido

Retornos

Promise<void>

resumeCall()

Retoma a chamada de um LocalHold estado.

function resumeCall(): Promise<void>

Retornos

Promise<void>

returnFromBreakoutRoom()

Retorno à chamada de origem da sala de descanso

function returnFromBreakoutRoom(): Promise<void>

Retornos

Promise<void>

sendDtmfTone(DtmfTone)

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

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

Parâmetros

dtmfTone

DtmfTone

Retornos

Promise<void>

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>

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

startCamera(VideoStreamOptions)

Iniciar a câmera Este método começará a renderizar um modo de exibição de câmera local quando a chamada não estiver ativa

function startCamera(options?: VideoStreamOptions): Promise<void>

Parâmetros

options

VideoStreamOptions

Opções para controlar como os fluxos de vídeo são renderizados <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Retornos

Promise<void>

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

Inicie o destaque para participantes locais e remotos por seus IDs de usuário. Se nenhuma matriz de IDs de usuário for passada, a ação será executada no participante local.

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

Parâmetros

userIds

string[]

Retornos

Promise<void>

startTogetherMode()

Modo Iniciar Juntos.

function startTogetherMode(): Promise<void>

Retornos

Promise<void>

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

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

function stopCamera(): Promise<void>

Retornos

Promise<void>

stopCaptions(StopCaptionsAdapterOptions)

Função para parar legendas

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

Parâmetros

options

StopCaptionsAdapterOptions

Retornos

Promise<void>

stopNoiseSuppressionEffect()

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

function stopNoiseSuppressionEffect(): Promise<void>

Retornos

Promise<void>

stopScreenShare()

Parar de compartilhar a tela

function stopScreenShare(): Promise<void>

Retornos

Promise<void>

stopSpotlight(string[])

Pare de destacar participantes locais e remotos por seus IDs de usuário. Se nenhuma matriz de IDs de usuário for passada, a ação será executada no participante local.

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

Parâmetros

userIds

string[]

Retornos

Promise<void>

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

Desativar o usuário atual durante a chamada ou habilitar 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.

updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)

Atualize o efeito de plano de fundo do vídeo selecionado.

function updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect)

Parâmetros

selectedVideoBackground

VideoBackgroundEffect