CallAdapterCallManagement interface

Pacote:

@azure/communication-react

Aviso

Essa 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)	Ingresse a chamada com o microfone ativado/desativado inicialmente.
startCall(string[], StartCallOptions)	Inicie a chamada.

Métodos herdados

createStreamView(string, VideoStreamOptions)	Crie a exibição html para um fluxo.
disposeStreamView(string, VideoStreamOptions)	Descarte a exibição html para um fluxo.
leaveCall(boolean)	Deixe a chamada
mute()	Ativar mudo do usuário atual durante a chamada ou desabilitar o microfone localmente
removeParticipant(string)	Remova um participante da chamada.
startCamera(VideoStreamOptions)	Iniciar a câmera Este 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()	Parar 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()	Parar de compartilhar a tela
unmute()	Desativar mudo do usuário atual durante a chamada ou habilitar o microfone localmente

Detalhes do método

joinCall(boolean)

Ingresse a chamada com o microfone ativado/desativado inicialmente.

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

Parâmetros

microphoneOn

boolean

Se o microfone está inicialmente habilitado

Retornos

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 ingressar

options

StartCallOptions

Retornos

undefined | Call

Detalhes do método herdado

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 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 | CreateVideoStreamViewResult>

Comentários

Esse método é implementado para composição

Herdado deCallAdapterCallOperations.createStreamView

disposeStreamView(string, VideoStreamOptions)

Descarte a exibição html para um fluxo.

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

Parâmetros

remoteUserId

string

ID do participante a ser renderizado, deixe 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

Herdado deCallAdapterCallOperations.disposeStreamView

leaveCall(boolean)

Deixe a chamada

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

Parâmetros

forEveryone

boolean

Se todos os participantes devem ser removidos ao sair

Retornos

Promise<void>

Herdado deCallAdapterCallOperations.leaveCall

mute()

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

function mute(): Promise<void>

Retornos

Promise<void>

Herdado deCallAdapterCallOperations.mute

removeParticipant(string)

Remova um participante da chamada.

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

Parâmetros

userId

string

ID do participante a ser removido

Retornos

Promise<void>

Herdado deCallAdapterCallOperations.removeParticipant

startCamera(VideoStreamOptions)

Iniciar a câmera Este 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>

Herdado deCallAdapterCallOperations.startCamera

startScreenShare()

Comece a compartilhar a tela durante uma chamada.

function startScreenShare(): Promise<void>

Retornos

Promise<void>

Herdado deCallAdapterCallOperations.startScreenShare

stopCamera()

Parar 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>

Herdado deCallAdapterCallOperations.stopCamera

stopScreenShare()

Parar de compartilhar a tela

function stopScreenShare(): Promise<void>

Retornos

Promise<void>

Herdado deCallAdapterCallOperations.stopScreenShare

unmute()

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

function unmute(): Promise<void>

Retornos

Promise<void>

Herdado deCallAdapterCallOperations.unmute