CallAdapterCallOperations interface

Paquete:

@azure/communication-react

Funcionalidad para administrar la llamada actual.

Métodos

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()	Desactive el usuario actual durante la llamada o habilite el micrófono localmente.

Detalles del método

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 composición

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 composición

leaveCall(boolean)

Deje la llamada.

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

Parámetros

forEveryone

boolean

Si se quitan todos los participantes al salir

Devoluciones

Promise<void>

mute()

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

function mute(): Promise<void>

Devoluciones

Promise<void>

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>

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>

startScreenShare()

Comience a compartir la pantalla durante una llamada.

function startScreenShare(): Promise<void>

Devoluciones

Promise<void>

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>

stopScreenShare()

Dejar de compartir la pantalla

function stopScreenShare(): Promise<void>

Devoluciones

Promise<void>

unmute()

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

function unmute(): Promise<void>

Devoluciones

Promise<void>