CallWithChatAdapterManagement interface

Paquete:

@azure/communication-react

Funcionalidad para administrar la llamada actual con chat.

Métodos

askDevicePermission(PermissionConstraints)	Solicitar permisos de dispositivos.
createStreamView(string, VideoStreamOptions)	Cree la vista html para una secuencia.
deleteMessage(string)	Elimine un mensaje en el subproceso.
disposeStreamView(string, VideoStreamOptions)	Elimine la vista html de una secuencia.
fetchInitialData()	Capturar el estado inicial del adaptador de chat. Realiza la captura mínima necesaria para los métodos chatComposite y API.
joinCall(boolean)	Únase a la llamada con el micrófono inicialmente activado o desactivado.
leaveCall(boolean)	Deje la llamada.
loadPreviousChatMessages(number)	Cargue más mensajes anteriores en el historial de subprocesos de chat.
mute()	Silenciar al usuario actual durante la llamada o deshabilitar el micrófono localmente.
queryCameras()	Consulta de dispositivos de cámara disponibles.
queryMicrophones()	Consulte los dispositivos de micrófono disponibles.
querySpeakers()	Consulte los dispositivos de micrófono disponibles.
removeParticipant(string)	Quite un participante de una llamada.
sendMessage(string, SendMessageOptions)	Envíe un mensaje en el subproceso.
sendReadReceipt(string)	Envíe un recibo de lectura para un mensaje.
sendTypingIndicator()	Enviar indicador de escritura en el subproceso.
setCamera(VideoDeviceInfo, VideoStreamOptions)	Establezca la cámara que se usará en la llamada.
setMicrophone(AudioDeviceInfo)	Establezca el micrófono que se va a usar en la llamada.
setSpeaker(AudioDeviceInfo)	Establezca el altavoz que se usará en la llamada.
startCall(string[], StartCallOptions)	Inicie la llamada.
startCamera(VideoStreamOptions)	Inicie la cámara. Este método comenzará a representar una vista de cámara local cuando la llamada no esté activa.
startScreenShare()	Comience a compartir la pantalla durante una llamada.
stopCamera()	Detenga la cámara. Este método dejará de representar una vista de cámara local cuando la llamada no esté activa.
stopScreenShare()	Deje de compartir la pantalla.
unmute()	Desactive el usuario actual durante la llamada o habilite el micrófono localmente.
updateMessage(string, string, Record<string, string>)	Actualizar un contenido del mensaje.

Detalles del método

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.

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>

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>

joinCall(boolean)

Únase a la llamada con el micrófono inicialmente activado o desactivado.

function joinCall(microphoneOn?: boolean): undefined | Call

Parámetros

microphoneOn

boolean

Si el micrófono está habilitado inicialmente

Devoluciones

undefined | Call

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>

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.

mute()

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

function mute(): Promise<void>

Devoluciones

Promise<void>

queryCameras()

Consulta de dispositivos de cámara disponibles.

function queryCameras(): Promise<VideoDeviceInfo[]>

Devoluciones

Promise<VideoDeviceInfo[]>

Matriz de entidades de información de dispositivo de vídeo <xref:%40azure%2Fcommunication-calling%23VideoDeviceInfo>

Comentarios

Se debe llamar a este método después de askDevicePermission()

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()

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>

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>

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>

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>

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>

startCall(string[], StartCallOptions)

Inicie la llamada.

function startCall(participants: string[], options?: StartCallOptions): undefined | Call

Parámetros

participants

string[]

Matriz de identificadores de participante que se van a unir

options

StartCallOptions

Devoluciones

undefined | Call

startCamera(VideoStreamOptions)

Inicie la cámara.

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

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

Parámetros

options

VideoStreamOptions

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

Devoluciones

Promise<void>

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>

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>

updateMessage(string, string, Record<string, string>)

Actualizar un contenido del 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>