CallWithChatAdapterManagement interface

Pacote:

@azure/communication-react

Funcionalidade para gerenciar a chamada atual com chat.

Métodos

askDevicePermission(PermissionConstraints)	Solicite permissões de dispositivos.
createStreamView(string, VideoStreamOptions)	Crie a exibição html para um fluxo.
deleteMessage(string)	Exclua uma mensagem no thread.
disposeStreamView(string, VideoStreamOptions)	Descarte a exibição html de um fluxo.
fetchInitialData()	Buscar o estado inicial do adaptador de chat. Executa a busca mínima necessária para métodos chatComposite e API.
joinCall(boolean)	Ingresse a chamada com o microfone inicialmente ativado/desativado.
leaveCall(boolean)	Deixe a chamada.
loadPreviousChatMessages(number)	Carregue mais mensagens anteriores no histórico de threads de chat.
mute()	Ativar mudo do usuário atual durante a chamada ou desabilitar o microfone localmente.
queryCameras()	Consultar dispositivos de câmera disponíveis.
queryMicrophones()	Consultar dispositivos de microfone disponíveis.
querySpeakers()	Consultar dispositivos de microfone disponíveis.
removeParticipant(string)	Remova um participante de uma Chamada.
sendMessage(string, SendMessageOptions)	Envie uma mensagem no thread.
sendReadReceipt(string)	Envie um recibo de leitura para uma mensagem.
sendTypingIndicator()	Enviar indicador de digitação no thread.
setCamera(VideoDeviceInfo, VideoStreamOptions)	Defina a câmera a ser usada na chamada.
setMicrophone(AudioDeviceInfo)	Defina o microfone a ser usado na chamada.
setSpeaker(AudioDeviceInfo)	Defina o alto-falante a ser usado na chamada.
startCall(string[], StartCallOptions)	Inicie a chamada.
startCamera(VideoStreamOptions)	Inicie a câmera. Esse método começará a renderizar uma exibição de câmera local quando a chamada não estiver ativa.
startScreenShare()	Comece a compartilhar a tela durante uma chamada.
stopCamera()	Pare a câmera. Esse método interromperá a renderização de uma exibição de câmera local quando a chamada não estiver ativa.
stopScreenShare()	Pare de compartilhar a tela.
unmute()	Desativar o usuário atual durante a chamada ou habilitar o microfone localmente.
updateMessage(string, string, Record<string, string>)	Atualizar um conteúdo de mensagem.

Detalhes do método

askDevicePermission(PermissionConstraints)

Solicite permissões de dispositivos.

function askDevicePermission(constrain: PermissionConstraints): Promise<void>

Parâmetros

constrain

PermissionConstraints

Definir restrições para acessar dispositivos locais <xref:%40azure%2Fcommunication-calling%23PermissionConstraints>

Retornos

Promise<void>

Comentários

A janela de permissão do navegador será exibida se as permissões ainda não forem concedidas.

createStreamView(string, VideoStreamOptions)

Crie a exibição html para um fluxo.

function createStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void | CreateVideoStreamViewResult>

Parâmetros

remoteUserId

string

Id do participante a ser renderizado, deixe-o indefinido para criar o modo de exibição de câmera local

options

VideoStreamOptions

Opções para controlar como os fluxos de vídeo são renderizados <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Retornos

Promise<void | CreateVideoStreamViewResult>

Comentários

Esse método é implementado para composição.

deleteMessage(string)

Exclua uma mensagem no thread.

function deleteMessage(messageId: string): Promise<void>

Parâmetros

messageId

string

Retornos

Promise<void>

disposeStreamView(string, VideoStreamOptions)

Descarte a exibição html de um fluxo.

function disposeStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void>

Parâmetros

remoteUserId

string

Id do participante a ser renderizado, deixe-o indefinido para descartar a exibição da câmera local

options

VideoStreamOptions

Opções para controlar como os fluxos de vídeo são renderizados <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Retornos

Promise<void>

Comentários

Esse método é implementado para composição.

fetchInitialData()

Buscar o estado inicial do adaptador de chat.

Executa a busca mínima necessária para métodos chatComposite e API.

function fetchInitialData(): Promise<void>

Retornos

Promise<void>

joinCall(boolean)

Ingresse a chamada com o microfone inicialmente ativado/desativado.

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

Parâmetros

microphoneOn

boolean

Se o microfone está habilitado inicialmente

Retornos

undefined | Call

leaveCall(boolean)

Deixe a chamada.

function leaveCall(forEveryone?: boolean): Promise<void>

Parâmetros

forEveryone

boolean

Se todos os participantes devem ser removidos

Retornos

Promise<void>

loadPreviousChatMessages(number)

Carregue mais mensagens anteriores no histórico de threads de chat.

function loadPreviousChatMessages(messagesToLoad: number): Promise<boolean>

