CommonCallAdapter interface

Paquet:

@azure/communication-react

interface CallComposite Adapter.

Extends

AdapterState<CallAdapterState>,Disposable,CallAdapterCallOperations,CallAdapterDeviceManagement,CallAdapterSubscribers

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

askDevicePermission(PermissionConstraints)	Demandez des autorisations sur les appareils.
createStreamView(string, VideoStreamOptions)	Créez la vue html pour un flux.
dispose()	Supprimer le composite
disposeStreamView(string, VideoStreamOptions)	Supprimez la vue html d’un flux.
getState()	Obtenir l’état actuel
leaveCall(boolean)	Laissez l’appel
mute()	Désactiver l’utilisateur actuel pendant l’appel ou désactiver le microphone localement
off("callEnded", CallEndedListener)	Fonction de désabonnement pour l’événement « callEnded ».
off("callIdChanged", CallIdChangedListener)	Fonction de désabonnement pour l’événement « callIdChanged ».
off("diagnosticChanged", DiagnosticChangedEventListner)	Fonction de désabonnement pour l’événement « diagnosticChanged ».
off("displayNameChanged", DisplayNameChangedListener)	Fonction de désabonnement pour l’événement « displayNameChanged ».
off("error", (e: AdapterError) => void)	Fonction de désabonnement pour l’événement « error ».
off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)	Fonction de désabonnement pour l’événement « isLocalScreenSharingActiveChanged ».
off("isMutedChanged", IsMutedChangedListener)	Fonction de désabonnement pour l’événement « isMutedChanged ».
off("isSpeakingChanged", IsSpeakingChangedListener)	Fonction de désabonnement pour l’événement « isSpeakingChanged ».
off("participantsJoined", ParticipantsJoinedListener)	Fonction de désabonnement pour l’événement « participantsJoined ».
off("participantsLeft", ParticipantsLeftListener)	Fonction de désabonnement pour l’événement « participantsLeft ».
off("selectedMicrophoneChanged", PropertyChangedEvent)	Fonction de désabonnement pour l’événement « selectedMicrophoneChanged ».
off("selectedSpeakerChanged", PropertyChangedEvent)	Fonction De désabonnement pour l’événement « selectedSpeakerChanged ».
offStateChange((state: CallAdapterState) => void)	Désinscrit le gestionnaire des événements stateChanged.
on("callEnded", CallEndedListener)	Fonction d’abonnement pour l’événement « callEnded ».
on("callIdChanged", CallIdChangedListener)	Fonction Subscribe pour l’événement « callIdChanged ».
on("diagnosticChanged", DiagnosticChangedEventListner)	Fonction Subscribe pour l’événement « diagnosticChanged ». Cet événement se déclenche chaque fois qu’il existe un changement dans les diagnostics auxquels l’utilisateur fait face au sujet de l’appel en cours.
on("displayNameChanged", DisplayNameChangedListener)	Fonction Subscribe pour l’événement « displayNameChanged ».
on("error", (e: AdapterError) => void)	Fonction d’abonnement pour l’événement « error ».
on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)	Fonction Subscribe pour l’événement « isLocalScreenSharingActiveChanged ».
on("isMutedChanged", IsMutedChangedListener)	Fonction Subscribe pour l’événement « isMutedChanged ».
on("isSpeakingChanged", IsSpeakingChangedListener)	Fonction d’abonnement pour l’événement « isSpeakingChanged ».
on("participantsJoined", ParticipantsJoinedListener)	Fonction d’abonnement pour l’événement « participantsJoined ».
on("participantsLeft", ParticipantsLeftListener)	Fonction d’abonnement pour l’événement « participantsLeft ».
on("selectedMicrophoneChanged", PropertyChangedEvent)	Fonction Subscribe pour l’événement « selectedMicrophoneChanged ». Cet événement se déclenche chaque fois que l’utilisateur sélectionne un nouvel appareil microphone.
on("selectedSpeakerChanged", PropertyChangedEvent)	Fonction Subscribe pour l’événement « selectedSpeakerChanged ». Cet événement se déclenche chaque fois que l’utilisateur sélectionne un nouvel appareil haut-parleur.
onStateChange((state: CallAdapterState) => void)	Abonne le gestionnaire aux événements stateChanged.
queryCameras()	Recherchez les appareils photo disponibles.
queryMicrophones()	Recherchez les appareils microphone disponibles.
querySpeakers()	Recherchez les appareils microphone disponibles.
removeParticipant(string)	Supprimez un participant de l’appel.
setCamera(VideoDeviceInfo, VideoStreamOptions)	Définissez la caméra à utiliser dans l’appel.
setMicrophone(AudioDeviceInfo)	Définissez le microphone à utiliser dans l’appel.
setSpeaker(AudioDeviceInfo)	Définissez l’orateur à utiliser dans 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)

