CallAdapterCallManagement interface

Pacote:

@azure/communication-react

Aviso

Esta API foi preterida.

CallAdapter interface will be flatten, consider using CallAdapter directly

Funcionalidade para gerenciar a chamada atual ou iniciar uma nova chamada

Extends

CallAdapterCallOperations

Métodos

joinCall(boolean)	Participe da chamada com o microfone inicialmente ligado/desligado.
startCall(string[], StartCallOptions)	Inicie a chamada.

Métodos Herdados

createStreamView(string, VideoStreamOptions)	Crie a visualização html para um fluxo.
disposeStreamView(string, VideoStreamOptions)	Descarte o modo de exibição html para um fluxo.
leaveCall(boolean)	Saia da chamada
mute()	Silenciar o usuário atual durante a chamada ou desativar o microfone localmente
removeParticipant(string)	Remova um participante da chamada.
startCamera(VideoStreamOptions)	Iniciar a câmara Este método começará a renderizar uma vista de câmara local quando a chamada não estiver ativa
startScreenShare()	Comece a partilhar o ecrã durante uma chamada.
stopCamera()	Parar a câmara Este método irá parar de renderizar uma vista de câmara local quando a chamada não estiver ativa
stopScreenShare()	Parar de partilhar o ecrã
unmute()	Ativar o mudo do usuário atual durante a chamada ou ativar o microfone localmente

Detalhes de Método

joinCall(boolean)

Participe da 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

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 participar

options

StartCallOptions

Devoluções

undefined | Call

Detalhes do Método Herdado

createStreamView(string, VideoStreamOptions)

Crie a visualização html para um fluxo.

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

Parâmetros

remoteUserId

string

Id do participante a renderizar, deixe-o indefinido para criar a visualizaçã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>

Devoluções

Promise<void | CreateVideoStreamViewResult>

Observações

Este método é implementado para compósitos

herdado de CallAdapterCallOperations.createStreamView

disposeStreamView(string, VideoStreamOptions)

Descarte o modo de exibição html para um fluxo.

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

Parâmetros

remoteUserId

string

Id do participante a renderizar, deixe-o indefinido para descartar a visã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>

Devoluções

Promise<void>

Observações

Este método é implementado para compósitos

herdado de CallAdapterCallOperations.disposeStreamView

leaveCall(boolean)

Saia da chamada

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

Parâmetros

forEveryone

boolean

Se todos os participantes devem ser removidos ao sair

Devoluções

Promise<void>

herdado deCallAdapterCallOperations.leaveCall

mute()

Silenciar o usuário atual durante a chamada ou desativar o microfone localmente

function mute(): Promise<void>

Devoluções

Promise<void>

herdado de CallAdapterCallOperations.mute

removeParticipant(string)

Remova um participante da chamada.

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

Parâmetros

userId

string

ID do participante a ser removido

Devoluções

Promise<void>

herdado de CallAdapterCallOperations.removeParticipant

startCamera(VideoStreamOptions)

Iniciar a câmara Este método começará a renderizar 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 como os fluxos de vídeo são renderizados <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Devoluções

Promise<void>

herdado de CallAdapterCallOperations.startCamera

startScreenShare()

Comece a partilhar o ecrã durante uma chamada.

function startScreenShare(): Promise<void>

Devoluções

Promise<void>

herdado de CallAdapterCallOperations.startScreenShare

stopCamera()

Parar a câmara Este método irá parar de renderizar uma vista de câmara local quando a chamada não estiver ativa

function stopCamera(): Promise<void>

Devoluções

Promise<void>

herdado de CallAdapterCallOperations.stopCamera

stopScreenShare()

Parar de partilhar o ecrã

function stopScreenShare(): Promise<void>

Devoluções

Promise<void>

herdado de CallAdapterCallOperations.stopScreenShare

unmute()

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

function unmute(): Promise<void>

Devoluções

Promise<void>

herdado de CallAdapterCallOperations.unmute