CallWithChatAdapterManagement interface
Fonctionnalité de gestion de l’appel actuel avec conversation.
Propriétés
| 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
| add |
|
| add |
Ajoute un nouveau 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 togethermode. |
| delete |
Supprimez un message dans le thread. |
| 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 |
Disposez la vue html pour un flux togethermode. |
| download |
|
| fetch |
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. |
| hold |
Place l’appel dans un arrêt local. |
| 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 |
| leave |
Laissez l’appel. |
| load |
Chargez d’autres messages précédents dans l’historique des threads de conversation. |
| lower |
Main inférieure pour l’utilisateur local. |
| mute() | Désactivez l’utilisateur actuel pendant l’appel ou désactivez le microphone localement. |
| mute |
Mettre un participant en sourdine |
| mute |
Mettre un participant en sourdine |
| on |
Envoyer une réaction à la réunion en cours. |
| query |
Recherchez les appareils photo disponibles. |
| query |
Recherchez les appareils microphone disponibles. |
| query |
Recherchez les appareils microphone disponibles. |
| raise |
Lever la main pour l’utilisateur local. |
| remove |
Supprimez un participant de l’appel. |
| remove |
Supprimez un participant d’un appel. |
| remove |
|
| resume |
Reprend l’appel à partir d’un état LocalHold. |
| return |
Retour à l’appel d’origine de la salle de discussion |
| send |
Envoyez un message dans le thread. |
| send |
Envoyez un reçu de lecture pour un message. |
| send |
Envoyez l’indicateur de saisie dans le thread. |
| 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émarrez l’appel. |
| start |
Démarrez l’appel. |
| start |
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. |
| 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émarrer spotlight |
| 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ê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. |
| stop |
Fonction d’arrêter les sous-titres |
| stop |
Démarrez l’effet de suppression du bruit. |
| stop |
Arrêtez le partage de l’écran. |
| stop |
Arrêter le projecteur |
| 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ésactivez l’utilisateur actuel pendant l’appel ou activez 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 un contenu de message. |
| update |
Mettre à jour l’effet d’arrière-plan de la vidéo sélectionnée |
Détails de la propriété
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
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
deleteMessage(string)
Supprimez un message dans le thread.
function deleteMessage(messageId: string): Promise<void>
Paramètres
- messageId
-
string
Retours
Promise<void>
disposeLocalVideoStreamView()
Disposer de la vue html pour un flux vidéo local
function disposeLocalVideoStreamView(): Promise<void>
Retours
Promise<void>
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>
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
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
downloadResourceToCache(ResourceDetails)
function downloadResourceToCache(resourceDetails: ResourceDetails): Promise<void>
Paramètres
- resourceDetails
- ResourceDetails
Retours
Promise<void>
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>
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
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
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>
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.
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>
muteAllRemoteParticipants()
Mettre un participant en sourdine
function muteAllRemoteParticipants(): Promise<void>
Retours
Promise<void>
muteParticipant(string)
Mettre un participant en sourdine
function muteParticipant(userId: string): Promise<void>
Paramètres
- userId
-
string
Retours
Promise<void>
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>
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
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>
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>
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>
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
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
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
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>
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>
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>
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>
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>
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>
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.
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