Partager via


CallAdapter interface

Interface d’adaptateur spécifique à l’identité Azure Communication qui étend CommonCallAdapter.

Extends

Propriétés héritées

sendRealTimeText

Envoyer du texte en temps réel

Méthodes

joinCall(boolean)

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

joinCall(JoinCallOptions)

Rejoignez l’appel avec le sac d’options pour définir l’état initial du microphone/de la caméra lors de la participation à l’appel true = allumer l’appareil lors de la participation à l’appel false = éteindre l’appareil lors de la participation à l’appel 'keep'/undefined = conserver l’état de pré-appel des appareils

startCall(CommunicationIdentifier[], StartCallOptions)

Démarrez l’appel.

startCall(string[], StartCallOptions)

Démarrez l’appel.

Méthodes héritées

addParticipant(CommunicationUserIdentifier)
addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

Ajoutez un participant à l’appel.

askDevicePermission(PermissionConstraints)

Demandez des autorisations sur les appareils.

createStreamView(string, VideoStreamOptions)

Créez la vue html pour un flux.

createTogetherModeStreamView(TogetherModeStreamOptions)

Créez la vue html pour un flux.

dispose()

Supprimer le composite

disposeLocalVideoStreamView()

Disposer de la vue html pour un flux vidéo local

disposeRemoteVideoStreamView(string)

Disposer de la vue html pour un flux vidéo distant

disposeScreenShareStreamView(string)

Disposer de la vue html pour un flux de partage d’écran

disposeStreamView(string, VideoStreamOptions)

Supprimez la vue html d’un flux.

disposeTogetherModeStreamView()

Supprimez la vue html d’un flux.

forbidAudio(string[])

Interdisez l’audio des participants à la réunion Teams par leurs ID utilisateur.

forbidOthersAudio()

Interdire l’audio des réunions Teams.

forbidOthersVideo()

Interdisez la vidéo de réunion Teams.

forbidVideo(string[])

Interdisez la vidéo des participants à la réunion Teams par leurs ID utilisateur.

getState()

Obtenir l’état actuel

holdCall()

Suspend l’appel.

leaveCall(boolean)

Laissez l’appel

lowerHand()

main inférieure pour l’utilisateur actuel

mute()

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

muteAllRemoteParticipants()

Muet tous les participants

muteParticipant(string)

Mettre un participant en sourdine

