CallAdapter interface

Paquet:

@azure/communication-react

Interface d’adaptateur spécifique pour l’identité De communication Azure qui étend CommonCallAdapter.

Extends

CommonCallAdapter

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 les autorisations des appareils.
createStreamView(string, VideoStreamOptions)	Créez l’affichage html pour un flux.
dispose()	Supprimer le composite
disposeStreamView(string, VideoStreamOptions)	Supprimer l’affichage html d’un flux.
getState()	Obtenir l’état actuel
leaveCall(boolean)	Quitter l’appel
mute()	Désactiver le son de 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 Unsubscribe 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)	Annule le gestionnaire pour les événements stateChanged.
on("callEnded", CallEndedListener)	Fonction d’abonnement pour l’événement « callEnded ».
on("callIdChanged", CallIdChangedListener)	Fonction d’abonnement pour l’événement « callIdChanged ».
on("diagnosticChanged", DiagnosticChangedEventListner)	Fonction d’abonnement pour l’événement « diagnosticChanged ». Cet événement se déclenche chaque fois qu’un utilisateur est confronté à diagnostics sur l’appel en cours.
on("displayNameChanged", DisplayNameChangedListener)	Fonction d’abonnement pour l’événement « displayNameChanged ».
on("error", (e: AdapterError) => void)	Fonction d’abonnement pour l’événement « error ».
on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)	Fonction d’abonnement pour l’événement « isLocalScreenSharingActiveChanged ».
on("isMutedChanged", IsMutedChangedListener)	Fonction d’abonnement 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 d’abonnement pour l’événement « selectedMicrophoneChanged ». Cet événement se déclenche chaque fois que l’utilisateur sélectionne un nouveau périphérique de microphone.
on("selectedSpeakerChanged", PropertyChangedEvent)	Fonction d’abonnement pour l’événement « selectedSpeakerChanged ». Cet événement se déclenche chaque fois que l’utilisateur sélectionne un nouveau périphérique haut-parleur.
onStateChange((state: CallAdapterState) => void)	Abonne le gestionnaire aux événements stateChanged.
queryCameras()	Recherchez les appareils photo disponibles.
queryMicrophones()	Recherchez les périphériques microphone disponibles.
querySpeakers()	Recherchez les périphériques microphone disponibles.
removeParticipant(string)	Supprimer 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 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

askDevicePermission(PermissionConstraints)

Demandez les autorisations des 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é deCommonCallAdapter.askDevicePermission

createStreamView(string, VideoStreamOptions)

Créez l’affichage 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 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é deCommonCallAdapter.createStreamView

dispose()

Supprimer le composite

function dispose()

Hérité deCommonCallAdapter.dispose

disposeStreamView(string, VideoStreamOptions)

Supprimer l’affichage 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 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é deCommonCallAdapter.disposeStreamView

getState()

Obtenir l’état actuel

function getState(): CallAdapterState

Retours

CallAdapterState

Hérité deCommonCallAdapter.getState

leaveCall(boolean)

Quitter 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é deCommonCallAdapter.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é deCommonCallAdapter.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é deCommonCallAdapter.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é deCommonCallAdapter.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é deCommonCallAdapter.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é deCommonCallAdapter.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é deCommonCallAdapter.off

off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

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

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

Paramètres

event

"isLocalScreenSharingActiveChanged"

listener

IsLocalScreenSharingActiveChangedListener

Hérité deCommonCallAdapter.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é deCommonCallAdapter.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é deCommonCallAdapter.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é deCommonCallAdapter.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é deCommonCallAdapter.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é deCommonCallAdapter.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é deCommonCallAdapter.off

offStateChange((state: CallAdapterState) => void)

Annule le gestionnaire pour les événements stateChanged.

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

Paramètres

handler

(state: CallAdapterState) => void

Hérité deCommonCallAdapter.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é deCommonCallAdapter.on

on("callIdChanged", CallIdChangedListener)

Fonction d’abonnement 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é deCommonCallAdapter.on

on("diagnosticChanged", DiagnosticChangedEventListner)

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

Cet événement se déclenche chaque fois qu’un utilisateur est confronté à diagnostics sur l’appel en cours.

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

Paramètres

event

"diagnosticChanged"

listener

DiagnosticChangedEventListner

Hérité deCommonCallAdapter.on

on("displayNameChanged", DisplayNameChangedListener)

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

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

Paramètres

event

"displayNameChanged"

listener

DisplayNameChangedListener

Hérité deCommonCallAdapter.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é deCommonCallAdapter.on

on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

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

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

Paramètres

event

"isLocalScreenSharingActiveChanged"

listener

IsLocalScreenSharingActiveChangedListener

Hérité deCommonCallAdapter.on

on("isMutedChanged", IsMutedChangedListener)

Fonction d’abonnement 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’utilisateur distant change d’état

Hérité deCommonCallAdapter.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é deCommonCallAdapter.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é deCommonCallAdapter.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é deCommonCallAdapter.on

on("selectedMicrophoneChanged", PropertyChangedEvent)

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

Cet événement se déclenche chaque fois que l’utilisateur sélectionne un nouveau périphérique de microphone.

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

Paramètres

event

"selectedMicrophoneChanged"

listener

PropertyChangedEvent

Hérité deCommonCallAdapter.on

on("selectedSpeakerChanged", PropertyChangedEvent)

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

Cet événement se déclenche chaque fois que l’utilisateur sélectionne un nouveau périphérique haut-parleur.

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

Paramètres

event

"selectedSpeakerChanged"

listener

PropertyChangedEvent

Hérité deCommonCallAdapter.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é deCommonCallAdapter.onStateChange

queryCameras()

Recherchez les appareils photo disponibles.

function queryCameras(): Promise<VideoDeviceInfo[]>

Retours

Promise<VideoDeviceInfo[]>

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

Remarques

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

Héritée deCommonCallAdapter.queryCameras

queryMicrophones()

Recherchez les périphériques microphone disponibles.

function queryMicrophones(): Promise<AudioDeviceInfo[]>

Retours

Promise<AudioDeviceInfo[]>

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

Remarques

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

Hérité deCommonCallAdapter.queryMicrophones

querySpeakers()

Recherchez les périphériques microphone disponibles.

function querySpeakers(): Promise<AudioDeviceInfo[]>

Retours

Promise<AudioDeviceInfo[]>

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

Remarques

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

Hérité deCommonCallAdapter.querySpeakers

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é deCommonCallAdapter.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é deCommonCallAdapter.setCamera

setMicrophone(AudioDeviceInfo)

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

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

Paramètres

sourceInfo

AudioDeviceInfo

Périphérique de microphone à choisir, choisissez-en un retourné par requêteMicrophones

Retours

Promise<void>

Hérité deCommonCallAdapter.setMicrophone

setSpeaker(AudioDeviceInfo)

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

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

Paramètres

sourceInfo

AudioDeviceInfo

Appareil d’orateur à choisir, choisissez-en un retourné par querySpeakers

Retours

Promise<void>

Hérité deCommonCallAdapter.setSpeaker

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é deCommonCallAdapter.startCamera

startScreenShare()

Commencez à partager l’écran pendant un appel.

function startScreenShare(): Promise<void>

Retours

Promise<void>

Hérité deCommonCallAdapter.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é deCommonCallAdapter.stopCamera

stopScreenShare()

Arrêter le partage de l’écran

function stopScreenShare(): Promise<void>

Retours

Promise<void>

Hérité deCommonCallAdapter.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é deCommonCallAdapter.unmute