CallAdapterCallManagement interface

Paquet:

@azure/communication-react

Avertissement

Cette API est à présent déconseillée.

CallAdapter interface will be flatten, consider using CallAdapter directly

Fonctionnalité de gestion de l’appel actuel ou de démarrage d’un nouvel appel

Extends

CallAdapterCallOperations

Méthodes

joinCall(boolean)	Joignez l’appel avec le microphone initialement activé/désactivé.
startCall(string[], StartCallOptions)	Démarrez l’appel.

Méthodes héritées

createStreamView(string, VideoStreamOptions)	Créez la vue html pour un flux.
disposeStreamView(string, VideoStreamOptions)	Supprimez la vue html d’un flux.
leaveCall(boolean)	Laissez l’appel
mute()	Désactiver l’utilisateur actuel pendant l’appel ou désactiver le microphone localement
removeParticipant(string)	Supprimez un participant de l’appel.
startCamera(VideoStreamOptions)	Démarrer la caméra Cette méthode démarre le rendu d’une vue de caméra locale lorsque l’appel n’est pas actif
startScreenShare()	Commencez à partager l’écran pendant un appel.
stopCamera()	Arrêter la caméra Cette méthode arrête le rendu d’une vue de caméra locale lorsque l’appel n’est pas actif
stopScreenShare()	Arrêter le partage de l’écran
unmute()	Désactiver l’utilisateur actuel pendant l’appel ou activer le microphone localement

Détails de la méthode

joinCall(boolean)

Joignez l’appel avec le microphone initialement activé/désactivé.

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

Paramètres

microphoneOn

boolean

Indique si le microphone est initialement activé

Retours

undefined | Call

startCall(string[], StartCallOptions)

Démarrez l’appel.

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

Paramètres

participants

string[]

Tableau d’ID de participant à joindre

options

StartCallOptions

Retours

undefined | Call

Détails de la méthode héritée

createStreamView(string, VideoStreamOptions)

Créez la vue html pour un flux.

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

Paramètres

remoteUserId

string

ID du participant à afficher, laissez-le non défini pour créer la vue de l’appareil photo local

options

VideoStreamOptions

Options pour contrôler le rendu des flux vidéo <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Retours

Promise<void | CreateVideoStreamViewResult>

Remarques

Cette méthode est implémentée pour composite

héritée deCallAdapterCallOperations.createStreamView

disposeStreamView(string, VideoStreamOptions)

Supprimez la vue html d’un flux.

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

Paramètres

remoteUserId

string

ID du participant à afficher, laissez-le non défini pour supprimer la vue de la caméra locale

options

VideoStreamOptions

Options pour contrôler le rendu des flux vidéo <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Retours

Promise<void>

Remarques

Cette méthode est implémentée pour composite

héritée deCallAdapterCallOperations.disposeStreamView

leaveCall(boolean)

Laissez l’appel

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

Paramètres

forEveryone

boolean

Indique s’il faut supprimer tous les participants lors de leur départ

Retours

Promise<void>

héritée deCallAdapterCallOperations.leaveCall

mute()

Désactiver l’utilisateur actuel pendant l’appel ou désactiver le microphone localement

function mute(): Promise<void>

Retours

Promise<void>

héritée deCallAdapterCallOperations.mute

removeParticipant(string)

Supprimez un participant de l’appel.

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

Paramètres

userId

string

ID du participant à supprimer

Retours

Promise<void>

héritée deCallAdapterCallOperations.removeParticipant

startCamera(VideoStreamOptions)

Démarrer la caméra Cette méthode démarre le rendu d’une vue de caméra locale lorsque l’appel n’est pas actif

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

Paramètres

options

VideoStreamOptions

Options pour contrôler le rendu des flux vidéo <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Retours

Promise<void>

héritée deCallAdapterCallOperations.startCamera

startScreenShare()

Commencez à partager l’écran pendant un appel.

function startScreenShare(): Promise<void>

Retours

Promise<void>

héritée deCallAdapterCallOperations.startScreenShare

stopCamera()

Arrêter la caméra Cette méthode arrête le rendu d’une vue de caméra locale lorsque l’appel n’est pas actif

function stopCamera(): Promise<void>

Retours

Promise<void>

héritée deCallAdapterCallOperations.stopCamera

stopScreenShare()

Arrêter le partage de l’écran

function stopScreenShare(): Promise<void>

Retours

Promise<void>

héritée deCallAdapterCallOperations.stopScreenShare

unmute()

Désactiver l’utilisateur actuel pendant l’appel ou activer le microphone localement

function unmute(): Promise<void>

Retours

Promise<void>

héritée deCallAdapterCallOperations.unmute