CommonCallAdapter interface
interface CallComposite Adapter.
- Extends
Propriétés héritées
| send |
Envoyer du texte en temps réel |
Méthodes
| join |
Joignez l’appel avec le microphone initialement activé/désactivé. |
| join |
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 |
| start |
Démarrez l’appel. |
| start |
Démarrez l’appel. |
Méthodes héritées
| add |
|
| add |
Ajoutez un participant à l’appel. |
| ask |
Demandez des autorisations sur les appareils. |
| create |
Créez la vue html pour un flux. |
| create |
Créez la vue html pour un flux. |
| dispose() | Supprimer le composite |
| dispose |
Disposer de la vue html pour un flux vidéo local |
| dispose |
Disposer de la vue html pour un flux vidéo distant |
| dispose |
Disposer de la vue html pour un flux de partage d’écran |
| dispose |
Supprimez la vue html d’un flux. |
| dispose |
Supprimez la vue html d’un flux. |
| forbid |
Interdisez l’audio des participants à la réunion Teams par leurs ID utilisateur. |
| forbid |
Interdire l’audio des réunions Teams. |
| forbid |
Interdisez la vidéo de réunion Teams. |
| forbid |
Interdisez la vidéo des participants à la réunion Teams par leurs ID utilisateur. |
| get |
Obtenir l’état actuel |
| hold |
Suspend l’appel. |
| leave |
Laissez l’appel |
| lower |
main inférieure pour l’utilisateur actuel |
| mute() | Désactiver l’utilisateur actuel pendant l’appel ou désactiver le microphone localement |
| mute |
Muet tous les participants |
| mute |
Mettre un participant en sourdine |
| off("breakout |
Fonction de désabonnement pour l’événement 'breakoutRoomsUpdated'. |
| off("call |
Fonction de désabonnement pour l’événement « callEnded ». |
| off("call |
Fonction de désabonnement pour l’événement « callIdChanged ». |
| off("capabilities |
Fonction de désabonnement pour l’événement 'capabilitiesChanged'. |
| off("captions |
Fonction de désabonnement pour l’événement 'captionsReceived'. |
| off("diagnostic |
Fonction de désabonnement pour l’événement « diagnosticChanged ». |
| off("display |
Fonction de désabonnement pour l’événement « displayNameChanged ». |
| off("error", (e: Adapter |
Fonction de désabonnement pour l’événement « error ». |
| off("is |
Fonction de désabonnement pour l’événement 'isCaptionLanguageChanged'. |
| off("is |
Fonction de désabonnement pour l’événement 'isCaptionsActiveChanged'. |
| off("is |
Fonction de désabonnement pour l’événement « isLocalScreenSharingActiveChanged ». |
| off("is |
Fonction de désabonnement pour l’événement « isMutedChanged ». |
| off("is |
Fonction de désabonnement pour l’événement « isSpeakingChanged ». |
| off("is |
Fonction de désabonnement pour l’événement 'isSpokenLanguageChanged'. |
| off("muted |
Fonction de désabonnement pour l’événement 'mutedByOthers'. |
| off("participants |
Fonction de désabonnement pour l’événement « participantsJoined ». |
| off("participants |
Fonction de désabonnement pour l’événement « participantsLeft ». |
| off("real |
Fonction de désabonnement pour l’événement 'realTimeTextReceived'. |
| off("role |
Fonction de désabonnement pour l’événement 'roleChanged'. |
| off("selected |
Fonction de désabonnement pour l’événement « selectedMicrophoneChanged ». |
| off("selected |
Fonction De désabonnement pour l’événement « selectedSpeakerChanged ». |
| off("spotlight |
Fonction de désabonnement pour l’événement 'spotlightChanged'. |
| off("transfer |
Fonction de désabonnement pour l’événement 'transferRequested'. |
| off |
Désinscrit le gestionnaire des événements stateChanged. |
| on("breakout |
Fonction d’abonnement à l’événement 'breakoutRoomsUpdated'. |
| on("call |
Fonction d’abonnement pour l’événement « callEnded ». |
| on("call |
Fonction Subscribe pour l’événement « callIdChanged ». |
| on("capabilities |
Fonction d’abonnement pour l’événement 'capabilitiesChanged'. |
| on("captions |
Fonction d’abonnement pour l’événement 'captionsReceived'. |
| on("diagnostic |
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("display |
Fonction Subscribe pour l’événement « displayNameChanged ». |
| on("error", (e: Adapter |
Fonction d’abonnement pour l’événement « error ». |
| on("is |
Fonction d’abonnement pour l’événement 'isCaptionLanguageChanged'. |
| on("is |
Fonction d’abonnement pour l’événement 'isCaptionsActiveChanged'. |
| on("is |
Fonction Subscribe pour l’événement « isLocalScreenSharingActiveChanged ». |
| on("is |
Fonction Subscribe pour l’événement « isMutedChanged ». |
| on("is |
Fonction d’abonnement pour l’événement « isSpeakingChanged ». |
| on("is |
Fonction d’abonnement pour l’événement 'isSpokenLanguageChanged'. |
| on("muted |
Fonction d’abonnement pour l’événement 'mutedByOthers'. |
| on("participants |
Fonction d’abonnement pour l’événement « participantsJoined ». |
| on("participants |
Fonction d’abonnement pour l’événement « participantsLeft ». |
| on("real |
Fonction d’abonnement pour l’événement 'realTimeTextReceived'. |
| on("role |
Fonction d’abonnement pour l’événement 'roleChanged'. |
| on("selected |
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("selected |
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("spotlight |
Fonction d’abonnement à l’événement 'spotlightChanged'. |
| on("transfer |
Fonction d’abonnement pour l’événement 'transferRequested'. |
| on |
Envoyer un emoji de réaction |
| on |
Abonne le gestionnaire aux événements stateChanged. |
| permit |
Autorisez l’audio des participants à la réunion Teams par leur ID utilisateur. |
| permit |
Autoriser l’audio de la réunion Teams. |
| permit |
Autoriser la vidéo de la réunion Teams. |
| permit |
Autorisez l’audio des participants à la réunion Teams par leur ID utilisateur. |
| query |
Recherchez les appareils photo disponibles. |
| query |
Recherchez les appareils microphone disponibles. |
| query |
Recherchez les haut-parleurs disponibles. |
| raise |
Lever la main pour l’utilisateur actuel |
| remove |
Supprimez un participant de l’appel. |
| remove |
Supprimez un participant de l’appel. |
| resume |
Reprend l’appel à partir d’un |
| return |
Retour à l’appel d’origine de la salle de discussion |
| send |
envoyer la tonalité DTMF à un autre participant dans un appel RTC 1:1 |
| set |
Définissez la caméra à utiliser dans l’appel. |
| set |
Fonction pour définir la langue des sous-titres |
| set |
Définissez le microphone à utiliser dans l’appel. |
| set |
Définissez l’orateur à utiliser dans l’appel. |
| set |
Fonction de réglage de la langue parlée |
| set |
Recalculez les positions assises pour le mode ensemble. |
| start |
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 |
| start |
Fonction pour démarrer les sous-titres |
| start |
Démarrez l’effet de suppression du bruit. |
| start |
Commencez à partager l’écran pendant un appel. |
| start |
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. |
| start |
Démarrer ensemble. |
| start |
Démarrez l’effet d’arrière-plan de la vidéo. |
| stop |
Arrêter tous les projecteurs |
| stop |
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 |
| stop |
Fonction d’arrêter les sous-titres |
| stop |
Arrêtez l’effet de suppression du bruit. |
| stop |
Arrêter le partage de l’écran |
| stop |
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. |
| stop |
Arrêtez l’effet d’arrière-plan de la vidéo. |
| submit |
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 |
| update |
Remplacez les images du sélecteur d’arrière-plan pour un effet de remplacement de l’arrière-plan. |
| update |
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>
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)
Paramètres
- microphoneOn
-
boolean
Indique si le microphone est initialement activé
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)
Paramètres
- options
- JoinCallOptions
pour régler l’état initialement Microphone/Caméra On/Off/Use Precall.
startCall(CommunicationIdentifier[], StartCallOptions)
Démarrez l’appel.
function startCall(participants: CommunicationIdentifier[], options?: StartCallOptions)
Paramètres
- participants
Un tableau de <xref:%40azure%2Fcommunication-common%23CommunicationIdentifier> à appeler
- options
- StartCallOptions
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
addParticipant(CommunicationUserIdentifier)
function addParticipant(participant: CommunicationUserIdentifier): Promise<void>
Paramètres
- participant
- CommunicationUserIdentifier
Retours
Promise<void>
addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)
Ajoutez un participant à l’appel.
function addParticipant(participant: PhoneNumberIdentifier, options?: AddPhoneNumberOptions): Promise<void>
Paramètres
- participant
- PhoneNumberIdentifier
- options
- AddPhoneNumberOptions
Retours
Promise<void>
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
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
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
Promise<void | TogetherModeStreamViewResult>
Remarques
Cette méthode est implémentée pour composite
Hérité deCallAdapterCallOperations.createTogetherModeStreamView
dispose()
disposeLocalVideoStreamView()
Disposer de la vue html pour un flux vidéo local
function disposeLocalVideoStreamView(): Promise<void>
Retours
Promise<void>
Hérité deCallAdapterCallOperations.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é deCallAdapterCallOperations.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é deCallAdapterCallOperations.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
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é deCallAdapterCallOperations.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>
forbidOthersAudio()
Interdire l’audio des réunions Teams.
function forbidOthersAudio(): Promise<void>
Retours
Promise<void>
forbidOthersVideo()
Interdisez la vidéo de réunion Teams.
function forbidOthersVideo(): Promise<void>
Retours
Promise<void>
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>
getState()
holdCall()
Suspend l’appel.
function holdCall(): Promise<void>
Retours
Promise<void>
Hérité deCallAdapterCallOperations.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 deCallAdapterCallOperations.leaveCall
lowerHand()
main inférieure pour l’utilisateur actuel
function lowerHand(): Promise<void>
Retours
Promise<void>
Hérité deCallAdapterCallOperations.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 deCallAdapterCallOperations.mute
muteAllRemoteParticipants()
Muet tous les participants
function muteAllRemoteParticipants(): Promise<void>
Retours
Promise<void>
Hérité deCallAdapterCallOperations.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>
off("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)
Fonction de désabonnement pour l’événement 'breakoutRoomsUpdated'.
function off(event: "breakoutRoomsUpdated", listener: BreakoutRoomsUpdatedListener)
Paramètres
- event
-
"breakoutRoomsUpdated"
- listener
- BreakoutRoomsUpdatedListener
héritée deCallAdapterSubscribers.off
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("capabilitiesChanged", CapabilitiesChangedListener)
Fonction de désabonnement pour l’événement 'capabilitiesChanged'.
function off(event: "capabilitiesChanged", listener: CapabilitiesChangedListener)
Paramètres
- event
-
"capabilitiesChanged"
- listener
- CapabilitiesChangedListener
héritée deCallAdapterSubscribers.off
off("captionsReceived", CaptionsReceivedListener)
Fonction de désabonnement pour l’événement 'captionsReceived'.
function off(event: "captionsReceived", listener: CaptionsReceivedListener)
Paramètres
- event
-
"captionsReceived"
- listener
- CaptionsReceivedListener
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("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)
Fonction de désabonnement pour l’événement 'isCaptionLanguageChanged'.
function off(event: "isCaptionLanguageChanged", listener: IsCaptionLanguageChangedListener)
Paramètres
- event
-
"isCaptionLanguageChanged"
- listener
- IsCaptionLanguageChangedListener
héritée deCallAdapterSubscribers.off
off("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)
Fonction de désabonnement pour l’événement 'isCaptionsActiveChanged'.
function off(event: "isCaptionsActiveChanged", listener: IsCaptionsActiveChangedListener)
Paramètres
- event
-
"isCaptionsActiveChanged"
- listener
- IsCaptionsActiveChangedListener
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"
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("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)
Fonction de désabonnement pour l’événement 'isSpokenLanguageChanged'.
function off(event: "isSpokenLanguageChanged", listener: IsSpokenLanguageChangedListener)
Paramètres
- event
-
"isSpokenLanguageChanged"
- listener
- IsSpokenLanguageChangedListener
héritée deCallAdapterSubscribers.off
off("mutedByOthers", PropertyChangedEvent)
Fonction de désabonnement pour l’événement 'mutedByOthers'.
function off(event: "mutedByOthers", listener: PropertyChangedEvent)
Paramètres
- event
-
"mutedByOthers"
- listener
- PropertyChangedEvent
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("realTimeTextReceived", RealTimeTextReceivedListener)
Fonction de désabonnement pour l’événement 'realTimeTextReceived'.
function off(event: "realTimeTextReceived", listener: RealTimeTextReceivedListener)
Paramètres
- event
-
"realTimeTextReceived"
- listener
- RealTimeTextReceivedListener
héritée deCallAdapterSubscribers.off
off("roleChanged", PropertyChangedEvent)
Fonction de désabonnement pour l’événement 'roleChanged'.
function off(event: "roleChanged", listener: PropertyChangedEvent)
Paramètres
- event
-
"roleChanged"
- listener
- PropertyChangedEvent
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
off("spotlightChanged", SpotlightChangedListener)
Fonction de désabonnement pour l’événement 'spotlightChanged'.
function off(event: "spotlightChanged", listener: SpotlightChangedListener)
Paramètres
- event
-
"spotlightChanged"
- listener
- SpotlightChangedListener
héritée deCallAdapterSubscribers.off
off("transferAccepted", TransferAcceptedListener)
Fonction de désabonnement pour l’événement 'transferRequested'.
function off(event: "transferAccepted", listener: TransferAcceptedListener)
Paramètres
- event
-
"transferAccepted"
- listener
- TransferAcceptedListener
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("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)
Fonction d’abonnement à l’événement 'breakoutRoomsUpdated'.
function on(event: "breakoutRoomsUpdated", listener: BreakoutRoomsUpdatedListener)
Paramètres
- event
-
"breakoutRoomsUpdated"
- listener
- BreakoutRoomsUpdatedListener
héritée deCallAdapterSubscribers.on
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("capabilitiesChanged", CapabilitiesChangedListener)
Fonction d’abonnement pour l’événement 'capabilitiesChanged'.
function on(event: "capabilitiesChanged", listener: CapabilitiesChangedListener)
Paramètres
- event
-
"capabilitiesChanged"
- listener
- CapabilitiesChangedListener
héritée deCallAdapterSubscribers.on
on("captionsReceived", CaptionsReceivedListener)
Fonction d’abonnement pour l’événement 'captionsReceived'.
function on(event: "captionsReceived", listener: CaptionsReceivedListener)
Paramètres
- event
-
"captionsReceived"
- listener
- CaptionsReceivedListener
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("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)
Fonction d’abonnement pour l’événement 'isCaptionLanguageChanged'.
function on(event: "isCaptionLanguageChanged", listener: IsCaptionLanguageChangedListener)
Paramètres
- event
-
"isCaptionLanguageChanged"
- listener
- IsCaptionLanguageChangedListener
héritée deCallAdapterSubscribers.on
on("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)
Fonction d’abonnement pour l’événement 'isCaptionsActiveChanged'.
function on(event: "isCaptionsActiveChanged", listener: IsCaptionsActiveChangedListener)
Paramètres
- event
-
"isCaptionsActiveChanged"
- listener
- IsCaptionsActiveChangedListener
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"
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("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)
Fonction d’abonnement pour l’événement 'isSpokenLanguageChanged'.
function on(event: "isSpokenLanguageChanged", listener: IsSpokenLanguageChangedListener)
Paramètres
- event
-
"isSpokenLanguageChanged"
- listener
- IsSpokenLanguageChangedListener
héritée deCallAdapterSubscribers.on
on("mutedByOthers", PropertyChangedEvent)
Fonction d’abonnement pour l’événement 'mutedByOthers'.
function on(event: "mutedByOthers", listener: PropertyChangedEvent)
Paramètres
- event
-
"mutedByOthers"
- listener
- PropertyChangedEvent
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("realTimeTextReceived", RealTimeTextReceivedListener)
Fonction d’abonnement pour l’événement 'realTimeTextReceived'.
function on(event: "realTimeTextReceived", listener: RealTimeTextReceivedListener)
Paramètres
- event
-
"realTimeTextReceived"
- listener
- RealTimeTextReceivedListener
héritée deCallAdapterSubscribers.on
on("roleChanged", PropertyChangedEvent)
Fonction d’abonnement pour l’événement 'roleChanged'.
function on(event: "roleChanged", listener: PropertyChangedEvent)
Paramètres
- event
-
"roleChanged"
- listener
- PropertyChangedEvent
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
on("spotlightChanged", SpotlightChangedListener)
Fonction d’abonnement à l’événement 'spotlightChanged'.
function on(event: "spotlightChanged", listener: SpotlightChangedListener)
Paramètres
- event
-
"spotlightChanged"
- listener
- SpotlightChangedListener
héritée deCallAdapterSubscribers.on
on("transferAccepted", TransferAcceptedListener)
Fonction d’abonnement pour l’événement 'transferRequested'.
function on(event: "transferAccepted", listener: TransferAcceptedListener)
Paramètres
- event
-
"transferAccepted"
- listener
- TransferAcceptedListener
héritée deCallAdapterSubscribers.on
onReactionClick(Reaction)
Envoyer un emoji de réaction
function onReactionClick(reaction: Reaction): Promise<void>
Paramètres
- reaction
- Reaction
Retours
Promise<void>
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
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>
permitOthersAudio()
Autoriser l’audio de la réunion Teams.
function permitOthersAudio(): Promise<void>
Retours
Promise<void>
permitOthersVideo()
Autoriser la vidéo de la réunion Teams.
function permitOthersVideo(): Promise<void>
Retours
Promise<void>
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>
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()
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()
raiseHand()
Lever la main pour l’utilisateur actuel
function raiseHand(): Promise<void>
Retours
Promise<void>
Hérité deCallAdapterCallOperations.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>
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>
resumeCall()
Reprend l’appel à partir d’un LocalHold état.
function resumeCall(): Promise<void>
Retours
Promise<void>
Hérité deCallAdapterCallOperations.resumeCall
returnFromBreakoutRoom()
Retour à l’appel d’origine de la salle de discussion
function returnFromBreakoutRoom(): Promise<void>
Retours
Promise<void>
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>
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
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>
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>
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
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>
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
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
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>
startNoiseSuppressionEffect()
Démarrez l’effet de suppression du bruit.
function startNoiseSuppressionEffect(): Promise<void>
Retours
Promise<void>
Hérité deCallAdapterCallOperations.startNoiseSuppressionEffect
startScreenShare()
Commencez à partager l’écran pendant un appel.
function startScreenShare(): Promise<void>
Retours
Promise<void>
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>
startTogetherMode()
Démarrer ensemble.
function startTogetherMode(): Promise<void>
Retours
Promise<void>
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é deCallAdapterCallOperations.startVideoBackgroundEffect
stopAllSpotlight()
Arrêter tous les projecteurs
function stopAllSpotlight(): Promise<void>
Retours
Promise<void>
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
stopCaptions(StopCaptionsAdapterOptions)
Fonction d’arrêter les sous-titres
function stopCaptions(options?: StopCaptionsAdapterOptions): Promise<void>
Paramètres
- options
- StopCaptionsAdapterOptions
Retours
Promise<void>
stopNoiseSuppressionEffect()
Arrêtez l’effet de suppression du bruit.
function stopNoiseSuppressionEffect(): Promise<void>
Retours
Promise<void>
Hérité deCallAdapterCallOperations.stopNoiseSuppressionEffect
stopScreenShare()
Arrêter le partage de l’écran
function stopScreenShare(): Promise<void>
Retours
Promise<void>
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>
stopVideoBackgroundEffects()
Arrêtez l’effet d’arrière-plan de la vidéo.
function stopVideoBackgroundEffects(): Promise<void>
Retours
Promise<void>
Hérité deCallAdapterCallOperations.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>
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
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
Tableau d’images d’arrière-plan personnalisées.
Hérité deCallAdapterCallOperations.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é deCallAdapterCallOperations.updateSelectedVideoBackgroundEffect