Paramètres

microphoneOn

boolean

Indique si le microphone est initialement activé

startCall(string[], StartCallOptions)

Démarrez l’appel.

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

Paramètres

participants

string[]

Tableau d’ID de participant à joindre

options

StartCallOptions

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

askDevicePermission(PermissionConstraints)

Demandez des autorisations sur les appareils.

function askDevicePermission(constrain: PermissionConstraints): Promise<void>

Paramètres

constrain

PermissionConstraints

Définir des contraintes pour accéder aux appareils locaux <xref:%40azure%2Fcommunication-calling%23PermissionConstraints>

Retours

Promise<void>

Remarques

La fenêtre d’autorisation du navigateur s’affiche si les autorisations ne sont pas encore accordées

héritée deCallAdapterDeviceManagement.askDevicePermission

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

dispose()

Supprimer le composite

function dispose()

héritée dejetable.dispose

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

getState()

Obtenir l’état actuel

function getState(): CallAdapterState

Retours

CallAdapterState

héritée deAdapterState.getState

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

off("callEnded", CallEndedListener)

Fonction de désabonnement pour l’événement « callEnded ».

function off(event: "callEnded", listener: CallEndedListener)

Paramètres

event

"callEnded"

listener

CallEndedListener

héritée deCallAdapterSubscribers.off

off("callIdChanged", CallIdChangedListener)

Fonction de désabonnement pour l’événement « callIdChanged ».

function off(event: "callIdChanged", listener: CallIdChangedListener)

Paramètres

event

"callIdChanged"

listener

CallIdChangedListener

héritée deCallAdapterSubscribers.off

off("diagnosticChanged", DiagnosticChangedEventListner)

Fonction de désabonnement pour l’événement « diagnosticChanged ».

function off(event: "diagnosticChanged", listener: DiagnosticChangedEventListner)

Paramètres

event

"diagnosticChanged"

listener

DiagnosticChangedEventListner

héritée deCallAdapterSubscribers.off

off("displayNameChanged", DisplayNameChangedListener)

Fonction de désabonnement pour l’événement « displayNameChanged ».

function off(event: "displayNameChanged", listener: DisplayNameChangedListener)

Paramètres

event

"displayNameChanged"

listener

DisplayNameChangedListener

héritée deCallAdapterSubscribers.off

off("error", (e: AdapterError) => void)

Fonction de désabonnement pour l’événement « error ».

function off(event: "error", listener: (e: AdapterError) => void)

Paramètres

event

"error"

listener

(e: AdapterError) => void

héritée deCallAdapterSubscribers.off

off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

Fonction de désabonnement pour l’événement « isLocalScreenSharingActiveChanged ».

function off(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)

Paramètres

event

"isLocalScreenSharingActiveChanged"

listener

IsLocalScreenSharingActiveChangedListener

héritée deCallAdapterSubscribers.off

off("isMutedChanged", IsMutedChangedListener)

Fonction de désabonnement pour l’événement « isMutedChanged ».

function off(event: "isMutedChanged", listener: IsMutedChangedListener)

Paramètres

event

"isMutedChanged"

listener

IsMutedChangedListener

héritée deCallAdapterSubscribers.off

off("isSpeakingChanged", IsSpeakingChangedListener)

Fonction de désabonnement pour l’événement « isSpeakingChanged ».

function off(event: "isSpeakingChanged", listener: IsSpeakingChangedListener)

Paramètres

event

"isSpeakingChanged"

listener

IsSpeakingChangedListener

héritée deCallAdapterSubscribers.off

off("participantsJoined", ParticipantsJoinedListener)

Fonction de désabonnement pour l’événement « participantsJoined ».

function off(event: "participantsJoined", listener: ParticipantsJoinedListener)

Paramètres

event

"participantsJoined"

listener

ParticipantsJoinedListener

