CallAdapterCallOperations interface

Paquete:

@azure/communication-react

Funcionalidad para administrar la llamada actual.

Propiedades

sendRealTimeText

Enviar texto en tiempo real

Métodos

addParticipant(CommunicationUserIdentifier)
addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)	Agregue un participante a la llamada.
createStreamView(string, VideoStreamOptions)	Cree la vista html para una secuencia.
createTogetherModeStreamView(TogetherModeStreamOptions)	Cree la vista html para una secuencia.
disposeLocalVideoStreamView()	Eliminación de la vista html para una secuencia de vídeo local
disposeRemoteVideoStreamView(string)	Eliminación de la vista html para una transmisión de vídeo remota
disposeScreenShareStreamView(string)	Eliminación de la vista html para una secuencia de uso compartido de pantalla
disposeStreamView(string, VideoStreamOptions)	Elimine la vista html de una secuencia.
disposeTogetherModeStreamView()	Elimine la vista html de una secuencia.
forbidAudio(string[])	Prohibir el audio de los asistentes a la reunión de Teams por sus identificadores de usuario.
forbidOthersAudio()	Prohibir el audio de la reunión de Teams.
forbidOthersVideo()	Prohibir el vídeo de la reunión de Teams.
forbidVideo(string[])	Prohibir el vídeo de los asistentes a la reunión de Teams por sus identificadores de usuario.
holdCall()	Mantiene la llamada.
leaveCall(boolean)	Dejar la llamada
lowerHand()	Manecilla inferior para el usuario actual
mute()	Silenciar al usuario actual durante la llamada o deshabilitar el micrófono localmente
muteAllRemoteParticipants()	Silenciar a todos los participantes
muteParticipant(string)	Silenciar a un participante
onReactionClick(Reaction)	Enviar emoji de reacción
permitAudio(string[])	Permitir que los asistentes a la reunión de Teams escuchen con sus identificadores de usuario.
permitOthersAudio()	Permitir el audio de la reunión de los equipos.
permitOthersVideo()	Vídeo de la reunión de los equipos de permisos.
permitVideo(string[])	Permitir que los asistentes a la reunión de Teams escuchen con sus identificadores de usuario.
raiseHand()	Levantar la mano para el usuario actual
removeParticipant(CommunicationIdentifier)	Quite un participante de la llamada.
removeParticipant(string)	Quite un participante de la llamada.
resumeCall()	Reanuda la llamada desde un LocalHold estado.
returnFromBreakoutRoom()	Volver a la llamada de origen de la sala para grupos pequeños
sendDtmfTone(DtmfTone)	enviar tono DTMF a otro participante en una llamada RTC 1:1
setCaptionLanguage(string)	Función para establecer el idioma de los subtítulos
setSpokenLanguage(string)	Función para configurar el idioma hablado
setTogetherModeSceneSize(number, number)	Vuelva a calcular las posiciones de los asientos para el modo juntos.
startCamera(VideoStreamOptions)	Iniciar la cámara Este método iniciará la representación de una vista de cámara local cuando la llamada no esté activa.
startCaptions(StartCaptionsAdapterOptions)	Función para iniciar subtítulos
startNoiseSuppressionEffect()	Inicie el efecto de supresión de ruido.
startScreenShare()	Empiece a compartir la pantalla durante una llamada.
startSpotlight(string[])	Inicie Spotlight para participantes locales y remotos por sus ID de usuario. Si no se pasa ninguna matriz de identificadores de usuario, la acción se realiza en el participante local.
startTogetherMode()	Modo Iniciar Juntos.
startVideoBackgroundEffect(VideoBackgroundEffect)	Inicie el efecto de fondo del video.
stopAllSpotlight()	Detén todos los focos
stopCamera()	Detener la cámara Este método dejará de representar una vista de cámara local cuando la llamada no esté activa.
stopCaptions(StopCaptionsAdapterOptions)	Función para detener los subtítulos
stopNoiseSuppressionEffect()	Detenga el efecto de supresión de ruido.
stopScreenShare()	Dejar de compartir la pantalla
stopSpotlight(string[])	Detenga el foco de atención para los participantes locales y remotos por sus ID de usuario. Si no se pasa ninguna matriz de identificadores de usuario, la acción se realiza en el participante local.
stopVideoBackgroundEffects()	Detenga el efecto de fondo del video.
submitSurvey(CallSurvey)	Enviar el resultado de la encuesta de fin de llamada
unmute()	Desactivar el usuario actual durante la llamada o habilitar el micrófono localmente
updateBackgroundPickerImages(VideoBackgroundImage[])	Anule las imágenes del selector de fondo para el efecto de reemplazo de fondo.
updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)	Actualice el efecto de fondo de video seleccionado.

Detalles de las propiedades

sendRealTimeText

Enviar texto en tiempo real

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

Valor de propiedad

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

Detalles del método

addParticipant(CommunicationUserIdentifier)

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

Parámetros

participant

CommunicationUserIdentifier

Devoluciones

Promise<void>

addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

Agregue un participante a la llamada.

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

Parámetros

participant

PhoneNumberIdentifier

options

AddPhoneNumberOptions

