CallWithChatAdapter interface
interfaz del adaptador CallWithChatComposite.
- Extends
Propiedades heredadas
| 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 heredados
Detalles de las propiedades heredadas
forbidAudio
Prohíbe el audio para los ID de usuario especificados.
forbidAudio: (userIds: string[]) => Promise<void>
Valor de propiedad
(userIds: string[]) => Promise<void>
heredado deCallWithChatAdapterManagement.forbidAudio
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>
heredado deCallWithChatAdapterManagement.forbidVideo
permitAudio
Permite audio para los ID de usuario especificados.
permitAudio: (userIds: string[]) => Promise<void>
Valor de propiedad
(userIds: string[]) => Promise<void>
heredado deCallWithChatAdapterManagement.permitAudio
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>
heredado deCallWithChatAdapterManagement.permitVideo
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>
heredado deCallWithChatAdapterManagement.sendDtmfTone
sendRealTimeText
Enviar texto en tiempo real
sendRealTimeText: (text: string, isFinalized: boolean) => Promise<void>
Valor de propiedad
(text: string, isFinalized: boolean) => Promise<void>
Detalles de los métodos heredados
addParticipant(CommunicationUserIdentifier)
function addParticipant(participant: CommunicationUserIdentifier): Promise<void>
Parámetros
- participant
- CommunicationUserIdentifier
Devoluciones
Promise<void>
heredado deCallWithChatAdapterManagement.addParticipant
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>
heredado deCallWithChatAdapterManagement.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.
heredado deCallWithChatAdapterManagement.askDevicePermission
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
heredado deCallWithChatAdapterManagement.createTogetherModeStreamView
deleteMessage(string)
Elimine un mensaje en el subproceso.
function deleteMessage(messageId: string): Promise<void>
Parámetros
- messageId
-
string
Devoluciones
Promise<void>
heredado deCallWithChatAdapterManagement.deleteMessage
dispose()
disposeLocalVideoStreamView()
Eliminación de la vista html para una secuencia de vídeo local
function disposeLocalVideoStreamView(): Promise<void>
Devoluciones
Promise<void>
heredado deCallWithChatAdapterManagement.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 deCallWithChatAdapterManagement.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 deCallWithChatAdapterManagement.disposeScreenShareStreamView
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
heredado deCallWithChatAdapterManagement.disposeTogetherModeStreamView
downloadResourceToCache(ResourceDetails)
function downloadResourceToCache(resourceDetails: ResourceDetails): Promise<void>
Parámetros
- resourceDetails
- ResourceDetails
Devoluciones
Promise<void>
heredado deCallWithChatAdapterManagement.downloadResourceToCache
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>
getState()
Obtener el estado actual
function getState(): CallWithChatAdapterState
Devoluciones
heredado deAdapterState.getState
holdCall()
Coloca la llamada en un localhold.
function holdCall(): Promise<void>
Devoluciones
Promise<void>
heredado deCallWithChatAdapterManagement.holdCall
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
Heredado deCallWithChatAdapterManagement.joinCall
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
Heredado deCallWithChatAdapterManagement.joinCall
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>
Heredado deCallWithChatAdapterManagement.leaveCall
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.
Heredado deCallWithChatAdapterManagement.loadPreviousChatMessages
lowerHand()
Manecilla inferior para usuario local.
function lowerHand(): Promise<void>
Devoluciones
Promise<void>
heredado deCallWithChatAdapterManagement.lowerHand
mute()
Silenciar al usuario actual durante la llamada o deshabilitar el micrófono localmente.
function mute(): Promise<void>
Devoluciones
Promise<void>
heredado decallWithChatAdapterManagement.mute
muteAllRemoteParticipants()
Silenciar a un participante
function muteAllRemoteParticipants(): Promise<void>
Devoluciones
Promise<void>
heredado deCallWithChatAdapterManagement.muteAllRemoteParticipants
muteParticipant(string)
Silenciar a un participante
function muteParticipant(userId: string): Promise<void>
Parámetros
- userId
-
string
Devoluciones
Promise<void>
off("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)
function off(event: "breakoutRoomsUpdated", listener: BreakoutRoomsUpdatedListener)
Parámetros
- event
-
"breakoutRoomsUpdated"
- listener
- BreakoutRoomsUpdatedListener
heredado deCallWithChatAdapterSubscriptions.off
off("callEnded", CallEndedListener)
function off(event: "callEnded", listener: CallEndedListener)
Parámetros
- event
-
"callEnded"
- listener
- CallEndedListener
heredado deCallWithChatAdapterSubscriptions.off
off("callError", (e: AdapterError) => void)
function off(event: "callError", listener: (e: AdapterError) => void)
Parámetros
- event
-
"callError"
- listener
-
(e: AdapterError) => void
heredado deCallWithChatAdapterSubscriptions.off
off("callIdChanged", CallIdChangedListener)
function off(event: "callIdChanged", listener: CallIdChangedListener)
Parámetros
- event
-
"callIdChanged"
- listener
- CallIdChangedListener
heredado deCallWithChatAdapterSubscriptions.off
off("callParticipantsJoined", ParticipantsJoinedListener)
function off(event: "callParticipantsJoined", listener: ParticipantsJoinedListener)
Parámetros
- event
-
"callParticipantsJoined"
- listener
- ParticipantsJoinedListener
heredado deCallWithChatAdapterSubscriptions.off
off("callParticipantsLeft", ParticipantsLeftListener)
function off(event: "callParticipantsLeft", listener: ParticipantsLeftListener)
Parámetros
- event
-
"callParticipantsLeft"
- listener
- ParticipantsLeftListener
heredado deCallWithChatAdapterSubscriptions.off
off("capabilitiesChanged", CapabilitiesChangedListener)
function off(event: "capabilitiesChanged", listener: CapabilitiesChangedListener)
Parámetros
- event
-
"capabilitiesChanged"
- listener
- CapabilitiesChangedListener
heredado deCallWithChatAdapterSubscriptions.off
off("captionsReceived", CaptionsReceivedListener)
function off(event: "captionsReceived", listener: CaptionsReceivedListener)
Parámetros
- event
-
"captionsReceived"
- listener
- CaptionsReceivedListener
heredado deCallWithChatAdapterSubscriptions.off
off("chatError", (e: AdapterError) => void)
function off(event: "chatError", listener: (e: AdapterError) => void)
Parámetros
- event
-
"chatError"
- listener
-
(e: AdapterError) => void
heredado deCallWithChatAdapterSubscriptions.off
off("chatInitialized", ChatInitializedListener)
function off(event: "chatInitialized", listener: ChatInitializedListener)
Parámetros
- event
-
"chatInitialized"
- listener
- ChatInitializedListener
heredado deCallWithChatAdapterSubscriptions.off
off("chatParticipantsAdded", ParticipantsAddedListener)
function off(event: "chatParticipantsAdded", listener: ParticipantsAddedListener)
Parámetros
- event
-
"chatParticipantsAdded"
- listener
- ParticipantsAddedListener
heredado deCallWithChatAdapterSubscriptions.off
off("chatParticipantsRemoved", ParticipantsRemovedListener)
function off(event: "chatParticipantsRemoved", listener: ParticipantsRemovedListener)
Parámetros
- event
-
"chatParticipantsRemoved"
- listener
- ParticipantsRemovedListener
heredado deCallWithChatAdapterSubscriptions.off
off("displayNameChanged", DisplayNameChangedListener)
function off(event: "displayNameChanged", listener: DisplayNameChangedListener)
Parámetros
- event
-
"displayNameChanged"
- listener
- DisplayNameChangedListener
heredado deCallWithChatAdapterSubscriptions.off
off("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)
function off(event: "isCaptionLanguageChanged", listener: IsCaptionLanguageChangedListener)
Parámetros
- event
-
"isCaptionLanguageChanged"
- listener
- IsCaptionLanguageChangedListener
heredado deCallWithChatAdapterSubscriptions.off
off("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)
function off(event: "isCaptionsActiveChanged", listener: IsCaptionsActiveChangedListener)
Parámetros
- event
-
"isCaptionsActiveChanged"
- listener
- IsCaptionsActiveChangedListener
heredado deCallWithChatAdapterSubscriptions.off
off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)
function off(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)
Parámetros
- event
-
"isLocalScreenSharingActiveChanged"
heredado deCallWithChatAdapterSubscriptions.off
off("isMutedChanged", IsMutedChangedListener)
function off(event: "isMutedChanged", listener: IsMutedChangedListener)
Parámetros
- event
-
"isMutedChanged"
- listener
- IsMutedChangedListener
heredado deCallWithChatAdapterSubscriptions.off
off("isSpeakingChanged", IsSpeakingChangedListener)
function off(event: "isSpeakingChanged", listener: IsSpeakingChangedListener)
Parámetros
- event
-
"isSpeakingChanged"
- listener
- IsSpeakingChangedListener
heredado deCallWithChatAdapterSubscriptions.off
off("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)
function off(event: "isSpokenLanguageChanged", listener: IsSpokenLanguageChangedListener)
Parámetros
- event
-
"isSpokenLanguageChanged"
- listener
- IsSpokenLanguageChangedListener
heredado deCallWithChatAdapterSubscriptions.off
off("messageDeleted", MessageReceivedListener)
function off(event: "messageDeleted", listener: MessageReceivedListener)
Parámetros
- event
-
"messageDeleted"
- listener
- MessageReceivedListener
heredado deCallWithChatAdapterSubscriptions.off
off("messageEdited", MessageReceivedListener)
function off(event: "messageEdited", listener: MessageReceivedListener)
Parámetros
- event
-
"messageEdited"
- listener
- MessageReceivedListener
heredado deCallWithChatAdapterSubscriptions.off
off("messageRead", MessageReadListener)
function off(event: "messageRead", listener: MessageReadListener)
Parámetros
- event
-
"messageRead"
- listener
- MessageReadListener
heredado deCallWithChatAdapterSubscriptions.off
off("messageReceived", MessageReceivedListener)
function off(event: "messageReceived", listener: MessageReceivedListener)
Parámetros
- event
-
"messageReceived"
- listener
- MessageReceivedListener
heredado deCallWithChatAdapterSubscriptions.off
off("messageSent", MessageReceivedListener)
function off(event: "messageSent", listener: MessageReceivedListener)
Parámetros
- event
-
"messageSent"
- listener
- MessageReceivedListener
heredado deCallWithChatAdapterSubscriptions.off
off("realTimeTextReceived", RealTimeTextReceivedListener)
function off(event: "realTimeTextReceived", listener: RealTimeTextReceivedListener)
Parámetros
- event
-
"realTimeTextReceived"
- listener
- RealTimeTextReceivedListener
heredado deCallWithChatAdapterSubscriptions.off
off("selectedMicrophoneChanged", PropertyChangedEvent)
function off(event: "selectedMicrophoneChanged", listener: PropertyChangedEvent)
Parámetros
- event
-
"selectedMicrophoneChanged"
- listener
- PropertyChangedEvent
heredado deCallWithChatAdapterSubscriptions.off
off("selectedSpeakerChanged", PropertyChangedEvent)
function off(event: "selectedSpeakerChanged", listener: PropertyChangedEvent)
Parámetros
- event
-
"selectedSpeakerChanged"
- listener
- PropertyChangedEvent
heredado deCallWithChatAdapterSubscriptions.off
off("spotlightChanged", SpotlightChangedListener)
function off(event: "spotlightChanged", listener: SpotlightChangedListener)
Parámetros
- event
-
"spotlightChanged"
- listener
- SpotlightChangedListener
heredado deCallWithChatAdapterSubscriptions.off
offStateChange((state: CallWithChatAdapterState) => void)
Cancela la suscripción del controlador a los eventos stateChanged.
function offStateChange(handler: (state: CallWithChatAdapterState) => void)
Parámetros
- handler
-
(state: CallWithChatAdapterState) => void
se hereda deAdapterState.offStateChange
on("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)
function on(event: "breakoutRoomsUpdated", listener: BreakoutRoomsUpdatedListener)
Parámetros
- event
-
"breakoutRoomsUpdated"
- listener
- BreakoutRoomsUpdatedListener
heredado deCallWithChatAdapterSubscriptions.on
on("callEnded", CallEndedListener)
function on(event: "callEnded", listener: CallEndedListener)
Parámetros
- event
-
"callEnded"
- listener
- CallEndedListener
heredado deCallWithChatAdapterSubscriptions.on
on("callError", (e: AdapterError) => void)
function on(event: "callError", listener: (e: AdapterError) => void)
Parámetros
- event
-
"callError"
- listener
-
(e: AdapterError) => void
heredado deCallWithChatAdapterSubscriptions.on
on("callIdChanged", CallIdChangedListener)
function on(event: "callIdChanged", listener: CallIdChangedListener)
Parámetros
- event
-
"callIdChanged"
- listener
- CallIdChangedListener
heredado deCallWithChatAdapterSubscriptions.on
on("callParticipantsJoined", ParticipantsJoinedListener)
function on(event: "callParticipantsJoined", listener: ParticipantsJoinedListener)
Parámetros
- event
-
"callParticipantsJoined"
- listener
- ParticipantsJoinedListener
heredado deCallWithChatAdapterSubscriptions.on
on("callParticipantsLeft", ParticipantsLeftListener)
function on(event: "callParticipantsLeft", listener: ParticipantsLeftListener)
Parámetros
- event
-
"callParticipantsLeft"
- listener
- ParticipantsLeftListener
heredado deCallWithChatAdapterSubscriptions.on
on("capabilitiesChanged", CapabilitiesChangedListener)
function on(event: "capabilitiesChanged", listener: CapabilitiesChangedListener)
Parámetros
- event
-
"capabilitiesChanged"
- listener
- CapabilitiesChangedListener
heredado deCallWithChatAdapterSubscriptions.on
on("captionsReceived", CaptionsReceivedListener)
function on(event: "captionsReceived", listener: CaptionsReceivedListener)
Parámetros
- event
-
"captionsReceived"
- listener
- CaptionsReceivedListener
heredado deCallWithChatAdapterSubscriptions.on
on("chatError", (e: AdapterError) => void)
function on(event: "chatError", listener: (e: AdapterError) => void)
Parámetros
- event
-
"chatError"
- listener
-
(e: AdapterError) => void
heredado deCallWithChatAdapterSubscriptions.on
on("chatInitialized", ChatInitializedListener)
function on(event: "chatInitialized", listener: ChatInitializedListener)
Parámetros
- event
-
"chatInitialized"
- listener
- ChatInitializedListener
heredado deCallWithChatAdapterSubscriptions.on
on("chatParticipantsAdded", ParticipantsAddedListener)
function on(event: "chatParticipantsAdded", listener: ParticipantsAddedListener)
Parámetros
- event
-
"chatParticipantsAdded"
- listener
- ParticipantsAddedListener
heredado deCallWithChatAdapterSubscriptions.on
on("chatParticipantsRemoved", ParticipantsRemovedListener)
function on(event: "chatParticipantsRemoved", listener: ParticipantsRemovedListener)
Parámetros
- event
-
"chatParticipantsRemoved"
- listener
- ParticipantsRemovedListener
heredado deCallWithChatAdapterSubscriptions.on
on("displayNameChanged", DisplayNameChangedListener)
function on(event: "displayNameChanged", listener: DisplayNameChangedListener)
Parámetros
- event
-
"displayNameChanged"
- listener
- DisplayNameChangedListener
heredado deCallWithChatAdapterSubscriptions.on
on("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)
function on(event: "isCaptionLanguageChanged", listener: IsCaptionLanguageChangedListener)
Parámetros
- event
-
"isCaptionLanguageChanged"
- listener
- IsCaptionLanguageChangedListener
heredado deCallWithChatAdapterSubscriptions.on
on("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)
function on(event: "isCaptionsActiveChanged", listener: IsCaptionsActiveChangedListener)
Parámetros
- event
-
"isCaptionsActiveChanged"
- listener
- IsCaptionsActiveChangedListener
heredado deCallWithChatAdapterSubscriptions.on
on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)
function on(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)
Parámetros
- event
-
"isLocalScreenSharingActiveChanged"
heredado deCallWithChatAdapterSubscriptions.on
on("isMutedChanged", IsMutedChangedListener)
function on(event: "isMutedChanged", listener: IsMutedChangedListener)
Parámetros
- event
-
"isMutedChanged"
- listener
- IsMutedChangedListener
heredado deCallWithChatAdapterSubscriptions.on
on("isSpeakingChanged", IsSpeakingChangedListener)
function on(event: "isSpeakingChanged", listener: IsSpeakingChangedListener)
Parámetros
- event
-
"isSpeakingChanged"
- listener
- IsSpeakingChangedListener
heredado deCallWithChatAdapterSubscriptions.on
on("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)
function on(event: "isSpokenLanguageChanged", listener: IsSpokenLanguageChangedListener)
Parámetros
- event
-
"isSpokenLanguageChanged"
- listener
- IsSpokenLanguageChangedListener
heredado deCallWithChatAdapterSubscriptions.on
on("messageDeleted", MessageReceivedListener)
function on(event: "messageDeleted", listener: MessageReceivedListener)
Parámetros
- event
-
"messageDeleted"
- listener
- MessageReceivedListener
heredado deCallWithChatAdapterSubscriptions.on
on("messageEdited", MessageReceivedListener)
function on(event: "messageEdited", listener: MessageReceivedListener)
Parámetros
- event
-
"messageEdited"
- listener
- MessageReceivedListener
heredado deCallWithChatAdapterSubscriptions.on
on("messageRead", MessageReadListener)
function on(event: "messageRead", listener: MessageReadListener)
Parámetros
- event
-
"messageRead"
- listener
- MessageReadListener
heredado deCallWithChatAdapterSubscriptions.on
on("messageReceived", MessageReceivedListener)
function on(event: "messageReceived", listener: MessageReceivedListener)
Parámetros
- event
-
"messageReceived"
- listener
- MessageReceivedListener
heredado deCallWithChatAdapterSubscriptions.on
on("messageSent", MessageReceivedListener)
function on(event: "messageSent", listener: MessageReceivedListener)
Parámetros
- event
-
"messageSent"
- listener
- MessageReceivedListener
heredado deCallWithChatAdapterSubscriptions.on
on("realTimeTextReceived", RealTimeTextReceivedListener)
function on(event: "realTimeTextReceived", listener: RealTimeTextReceivedListener)
Parámetros
- event
-
"realTimeTextReceived"
- listener
- RealTimeTextReceivedListener
heredado deCallWithChatAdapterSubscriptions.on
on("selectedMicrophoneChanged", PropertyChangedEvent)
function on(event: "selectedMicrophoneChanged", listener: PropertyChangedEvent)
Parámetros
- event
-
"selectedMicrophoneChanged"
- listener
- PropertyChangedEvent
heredado deCallWithChatAdapterSubscriptions.on
on("selectedSpeakerChanged", PropertyChangedEvent)
function on(event: "selectedSpeakerChanged", listener: PropertyChangedEvent)
Parámetros
- event
-
"selectedSpeakerChanged"
- listener
- PropertyChangedEvent
heredado deCallWithChatAdapterSubscriptions.on
on("spotlightChanged", SpotlightChangedListener)
function on(event: "spotlightChanged", listener: SpotlightChangedListener)
Parámetros
- event
-
"spotlightChanged"
- listener
- SpotlightChangedListener
heredado deCallWithChatAdapterSubscriptions.on
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>
onStateChange((state: CallWithChatAdapterState) => void)
Suscribe el controlador a eventos stateChanged.
function onStateChange(handler: (state: CallWithChatAdapterState) => void)
Parámetros
- handler
-
(state: CallWithChatAdapterState) => void
heredado deAdapterState.onStateChange
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 deCallWithChatAdapterManagement.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()
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()
heredado deCallWithChatAdapterManagement.querySpeakers
raiseHand()
Levante la mano por el usuario local.
function raiseHand(): Promise<void>
Devoluciones
Promise<void>
heredado deCallWithChatAdapterManagement.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>
se hereda deCallWithChatAdapterManagement.removeParticipant
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>
se hereda deCallWithChatAdapterManagement.removeParticipant
removeResourceFromCache(ResourceDetails)
function removeResourceFromCache(resourceDetails: ResourceDetails)
Parámetros
- resourceDetails
- ResourceDetails
heredado deCallWithChatAdapterManagement.removeResourceFromCache
resumeCall()
Reanuda la llamada desde un estado LocalHold.
function resumeCall(): Promise<void>
Devoluciones
Promise<void>
heredado deCallWithChatAdapterManagement.resumeCall
returnFromBreakoutRoom()
Volver a la llamada de origen de la sala para grupos pequeños
function returnFromBreakoutRoom(): Promise<void>
Devoluciones
Promise<void>
heredado deCallWithChatAdapterManagement.returnFromBreakoutRoom
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>
se hereda decallWithChatAdapterManagement.sendMessage
sendReadReceipt(string)
Enviar una confirmación de lectura para un mensaje.
function sendReadReceipt(chatMessageId: string): Promise<void>
Parámetros
- chatMessageId
-
string
Devoluciones
Promise<void>
Se hereda deCallWithChatAdapterManagement.sendReadReceipt
sendTypingIndicator()
Enviar indicador de escritura en el subproceso.
function sendTypingIndicator(): Promise<void>
Devoluciones
Promise<void>
heredado deCallWithChatAdapterManagement.sendTypingIndicator
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 deCallWithChatAdapterManagement.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>
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 deCallWithChatAdapterManagement.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 deCallWithChatAdapterManagement.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>
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 deCallWithChatAdapterManagement.setTogetherModeSceneSize
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
Heredado deCallWithChatAdapterManagement.startCall
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
Heredado deCallWithChatAdapterManagement.startCall
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>
Se hereda deCallWithChatAdapterManagement.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 deCallWithChatAdapterManagement.startCaptions
startNoiseSuppressionEffect()
Inicie el efecto de supresión de ruido.
function startNoiseSuppressionEffect(): Promise<void>
Devoluciones
Promise<void>
heredado deCallWithChatAdapterManagement.startNoiseSuppressionEffect
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>
heredado deCallWithChatAdapterManagement.startSpotlight
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>
heredado deCallWithChatAdapterManagement.startVideoBackgroundEffect
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>
heredado deCallWithChatAdapterManagement.stopCamera
stopCaptions(StopCaptionsAdapterOptions)
Función para detener los subtítulos
function stopCaptions(options?: StopCaptionsAdapterOptions): Promise<void>
Parámetros
- options
- StopCaptionsAdapterOptions
Devoluciones
Promise<void>
heredado deCallWithChatAdapterManagement.stopCaptions
stopNoiseSuppressionEffect()
Inicie el efecto de supresión de ruido.
function stopNoiseSuppressionEffect(): Promise<void>
Devoluciones
Promise<void>
heredado deCallWithChatAdapterManagement.stopNoiseSuppressionEffect
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>
heredado deCallWithChatAdapterManagement.stopSpotlight
stopVideoBackgroundEffects()
Detenga el efecto de fondo del video.
function stopVideoBackgroundEffects(): Promise<void>
Devoluciones
Promise<void>
heredado deCallWithChatAdapterManagement.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 deCallWithChatAdapterManagement.submitSurvey
unmute()
Desmute el usuario actual durante la llamada o habilite el micrófono localmente.
function unmute(): Promise<void>
Devoluciones
Promise<void>
heredado deCallWithChatAdapterManagement.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 deCallWithChatAdapterManagement.updateBackgroundPickerImages
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>
se hereda decallWithChatAdapterManagement.updateMessage
updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)
Actualizar el efecto de fondo de vídeo seleccionado
function updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect)
Parámetros
- selectedVideoBackground
- VideoBackgroundEffect
heredado deCallWithChatAdapterManagement.updateSelectedVideoBackgroundEffect