héritée deCallAdapterSubscribers.off

off("participantsLeft", ParticipantsLeftListener)

Fonction de désabonnement pour l’événement « participantsLeft ».

function off(event: "participantsLeft", listener: ParticipantsLeftListener)

Paramètres

event

"participantsLeft"

listener

ParticipantsLeftListener

héritée deCallAdapterSubscribers.off

off("selectedMicrophoneChanged", PropertyChangedEvent)

Fonction de désabonnement pour l’événement « selectedMicrophoneChanged ».

function off(event: "selectedMicrophoneChanged", listener: PropertyChangedEvent)

Paramètres

event

"selectedMicrophoneChanged"

listener

PropertyChangedEvent

héritée deCallAdapterSubscribers.off

off("selectedSpeakerChanged", PropertyChangedEvent)

Fonction De désabonnement pour l’événement « selectedSpeakerChanged ».

function off(event: "selectedSpeakerChanged", listener: PropertyChangedEvent)

Paramètres

event

"selectedSpeakerChanged"

listener

PropertyChangedEvent

héritée deCallAdapterSubscribers.off

offStateChange((state: CallAdapterState) => void)

Désinscrit le gestionnaire des événements stateChanged.

function offStateChange(handler: (state: CallAdapterState) => void)

Paramètres

handler

(state: CallAdapterState) => void

héritée deAdapterState.offStateChange

on("callEnded", CallEndedListener)

Fonction d’abonnement pour l’événement « callEnded ».

function on(event: "callEnded", listener: CallEndedListener)

Paramètres

event

"callEnded"

listener

CallEndedListener

héritée deCallAdapterSubscribers.on

on("callIdChanged", CallIdChangedListener)

Fonction Subscribe pour l’événement « callIdChanged ».

function on(event: "callIdChanged", listener: CallIdChangedListener)

Paramètres

event

"callIdChanged"

listener

CallIdChangedListener

Remarques

L’événement est déclenché lorsque callId de l’utilisateur actuel a changé.

héritée deCallAdapterSubscribers.on

on("diagnosticChanged", DiagnosticChangedEventListner)

Fonction Subscribe pour l’événement « diagnosticChanged ».

Cet événement se déclenche chaque fois qu’il existe un changement dans les diagnostics auxquels l’utilisateur fait face au sujet de l’appel en cours.

function on(event: "diagnosticChanged", listener: DiagnosticChangedEventListner)

Paramètres

event

"diagnosticChanged"

listener

DiagnosticChangedEventListner

héritée deCallAdapterSubscribers.on

on("displayNameChanged", DisplayNameChangedListener)

Fonction Subscribe pour l’événement « displayNameChanged ».

function on(event: "displayNameChanged", listener: DisplayNameChangedListener)

Paramètres

event

"displayNameChanged"

listener

DisplayNameChangedListener

héritée deCallAdapterSubscribers.on

on("error", (e: AdapterError) => void)

Fonction d’abonnement pour l’événement « error ».

function on(event: "error", listener: (e: AdapterError) => void)

Paramètres

event

"error"

listener

(e: AdapterError) => void

héritée deCallAdapterSubscribers.on

on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

Fonction Subscribe pour l’événement « isLocalScreenSharingActiveChanged ».

function on(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)

Paramètres

event

"isLocalScreenSharingActiveChanged"

listener

IsLocalScreenSharingActiveChangedListener

héritée deCallAdapterSubscribers.on

on("isMutedChanged", IsMutedChangedListener)

Fonction Subscribe pour l’événement « isMutedChanged ».

function on(event: "isMutedChanged", listener: IsMutedChangedListener)

Paramètres

event

"isMutedChanged"

listener

IsMutedChangedListener

Remarques

L’événement est déclenché chaque fois que l’utilisateur actuel ou l’état de l’utilisateur distant a changé

héritée deCallAdapterSubscribers.on

on("isSpeakingChanged", IsSpeakingChangedListener)

Fonction d’abonnement pour l’événement « isSpeakingChanged ».

function on(event: "isSpeakingChanged", listener: IsSpeakingChangedListener)

Paramètres

event

"isSpeakingChanged"

listener

IsSpeakingChangedListener

héritée deCallAdapterSubscribers.on

on("participantsJoined", ParticipantsJoinedListener)

Fonction d’abonnement pour l’événement « participantsJoined ».