Devoluciones

Promise<void>

createStreamView(string, VideoStreamOptions)

Cree la vista html para una secuencia.

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

Parámetros

remoteUserId

string

Identificador del participante que se va a representar, déjelo sin definir para crear la vista de cámara local.

options

VideoStreamOptions

Opciones para controlar cómo se representan las secuencias de vídeo <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Devoluciones

Promise<void | CreateVideoStreamViewResult>

Comentarios

Este método se implementa para compuesto

createTogetherModeStreamView(TogetherModeStreamOptions)

Cree la vista html para una secuencia.

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

Parámetros

options

TogetherModeStreamOptions

Opciones para controlar cómo se representan las secuencias de vídeo <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Devoluciones

Promise<void | TogetherModeStreamViewResult>

Comentarios

Este método se implementa para compuesto

disposeLocalVideoStreamView()

Eliminación de la vista html para una secuencia de vídeo local

function disposeLocalVideoStreamView(): Promise<void>

Devoluciones

Promise<void>

disposeRemoteVideoStreamView(string)

Eliminación de la vista html para una transmisión de vídeo remota

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

Parámetros

remoteUserId

string

Id del participante que se va a desechar

Devoluciones

Promise<void>

disposeScreenShareStreamView(string)

Eliminación de la vista html para una secuencia de uso compartido de pantalla

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

Parámetros

remoteUserId

string

Id del participante para el que se va a eliminar la vista de transmisión de uso compartido de pantalla.

Devoluciones

Promise<void>

Comentarios

Este método se implementa para materiales compuestos

disposeStreamView(string, VideoStreamOptions)

Advertencia

Esta API ya está en desuso.

Use disposeRemoteVideoStreamView, disposeLocalVideoStreamView and disposeRemoteVideoStreamView instead.

Elimine la vista html de una secuencia.

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

Parámetros

remoteUserId

string

Identificador del participante que se va a representar, deje que no esté definido para eliminar la vista de cámara local.

options

VideoStreamOptions

Opciones para controlar cómo se representan las secuencias de vídeo <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Devoluciones

Promise<void>

Comentarios

Este método se implementa para compuesto

disposeTogetherModeStreamView()

Elimine la vista html de una secuencia.

function disposeTogetherModeStreamView(): Promise<void>

Devoluciones

Promise<void>

Comentarios

Este método se implementa para compuesto

forbidAudio(string[])

Prohibir el audio de los asistentes a la reunión de Teams por sus identificadores de usuario.

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

Parámetros

userIds

string[]

Devoluciones

Promise<void>

forbidOthersAudio()

Prohibir el audio de la reunión de Teams.

function forbidOthersAudio(): Promise<void>

Devoluciones

Promise<void>

forbidOthersVideo()

Prohibir el vídeo de la reunión de Teams.

function forbidOthersVideo(): Promise<void>

Devoluciones

Promise<void>

forbidVideo(string[])

Prohibir el vídeo de los asistentes a la reunión de Teams por sus identificadores de usuario.

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

Parámetros

userIds

string[]

Devoluciones

Promise<void>

holdCall()

Mantiene la llamada.

function holdCall(): Promise<void>

Devoluciones

Promise<void>

leaveCall(boolean)

Dejar la llamada

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

Parámetros

forEveryone

boolean

Si se quitan todos los participantes al salir

Devoluciones

Promise<void>

lowerHand()

Manecilla inferior para el usuario actual

function lowerHand(): Promise<void>

Devoluciones

Promise<void>

mute()

Silenciar al usuario actual durante la llamada o deshabilitar el micrófono localmente

function mute(): Promise<void>

Devoluciones

Promise<void>

muteAllRemoteParticipants()

Silenciar a todos los participantes

function muteAllRemoteParticipants(): Promise<void>

Devoluciones

Promise<void>

muteParticipant(string)

Silenciar a un participante

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

Parámetros

userId

string

Id del participante que se va a silenciar

Devoluciones

Promise<void>

onReactionClick(Reaction)

Enviar emoji de reacción

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

Parámetros

reaction

Reaction

Devoluciones

Promise<void>

permitAudio(string[])

Permitir que los asistentes a la reunión de Teams escuchen con sus identificadores de usuario.

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

Parámetros

userIds

string[]

Devoluciones

Promise<void>

permitOthersAudio()

Permitir el audio de la reunión de los equipos.

function permitOthersAudio(): Promise<void>

Devoluciones

Promise<void>

permitOthersVideo()

Vídeo de la reunión de los equipos de permisos.

function permitOthersVideo(): Promise<void>

Devoluciones

Promise<void>

permitVideo(string[])

Permitir que los asistentes a la reunión de Teams escuchen con sus identificadores de usuario.

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

Parámetros

userIds

string[]

Devoluciones

Promise<void>

raiseHand()

Levantar la mano para el usuario actual

function raiseHand(): Promise<void>

Devoluciones

Promise<void>

removeParticipant(CommunicationIdentifier)

Quite un participante de la llamada.

function removeParticipant(participant: CommunicationIdentifier): Promise<void>

Parámetros

participant

CommunicationIdentifier

