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és 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)	Supprimer la vue html d’un flux.
leaveCall(boolean)	Quitter l’appel
mute()	Désactiver le son de l’utilisateur actuel pendant l’appel ou désactiver le microphone localement
removeParticipant(string)	Supprimer un participant de l’appel.
startCamera(VideoStreamOptions)	Démarrer l’appareil photo Cette méthode commence à afficher une vue de caméra locale lorsque l’appel n’est pas actif
startScreenShare()	Commencez à partager l’écran pendant un appel.
stopCamera()	Arrêter l’appareil photo 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()	Annuler le son de 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

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 à rejoindre

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 à restituer, laissez-le non défini pour créer la vue de la caméra locale

options

VideoStreamOptions

Options permettant de 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 les composites

Hérité deCallAdapterCallOperations.createStreamView

disposeStreamView(string, VideoStreamOptions)

Supprimer la vue html d’un flux.

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

Paramètres

remoteUserId

string

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

options

VideoStreamOptions

Options permettant de 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 les composites

Hérité deCallAdapterCallOperations.disposeStreamView

leaveCall(boolean)

Quitter l’appel

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

Paramètres

forEveryone

boolean

S’il faut supprimer tous les participants lors du départ

Retours

Promise<void>

Hérité deCallAdapterCallOperations.leaveCall

mute()

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

function mute(): Promise<void>

Retours

Promise<void>

Hérité deCallAdapterCallOperations.mute

removeParticipant(string)

Supprimer un participant de l’appel.

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

Paramètres

userId

string

ID du participant à supprimer

Retours

Promise<void>

Hérité deCallAdapterCallOperations.removeParticipant

startCamera(VideoStreamOptions)

Démarrer l’appareil photo Cette méthode commence à afficher une vue de caméra locale lorsque l’appel n’est pas actif

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

Paramètres

options

VideoStreamOptions

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

Retours

Promise<void>

Hérité deCallAdapterCallOperations.startCamera

startScreenShare()

Commencez à partager l’écran pendant un appel.

function startScreenShare(): Promise<void>

Retours

Promise<void>

Hérité deCallAdapterCallOperations.startScreenShare

stopCamera()

Arrêter l’appareil photo 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é deCallAdapterCallOperations.stopCamera

stopScreenShare()

Arrêter le partage de l’écran

function stopScreenShare(): Promise<void>

Retours

Promise<void>

Hérité deCallAdapterCallOperations.stopScreenShare

unmute()

Annuler le son de l’utilisateur actuel pendant l’appel ou activer le microphone localement

function unmute(): Promise<void>

Retours

Promise<void>

Hérité deCallAdapterCallOperations.unmute