CommonCallAdapter interface
interfaz del adaptador de CallComposite.
- Extends
Propiedades heredadas
| send |
Enviar texto en tiempo real |
Métodos
| 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 |
| start |
Inicie la llamada. |
| start |
Inicie la llamada. |
Métodos heredados
| add |
|
| add |
Agregue un 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. |
| dispose() | Eliminación de la composición |
| 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 de una secuencia. |
| forbid |
Prohibir el audio de los asistentes a la reunión de Teams por sus identificadores de usuario. |
| forbid |
Prohibir el audio de la reunión de Teams. |
| forbid |
Prohibir el vídeo de la reunión de Teams. |
| forbid |
Prohibir el vídeo de los asistentes a la reunión de Teams por sus identificadores de usuario. |
| get |
Obtener el estado actual |
| hold |
Mantiene la llamada. |
| leave |
Dejar la llamada |
| lower |
Manecilla inferior para el usuario actual |
| mute() | Silenciar al usuario actual durante la llamada o deshabilitar el micrófono localmente |
| mute |
Silenciar a todos los participantes |
| mute |
Silenciar a un participante |
| off("breakout |
Función de cancelación de suscripción para el evento 'breakoutRoomsUpdated'. |
| off("call |
Cancele la función para el evento "callEnded". |
| off("call |
Cancele la función para el evento "callIdChanged". |
| off("capabilities |
Función de cancelación de suscripción para el evento 'capabilitiesChanged'. |
| off("captions |
Función de cancelación de suscripción para el evento 'captionsReceived'. |
| off("diagnostic |
Cancele la función para el evento "diagnosticChanged". |
| off("display |
Función de cancelación de suscripción para el evento "displayNameChanged". |
| off("error", (e: Adapter |
Cancelar la suscripción de la función para el evento "error". |
| off("is |
Función de cancelación de suscripción para el evento 'isCaptionLanguageChanged'. |
| off("is |
Función de cancelación de suscripción para el evento 'isCaptionsActiveChanged'. |
| off("is |
Función Unsubscribe para el evento "isLocalScreenSharingActiveChanged". |
| off("is |
Cancele la función para el evento "isMutedChanged". |
| off("is |
Función de cancelación de suscripción para el evento "isSpeakingChanged". |
| off("is |
Función de cancelación de suscripción para el evento 'isSpokenLanguageChanged'. |
| off("muted |
Función de cancelación de suscripción para el evento 'mutedByOthers'. |
| off("participants |
Cancele la función para el evento "participantsJoined". |
| off("participants |
Cancele la función para el evento "participantsLeft". |
| off("real |
Función de cancelación de suscripción para el evento 'realTimeTextReceived'. |
| off("role |
Función de cancelación de suscripción para el evento 'roleChanged'. |
| off("selected |
Cancele la función para el evento "selectedMicrophoneChanged". |
| off("selected |
Cancele la función para el evento "selectedSpeakerChanged". |
| off("spotlight |
Función de cancelación de suscripción para el evento 'spotlightChanged'. |
| off("transfer |
Función de cancelación de suscripción para el evento 'transferRequested'. |
| off |
Cancela la suscripción del controlador a los eventos stateChanged. |
| on("breakout |
Función de suscripción para el evento 'breakoutRoomsUpdated'. |
| on("call |
Función Subscribe para el evento "callEnded". |
| on("call |
Función Subscribe para el evento "callIdChanged". |
| on("capabilities |
Función de suscripción para el evento 'capabilitiesChanged'. |
| on("captions |
Función de suscripción para el evento 'captionsReceived'. |
| on("diagnostic |
Suscripción de la función para el evento "diagnosticChanged". Este evento se desencadena cada vez que se produce un cambio en los diagnósticos orientados al usuario sobre la llamada en curso. |
| on("display |
Función Subscribe para el evento "displayNameChanged". |
| on("error", (e: Adapter |
Suscripción de la función para el evento "error". |
| on("is |
Función de suscripción para el evento 'isCaptionLanguageChanged'. |
| on("is |
Función de suscripción para el evento 'isCaptionsActiveChanged'. |
| on("is |
Función Subscribe para el evento "isLocalScreenSharingActiveChanged". |
| on("is |
Función Subscribe para el evento "isMutedChanged". |
| on("is |
Suscripción de la función para el evento "isSpeakingChanged". |
| on("is |
Función de suscripción para el evento 'isSpokenLanguageChanged'. |
| on("muted |
Función de suscripción para el evento 'mutedByOthers'. |
| on("participants |
Función Subscribe para el evento "participantsJoined". |
| on("participants |
Suscripción de la función para el evento "participantsLeft". |
| on("real |
Función de suscripción para el evento 'realTimeTextReceived'. |
| on("role |
Función de suscripción para el evento 'roleChanged'. |
| on("selected |
Función Subscribe para el evento "selectedMicrophoneChanged". Este evento se desencadena cada vez que el usuario selecciona un nuevo dispositivo de micrófono. |
| on("selected |
Función Subscribe para el evento "selectedSpeakerChanged". Este evento se desencadena cada vez que el usuario selecciona un nuevo dispositivo de altavoz. |
| on("spotlight |
Función de suscripción para el evento 'spotlightChanged'. |
| on("transfer |
Función de suscripción para el evento 'transferRequested'. |
| on |
Enviar emoji de reacción |
| on |
Suscribe el controlador a eventos stateChanged. |
| permit |
Permitir que los asistentes a la reunión de Teams escuchen con sus identificadores de usuario. |
| permit |
Permitir el audio de la reunión de los equipos. |
| permit |
Vídeo de la reunión de los equipos de permisos. |
| permit |
Permitir que los asistentes a la reunión de Teams escuchen con sus identificadores de usuario. |
| query |
Consulta de dispositivos de cámara disponibles. |
| query |
Consulta de dispositivos de micrófono disponibles. |
| query |
Consulta de los dispositivos de altavoz disponibles. |
| raise |
Levantar la mano para el usuario actual |
| remove |
Quite un participante de la llamada. |
| remove |
Quite un participante de la llamada. |
| resume |
Reanuda la llamada desde un |
| return |
Volver a la llamada de origen de la sala para grupos pequeños |
| send |
enviar tono DTMF a otro participante en una llamada RTC 1:1 |
| 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 |
Iniciar la cámara Este método iniciará la representación de 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 |
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. |
| start |
Modo Iniciar Juntos. |
| start |
Inicie el efecto de fondo del video. |
| stop |
Detén todos los focos |
| stop |
Detener 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 |
Detenga el efecto de supresión de ruido. |
| stop |
Dejar de compartir la pantalla |
| stop |
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. |
| stop |
Detenga el efecto de fondo del video. |
| submit |
Enviar el resultado de la encuesta de fin de llamada |
| unmute() | Desactivar el usuario actual durante la llamada o habilitar el micrófono localmente |
| update |
Anule las imágenes del selector de fondo para el efecto de reemplazo de fondo. |
| update |
Actualice el efecto de fondo de video seleccionado. |
Detalles de las propiedades heredadas
sendRealTimeText
Enviar texto en tiempo real
sendRealTimeText: (text: string, isFinalized: boolean) => Promise<void>
Valor de propiedad
(text: string, isFinalized: boolean) => Promise<void>
heredado deCallAdapterCallOperations.sendRealTimeText
Detalles del método
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)
Parámetros
- microphoneOn
-
boolean
Si el micrófono está habilitado inicialmente
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)
Parámetros
- options
- JoinCallOptions
param para configurar el micrófono/cámara inicialmente encendido/apagado/uso del estado de prellamada.
startCall(CommunicationIdentifier[], StartCallOptions)
Inicie la llamada.
function startCall(participants: CommunicationIdentifier[], options?: StartCallOptions)
Parámetros
- participants
Un array de <xref:%40azure%2Fcommunication-common%23CommunicationIdentifier> a ser llamado
- options
- StartCallOptions
startCall(string[], StartCallOptions)
Inicie la llamada.
function startCall(participants: string[], options?: StartCallOptions)
Parámetros
- participants
-
string[]
Matriz de identificadores de participante que se van a unir
- options
- StartCallOptions
Detalles de los métodos heredados
addParticipant(CommunicationUserIdentifier)
function addParticipant(participant: CommunicationUserIdentifier): Promise<void>
Parámetros
- participant
- CommunicationUserIdentifier
Devoluciones
Promise<void>
heredado deCallAdapterCallOperations.addParticipant
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>
heredado deCallAdapterCallOperations.addParticipant
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
heredado deCallAdapterCallOperations.createStreamView
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
heredado deCallAdapterCallOperations.createTogetherModeStreamView
dispose()
disposeLocalVideoStreamView()
Eliminación de la vista html para una secuencia de vídeo local
function disposeLocalVideoStreamView(): Promise<void>
Devoluciones
Promise<void>
heredado deCallAdapterCallOperations.disposeLocalVideoStreamView
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>
heredado deCallAdapterCallOperations.disposeRemoteVideoStreamView
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
heredado deCallAdapterCallOperations.disposeScreenShareStreamView
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
heredado deCallAdapterCallOperations.disposeStreamView
disposeTogetherModeStreamView()
Elimine la vista html de una secuencia.
function disposeTogetherModeStreamView(): Promise<void>
Devoluciones
Promise<void>
Comentarios
Este método se implementa para compuesto
heredado deCallAdapterCallOperations.disposeTogetherModeStreamView
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>
heredado deCallAdapterCallOperations.forbidAudio
forbidOthersAudio()
Prohibir el audio de la reunión de Teams.
function forbidOthersAudio(): Promise<void>
Devoluciones
Promise<void>
heredado deCallAdapterCallOperations.forbidOthersAudio
forbidOthersVideo()
Prohibir el vídeo de la reunión de Teams.
function forbidOthersVideo(): Promise<void>
Devoluciones
Promise<void>
heredado deCallAdapterCallOperations.forbidOthersVideo
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>
heredado deCallAdapterCallOperations.forbidVideo
getState()
Obtener el estado actual
function getState(): CallAdapterState
Devoluciones
heredado deAdapterState.getState
holdCall()
Mantiene la llamada.
function holdCall(): Promise<void>
Devoluciones
Promise<void>
heredado deCallAdapterCallOperations.holdCall
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>
Se hereda deCallAdapterCallOperations.leaveCall
lowerHand()
Manecilla inferior para el usuario actual
function lowerHand(): Promise<void>
Devoluciones
Promise<void>
heredado deCallAdapterCallOperations.lowerHand
mute()
Silenciar al usuario actual durante la llamada o deshabilitar el micrófono localmente
function mute(): Promise<void>
Devoluciones
Promise<void>
heredado decallAdapterCallOperations.mute
muteAllRemoteParticipants()
Silenciar a todos los participantes
function muteAllRemoteParticipants(): Promise<void>
Devoluciones
Promise<void>
heredado deCallAdapterCallOperations.muteAllRemoteParticipants
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>
heredado deCallAdapterCallOperations.muteParticipant
off("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)
Función de cancelación de suscripción para el evento 'breakoutRoomsUpdated'.
function off(event: "breakoutRoomsUpdated", listener: BreakoutRoomsUpdatedListener)
Parámetros
- event
-
"breakoutRoomsUpdated"
- listener
- BreakoutRoomsUpdatedListener
heredado deCallAdapterSubscribers.off
off("callEnded", CallEndedListener)
Cancele la función para el evento "callEnded".
function off(event: "callEnded", listener: CallEndedListener)
Parámetros
- event
-
"callEnded"
- listener
- CallEndedListener
heredado deCallAdapterSubscribers.off
off("callIdChanged", CallIdChangedListener)
Cancele la función para el evento "callIdChanged".
function off(event: "callIdChanged", listener: CallIdChangedListener)
Parámetros
- event
-
"callIdChanged"
- listener
- CallIdChangedListener
heredado deCallAdapterSubscribers.off
off("capabilitiesChanged", CapabilitiesChangedListener)
Función de cancelación de suscripción para el evento 'capabilitiesChanged'.
function off(event: "capabilitiesChanged", listener: CapabilitiesChangedListener)
Parámetros
- event
-
"capabilitiesChanged"
- listener
- CapabilitiesChangedListener
heredado deCallAdapterSubscribers.off
off("captionsReceived", CaptionsReceivedListener)
Función de cancelación de suscripción para el evento 'captionsReceived'.
function off(event: "captionsReceived", listener: CaptionsReceivedListener)
Parámetros
- event
-
"captionsReceived"
- listener
- CaptionsReceivedListener
heredado deCallAdapterSubscribers.off
off("diagnosticChanged", DiagnosticChangedEventListner)
Cancele la función para el evento "diagnosticChanged".
function off(event: "diagnosticChanged", listener: DiagnosticChangedEventListner)
Parámetros
- event
-
"diagnosticChanged"
- listener
- DiagnosticChangedEventListner
heredado deCallAdapterSubscribers.off
off("displayNameChanged", DisplayNameChangedListener)
Función de cancelación de suscripción para el evento "displayNameChanged".
function off(event: "displayNameChanged", listener: DisplayNameChangedListener)
Parámetros
- event
-
"displayNameChanged"
- listener
- DisplayNameChangedListener
heredado deCallAdapterSubscribers.off
off("error", (e: AdapterError) => void)
Cancelar la suscripción de la función para el evento "error".
function off(event: "error", listener: (e: AdapterError) => void)
Parámetros
- event
-
"error"
- listener
-
(e: AdapterError) => void
heredado deCallAdapterSubscribers.off
off("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)
Función de cancelación de suscripción para el evento 'isCaptionLanguageChanged'.
function off(event: "isCaptionLanguageChanged", listener: IsCaptionLanguageChangedListener)
Parámetros
- event
-
"isCaptionLanguageChanged"
- listener
- IsCaptionLanguageChangedListener
heredado deCallAdapterSubscribers.off
off("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)
Función de cancelación de suscripción para el evento 'isCaptionsActiveChanged'.
function off(event: "isCaptionsActiveChanged", listener: IsCaptionsActiveChangedListener)
Parámetros
- event
-
"isCaptionsActiveChanged"
- listener
- IsCaptionsActiveChangedListener
heredado deCallAdapterSubscribers.off
off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)
Función Unsubscribe para el evento "isLocalScreenSharingActiveChanged".
function off(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)
Parámetros
- event
-
"isLocalScreenSharingActiveChanged"
heredado deCallAdapterSubscribers.off
off("isMutedChanged", IsMutedChangedListener)
Cancele la función para el evento "isMutedChanged".
function off(event: "isMutedChanged", listener: IsMutedChangedListener)
Parámetros
- event
-
"isMutedChanged"
- listener
- IsMutedChangedListener
heredado deCallAdapterSubscribers.off
off("isSpeakingChanged", IsSpeakingChangedListener)
Función de cancelación de suscripción para el evento "isSpeakingChanged".
function off(event: "isSpeakingChanged", listener: IsSpeakingChangedListener)
Parámetros
- event
-
"isSpeakingChanged"
- listener
- IsSpeakingChangedListener
heredado deCallAdapterSubscribers.off
off("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)
Función de cancelación de suscripción para el evento 'isSpokenLanguageChanged'.
function off(event: "isSpokenLanguageChanged", listener: IsSpokenLanguageChangedListener)
Parámetros
- event
-
"isSpokenLanguageChanged"
- listener
- IsSpokenLanguageChangedListener
heredado deCallAdapterSubscribers.off
off("mutedByOthers", PropertyChangedEvent)
Función de cancelación de suscripción para el evento 'mutedByOthers'.
function off(event: "mutedByOthers", listener: PropertyChangedEvent)
Parámetros
- event
-
"mutedByOthers"
- listener
- PropertyChangedEvent
heredado deCallAdapterSubscribers.off
off("participantsJoined", ParticipantsJoinedListener)
Cancele la función para el evento "participantsJoined".
function off(event: "participantsJoined", listener: ParticipantsJoinedListener)
Parámetros
- event
-
"participantsJoined"
- listener
- ParticipantsJoinedListener
heredado deCallAdapterSubscribers.off
off("participantsLeft", ParticipantsLeftListener)
Cancele la función para el evento "participantsLeft".
function off(event: "participantsLeft", listener: ParticipantsLeftListener)
Parámetros
- event
-
"participantsLeft"
- listener
- ParticipantsLeftListener
heredado deCallAdapterSubscribers.off
off("realTimeTextReceived", RealTimeTextReceivedListener)
Función de cancelación de suscripción para el evento 'realTimeTextReceived'.
function off(event: "realTimeTextReceived", listener: RealTimeTextReceivedListener)
Parámetros
- event
-
"realTimeTextReceived"
- listener
- RealTimeTextReceivedListener
heredado deCallAdapterSubscribers.off
off("roleChanged", PropertyChangedEvent)
Función de cancelación de suscripción para el evento 'roleChanged'.
function off(event: "roleChanged", listener: PropertyChangedEvent)
Parámetros
- event
-
"roleChanged"
- listener
- PropertyChangedEvent
heredado deCallAdapterSubscribers.off
off("selectedMicrophoneChanged", PropertyChangedEvent)
Cancele la función para el evento "selectedMicrophoneChanged".
function off(event: "selectedMicrophoneChanged", listener: PropertyChangedEvent)
Parámetros
- event
-
"selectedMicrophoneChanged"
- listener
- PropertyChangedEvent
heredado deCallAdapterSubscribers.off
off("selectedSpeakerChanged", PropertyChangedEvent)
Cancele la función para el evento "selectedSpeakerChanged".
function off(event: "selectedSpeakerChanged", listener: PropertyChangedEvent)
Parámetros
- event
-
"selectedSpeakerChanged"
- listener
- PropertyChangedEvent
heredado deCallAdapterSubscribers.off
off("spotlightChanged", SpotlightChangedListener)
Función de cancelación de suscripción para el evento 'spotlightChanged'.
function off(event: "spotlightChanged", listener: SpotlightChangedListener)
Parámetros
- event
-
"spotlightChanged"
- listener
- SpotlightChangedListener
heredado deCallAdapterSubscribers.off
off("transferAccepted", TransferAcceptedListener)
Función de cancelación de suscripción para el evento 'transferRequested'.
function off(event: "transferAccepted", listener: TransferAcceptedListener)
Parámetros
- event
-
"transferAccepted"
- listener
- TransferAcceptedListener
heredado deCallAdapterSubscribers.off
offStateChange((state: CallAdapterState) => void)
Cancela la suscripción del controlador a los eventos stateChanged.
function offStateChange(handler: (state: CallAdapterState) => void)
Parámetros
- handler
-
(state: CallAdapterState) => void
se hereda deAdapterState.offStateChange
on("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)
Función de suscripción para el evento 'breakoutRoomsUpdated'.
function on(event: "breakoutRoomsUpdated", listener: BreakoutRoomsUpdatedListener)
Parámetros
- event
-
"breakoutRoomsUpdated"
- listener
- BreakoutRoomsUpdatedListener
heredado deCallAdapterSubscribers.on
on("callEnded", CallEndedListener)
Función Subscribe para el evento "callEnded".
function on(event: "callEnded", listener: CallEndedListener)
Parámetros
- event
-
"callEnded"
- listener
- CallEndedListener
heredado deCallAdapterSubscribers.on
on("callIdChanged", CallIdChangedListener)
Función Subscribe para el evento "callIdChanged".
function on(event: "callIdChanged", listener: CallIdChangedListener)
Parámetros
- event
-
"callIdChanged"
- listener
- CallIdChangedListener
Comentarios
El evento se desencadenará cuando haya cambiado callId del usuario actual.
heredado deCallAdapterSubscribers.on
on("capabilitiesChanged", CapabilitiesChangedListener)
Función de suscripción para el evento 'capabilitiesChanged'.
function on(event: "capabilitiesChanged", listener: CapabilitiesChangedListener)
Parámetros
- event
-
"capabilitiesChanged"
- listener
- CapabilitiesChangedListener
heredado deCallAdapterSubscribers.on
on("captionsReceived", CaptionsReceivedListener)
Función de suscripción para el evento 'captionsReceived'.
function on(event: "captionsReceived", listener: CaptionsReceivedListener)
Parámetros
- event
-
"captionsReceived"
- listener
- CaptionsReceivedListener
heredado deCallAdapterSubscribers.on
on("diagnosticChanged", DiagnosticChangedEventListner)
Suscripción de la función para el evento "diagnosticChanged".
Este evento se desencadena cada vez que se produce un cambio en los diagnósticos orientados al usuario sobre la llamada en curso.
function on(event: "diagnosticChanged", listener: DiagnosticChangedEventListner)
Parámetros
- event
-
"diagnosticChanged"
- listener
- DiagnosticChangedEventListner
heredado deCallAdapterSubscribers.on
on("displayNameChanged", DisplayNameChangedListener)
Función Subscribe para el evento "displayNameChanged".
function on(event: "displayNameChanged", listener: DisplayNameChangedListener)
Parámetros
- event
-
"displayNameChanged"
- listener
- DisplayNameChangedListener
heredado deCallAdapterSubscribers.on
on("error", (e: AdapterError) => void)
Suscripción de la función para el evento "error".
function on(event: "error", listener: (e: AdapterError) => void)
Parámetros
- event
-
"error"
- listener
-
(e: AdapterError) => void
heredado deCallAdapterSubscribers.on
on("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)
Función de suscripción para el evento 'isCaptionLanguageChanged'.
function on(event: "isCaptionLanguageChanged", listener: IsCaptionLanguageChangedListener)
Parámetros
- event
-
"isCaptionLanguageChanged"
- listener
- IsCaptionLanguageChangedListener
heredado deCallAdapterSubscribers.on
on("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)
Función de suscripción para el evento 'isCaptionsActiveChanged'.
function on(event: "isCaptionsActiveChanged", listener: IsCaptionsActiveChangedListener)
Parámetros
- event
-
"isCaptionsActiveChanged"
- listener
- IsCaptionsActiveChangedListener
heredado deCallAdapterSubscribers.on
on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)
Función Subscribe para el evento "isLocalScreenSharingActiveChanged".
function on(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)
Parámetros
- event
-
"isLocalScreenSharingActiveChanged"
heredado deCallAdapterSubscribers.on
on("isMutedChanged", IsMutedChangedListener)
Función Subscribe para el evento "isMutedChanged".
function on(event: "isMutedChanged", listener: IsMutedChangedListener)
Parámetros
- event
-
"isMutedChanged"
- listener
- IsMutedChangedListener
Comentarios
El evento se desencadenará siempre que el usuario actual o el estado de silenciación de usuario remoto cambien.
heredado deCallAdapterSubscribers.on
on("isSpeakingChanged", IsSpeakingChangedListener)
Suscripción de la función para el evento "isSpeakingChanged".
function on(event: "isSpeakingChanged", listener: IsSpeakingChangedListener)
Parámetros
- event
-
"isSpeakingChanged"
- listener
- IsSpeakingChangedListener
heredado deCallAdapterSubscribers.on
on("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)
Función de suscripción para el evento 'isSpokenLanguageChanged'.
function on(event: "isSpokenLanguageChanged", listener: IsSpokenLanguageChangedListener)
Parámetros
- event
-
"isSpokenLanguageChanged"
- listener
- IsSpokenLanguageChangedListener
heredado deCallAdapterSubscribers.on
on("mutedByOthers", PropertyChangedEvent)
Función de suscripción para el evento 'mutedByOthers'.
function on(event: "mutedByOthers", listener: PropertyChangedEvent)
Parámetros
- event
-
"mutedByOthers"
- listener
- PropertyChangedEvent
heredado deCallAdapterSubscribers.on
on("participantsJoined", ParticipantsJoinedListener)
Función Subscribe para el evento "participantsJoined".
function on(event: "participantsJoined", listener: ParticipantsJoinedListener)
Parámetros
- event
-
"participantsJoined"
- listener
- ParticipantsJoinedListener
heredado deCallAdapterSubscribers.on
on("participantsLeft", ParticipantsLeftListener)
Suscripción de la función para el evento "participantsLeft".
function on(event: "participantsLeft", listener: ParticipantsLeftListener)
Parámetros
- event
-
"participantsLeft"
- listener
- ParticipantsLeftListener
heredado deCallAdapterSubscribers.on
on("realTimeTextReceived", RealTimeTextReceivedListener)
Función de suscripción para el evento 'realTimeTextReceived'.
function on(event: "realTimeTextReceived", listener: RealTimeTextReceivedListener)
Parámetros
- event
-
"realTimeTextReceived"
- listener
- RealTimeTextReceivedListener
heredado deCallAdapterSubscribers.on
on("roleChanged", PropertyChangedEvent)
Función de suscripción para el evento 'roleChanged'.
function on(event: "roleChanged", listener: PropertyChangedEvent)
Parámetros
- event
-
"roleChanged"
- listener
- PropertyChangedEvent
heredado deCallAdapterSubscribers.on
on("selectedMicrophoneChanged", PropertyChangedEvent)
Función Subscribe para el evento "selectedMicrophoneChanged".
Este evento se desencadena cada vez que el usuario selecciona un nuevo dispositivo de micrófono.
function on(event: "selectedMicrophoneChanged", listener: PropertyChangedEvent)
Parámetros
- event
-
"selectedMicrophoneChanged"
- listener
- PropertyChangedEvent
heredado deCallAdapterSubscribers.on
on("selectedSpeakerChanged", PropertyChangedEvent)
Función Subscribe para el evento "selectedSpeakerChanged".
Este evento se desencadena cada vez que el usuario selecciona un nuevo dispositivo de altavoz.
function on(event: "selectedSpeakerChanged", listener: PropertyChangedEvent)
Parámetros
- event
-
"selectedSpeakerChanged"
- listener
- PropertyChangedEvent
heredado deCallAdapterSubscribers.on
on("spotlightChanged", SpotlightChangedListener)
Función de suscripción para el evento 'spotlightChanged'.
function on(event: "spotlightChanged", listener: SpotlightChangedListener)
Parámetros
- event
-
"spotlightChanged"
- listener
- SpotlightChangedListener
heredado deCallAdapterSubscribers.on
on("transferAccepted", TransferAcceptedListener)
Función de suscripción para el evento 'transferRequested'.
function on(event: "transferAccepted", listener: TransferAcceptedListener)
Parámetros
- event
-
"transferAccepted"
- listener
- TransferAcceptedListener
heredado deCallAdapterSubscribers.on
onReactionClick(Reaction)
Enviar emoji de reacción
function onReactionClick(reaction: Reaction): Promise<void>
Parámetros
- reaction
- Reaction
Devoluciones
Promise<void>
heredado deCallAdapterCallOperations.onReactionClick
onStateChange((state: CallAdapterState) => void)
Suscribe el controlador a eventos stateChanged.
function onStateChange(handler: (state: CallAdapterState) => void)
Parámetros
- handler
-
(state: CallAdapterState) => void
heredado deAdapterState.onStateChange
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>
heredado deCallAdapterCallOperations.permitAudio
permitOthersAudio()
Permitir el audio de la reunión de los equipos.
function permitOthersAudio(): Promise<void>
Devoluciones
Promise<void>
heredado deCallAdapterCallOperations.permitOthersAudio
permitOthersVideo()
Vídeo de la reunión de los equipos de permisos.
function permitOthersVideo(): Promise<void>
Devoluciones
Promise<void>
heredado deCallAdapterCallOperations.permitOthersVideo
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>
heredado deCallAdapterCallOperations.permitVideo
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()
heredado deCallAdapterDeviceManagement.queryCameras
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()
Heredado deCallAdapterDeviceManagement.queryMicrophones
querySpeakers()
Consulta de los dispositivos de altavoz 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()
heredado deCallAdapterDeviceManagement.querySpeakers
raiseHand()
Levantar la mano para el usuario actual
function raiseHand(): Promise<void>
Devoluciones
Promise<void>
heredado deCallAdapterCallOperations.raiseHand
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>
Heredado deCallAdapterCallOperations.removeParticipant
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>
Heredado deCallAdapterCallOperations.removeParticipant
resumeCall()
Reanuda la llamada desde un LocalHold estado.
function resumeCall(): Promise<void>
Devoluciones
Promise<void>
heredado deCallAdapterCallOperations.resumeCall
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>
heredado deCallAdapterCallOperations.sendDtmfTone
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>
Heredado deCallAdapterDeviceManagement.setCamera
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>
heredado deCallAdapterCallOperations.setCaptionLanguage
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>
heredado deCallAdapterDeviceManagement.setMicrophone
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>
heredado deCallAdapterDeviceManagement.setSpeaker
setSpokenLanguage(string)
Función para configurar el idioma hablado
function setSpokenLanguage(language: string): Promise<void>
Parámetros
- language
-
string
Lenguaje hablado
Devoluciones
Promise<void>
heredado deCallAdapterCallOperations.setSpokenLanguage
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
heredado deCallAdapterCallOperations.setTogetherModeSceneSize
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>
Se hereda deCallAdapterCallOperations.startCamera
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>
heredado deCallAdapterCallOperations.startCaptions
startNoiseSuppressionEffect()
Inicie el efecto de supresión de ruido.
function startNoiseSuppressionEffect(): Promise<void>
Devoluciones
Promise<void>
heredado deCallAdapterCallOperations.startNoiseSuppressionEffect
startScreenShare()
Empiece a compartir la pantalla durante una llamada.
function startScreenShare(): Promise<void>
Devoluciones
Promise<void>
heredado deCallAdapterCallOperations.startScreenShare
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>
heredado deCallAdapterCallOperations.startSpotlight
startTogetherMode()
Modo Iniciar Juntos.
function startTogetherMode(): Promise<void>
Devoluciones
Promise<void>
heredado deCallAdapterCallOperations.startTogetherMode
startVideoBackgroundEffect(VideoBackgroundEffect)
Inicie el efecto de fondo del video.
function startVideoBackgroundEffect(videoBackgroundEffect: VideoBackgroundEffect): Promise<void>
Parámetros
- videoBackgroundEffect
- VideoBackgroundEffect
Devoluciones
Promise<void>
heredado deCallAdapterCallOperations.startVideoBackgroundEffect
stopAllSpotlight()
Detén todos los focos
function stopAllSpotlight(): Promise<void>
Devoluciones
Promise<void>
heredado deCallAdapterCallOperations.stopAllSpotlight
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>
heredado deCallAdapterCallOperations.stopCamera
stopCaptions(StopCaptionsAdapterOptions)
Función para detener los subtítulos
function stopCaptions(options?: StopCaptionsAdapterOptions): Promise<void>
Parámetros
- options
- StopCaptionsAdapterOptions
Devoluciones
Promise<void>
heredado deCallAdapterCallOperations.stopCaptions
stopNoiseSuppressionEffect()
Detenga el efecto de supresión de ruido.
function stopNoiseSuppressionEffect(): Promise<void>
Devoluciones
Promise<void>
heredado deCallAdapterCallOperations.stopNoiseSuppressionEffect
stopScreenShare()
Dejar de compartir la pantalla
function stopScreenShare(): Promise<void>
Devoluciones
Promise<void>
heredado deCallAdapterCallOperations.stopScreenShare
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>
heredado deCallAdapterCallOperations.stopSpotlight
stopVideoBackgroundEffects()
Detenga el efecto de fondo del video.
function stopVideoBackgroundEffects(): Promise<void>
Devoluciones
Promise<void>
heredado deCallAdapterCallOperations.stopVideoBackgroundEffects
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>
heredado deCallAdapterCallOperations.submitSurvey
unmute()
Desactivar el usuario actual durante la llamada o habilitar el micrófono localmente
function unmute(): Promise<void>
Devoluciones
Promise<void>
heredado deCallAdapterCallOperations.unmute
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.
heredado deCallAdapterCallOperations.updateBackgroundPickerImages
updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)
Actualice el efecto de fondo de video seleccionado.
function updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect)
Parámetros
- selectedVideoBackground
- VideoBackgroundEffect
heredado deCallAdapterCallOperations.updateSelectedVideoBackgroundEffect