CallWithChatAdapterManagement interface
Funcionalidad para administrar la llamada actual con chat.
Propiedades
| forbid |
Prohíbe el audio para los ID de usuario especificados. |
| forbid |
prohíbe el audio para los asistentes a la reunión de Teams, excepto para el usuario local. |
| forbid |
prohíbe el vídeo para los asistentes a la reunión de Teams, excepto para el usuario local. |
| forbid |
Prohíbe el vídeo para los ID de usuario especificados. |
| permit |
Permite audio para los ID de usuario especificados. |
| permit |
permite audio para los asistentes a la reunión de Teams, excepto el usuario local. |
| permit |
permite vídeo para los asistentes a la reunión de Teams, excepto para el usuario local. |
| permit |
Permite vídeo para los ID de usuario especificados. |
| send |
Enviar tono DTMF a otro participante en la llamada en llamadas 1:1 |
| send |
Enviar texto en tiempo real |
Métodos
| add |
|
| add |
Agrega un nuevo participante a la llamada. |
| ask |
Solicitar permisos de dispositivos. |
| create |
Cree la vista html para una secuencia. |
| create |
Cree la vista html para una secuencia en modo conjunto. |
| delete |
Elimine un mensaje en el subproceso. |
| dispose |
Eliminación de la vista html para una secuencia de vídeo local |
| dispose |
Eliminación de la vista html para una transmisión de vídeo remota |
| dispose |
Eliminación de la vista html para una secuencia de uso compartido de pantalla |
| dispose |
Elimine la vista html de una secuencia. |
| dispose |
Elimine la vista html para una secuencia togethermode. |
| download |
|
| fetch |
Capturar el estado inicial del adaptador de chat. Realiza la captura mínima necesaria para los métodos chatComposite y API. |
| hold |
Coloca la llamada en un localhold. |
| join |
Únase a la llamada con el micrófono inicialmente activado/desactivado. |
| join |
Unirse a la llamada con bolsa de opciones para establecer el estado inicial del micrófono/cámara al unirse a la llamada true = encender el dispositivo al unirse a la llamada false = apagar el dispositivo al unirse a la llamada 'keep'/undefined = retener el estado previo a la llamada de los dispositivos |
| leave |
Deje la llamada. |
| load |
Cargue más mensajes anteriores en el historial de subprocesos de chat. |
| lower |
Manecilla inferior para usuario local. |
| mute() | Silenciar al usuario actual durante la llamada o deshabilitar el micrófono localmente. |
| mute |
Silenciar a un participante |
| mute |
Silenciar a un participante |
| on |
Enviar reacción a la reunión en curso. |
| query |
Consulta de dispositivos de cámara disponibles. |
| query |
Consulta de dispositivos de micrófono disponibles. |
| query |
Consulta de dispositivos de micrófono disponibles. |
| raise |
Levante la mano por el usuario local. |
| remove |
Quite un participante de la llamada. |
| remove |
Quite un participante de una llamada. |
| remove |
|
| resume |
Reanuda la llamada desde un estado LocalHold. |
| return |
Volver a la llamada de origen de la sala para grupos pequeños |
| send |
Envíe un mensaje en el subproceso. |
| send |
Enviar una confirmación de lectura para un mensaje. |
| send |
Enviar indicador de escritura en el subproceso. |
| set |
Establezca la cámara que se va a usar en la llamada. |
| set |
Función para establecer el idioma de los subtítulos |
| set |
Establezca el micrófono que se usará en la llamada. |
| set |
Establezca el altavoz que se usará en la llamada. |
| set |
Función para configurar el idioma hablado |
| set |
Vuelva a calcular las posiciones de los asientos para el modo juntos. |
| start |
Inicie la llamada. |
| start |
Inicie la llamada. |
| start |
Inicie la cámara. Este método comenzará a representar una vista de cámara local cuando la llamada no esté activa. |
| start |
Función para iniciar subtítulos |
| start |
Inicie el efecto de supresión de ruido. |
| start |
Empiece a compartir la pantalla durante una llamada. |
| start |
Iniciar foco |
| start |
Modo de inicio juntos. |
| start |
Inicie el efecto de fondo del video. |
| stop |
Detén todos los focos |
| stop |
Detenga la cámara. Este método dejará de representar una vista de cámara local cuando la llamada no esté activa. |
| stop |
Función para detener los subtítulos |
| stop |
Inicie el efecto de supresión de ruido. |
| stop |
Deje de compartir la pantalla. |
| stop |
Detener el foco de atención |
| stop |
Detenga el efecto de fondo del video. |
| submit |
Enviar el resultado de la encuesta de fin de llamada |
| unmute() | Desmute el usuario actual durante la llamada o habilite el micrófono localmente. |
| update |
Anule las imágenes del selector de fondo para el efecto de reemplazo de fondo. |
| update |
Actualice un contenido de mensaje. |
| update |
Actualizar el efecto de fondo de vídeo seleccionado |
Detalles de las propiedades
forbidAudio
Prohíbe el audio para los ID de usuario especificados.
forbidAudio: (userIds: string[]) => Promise<void>
Valor de propiedad
(userIds: string[]) => Promise<void>
forbidOthersAudio
prohíbe el audio para los asistentes a la reunión de Teams, excepto para el usuario local.
forbidOthersAudio: () => Promise<void>
Valor de propiedad
() => Promise<void>
forbidOthersVideo
prohíbe el vídeo para los asistentes a la reunión de Teams, excepto para el usuario local.
forbidOthersVideo: () => Promise<void>
Valor de propiedad
() => Promise<void>
forbidVideo
Prohíbe el vídeo para los ID de usuario especificados.
forbidVideo: (userIds: string[]) => Promise<void>
Valor de propiedad
(userIds: string[]) => Promise<void>
permitAudio
Permite audio para los ID de usuario especificados.
permitAudio: (userIds: string[]) => Promise<void>
Valor de propiedad
(userIds: string[]) => Promise<void>
permitOthersAudio
permite audio para los asistentes a la reunión de Teams, excepto el usuario local.
permitOthersAudio: () => Promise<void>
Valor de propiedad
() => Promise<void>
permitOthersVideo
permite vídeo para los asistentes a la reunión de Teams, excepto para el usuario local.
permitOthersVideo: () => Promise<void>
Valor de propiedad
() => Promise<void>
permitVideo
Permite vídeo para los ID de usuario especificados.
permitVideo: (userIds: string[]) => Promise<void>
Valor de propiedad
(userIds: string[]) => Promise<void>
sendDtmfTone
Enviar tono DTMF a otro participante en la llamada en llamadas 1:1
public sendDtmfTone: (dtmfTone: DtmfTone) => Promise<void>
Valor de propiedad
(dtmfTone: DtmfTone) => Promise<void>
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)
Agrega un nuevo participante a la llamada.
function addParticipant(participant: PhoneNumberIdentifier, options?: AddPhoneNumberOptions): Promise<void>
Parámetros
- participant
- PhoneNumberIdentifier
- options
- AddPhoneNumberOptions
Devoluciones
Promise<void>
askDevicePermission(PermissionConstraints)
Solicitar permisos de dispositivos.
function askDevicePermission(constrain: PermissionConstraints): Promise<DeviceAccess>
Parámetros
- constrain
- PermissionConstraints
Definición de restricciones para acceder a dispositivos locales <xref:%40azure%2Fcommunication-calling%23PermissionConstraints>
Devoluciones
Promise<DeviceAccess>
Comentarios
Aparecerá la ventana de permisos del explorador si aún no se conceden permisos.
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 en modo conjunto.
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
deleteMessage(string)
Elimine un mensaje en el subproceso.
function deleteMessage(messageId: string): Promise<void>
Parámetros
- messageId
-
string
Devoluciones
Promise<void>
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)
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 para una secuencia togethermode.
function disposeTogetherModeStreamView(): Promise<void>
Devoluciones
Promise<void>
Comentarios
Este método se implementa para compuesto
downloadResourceToCache(ResourceDetails)
function downloadResourceToCache(resourceDetails: ResourceDetails): Promise<void>
Parámetros
- resourceDetails
- ResourceDetails
Devoluciones
Promise<void>
fetchInitialData()
Capturar el estado inicial del adaptador de chat.
Realiza la captura mínima necesaria para los métodos chatComposite y API.
function fetchInitialData(): Promise<void>
Devoluciones
Promise<void>
holdCall()
Coloca la llamada en un localhold.
function holdCall(): Promise<void>
Devoluciones
Promise<void>
joinCall(boolean)
Advertencia
Esta API ya está en desuso.
Use joinCall(options?:JoinCallOptions) instead.
Únase a la llamada con el micrófono inicialmente activado/desactivado.
function joinCall(microphoneOn?: boolean): undefined | Call
Parámetros
- microphoneOn
-
boolean
Si el micrófono está habilitado inicialmente
Devoluciones
undefined | Call
joinCall(JoinCallOptions)
Unirse a la llamada con bolsa de opciones para establecer el estado inicial del micrófono/cámara al unirse a la llamada true = encender el dispositivo al unirse a la llamada false = apagar el dispositivo al unirse a la llamada 'keep'/undefined = retener el estado previo a la llamada de los dispositivos
function joinCall(options?: JoinCallOptions): undefined | Call
Parámetros
- options
- JoinCallOptions
param para configurar el micrófono/cámara inicialmente encendido/apagado/uso del estado de prellamada.
Devoluciones
undefined | Call
leaveCall(boolean)
Deje la llamada.
function leaveCall(forEveryone?: boolean): Promise<void>
Parámetros
- forEveryone
-
boolean
Si se quitan todos los participantes al salir
Devoluciones
Promise<void>
loadPreviousChatMessages(number)
Cargue más mensajes anteriores en el historial de subprocesos de chat.
function loadPreviousChatMessages(messagesToLoad: number): Promise<boolean>
Parámetros
- messagesToLoad
-
number
Devoluciones
Promise<boolean>
Comentarios
Este método se usa normalmente para controlar el desplazamiento incremental de captura/infinito.
lowerHand()
Manecilla inferior para usuario local.
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 un participante
function muteAllRemoteParticipants(): Promise<void>
Devoluciones
Promise<void>
muteParticipant(string)
Silenciar a un participante
function muteParticipant(userId: string): Promise<void>
Parámetros
- userId
-
string
Devoluciones
Promise<void>
onReactionClick(Reaction)
Enviar reacción a la reunión en curso.
function onReactionClick(reaction: Reaction): Promise<void>
Parámetros
- reaction
- Reaction
Un valor de type <xref:%40azure%2Fcommunication-calling%23Reaction>
Devoluciones
Promise<void>
queryCameras()
Consulta de dispositivos de cámara disponibles.
function queryCameras(): Promise<VideoDeviceInfo[]>
Devoluciones
Promise<VideoDeviceInfo[]>
Matriz de entidades de información de dispositivos de vídeo <xref:%40azure%2Fcommunication-calling%23VideoDeviceInfo>
Comentarios
Se debe llamar a este método después de askDevicePermission()
queryMicrophones()
Consulta de dispositivos de micrófono disponibles.
function queryMicrophones(): Promise<AudioDeviceInfo[]>
Devoluciones
Promise<AudioDeviceInfo[]>
Matriz de entidades de información del dispositivo de audio <xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo>
Comentarios
Se debe llamar a este método después de askDevicePermission()
querySpeakers()
Consulta de dispositivos de micrófono disponibles.
function querySpeakers(): Promise<AudioDeviceInfo[]>
Devoluciones
Promise<AudioDeviceInfo[]>
Matriz de entidades de información del dispositivo de audio <xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo>
Comentarios
Se debe llamar a este método después de askDevicePermission()
raiseHand()
Levante la mano por el usuario local.
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 una llamada.
function removeParticipant(userId: string): Promise<void>
Parámetros
- userId
-
string
UserId del participante que se va a quitar.
Devoluciones
Promise<void>
removeResourceFromCache(ResourceDetails)
function removeResourceFromCache(resourceDetails: ResourceDetails)
Parámetros
- resourceDetails
- ResourceDetails
resumeCall()
Reanuda la llamada desde un estado LocalHold.
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>
sendMessage(string, SendMessageOptions)
Envíe un mensaje en el subproceso.
function sendMessage(content: string, options?: SendMessageOptions): Promise<void>
Parámetros
- content
-
string
- options
- SendMessageOptions
Devoluciones
Promise<void>
sendReadReceipt(string)
Enviar una confirmación de lectura para un mensaje.
function sendReadReceipt(chatMessageId: string): Promise<void>
Parámetros
- chatMessageId
-
string
Devoluciones
Promise<void>
sendTypingIndicator()
Enviar indicador de escritura en el subproceso.
function sendTypingIndicator(): Promise<void>
Devoluciones
Promise<void>
setCamera(VideoDeviceInfo, VideoStreamOptions)
Establezca la cámara que se va a usar en la llamada.
function setCamera(sourceInfo: VideoDeviceInfo, options?: VideoStreamOptions): Promise<void>
Parámetros
- sourceInfo
- VideoDeviceInfo
Dispositivo de cámara que elegir, elija uno devuelto por queryCameras
- options
- VideoStreamOptions
Opciones para controlar cómo se representa la secuencia de cámara <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
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>
setMicrophone(AudioDeviceInfo)
Establezca el micrófono que se usará en la llamada.
function setMicrophone(sourceInfo: AudioDeviceInfo): Promise<void>
Parámetros
- sourceInfo
- AudioDeviceInfo
Dispositivo micrófono que elegir, elija uno devuelto por consultaMicrophones
Devoluciones
Promise<void>
setSpeaker(AudioDeviceInfo)
Establezca el altavoz que se usará en la llamada.
function setSpeaker(sourceInfo: AudioDeviceInfo): Promise<void>
Parámetros
- sourceInfo
- AudioDeviceInfo
Dispositivo de altavoz que elegir, elija uno devuelto por querySpeakers
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
startCall((CommunicationUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], StartCallOptions)
Inicie la llamada.
function startCall(participants: (CommunicationUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], options?: StartCallOptions): undefined | Call
Parámetros
- participants
-
(CommunicationUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[]
Un array de <xref:%40azure%2Fcommunication-common%23CommunicationIdentifier> a ser llamado
- options
- StartCallOptions
Devoluciones
undefined | Call
startCall(string[], StartCallOptions)
Inicie la llamada.
function startCall(participants: string[], options?: StartCallOptions): undefined | Call
Parámetros
- participants
-
string[]
Matriz de identificadores de participante que se van a unir
- options
- StartCallOptions
Devoluciones
undefined | Call
startCamera(VideoStreamOptions)
Inicie la cámara.
Este método comenzará a representar 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[])
Iniciar foco
function startSpotlight(userIds?: string[]): Promise<void>
Parámetros
- userIds
-
string[]
Devoluciones
Promise<void>
startTogetherMode()
Modo de inicio juntos.
function startTogetherMode(): Promise<void>
Devoluciones
Promise<void>
Comentarios
Este método se implementa para compuesto
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()
Detenga 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()
Inicie el efecto de supresión de ruido.
function stopNoiseSuppressionEffect(): Promise<void>
Devoluciones
Promise<void>
stopScreenShare()
Deje de compartir la pantalla.
function stopScreenShare(): Promise<void>
Devoluciones
Promise<void>
stopSpotlight(string[])
Detener el foco de atención
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()
Desmute el usuario actual durante la llamada o habilite 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
Matriz de imágenes de fondo personalizadas.
updateMessage(string, string, Record<string, string>)
Actualice un contenido de mensaje.
function updateMessage(messageId: string, content: string, options?: Record<string, string>): Promise<void>
Parámetros
- messageId
-
string
- content
-
string
- options
-
Record<string, string>
Devoluciones
Promise<void>
updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)
Actualizar el efecto de fondo de vídeo seleccionado
function updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect)
Parámetros
- selectedVideoBackground
- VideoBackgroundEffect