CallWithChatAdapterManagement interface

Pacote:

@azure/communication-react

Funcionalidade para gerir a chamada atual com o chat.

Métodos

askDevicePermission(PermissionConstraints)	Peça permissões de dispositivos.
createStreamView(string, VideoStreamOptions)	Crie a vista html para um fluxo.
deleteMessage(string)	Elimine uma mensagem no tópico.
disposeStreamView(string, VideoStreamOptions)	Elimine a vista html de um fluxo.
fetchInitialData()	Obtenha o estado inicial do adaptador chat. Executa a obtenção mínima necessária para os métodos ChatComposite e API.
joinCall(boolean)	Junte-se à chamada com o microfone inicialmente ligado/desligado.
leaveCall(boolean)	Deixe a chamada.
loadPreviousChatMessages(number)	Carregue mais mensagens anteriores no histórico de tópicos de chat.
mute()	Desative o som do utilizador atual durante a chamada ou desative o microfone localmente.
queryCameras()	Consulta para dispositivos de câmara disponíveis.
queryMicrophones()	Consulta para dispositivos de microfone disponíveis.
querySpeakers()	Consulta para dispositivos de microfone disponíveis.
removeParticipant(string)	Remover um participante de uma Chamada.
sendMessage(string, SendMessageOptions)	Enviar uma mensagem no tópico.
sendReadReceipt(string)	Envie um recibo de leitura para uma mensagem.
sendTypingIndicator()	Enviar indicador de escrita no thread.
setCamera(VideoDeviceInfo, VideoStreamOptions)	Defina a câmara para utilizar na chamada.
setMicrophone(AudioDeviceInfo)	Defina o microfone a utilizar na chamada.
setSpeaker(AudioDeviceInfo)	Defina o altifalante para utilizar na chamada.
startCall(string[], StartCallOptions)	Inicie a chamada.
startCamera(VideoStreamOptions)	Inicie a câmara. Este método começará a compor uma vista de câmara local quando a chamada não estiver ativa.
startScreenShare()	Comece a partilhar o ecrã durante uma chamada.
stopCamera()	Pare a câmara. Este método deixará de compor uma vista de câmara local quando a chamada não estiver ativa.
stopScreenShare()	Pare de partilhar o ecrã.
unmute()	Desativar o som do utilizador atual durante a chamada ou ativar o microfone localmente.
updateMessage(string, string, Record<string, string>)	Atualizar o conteúdo de uma mensagem.

Detalhes de Método

askDevicePermission(PermissionConstraints)

Peça permissões de dispositivos.

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

Parâmetros

constrain

PermissionConstraints

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

Devoluções

Promise<void>

Observações

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

createStreamView(string, VideoStreamOptions)

Crie a vista html para um fluxo.

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

Parâmetros

remoteUserId

string

ID do participante a compor, deixe-o indefinido para criar a vista da câmara local

options

VideoStreamOptions

Opções para controlar a forma como as transmissões de vídeo são compostas <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Devoluções

Promise<void | CreateVideoStreamViewResult>

Observações

Este método é implementado para composto.

deleteMessage(string)

Elimine uma mensagem no tópico.

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

Parâmetros

messageId

string

Devoluções

Promise<void>

disposeStreamView(string, VideoStreamOptions)

Elimine a vista html de um fluxo.

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

Parâmetros

remoteUserId

string

ID do participante a compor, deixe-o indefinido para eliminar a vista da câmara local

options

VideoStreamOptions

Opções para controlar a forma como as transmissões de vídeo são compostas <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Devoluções

Promise<void>

Observações

Este método é implementado para composto.

fetchInitialData()

Obtenha o estado inicial do adaptador chat.

Executa a obtenção mínima necessária para os métodos ChatComposite e API.

function fetchInitialData(): Promise<void>

Devoluções

Promise<void>

joinCall(boolean)

Junte-se à chamada com o microfone inicialmente ligado/desligado.

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

Parâmetros

microphoneOn

boolean

Se o microfone está inicialmente ativado

Devoluções

undefined | Call

leaveCall(boolean)