<xref:%40azure%2Fcommunication-common%23CommunicationIdentifier> del participante que se va a eliminar

Devoluciones

Promise<void>

removeParticipant(string)

Quite un participante de la llamada.

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

Parámetros

userId

string

Identificador del participante que se va a quitar

Devoluciones

Promise<void>

resumeCall()

Reanuda la llamada desde un LocalHold estado.

function resumeCall(): Promise<void>

Devoluciones

Promise<void>

returnFromBreakoutRoom()

Volver a la llamada de origen de la sala para grupos pequeños

function returnFromBreakoutRoom(): Promise<void>

Devoluciones

Promise<void>

sendDtmfTone(DtmfTone)

enviar tono DTMF a otro participante en una llamada RTC 1:1

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

Parámetros

dtmfTone

DtmfTone

Devoluciones

Promise<void>

setCaptionLanguage(string)

Función para establecer el idioma de los subtítulos

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

Parámetros

language

string

Conjunto de idioma para el subtítulo

Devoluciones

Promise<void>

setSpokenLanguage(string)

Función para configurar el idioma hablado

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

Parámetros

language

string

Lenguaje hablado

Devoluciones

Promise<void>

setTogetherModeSceneSize(number, number)

Vuelva a calcular las posiciones de los asientos para el modo juntos.

function setTogetherModeSceneSize(width: number, height: number)

Parámetros

width

number

Anchura del contenedor

height

number

Altura del contenedor

Comentarios

Este método se implementa para compuesto

startCamera(VideoStreamOptions)

Iniciar la cámara Este método iniciará la representación de una vista de cámara local cuando la llamada no esté activa.

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

Parámetros

options

VideoStreamOptions

Opciones para controlar cómo se representan las secuencias de vídeo <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Devoluciones

Promise<void>

startCaptions(StartCaptionsAdapterOptions)

Función para iniciar subtítulos

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

Parámetros

options

StartCaptionsAdapterOptions

Opciones para iniciar subtítulos

Devoluciones

Promise<void>

startNoiseSuppressionEffect()

Inicie el efecto de supresión de ruido.

function startNoiseSuppressionEffect(): Promise<void>

Devoluciones

Promise<void>

startScreenShare()

Empiece a compartir la pantalla durante una llamada.

function startScreenShare(): Promise<void>

Devoluciones

Promise<void>

startSpotlight(string[])

Inicie Spotlight para participantes locales y remotos por sus ID de usuario. Si no se pasa ninguna matriz de identificadores de usuario, la acción se realiza en el participante local.

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

Parámetros

userIds

string[]

Devoluciones

Promise<void>

startTogetherMode()

Modo Iniciar Juntos.

function startTogetherMode(): Promise<void>

Devoluciones

Promise<void>

startVideoBackgroundEffect(VideoBackgroundEffect)

Inicie el efecto de fondo del video.

function startVideoBackgroundEffect(videoBackgroundEffect: VideoBackgroundEffect): Promise<void>

Parámetros

videoBackgroundEffect

VideoBackgroundEffect

Devoluciones

Promise<void>

stopAllSpotlight()

Detén todos los focos

function stopAllSpotlight(): Promise<void>

Devoluciones

Promise<void>

stopCamera()

Detener la cámara Este método dejará de representar una vista de cámara local cuando la llamada no esté activa.

function stopCamera(): Promise<void>

Devoluciones

Promise<void>

stopCaptions(StopCaptionsAdapterOptions)

Función para detener los subtítulos

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

Parámetros

options

StopCaptionsAdapterOptions

Devoluciones

Promise<void>

stopNoiseSuppressionEffect()

Detenga el efecto de supresión de ruido.

function stopNoiseSuppressionEffect(): Promise<void>

Devoluciones

Promise<void>

stopScreenShare()

Dejar de compartir la pantalla

function stopScreenShare(): Promise<void>

Devoluciones

Promise<void>

stopSpotlight(string[])

Detenga el foco de atención para los participantes locales y remotos por sus ID de usuario. Si no se pasa ninguna matriz de identificadores de usuario, la acción se realiza en el participante local.

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

Parámetros

userIds

string[]

Devoluciones

Promise<void>

stopVideoBackgroundEffects()

Detenga el efecto de fondo del video.

function stopVideoBackgroundEffects(): Promise<void>

Devoluciones

Promise<void>

submitSurvey(CallSurvey)

Enviar el resultado de la encuesta de fin de llamada

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

Parámetros

survey

CallSurvey

Devoluciones

Promise<undefined | CallSurveyResponse>

unmute()

Desactivar el usuario actual durante la llamada o habilitar el micrófono localmente

function unmute(): Promise<void>

Devoluciones

Promise<void>

updateBackgroundPickerImages(VideoBackgroundImage[])

Anule las imágenes del selector de fondo para el efecto de reemplazo de fondo.

function updateBackgroundPickerImages(backgroundImages: VideoBackgroundImage[])

Parámetros

backgroundImages

VideoBackgroundImage[]

Matriz de imágenes de fondo personalizadas.

updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)

Actualice el efecto de fondo de video seleccionado.

function updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect)

Parámetros

selectedVideoBackground

VideoBackgroundEffect