Parâmetros

messagesToLoad

number

Retornos

Promise<boolean>

Comentários

Esse método geralmente é usado para controlar a busca incremental/rolagem infinita.

mute()

Ativar mudo do usuário atual durante a chamada ou desabilitar o microfone localmente.

function mute(): Promise<void>

Retornos

Promise<void>

queryCameras()

Consultar dispositivos de câmera disponíveis.

function queryCameras(): Promise<VideoDeviceInfo[]>

Retornos

Promise<VideoDeviceInfo[]>

Uma matriz de entidades de informações do dispositivo de vídeo <xref:%40azure%2Fcommunication-calling%23VideoDeviceInfo>

Comentários

Esse método deve ser chamado após askDevicePermission()

queryMicrophones()

Consultar dispositivos de microfone disponíveis.

function queryMicrophones(): Promise<AudioDeviceInfo[]>

Retornos

Promise<AudioDeviceInfo[]>

Uma matriz de entidades de informações do dispositivo de áudio <xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo>

Comentários

Esse método deve ser chamado após askDevicePermission()

querySpeakers()

Consultar dispositivos de microfone disponíveis.

function querySpeakers(): Promise<AudioDeviceInfo[]>

Retornos

Promise<AudioDeviceInfo[]>

Uma matriz de entidades de informações do dispositivo de áudio <xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo>

Comentários

Esse método deve ser chamado após askDevicePermission()

removeParticipant(string)

Remova um participante de uma Chamada.

function removeParticipant(userId: string): Promise<void>

Parâmetros

userId

string

UserId do participante a ser removido.

Retornos

Promise<void>

sendMessage(string, SendMessageOptions)

Envie uma mensagem no thread.

function sendMessage(content: string, options?: SendMessageOptions): Promise<void>

Parâmetros

content

string

options

SendMessageOptions

Retornos

Promise<void>

sendReadReceipt(string)

Envie um recibo de leitura para uma mensagem.

function sendReadReceipt(chatMessageId: string): Promise<void>

Parâmetros

chatMessageId

string

Retornos

Promise<void>

sendTypingIndicator()

Enviar indicador de digitação no thread.

function sendTypingIndicator(): Promise<void>

Retornos

Promise<void>

setCamera(VideoDeviceInfo, VideoStreamOptions)

Defina a câmera a ser usada na chamada.

function setCamera(sourceInfo: VideoDeviceInfo, options?: VideoStreamOptions): Promise<void>

Parâmetros

sourceInfo

VideoDeviceInfo

Dispositivo de câmera para escolher, escolha um retornado por queryCameras

options

VideoStreamOptions

Opções para controlar como o fluxo de câmera é renderizado <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Retornos

Promise<void>

setMicrophone(AudioDeviceInfo)

Defina o microfone a ser usado na chamada.

function setMicrophone(sourceInfo: AudioDeviceInfo): Promise<void>

Parâmetros

sourceInfo

AudioDeviceInfo

Dispositivo de microfone para escolher, escolha um retornado por queryMicrophones

Retornos

Promise<void>

setSpeaker(AudioDeviceInfo)

Defina o alto-falante a ser usado na chamada.

function setSpeaker(sourceInfo: AudioDeviceInfo): Promise<void>

Parâmetros

sourceInfo

AudioDeviceInfo

Dispositivo de alto-falante para escolher, escolha um retornado por querySpeakers

Retornos

Promise<void>

startCall(string[], StartCallOptions)

Inicie a chamada.

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

Parâmetros

participants

string[]

Uma matriz de IDs de participante para ingressar

options

StartCallOptions

Retornos

undefined | Call

startCamera(VideoStreamOptions)

Inicie a câmera.

Esse método começará a renderizar uma exibição de câmera local quando a chamada não estiver ativa.

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

Parâmetros

options

VideoStreamOptions

Opções para controlar como os fluxos de vídeo são renderizados <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Retornos

Promise<void>

startScreenShare()

Comece a compartilhar a tela durante uma chamada.

function startScreenShare(): Promise<void>

Retornos

Promise<void>

stopCamera()

Pare a câmera.

Esse método interromperá a renderização de uma exibição de câmera local quando a chamada não estiver ativa.

function stopCamera(): Promise<void>

Retornos

Promise<void>

stopScreenShare()

Pare de compartilhar a tela.

function stopScreenShare(): Promise<void>

Retornos

Promise<void>

unmute()

Desativar o usuário atual durante a chamada ou habilitar o microfone localmente.

function unmute(): Promise<void>

Retornos

Promise<void>

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

Atualizar um conteúdo de mensagem.

function updateMessage(messageId: string, content: string, metadata?: Record<string, string>): Promise<void>

Parâmetros

messageId

string

content

string

metadata

Record<string, string>

Retornos

Promise<void>