CallAdapterCallManagement interface

Paquete:

@azure/communication-react

Advertencia

Esta API ya está en desuso.

CallAdapter interface will be flatten, consider using CallAdapter directly

Funcionalidad para administrar la llamada actual o iniciar una nueva llamada

Extends

CallAdapterCallOperations

Métodos

joinCall(boolean)	Únase a la llamada con el micrófono inicialmente activado o desactivado.
startCall(string[], StartCallOptions)	Inicie la llamada.

Métodos heredados

createStreamView(string, VideoStreamOptions)	Cree la vista html para una secuencia.
disposeStreamView(string, VideoStreamOptions)	Elimine la vista html de una secuencia.
leaveCall(boolean)	Deje la llamada.
mute()	Silenciar al usuario actual durante la llamada o deshabilitar el micrófono localmente
removeParticipant(string)	Quite un participante de la llamada.
startCamera(VideoStreamOptions)	Iniciar 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()	Detener la cámara Este método dejará de representar una vista de cámara local cuando la llamada no esté activa.
stopScreenShare()	Dejar de compartir la pantalla
unmute()	Desmute el usuario actual durante la llamada o habilite el micrófono localmente.

Detalles del método

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

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

Detalles de los métodos heredados

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.

Heredado deCallAdapterCallOperations.createStreamView

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.

Heredado deCallAdapterCallOperations.disposeStreamView

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>

Heredado deCallAdapterCallOperations.leaveCall

mute()

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

function mute(): Promise<void>

Devoluciones

Promise<void>

Heredado deCallAdapterCallOperations.mute

removeParticipant(string)

Quite un participante de la llamada.

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

Parámetros

userId

string

Identificador del participante que se va a quitar

Devoluciones

Promise<void>

Heredado deCallAdapterCallOperations.removeParticipant

startCamera(VideoStreamOptions)

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

Heredado deCallAdapterCallOperations.startCamera

startScreenShare()

Comience a compartir la pantalla durante una llamada.

function startScreenShare(): Promise<void>

Devoluciones

Promise<void>

Heredado deCallAdapterCallOperations.startScreenShare

stopCamera()

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

Heredado deCallAdapterCallOperations.stopCamera

stopScreenShare()

Dejar de compartir la pantalla

function stopScreenShare(): Promise<void>

Devoluciones

Promise<void>

Heredado deCallAdapterCallOperations.stopScreenShare

unmute()

Desmute el usuario actual durante la llamada o habilite el micrófono localmente.

function unmute(): Promise<void>

Devoluciones

Promise<void>

Se hereda deCallAdapterCallOperations.unmute