off("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)

Fonction de désabonnement pour l’événement 'breakoutRoomsUpdated'.

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("capabilitiesChanged", CapabilitiesChangedListener)

Fonction de désabonnement pour l’événement 'capabilitiesChanged'.

off("captionsReceived", CaptionsReceivedListener)

Fonction de désabonnement pour l’événement 'captionsReceived'.

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("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)

Fonction de désabonnement pour l’événement 'isCaptionLanguageChanged'.

off("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)

Fonction de désabonnement pour l’événement 'isCaptionsActiveChanged'.

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("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)

Fonction de désabonnement pour l’événement 'isSpokenLanguageChanged'.

off("mutedByOthers", PropertyChangedEvent)

Fonction de désabonnement pour l’événement 'mutedByOthers'.

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("realTimeTextReceived", RealTimeTextReceivedListener)

Fonction de désabonnement pour l’événement 'realTimeTextReceived'.

off("roleChanged", PropertyChangedEvent)

Fonction de désabonnement pour l’événement 'roleChanged'.

off("selectedMicrophoneChanged", PropertyChangedEvent)

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

off("selectedSpeakerChanged", PropertyChangedEvent)

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

off("spotlightChanged", SpotlightChangedListener)

Fonction de désabonnement pour l’événement 'spotlightChanged'.

off("transferAccepted", TransferAcceptedListener)

Fonction de désabonnement pour l’événement 'transferRequested'.

offStateChange((state: CallAdapterState) => void)

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

on("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)

Fonction d’abonnement à l’événement 'breakoutRoomsUpdated'.

on("callEnded", CallEndedListener)

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

on("callIdChanged", CallIdChangedListener)

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

on("capabilitiesChanged", CapabilitiesChangedListener)

Fonction d’abonnement pour l’événement 'capabilitiesChanged'.

on("captionsReceived", CaptionsReceivedListener)

Fonction d’abonnement pour l’événement 'captionsReceived'.

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("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)

Fonction d’abonnement pour l’événement 'isCaptionLanguageChanged'.

on("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)

Fonction d’abonnement pour l’événement 'isCaptionsActiveChanged'.

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("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)

Fonction d’abonnement pour l’événement 'isSpokenLanguageChanged'.

on("mutedByOthers", PropertyChangedEvent)

Fonction d’abonnement pour l’événement 'mutedByOthers'.

on("participantsJoined", ParticipantsJoinedListener)

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

on("participantsLeft", ParticipantsLeftListener)

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

on("realTimeTextReceived", RealTimeTextReceivedListener)

Fonction d’abonnement pour l’événement 'realTimeTextReceived'.

on("roleChanged", PropertyChangedEvent)

Fonction d’abonnement pour l’événement 'roleChanged'.

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.

on("spotlightChanged", SpotlightChangedListener)

Fonction d’abonnement à l’événement 'spotlightChanged'.

on("transferAccepted", TransferAcceptedListener)

Fonction d’abonnement pour l’événement 'transferRequested'.

onReactionClick(Reaction)

Envoyer un emoji de réaction

onStateChange((state: CallAdapterState) => void)

Abonne le gestionnaire aux événements stateChanged.

permitAudio(string[])

Autorisez l’audio des participants à la réunion Teams par leur ID utilisateur.

permitOthersAudio()

Autoriser l’audio de la réunion Teams.

permitOthersVideo()

Autoriser la vidéo de la réunion Teams.

permitVideo(string[])

Autorisez l’audio des participants à la réunion Teams par leur ID utilisateur.

queryCameras()

Recherchez les appareils photo disponibles.

queryMicrophones()

Recherchez les appareils microphone disponibles.

querySpeakers()

Recherchez les haut-parleurs disponibles.

raiseHand()

Lever la main pour l’utilisateur actuel

removeParticipant(CommunicationIdentifier)

Supprimez un participant de l’appel.

removeParticipant(string)

Supprimez un participant de l’appel.

resumeCall()

Reprend l’appel à partir d’un LocalHold état.

returnFromBreakoutRoom()

Retour à l’appel d’origine de la salle de discussion

sendDtmfTone(DtmfTone)

envoyer la tonalité DTMF à un autre participant dans un appel RTC 1:1

setCamera(VideoDeviceInfo, VideoStreamOptions)

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

setCaptionLanguage(string)

Fonction pour définir la langue des sous-titres

setMicrophone(AudioDeviceInfo)

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

setSpeaker(AudioDeviceInfo)

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

setSpokenLanguage(string)

Fonction de réglage de la langue parlée

setTogetherModeSceneSize(number, number)

Recalculez les positions assises pour le mode ensemble.

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

startCaptions(StartCaptionsAdapterOptions)

Fonction pour démarrer les sous-titres

startNoiseSuppressionEffect()

Démarrez l’effet de suppression du bruit.

startScreenShare()

Commencez à partager l’écran pendant un appel.

startSpotlight(string[])

Démarrez Spotlight pour les participants locaux et distants par leurs identifiants d’utilisateur. Si aucun tableau d’identifiants d’utilisateur n’est transmis, l’action est effectuée sur le participant local.

startTogetherMode()

Démarrer ensemble.

startVideoBackgroundEffect(VideoBackgroundEffect)

Démarrez l’effet d’arrière-plan de la vidéo.

stopAllSpotlight()

Arrêter tous les projecteurs

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

stopCaptions(StopCaptionsAdapterOptions)

Fonction d’arrêter les sous-titres

stopNoiseSuppressionEffect()

Arrêtez l’effet de suppression du bruit.

stopScreenShare()

Arrêter le partage de l’écran

stopSpotlight(string[])

Arrêtez de mettre en lumière les participants locaux et distants par leurs identifiants d’utilisateur. Si aucun tableau d’identifiants d’utilisateur n’est transmis, l’action est effectuée sur le participant local.

stopVideoBackgroundEffects()

Arrêtez l’effet d’arrière-plan de la vidéo.

submitSurvey(CallSurvey)

Envoyer le résultat de l’enquête de fin d’appel

unmute()

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

updateBackgroundPickerImages(VideoBackgroundImage[])

Remplacez les images du sélecteur d’arrière-plan pour un effet de remplacement de l’arrière-plan.

updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)

Mettez à jour l’effet d’arrière-plan vidéo sélectionné.

Détails de la propriété héritée

sendRealTimeText

Envoyer du texte en temps réel

sendRealTimeText: (text: string, isFinalized: boolean) => Promise<void>

Valeur de propriété

(text: string, isFinalized: boolean) => Promise<void>

Hérité deCommonCallAdapter.sendRealTimeText

Détails de la méthode

joinCall(boolean)

Avertissement

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

Use joinCall(options?:JoinCallOptions) instead.

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

joinCall(JoinCallOptions)

Rejoignez l’appel avec le sac d’options pour définir l’état initial du microphone/de la caméra lors de la participation à l’appel true = allumer l’appareil lors de la participation à l’appel false = éteindre l’appareil lors de la participation à l’appel 'keep'/undefined = conserver l’état de pré-appel des appareils

function joinCall(options?: JoinCallOptions): undefined | Call

Paramètres

options
JoinCallOptions

pour régler l’état initialement Microphone/Caméra On/Off/Use Precall.

Retours

undefined | Call

startCall(CommunicationIdentifier[], StartCallOptions)

Démarrez l’appel.

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

Paramètres

participants

CommunicationIdentifier[]

Un tableau de <xref:%40azure%2Fcommunication-common%23CommunicationIdentifier> à appeler

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

Retours

undefined | Call

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

addParticipant(CommunicationUserIdentifier)

function addParticipant(participant: CommunicationUserIdentifier): Promise<void>

Paramètres

Retours

Promise<void>

Hérité deCommonCallAdapter.addParticipant

addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

Ajoutez un participant à l’appel.

function addParticipant(participant: PhoneNumberIdentifier, options?: AddPhoneNumberOptions): Promise<void>

Paramètres

participant
PhoneNumberIdentifier

Retours

Promise<void>

Hérité deCommonCallAdapter.addParticipant

askDevicePermission(PermissionConstraints)

Demandez des autorisations sur les appareils.

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

Paramètres

constrain
PermissionConstraints

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

Retours

Promise<DeviceAccess>

Remarques

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

héritée deCommonCallAdapter.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 deCommonCallAdapter.createStreamView

createTogetherModeStreamView(TogetherModeStreamOptions)

Créez la vue html pour un flux.

function createTogetherModeStreamView(options?: TogetherModeStreamOptions): Promise<void | TogetherModeStreamViewResult>

Paramètres

options
TogetherModeStreamOptions

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

Retours

Remarques

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

Hérité deCommonCallAdapter.createTogetherModeStreamView

dispose()

Supprimer le composite

function dispose()

héritée deCommonCallAdapter.dispose

disposeLocalVideoStreamView()

Disposer de la vue html pour un flux vidéo local

function disposeLocalVideoStreamView(): Promise<void>

Retours

Promise<void>

Hérité deCommonCallAdapter.disposeLocalVideoStreamView

disposeRemoteVideoStreamView(string)

Disposer de la vue html pour un flux vidéo distant

function disposeRemoteVideoStreamView(remoteUserId: string): Promise<void>

Paramètres

remoteUserId

string

Identifiant du participant à disposer

Retours

Promise<void>

Hérité deCommonCallAdapter.disposeRemoteVideoStreamView

disposeScreenShareStreamView(string)

Disposer de la vue html pour un flux de partage d’écran

function disposeScreenShareStreamView(remoteUserId: string): Promise<void>

Paramètres

remoteUserId

string

Id du participant pour lequel disposer de la vue de flux de partage d’écran.

Retours

Promise<void>

Remarques

Cette méthode est mise en œuvre pour les composites

Hérité deCommonCallAdapter.disposeScreenShareStreamView

disposeStreamView(string, VideoStreamOptions)

Avertissement

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

Use disposeRemoteVideoStreamView, disposeLocalVideoStreamView and disposeRemoteVideoStreamView instead.

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 deCommonCallAdapter.disposeStreamView

disposeTogetherModeStreamView()

Supprimez la vue html d’un flux.

function disposeTogetherModeStreamView(): Promise<void>

Retours

Promise<void>

Remarques

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

Hérité deCommonCallAdapter.disposeTogetherModeStreamView

forbidAudio(string[])

Interdisez l’audio des participants à la réunion Teams par leurs ID utilisateur.

function forbidAudio(userIds: string[]): Promise<void>

Paramètres

userIds

string[]

Retours

Promise<void>

Hérité deCommonCallAdapter.forbidAudio

forbidOthersAudio()

Interdire l’audio des réunions Teams.

function forbidOthersAudio(): Promise<void>

Retours

Promise<void>

Hérité deCommonCallAdapter.forbidOthersAudio

forbidOthersVideo()

Interdisez la vidéo de réunion Teams.

function forbidOthersVideo(): Promise<void>

Retours

Promise<void>

Hérité deCommonCallAdapter.forbidOthersVideo

forbidVideo(string[])

Interdisez la vidéo des participants à la réunion Teams par leurs ID utilisateur.

function forbidVideo(userIds: string[]): Promise<void>

Paramètres

userIds

string[]

Retours

Promise<void>

Hérité deCommonCallAdapter.forbidVideo

getState()

Obtenir l’état actuel

function getState(): CallAdapterState

Retours

héritée deCommonCallAdapter.getState

holdCall()

Suspend l’appel.

function holdCall(): Promise<void>

Retours

Promise<void>

Hérité deCommonCallAdapter.holdCall

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 deCommonCallAdapter.leaveCall

lowerHand()

main inférieure pour l’utilisateur actuel

function lowerHand(): Promise<void>

Retours

Promise<void>

Hérité deCommonCallAdapter.lowerHand

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 deCommonCallAdapter.mute

muteAllRemoteParticipants()

Muet tous les participants

function muteAllRemoteParticipants(): Promise<void>

Retours

Promise<void>

Hérité deCommonCallAdapter.muteAllRemoteParticipants

muteParticipant(string)

Mettre un participant en sourdine

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

Paramètres

userId

string

Identifiant du participant à mettre en sourdine

Retours

Promise<void>

Hérité deCommonCallAdapter.muteParticipant

off("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)

Fonction de désabonnement pour l’événement 'breakoutRoomsUpdated'.

function off(event: "breakoutRoomsUpdated", listener: BreakoutRoomsUpdatedListener)

Paramètres

event

"breakoutRoomsUpdated"

héritée deCommonCallAdapter.off

off("callEnded", CallEndedListener)

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

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

Paramètres

event

"callEnded"

héritée deCommonCallAdapter.off

off("callIdChanged", CallIdChangedListener)

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

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

Paramètres

event

"callIdChanged"

héritée deCommonCallAdapter.off

off("capabilitiesChanged", CapabilitiesChangedListener)

Fonction de désabonnement pour l’événement 'capabilitiesChanged'.

function off(event: "capabilitiesChanged", listener: CapabilitiesChangedListener)

Paramètres

event

"capabilitiesChanged"

héritée deCommonCallAdapter.off

off("captionsReceived", CaptionsReceivedListener)

Fonction de désabonnement pour l’événement 'captionsReceived'.

function off(event: "captionsReceived", listener: CaptionsReceivedListener)

Paramètres

event

"captionsReceived"

héritée deCommonCallAdapter.off

off("diagnosticChanged", DiagnosticChangedEventListner)

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

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

Paramètres

event

"diagnosticChanged"

héritée deCommonCallAdapter.off

off("displayNameChanged", DisplayNameChangedListener)

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

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

Paramètres

event

"displayNameChanged"

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

off("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)

Fonction de désabonnement pour l’événement 'isCaptionLanguageChanged'.

function off(event: "isCaptionLanguageChanged", listener: IsCaptionLanguageChangedListener)

Paramètres

event

"isCaptionLanguageChanged"

héritée deCommonCallAdapter.off

off("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)

Fonction de désabonnement pour l’événement 'isCaptionsActiveChanged'.

function off(event: "isCaptionsActiveChanged", listener: IsCaptionsActiveChangedListener)

Paramètres

event

"isCaptionsActiveChanged"

héritée deCommonCallAdapter.off

off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

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

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

Paramètres

event

"isLocalScreenSharingActiveChanged"

héritée deCommonCallAdapter.off

off("isMutedChanged", IsMutedChangedListener)

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

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

Paramètres

event

"isMutedChanged"

héritée deCommonCallAdapter.off

off("isSpeakingChanged", IsSpeakingChangedListener)

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

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

Paramètres

event

"isSpeakingChanged"

héritée deCommonCallAdapter.off

off("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)

Fonction de désabonnement pour l’événement 'isSpokenLanguageChanged'.

function off(event: "isSpokenLanguageChanged", listener: IsSpokenLanguageChangedListener)

Paramètres

event

"isSpokenLanguageChanged"

héritée deCommonCallAdapter.off

off("mutedByOthers", PropertyChangedEvent)

Fonction de désabonnement pour l’événement 'mutedByOthers'.

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

Paramètres

event

"mutedByOthers"

héritée deCommonCallAdapter.off

off("participantsJoined", ParticipantsJoinedListener)

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

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

Paramètres

event

"participantsJoined"

héritée deCommonCallAdapter.off

off("participantsLeft", ParticipantsLeftListener)

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

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

Paramètres

event

"participantsLeft"

héritée deCommonCallAdapter.off

off("realTimeTextReceived", RealTimeTextReceivedListener)

Fonction de désabonnement pour l’événement 'realTimeTextReceived'.

function off(event: "realTimeTextReceived", listener: RealTimeTextReceivedListener)

Paramètres

event

"realTimeTextReceived"

héritée deCommonCallAdapter.off

off("roleChanged", PropertyChangedEvent)

Fonction de désabonnement pour l’événement 'roleChanged'.

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

Paramètres

event

"roleChanged"

héritée deCommonCallAdapter.off

off("selectedMicrophoneChanged", PropertyChangedEvent)

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

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

Paramètres

event

"selectedMicrophoneChanged"

héritée deCommonCallAdapter.off

off("selectedSpeakerChanged", PropertyChangedEvent)

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

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

Paramètres

event

"selectedSpeakerChanged"

héritée deCommonCallAdapter.off

off("spotlightChanged", SpotlightChangedListener)

Fonction de désabonnement pour l’événement 'spotlightChanged'.

function off(event: "spotlightChanged", listener: SpotlightChangedListener)

Paramètres

event

"spotlightChanged"

héritée deCommonCallAdapter.off

off("transferAccepted", TransferAcceptedListener)

Fonction de désabonnement pour l’événement 'transferRequested'.

function off(event: "transferAccepted", listener: TransferAcceptedListener)

Paramètres

event

"transferAccepted"

héritée deCommonCallAdapter.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 deCommonCallAdapter.offStateChange

on("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)

Fonction d’abonnement à l’événement 'breakoutRoomsUpdated'.

function on(event: "breakoutRoomsUpdated", listener: BreakoutRoomsUpdatedListener)

Paramètres

event

"breakoutRoomsUpdated"

héritée deCommonCallAdapter.on

on("callEnded", CallEndedListener)

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

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

Paramètres

event

"callEnded"

héritée deCommonCallAdapter.on

on("callIdChanged", CallIdChangedListener)

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

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

Paramètres

event

"callIdChanged"

Remarques

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

héritée deCommonCallAdapter.on

on("capabilitiesChanged", CapabilitiesChangedListener)

Fonction d’abonnement pour l’événement 'capabilitiesChanged'.

function on(event: "capabilitiesChanged", listener: CapabilitiesChangedListener)

Paramètres

event

"capabilitiesChanged"

héritée deCommonCallAdapter.on

on("captionsReceived", CaptionsReceivedListener)

Fonction d’abonnement pour l’événement 'captionsReceived'.

function on(event: "captionsReceived", listener: CaptionsReceivedListener)

Paramètres

event

"captionsReceived"

héritée deCommonCallAdapter.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"

héritée deCommonCallAdapter.on

on("displayNameChanged", DisplayNameChangedListener)

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

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

Paramètres

event

"displayNameChanged"

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

on("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)

Fonction d’abonnement pour l’événement 'isCaptionLanguageChanged'.

function on(event: "isCaptionLanguageChanged", listener: IsCaptionLanguageChangedListener)

Paramètres

event

"isCaptionLanguageChanged"

héritée deCommonCallAdapter.on

on("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)

Fonction d’abonnement pour l’événement 'isCaptionsActiveChanged'.

function on(event: "isCaptionsActiveChanged", listener: IsCaptionsActiveChangedListener)

Paramètres

event

"isCaptionsActiveChanged"

héritée deCommonCallAdapter.on

on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

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

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

Paramètres

event

"isLocalScreenSharingActiveChanged"

héritée deCommonCallAdapter.on

on("isMutedChanged", IsMutedChangedListener)

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

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

Paramètres

event

"isMutedChanged"

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 deCommonCallAdapter.on

on("isSpeakingChanged", IsSpeakingChangedListener)

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

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

Paramètres

event

"isSpeakingChanged"

héritée deCommonCallAdapter.on

on("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)

Fonction d’abonnement pour l’événement 'isSpokenLanguageChanged'.

function on(event: "isSpokenLanguageChanged", listener: IsSpokenLanguageChangedListener)

Paramètres

event

"isSpokenLanguageChanged"

héritée deCommonCallAdapter.on

on("mutedByOthers", PropertyChangedEvent)

Fonction d’abonnement pour l’événement 'mutedByOthers'.

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

Paramètres

event

"mutedByOthers"

héritée deCommonCallAdapter.on

on("participantsJoined", ParticipantsJoinedListener)

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

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

Paramètres

event

"participantsJoined"

héritée deCommonCallAdapter.on

on("participantsLeft", ParticipantsLeftListener)

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

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

Paramètres

event

"participantsLeft"

héritée deCommonCallAdapter.on

on("realTimeTextReceived", RealTimeTextReceivedListener)

Fonction d’abonnement pour l’événement 'realTimeTextReceived'.

function on(event: "realTimeTextReceived", listener: RealTimeTextReceivedListener)

Paramètres

event

"realTimeTextReceived"

héritée deCommonCallAdapter.on

on("roleChanged", PropertyChangedEvent)

Fonction d’abonnement pour l’événement 'roleChanged'.

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

Paramètres

event

"roleChanged"

héritée deCommonCallAdapter.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"

héritée deCommonCallAdapter.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"

héritée deCommonCallAdapter.on

on("spotlightChanged", SpotlightChangedListener)

Fonction d’abonnement à l’événement 'spotlightChanged'.

function on(event: "spotlightChanged", listener: SpotlightChangedListener)

Paramètres

event

"spotlightChanged"

héritée deCommonCallAdapter.on

on("transferAccepted", TransferAcceptedListener)

Fonction d’abonnement pour l’événement 'transferRequested'.

function on(event: "transferAccepted", listener: TransferAcceptedListener)

Paramètres

event

"transferAccepted"

héritée deCommonCallAdapter.on

onReactionClick(Reaction)

Envoyer un emoji de réaction

function onReactionClick(reaction: Reaction): Promise<void>

Paramètres

reaction
Reaction

Retours

Promise<void>

Hérité deCommonCallAdapter.onReactionClick

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 deCommonCallAdapter.onStateChange

permitAudio(string[])

Autorisez l’audio des participants à la réunion Teams par leur ID utilisateur.

function permitAudio(userIds: string[]): Promise<void>

Paramètres

userIds

string[]

Retours

Promise<void>

Hérité deCommonCallAdapter.permitAudio

permitOthersAudio()

Autoriser l’audio de la réunion Teams.

function permitOthersAudio(): Promise<void>

Retours

Promise<void>

Hérité deCommonCallAdapter.permitOthersAudio

permitOthersVideo()

Autoriser la vidéo de la réunion Teams.

function permitOthersVideo(): Promise<void>

Retours

Promise<void>

Hérité deCommonCallAdapter.permitOthersVideo

permitVideo(string[])

Autorisez l’audio des participants à la réunion Teams par leur ID utilisateur.

function permitVideo(userIds: string[]): Promise<void>

Paramètres

userIds

string[]

Retours

Promise<void>

Hérité deCommonCallAdapter.permitVideo

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 deCommonCallAdapter.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 deCommonCallAdapter.queryMicrophones

querySpeakers()

Recherchez les haut-parleurs 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 deCommonCallAdapter.querySpeakers

raiseHand()

Lever la main pour l’utilisateur actuel

function raiseHand(): Promise<void>

Retours

Promise<void>

Hérité deCommonCallAdapter.raiseHand

removeParticipant(CommunicationIdentifier)

Supprimez un participant de l’appel.

function removeParticipant(participant: CommunicationIdentifier): Promise<void>

Paramètres

participant
CommunicationIdentifier

<xref:%40azure%2Fcommunication-common%23CommunicationIdentifier> du participant à supprimer

Retours

Promise<void>

héritée deCommonCallAdapter.removeParticipant

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 deCommonCallAdapter.removeParticipant

resumeCall()

Reprend l’appel à partir d’un LocalHold état.

function resumeCall(): Promise<void>

Retours

Promise<void>

Hérité deCommonCallAdapter.resumeCall

returnFromBreakoutRoom()

Retour à l’appel d’origine de la salle de discussion

function returnFromBreakoutRoom(): Promise<void>

Retours

Promise<void>

Hérité deCommonCallAdapter.returnFromBreakoutRoom

sendDtmfTone(DtmfTone)

envoyer la tonalité DTMF à un autre participant dans un appel RTC 1:1

function sendDtmfTone(dtmfTone: DtmfTone): Promise<void>

Paramètres

dtmfTone
DtmfTone

Retours

Promise<void>

Hérité deCommonCallAdapter.sendDtmfTone

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

setCaptionLanguage(string)

Fonction pour définir la langue des sous-titres

function setCaptionLanguage(language: string): Promise<void>

Paramètres

language

string

Langue définie pour la légende

Retours

Promise<void>

Hérité deCommonCallAdapter.setCaptionLanguage

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 deCommonCallAdapter.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 deCommonCallAdapter.setSpeaker

setSpokenLanguage(string)

Fonction de réglage de la langue parlée

function setSpokenLanguage(language: string): Promise<void>

Paramètres

language

string

langue parlée

Retours

Promise<void>

Hérité deCommonCallAdapter.setSpokenLanguage

setTogetherModeSceneSize(number, number)

Recalculez les positions assises pour le mode ensemble.

function setTogetherModeSceneSize(width: number, height: number)

Paramètres

width

number

Largeur du conteneur

height

number

Hauteur du conteneur

Remarques

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

Hérité deCommonCallAdapter.setTogetherModeSceneSize

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

startCaptions(StartCaptionsAdapterOptions)

Fonction pour démarrer les sous-titres

function startCaptions(options?: StartCaptionsAdapterOptions): Promise<void>

Paramètres

options
StartCaptionsAdapterOptions

Options pour les sous-titres de départ

Retours

Promise<void>

Hérité deCommonCallAdapter.startCaptions

startNoiseSuppressionEffect()

Démarrez l’effet de suppression du bruit.

function startNoiseSuppressionEffect(): Promise<void>

Retours

Promise<void>

Hérité deCommonCallAdapter.startNoiseSuppressionEffect

startScreenShare()

Commencez à partager l’écran pendant un appel.

function startScreenShare(): Promise<void>

Retours

Promise<void>

héritée deCommonCallAdapter.startScreenShare

startSpotlight(string[])

Démarrez Spotlight pour les participants locaux et distants par leurs identifiants d’utilisateur. Si aucun tableau d’identifiants d’utilisateur n’est transmis, l’action est effectuée sur le participant local.

function startSpotlight(userIds?: string[]): Promise<void>

Paramètres

userIds

string[]

Retours

Promise<void>

Hérité deCommonCallAdapter.startSpotlight

startTogetherMode()

Démarrer ensemble.

function startTogetherMode(): Promise<void>

Retours

Promise<void>

Hérité deCommonCallAdapter.startTogetherMode

startVideoBackgroundEffect(VideoBackgroundEffect)

Démarrez l’effet d’arrière-plan de la vidéo.

function startVideoBackgroundEffect(videoBackgroundEffect: VideoBackgroundEffect): Promise<void>

Paramètres

videoBackgroundEffect
VideoBackgroundEffect

Retours

Promise<void>

Hérité deCommonCallAdapter.startVideoBackgroundEffect

stopAllSpotlight()

Arrêter tous les projecteurs

function stopAllSpotlight(): Promise<void>

Retours

Promise<void>

Hérité deCommonCallAdapter.stopAllSpotlight

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 deCommonCallAdapter.stopCamera

stopCaptions(StopCaptionsAdapterOptions)

Fonction d’arrêter les sous-titres

function stopCaptions(options?: StopCaptionsAdapterOptions): Promise<void>

Paramètres

Retours

Promise<void>

Hérité deCommonCallAdapter.stopCaptions

stopNoiseSuppressionEffect()

Arrêtez l’effet de suppression du bruit.

function stopNoiseSuppressionEffect(): Promise<void>

Retours

Promise<void>

Hérité deCommonCallAdapter.stopNoiseSuppressionEffect

stopScreenShare()

Arrêter le partage de l’écran

function stopScreenShare(): Promise<void>

Retours

Promise<void>

héritée deCommonCallAdapter.stopScreenShare

stopSpotlight(string[])

Arrêtez de mettre en lumière les participants locaux et distants par leurs identifiants d’utilisateur. Si aucun tableau d’identifiants d’utilisateur n’est transmis, l’action est effectuée sur le participant local.

function stopSpotlight(userIds?: string[]): Promise<void>

Paramètres

userIds

string[]

Retours

Promise<void>

Hérité deCommonCallAdapter.stopSpotlight

stopVideoBackgroundEffects()

Arrêtez l’effet d’arrière-plan de la vidéo.

function stopVideoBackgroundEffects(): Promise<void>

Retours

Promise<void>

Hérité deCommonCallAdapter.stopVideoBackgroundEffects

submitSurvey(CallSurvey)

Envoyer le résultat de l’enquête de fin d’appel

function submitSurvey(survey: CallSurvey): Promise<undefined | CallSurveyResponse>

Paramètres

survey
CallSurvey

Retours

Promise<undefined | CallSurveyResponse>

Hérité deCommonCallAdapter.submitSurvey

unmute()

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

function unmute(): Promise<void>

Retours

Promise<void>

héritée deCommonCallAdapter.unmute

updateBackgroundPickerImages(VideoBackgroundImage[])

Remplacez les images du sélecteur d’arrière-plan pour un effet de remplacement de l’arrière-plan.

function updateBackgroundPickerImages(backgroundImages: VideoBackgroundImage[])

Paramètres

backgroundImages

VideoBackgroundImage[]

Tableau d’images d’arrière-plan personnalisées.

Hérité deCommonCallAdapter.updateBackgroundPickerImages

updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)

Mettez à jour l’effet d’arrière-plan vidéo sélectionné.

function updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect)

Paramètres

selectedVideoBackground
VideoBackgroundEffect

Hérité deCommonCallAdapter.updateSelectedVideoBackgroundEffect