function on(event: "participantsJoined", listener: ParticipantsJoinedListener)

Paramètres

event

"participantsJoined"

listener

ParticipantsJoinedListener

héritée deCallAdapterSubscribers.on

on("participantsLeft", ParticipantsLeftListener)

Fonction d’abonnement pour l’événement « participantsLeft ».

function on(event: "participantsLeft", listener: ParticipantsLeftListener)

Paramètres

event

"participantsLeft"

listener

ParticipantsLeftListener

héritée deCallAdapterSubscribers.on

on("selectedMicrophoneChanged", PropertyChangedEvent)

Fonction Subscribe pour l’événement « selectedMicrophoneChanged ».

Cet événement se déclenche chaque fois que l’utilisateur sélectionne un nouvel appareil microphone.

function on(event: "selectedMicrophoneChanged", listener: PropertyChangedEvent)

Paramètres

event

"selectedMicrophoneChanged"

listener

PropertyChangedEvent

héritée deCallAdapterSubscribers.on

on("selectedSpeakerChanged", PropertyChangedEvent)

Fonction Subscribe pour l’événement « selectedSpeakerChanged ».

Cet événement se déclenche chaque fois que l’utilisateur sélectionne un nouvel appareil haut-parleur.

function on(event: "selectedSpeakerChanged", listener: PropertyChangedEvent)

Paramètres

event

"selectedSpeakerChanged"

listener

PropertyChangedEvent

héritée deCallAdapterSubscribers.on

onStateChange((state: CallAdapterState) => void)

Abonne le gestionnaire aux événements stateChanged.

function onStateChange(handler: (state: CallAdapterState) => void)

Paramètres

handler

(state: CallAdapterState) => void

héritée deAdapterState.onStateChange

queryCameras()

Recherchez les appareils photo disponibles.

function queryCameras(): Promise<VideoDeviceInfo[]>

Retours

Promise<VideoDeviceInfo[]>

Tableau d’entités d’informations d’appareil vidéo <xref:%40azure%2Fcommunication-calling%23VideoDeviceInfo>

Remarques

Cette méthode doit être appelée après askDevicePermission()

héritée deCallAdapterDeviceManagement.queryCameras

queryMicrophones()

Recherchez les appareils microphone disponibles.

function queryMicrophones(): Promise<AudioDeviceInfo[]>

Retours

Promise<AudioDeviceInfo[]>

Tableau d’entités d’informations d’appareil audio <xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo>

Remarques

Cette méthode doit être appelée après askDevicePermission()

héritée deCallAdapterDeviceManagement.queryMicrophones

querySpeakers()

Recherchez les appareils microphone disponibles.

function querySpeakers(): Promise<AudioDeviceInfo[]>

Retours

Promise<AudioDeviceInfo[]>

Tableau d’entités d’informations d’appareil audio <xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo>

Remarques

Cette méthode doit être appelée après askDevicePermission()

héritée deCallAdapterDeviceManagement.querySpeakers

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

setCamera(VideoDeviceInfo, VideoStreamOptions)

Définissez la caméra à utiliser dans l’appel.

function setCamera(sourceInfo: VideoDeviceInfo, options?: VideoStreamOptions): Promise<void>

Paramètres

sourceInfo

VideoDeviceInfo

Appareil photo à choisir, choisissez-en un retourné par queryCameras

options

VideoStreamOptions

Options permettant de contrôler le rendu du flux de caméra <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Retours

Promise<void>

héritée deCallAdapterDeviceManagement.setCamera

setMicrophone(AudioDeviceInfo)

Définissez le microphone à utiliser dans l’appel.

function setMicrophone(sourceInfo: AudioDeviceInfo): Promise<void>

Paramètres

sourceInfo

AudioDeviceInfo

Appareil microphone à choisir, sélectionnez-en un retourné par queryMicrophones

Retours

Promise<void>

héritée deCallAdapterDeviceManagement.setMicrophone

setSpeaker(AudioDeviceInfo)

Définissez l’orateur à utiliser dans l’appel.

function setSpeaker(sourceInfo: AudioDeviceInfo): Promise<void>

Paramètres

sourceInfo

AudioDeviceInfo

Appareil haut-parleur à choisir, choisissez-en un retourné par querySpeakers

Retours

Promise<void>

héritée deCallAdapterDeviceManagement.setSpeaker

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