CallWithChatAdapter interface
CallWithChatComposite Interfaz del adaptador.
- Extends
Métodos heredados
Detalles de los métodos heredados
askDevicePermission(PermissionConstraints)
Solicitar permisos de dispositivos.
function askDevicePermission(constrain: PermissionConstraints): Promise<void>Parámetros
- constrain
- PermissionConstraints
Definición de restricciones para acceder a dispositivos locales <xref:%40azure%2Fcommunication-calling%23PermissionConstraints>
Devoluciones
Promise<void>
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.
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()
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, déjelo sin definir 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.
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(): CallWithChatAdapterStateDevoluciones
Heredado deAdapterState.getState
joinCall(boolean)
Únase a la llamada con el micrófono inicialmente activado o desactivado.
function joinCall(microphoneOn?: boolean): undefined | CallParámetros
- microphoneOn
-
boolean
Si el micrófono está habilitado inicialmente
Devoluciones
undefined | Call
Heredado deCallWithChatAdapterManagement.joinCall
leaveCall(boolean)
Deje la llamada.
function leaveCall(forEveryone?: boolean): Promise<void>Parámetros
- forEveryone
-
boolean
Si se van a quitar todos los participantes
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
mute()
Silenciar al usuario actual durante la llamada o deshabilitar el micrófono localmente.
function mute(): Promise<void>Devoluciones
Promise<void>
Heredado deCallWithChatAdapterManagement.mute
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("chatError", (e: AdapterError) => void)
function off(event: "chatError", listener: (e: AdapterError) => void)Parámetros
- event
-
"chatError"
- listener
-
(e: AdapterError) => void
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("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("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("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
offStateChange((state: CallWithChatAdapterState) => void)
Cancela la suscripción del controlador a eventos stateChanged.
function offStateChange(handler: (state: CallWithChatAdapterState) => void)Parámetros
- handler
-
(state: CallWithChatAdapterState) => void
Heredado deAdapterState.offStateChange
on("callEnded", CallEndedListener)
function on(event: "callEnded", listener: CallEndedListener)Parámetros
- event
-
"callEnded"
- listener
- CallEndedListener
Se hereda deCallWithChatAdapterSubscriptions.on
on("callError", (e: AdapterError) => void)
function on(event: "callError", listener: (e: AdapterError) => void)Parámetros
- event
-
"callError"
- listener
-
(e: AdapterError) => void
Se hereda deCallWithChatAdapterSubscriptions.on
on("callIdChanged", CallIdChangedListener)
function on(event: "callIdChanged", listener: CallIdChangedListener)Parámetros
- event
-
"callIdChanged"
- listener
- CallIdChangedListener
Se hereda deCallWithChatAdapterSubscriptions.on
on("callParticipantsJoined", ParticipantsJoinedListener)
function on(event: "callParticipantsJoined", listener: ParticipantsJoinedListener)Parámetros
- event
-
"callParticipantsJoined"
- listener
- ParticipantsJoinedListener
Se hereda deCallWithChatAdapterSubscriptions.on
on("callParticipantsLeft", ParticipantsLeftListener)
function on(event: "callParticipantsLeft", listener: ParticipantsLeftListener)Parámetros
- event
-
"callParticipantsLeft"
- listener
- ParticipantsLeftListener
Se hereda deCallWithChatAdapterSubscriptions.on
on("chatError", (e: AdapterError) => void)
function on(event: "chatError", listener: (e: AdapterError) => void)Parámetros
- event
-
"chatError"
- listener
-
(e: AdapterError) => void
Se hereda deCallWithChatAdapterSubscriptions.on
on("chatParticipantsAdded", ParticipantsAddedListener)
function on(event: "chatParticipantsAdded", listener: ParticipantsAddedListener)Parámetros
- event
-
"chatParticipantsAdded"
- listener
- ParticipantsAddedListener
Se hereda deCallWithChatAdapterSubscriptions.on
on("chatParticipantsRemoved", ParticipantsRemovedListener)
function on(event: "chatParticipantsRemoved", listener: ParticipantsRemovedListener)Parámetros
- event
-
"chatParticipantsRemoved"
- listener
- ParticipantsRemovedListener
Se hereda deCallWithChatAdapterSubscriptions.on
on("displayNameChanged", DisplayNameChangedListener)
function on(event: "displayNameChanged", listener: DisplayNameChangedListener)Parámetros
- event
-
"displayNameChanged"
- listener
- DisplayNameChangedListener
Se hereda deCallWithChatAdapterSubscriptions.on
on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)
function on(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)Parámetros
- event
-
"isLocalScreenSharingActiveChanged"
Se hereda deCallWithChatAdapterSubscriptions.on
on("isMutedChanged", IsMutedChangedListener)
function on(event: "isMutedChanged", listener: IsMutedChangedListener)Parámetros
- event
-
"isMutedChanged"
- listener
- IsMutedChangedListener
Se hereda deCallWithChatAdapterSubscriptions.on
on("isSpeakingChanged", IsSpeakingChangedListener)
function on(event: "isSpeakingChanged", listener: IsSpeakingChangedListener)Parámetros
- event
-
"isSpeakingChanged"
- listener
- IsSpeakingChangedListener
Se hereda deCallWithChatAdapterSubscriptions.on
on("messageRead", MessageReadListener)
function on(event: "messageRead", listener: MessageReadListener)Parámetros
- event
-
"messageRead"
- listener
- MessageReadListener
Se hereda deCallWithChatAdapterSubscriptions.on
on("messageReceived", MessageReceivedListener)
function on(event: "messageReceived", listener: MessageReceivedListener)Parámetros
- event
-
"messageReceived"
- listener
- MessageReceivedListener
Se hereda deCallWithChatAdapterSubscriptions.on
on("messageSent", MessageReceivedListener)
function on(event: "messageSent", listener: MessageReceivedListener)Parámetros
- event
-
"messageSent"
- listener
- MessageReceivedListener
Se hereda deCallWithChatAdapterSubscriptions.on
on("selectedMicrophoneChanged", PropertyChangedEvent)
function on(event: "selectedMicrophoneChanged", listener: PropertyChangedEvent)Parámetros
- event
-
"selectedMicrophoneChanged"
- listener
- PropertyChangedEvent
Se hereda deCallWithChatAdapterSubscriptions.on
on("selectedSpeakerChanged", PropertyChangedEvent)
function on(event: "selectedSpeakerChanged", listener: PropertyChangedEvent)Parámetros
- event
-
"selectedSpeakerChanged"
- listener
- PropertyChangedEvent
Se hereda deCallWithChatAdapterSubscriptions.on
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 dispositivo de vídeo <xref:%40azure%2Fcommunication-calling%23VideoDeviceInfo>
Comentarios
Se debe llamar a este método después de askDevicePermission()
Heredado deCallWithChatAdapterManagement.queryCameras
queryMicrophones()
Consulte los dispositivos de micrófono disponibles.
function queryMicrophones(): Promise<AudioDeviceInfo[]>Devoluciones
Promise<AudioDeviceInfo[]>
Matriz de entidades de información de dispositivos de audio <xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo>
Comentarios
Se debe llamar a este método después de askDevicePermission()
querySpeakers()
Consulte los dispositivos de micrófono disponibles.
function querySpeakers(): Promise<AudioDeviceInfo[]>Devoluciones
Promise<AudioDeviceInfo[]>
Matriz de entidades de información de dispositivos de audio <xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo>
Comentarios
Se debe llamar a este método después de askDevicePermission()
Heredado deCallWithChatAdapterManagement.querySpeakers
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>
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>
Heredado deCallWithChatAdapterManagement.sendMessage
sendReadReceipt(string)
Envíe un recibo 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>
Heredado deCallWithChatAdapterManagement.sendTypingIndicator
setCamera(VideoDeviceInfo, VideoStreamOptions)
Establezca la cámara que se 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
setMicrophone(AudioDeviceInfo)
Establezca el micrófono que se va a usar en la llamada.
function setMicrophone(sourceInfo: AudioDeviceInfo): Promise<void>Parámetros
- sourceInfo
- AudioDeviceInfo
Dispositivo de micrófono que se va a 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
startCall(string[], StartCallOptions)
Inicie la llamada.
function startCall(participants: string[], options?: StartCallOptions): undefined | CallPará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>
Heredado deCallWithChatAdapterManagement.startCamera
startScreenShare()
Comience a compartir la pantalla durante una llamada.
function startScreenShare(): 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
stopScreenShare()
Deje de compartir la pantalla.
function stopScreenShare(): Promise<void>Devoluciones
Promise<void>
unmute()
Desactive el usuario actual durante la llamada o habilite el micrófono localmente.
function unmute(): Promise<void>Devoluciones
Promise<void>
Heredado deCallWithChatAdapterManagement.unmute
updateMessage(string, string, Record<string, string>)
Actualice un contenido de mensaje.
function updateMessage(messageId: string, content: string, metadata?: Record<string, string>): Promise<void>Parámetros
- messageId
-
string
- content
-
string
- metadata
-
Record<string, string>
Devoluciones
Promise<void>
Heredado deCallWithChatAdapterManagement.updateMessage