Deixe a chamada.

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

Parâmetros

forEveryone

boolean

Se pretende remover todos os participantes ao sair

Devoluções

Promise<void>

loadPreviousChatMessages(number)

Carregue mais mensagens anteriores no histórico de tópicos de chat.

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

Parâmetros

messagesToLoad

number

Devoluções

Promise<boolean>

Observações

Normalmente, este método é utilizado para controlar a obtenção incremental/deslocamento infinito.

mute()

Desative o som do utilizador atual durante a chamada ou desative o microfone localmente.

function mute(): Promise<void>

Devoluções

Promise<void>

queryCameras()

Consulta para dispositivos de câmara disponíveis.

function queryCameras(): Promise<VideoDeviceInfo[]>

Devoluções

Promise<VideoDeviceInfo[]>

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

Observações

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

queryMicrophones()

Consulta para dispositivos de microfone disponíveis.

function queryMicrophones(): Promise<AudioDeviceInfo[]>

Devoluções

Promise<AudioDeviceInfo[]>

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

Observações

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

querySpeakers()

Consulta para dispositivos de microfone disponíveis.

function querySpeakers(): Promise<AudioDeviceInfo[]>

Devoluções

Promise<AudioDeviceInfo[]>

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

Observações

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

removeParticipant(string)

Remover um participante de uma Chamada.

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

Parâmetros

userId

string

UserId do participante a remover.

Devoluções

Promise<void>

sendMessage(string, SendMessageOptions)

Enviar uma mensagem no tópico.

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

Parâmetros

content

string

options

SendMessageOptions

Devoluções

Promise<void>

sendReadReceipt(string)

Envie um recibo de leitura para uma mensagem.

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

Parâmetros

chatMessageId

string

Devoluções

Promise<void>

sendTypingIndicator()

Enviar indicador de escrita no thread.

function sendTypingIndicator(): Promise<void>

Devoluções

Promise<void>

setCamera(VideoDeviceInfo, VideoStreamOptions)

Defina a câmara para utilizar na chamada.

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

Parâmetros

sourceInfo

VideoDeviceInfo

Dispositivo de câmara à escolha, escolha um devolvido por queryCameras

options

VideoStreamOptions

Opções para controlar a forma como o fluxo da câmara é composto <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Devoluções

Promise<void>

setMicrophone(AudioDeviceInfo)

Defina o microfone a utilizar na chamada.

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

Parâmetros

sourceInfo

AudioDeviceInfo

Dispositivo de microfone à escolha, escolha um devolvido por queryMicrophones

Devoluções

Promise<void>

setSpeaker(AudioDeviceInfo)

Defina o altifalante para utilizar na chamada.

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

Parâmetros

sourceInfo

AudioDeviceInfo

Dispositivo de orador à escolha, escolha um devolvido por querySpeakers

Devoluções

Promise<void>

startCall(string[], StartCallOptions)

Inicie a chamada.

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

Parâmetros

participants

string[]

Uma matriz de IDs dos participantes a aderir

options

StartCallOptions

Devoluções

undefined | Call

startCamera(VideoStreamOptions)

Inicie a câmara.

Este método começará a compor uma vista de câmara local quando a chamada não estiver ativa.

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

Parâmetros

options

VideoStreamOptions

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

Devoluções

Promise<void>

startScreenShare()

Comece a partilhar o ecrã durante uma chamada.

function startScreenShare(): Promise<void>

Devoluções

Promise<void>

stopCamera()

Pare a câmara.

Este método deixará de compor uma vista de câmara local quando a chamada não estiver ativa.

function stopCamera(): Promise<void>

Devoluções

Promise<void>

stopScreenShare()

Pare de partilhar o ecrã.

function stopScreenShare(): Promise<void>

Devoluções

Promise<void>

unmute()

Desativar o som do utilizador atual durante a chamada ou ativar o microfone localmente.

function unmute(): Promise<void>

Devoluções

Promise<void>

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

Atualizar o conteúdo de uma mensagem.

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

Parâmetros

messageId

string

content

string

metadata

Record<string, string>

Devoluções

Promise<void>