CallWithChatAdapter interface
- Extends
Propriétés héritées
| forbid |
Interdit l’audio pour les ID utilisateur spécifiés. |
| forbid |
interdit l’audio pour les participants à la réunion Teams, à l’exception de l’utilisateur local. |
| forbid |
interdit la vidéo pour les participants à la réunion Teams, à l’exception de l’utilisateur local. |
| forbid |
Interdit la vidéo pour les ID utilisateur spécifiés. |
| permit |
Autorise l’audio pour les ID utilisateur spécifiés. |
| permit |
autorise l’audio pour les participants aux réunions Teams, à l’exception de l’utilisateur local. |
| permit |
autorise la vidéo pour les participants aux réunions Teams, à l’exception de l’utilisateur local. |
| permit |
Autorise la vidéo pour les ID utilisateur spécifiés. |
| send |
Envoi d’une tonalité DTMF à un autre participant à l’appel en appels 1:1 |
| send |
Envoyer du texte en temps réel |
Méthodes héritées
Détails de la propriété héritée
forbidAudio
Interdit l’audio pour les ID utilisateur spécifiés.
forbidAudio: (userIds: string[]) => Promise<void>
Valeur de propriété
(userIds: string[]) => Promise<void>
forbidOthersAudio
interdit l’audio pour les participants à la réunion Teams, à l’exception de l’utilisateur local.
forbidOthersAudio: () => Promise<void>
Valeur de propriété
() => Promise<void>
forbidOthersVideo
interdit la vidéo pour les participants à la réunion Teams, à l’exception de l’utilisateur local.
forbidOthersVideo: () => Promise<void>
Valeur de propriété
() => Promise<void>
forbidVideo
Interdit la vidéo pour les ID utilisateur spécifiés.
forbidVideo: (userIds: string[]) => Promise<void>
Valeur de propriété
(userIds: string[]) => Promise<void>
permitAudio
Autorise l’audio pour les ID utilisateur spécifiés.
permitAudio: (userIds: string[]) => Promise<void>
Valeur de propriété
(userIds: string[]) => Promise<void>
permitOthersAudio
autorise l’audio pour les participants aux réunions Teams, à l’exception de l’utilisateur local.
permitOthersAudio: () => Promise<void>
Valeur de propriété
() => Promise<void>
permitOthersVideo
autorise la vidéo pour les participants aux réunions Teams, à l’exception de l’utilisateur local.
permitOthersVideo: () => Promise<void>
Valeur de propriété
() => Promise<void>
permitVideo
Autorise la vidéo pour les ID utilisateur spécifiés.
permitVideo: (userIds: string[]) => Promise<void>
Valeur de propriété
(userIds: string[]) => Promise<void>
sendDtmfTone
Envoi d’une tonalité DTMF à un autre participant à l’appel en appels 1:1
public sendDtmfTone: (dtmfTone: DtmfTone) => Promise<void>
Valeur de propriété
(dtmfTone: DtmfTone) => Promise<void>
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 héritée
addParticipant(CommunicationUserIdentifier)
function addParticipant(participant: CommunicationUserIdentifier): Promise<void>
Paramètres
- participant
- CommunicationUserIdentifier
Retours
Promise<void>
addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)
Ajoute un nouveau 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 togethermode.
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é deCallWithChatAdapterManagement.createTogetherModeStreamView
deleteMessage(string)
Supprimez un message dans le thread.
function deleteMessage(messageId: string): Promise<void>
Paramètres
- messageId
-
string
Retours
Promise<void>
dispose()
disposeLocalVideoStreamView()
Disposer de la vue html pour un flux vidéo local
function disposeLocalVideoStreamView(): Promise<void>
Retours
Promise<void>
Hérité deCallWithChatAdapterManagement.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é deCallWithChatAdapterManagement.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é deCallWithChatAdapterManagement.disposeScreenShareStreamView
disposeStreamView(string, VideoStreamOptions)
Supprimez la vue html d’un flux.
function disposeStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void>
Paramètres
- remoteUserId
-
string
ID du participant à afficher, laissez-le non défini pour supprimer la vue de la caméra locale
- options
- VideoStreamOptions
Options pour contrôler le rendu des flux vidéo <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
Retours
Promise<void>
Remarques
Cette méthode est implémentée pour composite.
disposeTogetherModeStreamView()
Disposez la vue html pour un flux togethermode.
function disposeTogetherModeStreamView(): Promise<void>
Retours
Promise<void>
Remarques
Cette méthode est implémentée pour composite
Hérité deCallWithChatAdapterManagement.disposeTogetherModeStreamView
downloadResourceToCache(ResourceDetails)
function downloadResourceToCache(resourceDetails: ResourceDetails): Promise<void>
Paramètres
- resourceDetails
- ResourceDetails
Retours
Promise<void>
Hérité deCallWithChatAdapterManagement.downloadResourceToCache
fetchInitialData()
Récupérez l’état initial de l’adaptateur Chat.
Effectue la récupération minimale nécessaire pour les méthodes ChatComposite et API.
function fetchInitialData(): Promise<void>
Retours
Promise<void>
getState()
Obtenir l’état actuel
function getState(): CallWithChatAdapterState
Retours
héritée deAdapterState.getState
holdCall()
Place l’appel dans un arrêt local.
function holdCall(): Promise<void>
Retours
Promise<void>
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
héritée deCallWithChatAdapterManagement.joinCall
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
héritée deCallWithChatAdapterManagement.joinCall
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 deCallWithChatAdapterManagement.leaveCall
loadPreviousChatMessages(number)
Chargez d’autres messages précédents dans l’historique des threads de conversation.
function loadPreviousChatMessages(messagesToLoad: number): Promise<boolean>
Paramètres
- messagesToLoad
-
number
Retours
Promise<boolean>
Remarques
Cette méthode est généralement utilisée pour contrôler la récupération incrémentielle/le défilement infini.
héritée deCallWithChatAdapterManagement.loadPreviousChatMessages
lowerHand()
Main inférieure pour l’utilisateur local.
function lowerHand(): Promise<void>
Retours
Promise<void>
mute()
Désactivez l’utilisateur actuel pendant l’appel ou désactivez le microphone localement.
function mute(): Promise<void>
Retours
Promise<void>
héritée deCallWithChatAdapterManagement.mute
muteAllRemoteParticipants()
Mettre un participant en sourdine
function muteAllRemoteParticipants(): Promise<void>
Retours
Promise<void>
Hérité deCallWithChatAdapterManagement.muteAllRemoteParticipants
muteParticipant(string)
Mettre un participant en sourdine
function muteParticipant(userId: string): Promise<void>
Paramètres
- userId
-
string
Retours
Promise<void>
off("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)
function off(event: "breakoutRoomsUpdated", listener: BreakoutRoomsUpdatedListener)
Paramètres
- event
-
"breakoutRoomsUpdated"
- listener
- BreakoutRoomsUpdatedListener
héritée deCallWithChatAdapterSubscriptions.off
off("callEnded", CallEndedListener)
function off(event: "callEnded", listener: CallEndedListener)
Paramètres
- event
-
"callEnded"
- listener
- CallEndedListener
héritée deCallWithChatAdapterSubscriptions.off
off("callError", (e: AdapterError) => void)
function off(event: "callError", listener: (e: AdapterError) => void)
Paramètres
- event
-
"callError"
- listener
-
(e: AdapterError) => void
héritée deCallWithChatAdapterSubscriptions.off
off("callIdChanged", CallIdChangedListener)
function off(event: "callIdChanged", listener: CallIdChangedListener)
Paramètres
- event
-
"callIdChanged"
- listener
- CallIdChangedListener
héritée deCallWithChatAdapterSubscriptions.off
off("callParticipantsJoined", ParticipantsJoinedListener)
function off(event: "callParticipantsJoined", listener: ParticipantsJoinedListener)
Paramètres
- event
-
"callParticipantsJoined"
- listener
- ParticipantsJoinedListener
héritée deCallWithChatAdapterSubscriptions.off
off("callParticipantsLeft", ParticipantsLeftListener)
function off(event: "callParticipantsLeft", listener: ParticipantsLeftListener)
Paramètres
- event
-
"callParticipantsLeft"
- listener
- ParticipantsLeftListener
héritée deCallWithChatAdapterSubscriptions.off
off("capabilitiesChanged", CapabilitiesChangedListener)
function off(event: "capabilitiesChanged", listener: CapabilitiesChangedListener)
Paramètres
- event
-
"capabilitiesChanged"
- listener
- CapabilitiesChangedListener
héritée deCallWithChatAdapterSubscriptions.off
off("captionsReceived", CaptionsReceivedListener)
function off(event: "captionsReceived", listener: CaptionsReceivedListener)
Paramètres
- event
-
"captionsReceived"
- listener
- CaptionsReceivedListener
héritée deCallWithChatAdapterSubscriptions.off
off("chatError", (e: AdapterError) => void)
function off(event: "chatError", listener: (e: AdapterError) => void)
Paramètres
- event
-
"chatError"
- listener
-
(e: AdapterError) => void
héritée deCallWithChatAdapterSubscriptions.off
off("chatInitialized", ChatInitializedListener)
function off(event: "chatInitialized", listener: ChatInitializedListener)
Paramètres
- event
-
"chatInitialized"
- listener
- ChatInitializedListener
héritée deCallWithChatAdapterSubscriptions.off
off("chatParticipantsAdded", ParticipantsAddedListener)
function off(event: "chatParticipantsAdded", listener: ParticipantsAddedListener)
Paramètres
- event
-
"chatParticipantsAdded"
- listener
- ParticipantsAddedListener
héritée deCallWithChatAdapterSubscriptions.off
off("chatParticipantsRemoved", ParticipantsRemovedListener)
function off(event: "chatParticipantsRemoved", listener: ParticipantsRemovedListener)
Paramètres
- event
-
"chatParticipantsRemoved"
- listener
- ParticipantsRemovedListener
héritée deCallWithChatAdapterSubscriptions.off
off("displayNameChanged", DisplayNameChangedListener)
function off(event: "displayNameChanged", listener: DisplayNameChangedListener)
Paramètres
- event
-
"displayNameChanged"
- listener
- DisplayNameChangedListener
héritée deCallWithChatAdapterSubscriptions.off
off("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)
function off(event: "isCaptionLanguageChanged", listener: IsCaptionLanguageChangedListener)
Paramètres
- event
-
"isCaptionLanguageChanged"
- listener
- IsCaptionLanguageChangedListener
héritée deCallWithChatAdapterSubscriptions.off
off("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)
function off(event: "isCaptionsActiveChanged", listener: IsCaptionsActiveChangedListener)
Paramètres
- event
-
"isCaptionsActiveChanged"
- listener
- IsCaptionsActiveChangedListener
héritée deCallWithChatAdapterSubscriptions.off
off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)
function off(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)
Paramètres
- event
-
"isLocalScreenSharingActiveChanged"
héritée deCallWithChatAdapterSubscriptions.off
off("isMutedChanged", IsMutedChangedListener)
function off(event: "isMutedChanged", listener: IsMutedChangedListener)
Paramètres
- event
-
"isMutedChanged"
- listener
- IsMutedChangedListener
héritée deCallWithChatAdapterSubscriptions.off
off("isSpeakingChanged", IsSpeakingChangedListener)
function off(event: "isSpeakingChanged", listener: IsSpeakingChangedListener)
Paramètres
- event
-
"isSpeakingChanged"
- listener
- IsSpeakingChangedListener
héritée deCallWithChatAdapterSubscriptions.off
off("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)
function off(event: "isSpokenLanguageChanged", listener: IsSpokenLanguageChangedListener)
Paramètres
- event
-
"isSpokenLanguageChanged"
- listener
- IsSpokenLanguageChangedListener
héritée deCallWithChatAdapterSubscriptions.off
off("messageDeleted", MessageReceivedListener)
function off(event: "messageDeleted", listener: MessageReceivedListener)
Paramètres
- event
-
"messageDeleted"
- listener
- MessageReceivedListener
héritée deCallWithChatAdapterSubscriptions.off
off("messageEdited", MessageReceivedListener)
function off(event: "messageEdited", listener: MessageReceivedListener)
Paramètres
- event
-
"messageEdited"
- listener
- MessageReceivedListener
héritée deCallWithChatAdapterSubscriptions.off
off("messageRead", MessageReadListener)
function off(event: "messageRead", listener: MessageReadListener)
Paramètres
- event
-
"messageRead"
- listener
- MessageReadListener
héritée deCallWithChatAdapterSubscriptions.off
off("messageReceived", MessageReceivedListener)
function off(event: "messageReceived", listener: MessageReceivedListener)
Paramètres
- event
-
"messageReceived"
- listener
- MessageReceivedListener
héritée deCallWithChatAdapterSubscriptions.off
off("messageSent", MessageReceivedListener)
function off(event: "messageSent", listener: MessageReceivedListener)
Paramètres
- event
-
"messageSent"
- listener
- MessageReceivedListener
héritée deCallWithChatAdapterSubscriptions.off
off("realTimeTextReceived", RealTimeTextReceivedListener)
function off(event: "realTimeTextReceived", listener: RealTimeTextReceivedListener)
Paramètres
- event
-
"realTimeTextReceived"
- listener
- RealTimeTextReceivedListener
héritée deCallWithChatAdapterSubscriptions.off
off("selectedMicrophoneChanged", PropertyChangedEvent)
function off(event: "selectedMicrophoneChanged", listener: PropertyChangedEvent)
Paramètres
- event
-
"selectedMicrophoneChanged"
- listener
- PropertyChangedEvent
héritée deCallWithChatAdapterSubscriptions.off
off("selectedSpeakerChanged", PropertyChangedEvent)
function off(event: "selectedSpeakerChanged", listener: PropertyChangedEvent)
Paramètres
- event
-
"selectedSpeakerChanged"
- listener
- PropertyChangedEvent
héritée deCallWithChatAdapterSubscriptions.off
off("spotlightChanged", SpotlightChangedListener)
function off(event: "spotlightChanged", listener: SpotlightChangedListener)
Paramètres
- event
-
"spotlightChanged"
- listener
- SpotlightChangedListener
héritée deCallWithChatAdapterSubscriptions.off
offStateChange((state: CallWithChatAdapterState) => void)
Désinscrit le gestionnaire des événements stateChanged.
function offStateChange(handler: (state: CallWithChatAdapterState) => void)
Paramètres
- handler
-
(state: CallWithChatAdapterState) => void
héritée deAdapterState.offStateChange
on("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)
function on(event: "breakoutRoomsUpdated", listener: BreakoutRoomsUpdatedListener)
Paramètres
- event
-
"breakoutRoomsUpdated"
- listener
- BreakoutRoomsUpdatedListener
héritée deCallWithChatAdapterSubscriptions.on
on("callEnded", CallEndedListener)
function on(event: "callEnded", listener: CallEndedListener)
Paramètres
- event
-
"callEnded"
- listener
- CallEndedListener
héritée deCallWithChatAdapterSubscriptions.on
on("callError", (e: AdapterError) => void)
function on(event: "callError", listener: (e: AdapterError) => void)
Paramètres
- event
-
"callError"
- listener
-
(e: AdapterError) => void
héritée deCallWithChatAdapterSubscriptions.on
on("callIdChanged", CallIdChangedListener)
function on(event: "callIdChanged", listener: CallIdChangedListener)
Paramètres
- event
-
"callIdChanged"
- listener
- CallIdChangedListener
héritée deCallWithChatAdapterSubscriptions.on
on("callParticipantsJoined", ParticipantsJoinedListener)
function on(event: "callParticipantsJoined", listener: ParticipantsJoinedListener)
Paramètres
- event
-
"callParticipantsJoined"
- listener
- ParticipantsJoinedListener
héritée deCallWithChatAdapterSubscriptions.on
on("callParticipantsLeft", ParticipantsLeftListener)
function on(event: "callParticipantsLeft", listener: ParticipantsLeftListener)
Paramètres
- event
-
"callParticipantsLeft"
- listener
- ParticipantsLeftListener
héritée deCallWithChatAdapterSubscriptions.on
on("capabilitiesChanged", CapabilitiesChangedListener)
function on(event: "capabilitiesChanged", listener: CapabilitiesChangedListener)
Paramètres
- event
-
"capabilitiesChanged"
- listener
- CapabilitiesChangedListener
héritée deCallWithChatAdapterSubscriptions.on
on("captionsReceived", CaptionsReceivedListener)
function on(event: "captionsReceived", listener: CaptionsReceivedListener)
Paramètres
- event
-
"captionsReceived"
- listener
- CaptionsReceivedListener
héritée deCallWithChatAdapterSubscriptions.on
on("chatError", (e: AdapterError) => void)
function on(event: "chatError", listener: (e: AdapterError) => void)
Paramètres
- event
-
"chatError"
- listener
-
(e: AdapterError) => void
héritée deCallWithChatAdapterSubscriptions.on
on("chatInitialized", ChatInitializedListener)
function on(event: "chatInitialized", listener: ChatInitializedListener)
Paramètres
- event
-
"chatInitialized"
- listener
- ChatInitializedListener
héritée deCallWithChatAdapterSubscriptions.on
on("chatParticipantsAdded", ParticipantsAddedListener)
function on(event: "chatParticipantsAdded", listener: ParticipantsAddedListener)
Paramètres
- event
-
"chatParticipantsAdded"
- listener
- ParticipantsAddedListener
héritée deCallWithChatAdapterSubscriptions.on
on("chatParticipantsRemoved", ParticipantsRemovedListener)
function on(event: "chatParticipantsRemoved", listener: ParticipantsRemovedListener)
Paramètres
- event
-
"chatParticipantsRemoved"
- listener
- ParticipantsRemovedListener
héritée deCallWithChatAdapterSubscriptions.on
on("displayNameChanged", DisplayNameChangedListener)
function on(event: "displayNameChanged", listener: DisplayNameChangedListener)
Paramètres
- event
-
"displayNameChanged"
- listener
- DisplayNameChangedListener
héritée deCallWithChatAdapterSubscriptions.on
on("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)
function on(event: "isCaptionLanguageChanged", listener: IsCaptionLanguageChangedListener)
Paramètres
- event
-
"isCaptionLanguageChanged"
- listener
- IsCaptionLanguageChangedListener
héritée deCallWithChatAdapterSubscriptions.on
on("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)
function on(event: "isCaptionsActiveChanged", listener: IsCaptionsActiveChangedListener)
Paramètres
- event
-
"isCaptionsActiveChanged"
- listener
- IsCaptionsActiveChangedListener
héritée deCallWithChatAdapterSubscriptions.on
on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)
function on(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)
Paramètres
- event
-
"isLocalScreenSharingActiveChanged"
héritée deCallWithChatAdapterSubscriptions.on
on("isMutedChanged", IsMutedChangedListener)
function on(event: "isMutedChanged", listener: IsMutedChangedListener)
Paramètres
- event
-
"isMutedChanged"
- listener
- IsMutedChangedListener
héritée deCallWithChatAdapterSubscriptions.on
on("isSpeakingChanged", IsSpeakingChangedListener)
function on(event: "isSpeakingChanged", listener: IsSpeakingChangedListener)
Paramètres
- event
-
"isSpeakingChanged"
- listener
- IsSpeakingChangedListener
héritée deCallWithChatAdapterSubscriptions.on
on("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)
function on(event: "isSpokenLanguageChanged", listener: IsSpokenLanguageChangedListener)
Paramètres
- event
-
"isSpokenLanguageChanged"
- listener
- IsSpokenLanguageChangedListener
héritée deCallWithChatAdapterSubscriptions.on
on("messageDeleted", MessageReceivedListener)
function on(event: "messageDeleted", listener: MessageReceivedListener)
Paramètres
- event
-
"messageDeleted"
- listener
- MessageReceivedListener
héritée deCallWithChatAdapterSubscriptions.on
on("messageEdited", MessageReceivedListener)
function on(event: "messageEdited", listener: MessageReceivedListener)
Paramètres
- event
-
"messageEdited"
- listener
- MessageReceivedListener
héritée deCallWithChatAdapterSubscriptions.on
on("messageRead", MessageReadListener)
function on(event: "messageRead", listener: MessageReadListener)
Paramètres
- event
-
"messageRead"
- listener
- MessageReadListener
héritée deCallWithChatAdapterSubscriptions.on
on("messageReceived", MessageReceivedListener)
function on(event: "messageReceived", listener: MessageReceivedListener)
Paramètres
- event
-
"messageReceived"
- listener
- MessageReceivedListener
héritée deCallWithChatAdapterSubscriptions.on
on("messageSent", MessageReceivedListener)
function on(event: "messageSent", listener: MessageReceivedListener)
Paramètres
- event
-
"messageSent"
- listener
- MessageReceivedListener
héritée deCallWithChatAdapterSubscriptions.on
on("realTimeTextReceived", RealTimeTextReceivedListener)
function on(event: "realTimeTextReceived", listener: RealTimeTextReceivedListener)
Paramètres
- event
-
"realTimeTextReceived"
- listener
- RealTimeTextReceivedListener
héritée deCallWithChatAdapterSubscriptions.on
on("selectedMicrophoneChanged", PropertyChangedEvent)
function on(event: "selectedMicrophoneChanged", listener: PropertyChangedEvent)
Paramètres
- event
-
"selectedMicrophoneChanged"
- listener
- PropertyChangedEvent
héritée deCallWithChatAdapterSubscriptions.on
on("selectedSpeakerChanged", PropertyChangedEvent)
function on(event: "selectedSpeakerChanged", listener: PropertyChangedEvent)
Paramètres
- event
-
"selectedSpeakerChanged"
- listener
- PropertyChangedEvent
héritée deCallWithChatAdapterSubscriptions.on
on("spotlightChanged", SpotlightChangedListener)
function on(event: "spotlightChanged", listener: SpotlightChangedListener)
Paramètres
- event
-
"spotlightChanged"
- listener
- SpotlightChangedListener
héritée deCallWithChatAdapterSubscriptions.on
onReactionClick(Reaction)
Envoyer une réaction à la réunion en cours.
function onReactionClick(reaction: Reaction): Promise<void>
Paramètres
- reaction
- Reaction
Une valeur de type <xref:%40azure%2Fcommunication-calling%23Reaction>
Retours
Promise<void>
onStateChange((state: CallWithChatAdapterState) => void)
Abonne le gestionnaire aux événements stateChanged.
function onStateChange(handler: (state: CallWithChatAdapterState) => void)
Paramètres
- handler
-
(state: CallWithChatAdapterState) => void
héritée deAdapterState.onStateChange
queryCameras()
Recherchez les appareils photo disponibles.
function queryCameras(): Promise<VideoDeviceInfo[]>
Retours
Promise<VideoDeviceInfo[]>
Tableau d’entités d’informations d’appareil vidéo <xref:%40azure%2Fcommunication-calling%23VideoDeviceInfo>
Remarques
Cette méthode doit être appelée après askDevicePermission()
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 appareils microphone disponibles.
function querySpeakers(): Promise<AudioDeviceInfo[]>
Retours
Promise<AudioDeviceInfo[]>
Tableau d’entités d’informations d’appareil audio <xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo>
Remarques
Cette méthode doit être appelée après askDevicePermission()
raiseHand()
Lever la main pour l’utilisateur local.
function raiseHand(): Promise<void>
Retours
Promise<void>
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 d’un appel.
function removeParticipant(userId: string): Promise<void>
Paramètres
- userId
-
string
UserId du participant à supprimer.
Retours
Promise<void>
removeResourceFromCache(ResourceDetails)
function removeResourceFromCache(resourceDetails: ResourceDetails)
Paramètres
- resourceDetails
- ResourceDetails
Hérité deCallWithChatAdapterManagement.removeResourceFromCache
resumeCall()
Reprend l’appel à partir d’un état LocalHold.
function resumeCall(): Promise<void>
Retours
Promise<void>
returnFromBreakoutRoom()
Retour à l’appel d’origine de la salle de discussion
function returnFromBreakoutRoom(): Promise<void>
Retours
Promise<void>
Hérité deCallWithChatAdapterManagement.returnFromBreakoutRoom
sendMessage(string, SendMessageOptions)
Envoyez un message dans le thread.
function sendMessage(content: string, options?: SendMessageOptions): Promise<void>
Paramètres
- content
-
string
- options
- SendMessageOptions
Retours
Promise<void>
sendReadReceipt(string)
Envoyez un reçu de lecture pour un message.
function sendReadReceipt(chatMessageId: string): Promise<void>
Paramètres
- chatMessageId
-
string
Retours
Promise<void>
sendTypingIndicator()
Envoyez l’indicateur de saisie dans le thread.
function sendTypingIndicator(): Promise<void>
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 deCallWithChatAdapterManagement.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 deCallWithChatAdapterManagement.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
Hérité deCallWithChatAdapterManagement.setTogetherModeSceneSize
startCall((CommunicationUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], StartCallOptions)
Démarrez l’appel.
function startCall(participants: (CommunicationUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], options?: StartCallOptions): undefined | Call
Paramètres
- participants
-
(CommunicationUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[]
Un tableau de <xref:%40azure%2Fcommunication-common%23CommunicationIdentifier> à appeler
- options
- StartCallOptions
Retours
undefined | Call
héritée deCallWithChatAdapterManagement.startCall
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
- options
- StartCallOptions
Retours
undefined | Call
héritée deCallWithChatAdapterManagement.startCall
startCamera(VideoStreamOptions)
Démarrez 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>
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é deCallWithChatAdapterManagement.startNoiseSuppressionEffect
startScreenShare()
Commencez à partager l’écran pendant un appel.
function startScreenShare(): Promise<void>
Retours
Promise<void>
startSpotlight(string[])
Démarrer spotlight
function startSpotlight(userIds?: string[]): Promise<void>
Paramètres
- userIds
-
string[]
Retours
Promise<void>
startTogetherMode()
Démarrer ensemble.
function startTogetherMode(): Promise<void>
Retours
Promise<void>
Remarques
Cette méthode est implémentée pour composite
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é deCallWithChatAdapterManagement.startVideoBackgroundEffect
stopAllSpotlight()
Arrêter tous les projecteurs
function stopAllSpotlight(): Promise<void>
Retours
Promise<void>
stopCamera()
Arrêtez 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 deCallWithChatAdapterManagement.stopCamera
stopCaptions(StopCaptionsAdapterOptions)
Fonction d’arrêter les sous-titres
function stopCaptions(options?: StopCaptionsAdapterOptions): Promise<void>
Paramètres
- options
- StopCaptionsAdapterOptions
Retours
Promise<void>
stopNoiseSuppressionEffect()
Démarrez l’effet de suppression du bruit.
function stopNoiseSuppressionEffect(): Promise<void>
Retours
Promise<void>
Hérité deCallWithChatAdapterManagement.stopNoiseSuppressionEffect
stopScreenShare()
Arrêtez le partage de l’écran.
function stopScreenShare(): Promise<void>
Retours
Promise<void>
stopSpotlight(string[])
Arrêter le projecteur
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é deCallWithChatAdapterManagement.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ésactivez l’utilisateur actuel pendant l’appel ou activez le microphone localement.
function unmute(): Promise<void>
Retours
Promise<void>
héritée deCallWithChatAdapterManagement.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é deCallWithChatAdapterManagement.updateBackgroundPickerImages
updateMessage(string, string, Record<string, string>)
Mettez à jour un contenu de message.
function updateMessage(messageId: string, content: string, options?: Record<string, string>): Promise<void>
Paramètres
- messageId
-
string
- content
-
string
- options
-
Record<string, string>
Retours
Promise<void>
updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)
Mettre à jour l’effet d’arrière-plan de la vidéo sélectionnée
function updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect)
Paramètres
- selectedVideoBackground
- VideoBackgroundEffect
Hérité deCallWithChatAdapterManagement.updateSelectedVideoBackgroundEffect