CallAdapterCallOperations interface

Paquet:

@azure/communication-react

Fonctionnalité de gestion de l’appel actuel.

Propriétés

sendRealTimeText

Envoyer du texte en temps réel

Méthodes

addParticipant(CommunicationUserIdentifier)
addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)	Ajoutez un participant à l’appel.
createStreamView(string, VideoStreamOptions)	Créez la vue html pour un flux.
createTogetherModeStreamView(TogetherModeStreamOptions)	Créez la vue html pour un flux.
disposeLocalVideoStreamView()	Disposer de la vue html pour un flux vidéo local
disposeRemoteVideoStreamView(string)	Disposer de la vue html pour un flux vidéo distant
disposeScreenShareStreamView(string)	Disposer de la vue html pour un flux de partage d’écran
disposeStreamView(string, VideoStreamOptions)	Supprimez la vue html d’un flux.
disposeTogetherModeStreamView()	Supprimez la vue html d’un flux.
forbidAudio(string[])	Interdisez l’audio des participants à la réunion Teams par leurs ID utilisateur.
forbidOthersAudio()	Interdire l’audio des réunions Teams.
forbidOthersVideo()	Interdisez la vidéo de réunion Teams.
forbidVideo(string[])	Interdisez la vidéo des participants à la réunion Teams par leurs ID utilisateur.
holdCall()	Suspend l’appel.
leaveCall(boolean)	Laissez l’appel
lowerHand()	main inférieure pour l’utilisateur actuel
mute()	Désactiver l’utilisateur actuel pendant l’appel ou désactiver le microphone localement
muteAllRemoteParticipants()	Muet tous les participants
muteParticipant(string)	Mettre un participant en sourdine
onReactionClick(Reaction)	Envoyer un emoji de réaction
permitAudio(string[])	Autorisez l’audio des participants à la réunion Teams par leur ID utilisateur.
permitOthersAudio()	Autoriser l’audio de la réunion Teams.
permitOthersVideo()	Autoriser la vidéo de la réunion Teams.
permitVideo(string[])	Autorisez l’audio des participants à la réunion Teams par leur ID utilisateur.
raiseHand()	Lever la main pour l’utilisateur actuel
removeParticipant(CommunicationIdentifier)	Supprimez un participant de l’appel.
removeParticipant(string)	Supprimez un participant de l’appel.
resumeCall()	Reprend l’appel à partir d’un LocalHold état.
returnFromBreakoutRoom()	Retour à l’appel d’origine de la salle de discussion
sendDtmfTone(DtmfTone)	envoyer la tonalité DTMF à un autre participant dans un appel RTC 1:1
setCaptionLanguage(string)	Fonction pour définir la langue des sous-titres
setSpokenLanguage(string)	Fonction de réglage de la langue parlée
setTogetherModeSceneSize(number, number)	Recalculez les positions assises pour le mode ensemble.
startCamera(VideoStreamOptions)	Démarrer la caméra Cette méthode démarre le rendu d’une vue de caméra locale lorsque l’appel n’est pas actif
startCaptions(StartCaptionsAdapterOptions)	Fonction pour démarrer les sous-titres
startNoiseSuppressionEffect()	Démarrez l’effet de suppression du bruit.
startScreenShare()	Commencez à partager l’écran pendant un appel.
startSpotlight(string[])	Démarrez Spotlight pour les participants locaux et distants par leurs identifiants d’utilisateur. Si aucun tableau d’identifiants d’utilisateur n’est transmis, l’action est effectuée sur le participant local.
startTogetherMode()	Démarrer ensemble.
startVideoBackgroundEffect(VideoBackgroundEffect)	Démarrez l’effet d’arrière-plan de la vidéo.
stopAllSpotlight()	Arrêter tous les projecteurs
stopCamera()	Arrêter la caméra Cette méthode arrête le rendu d’une vue de caméra locale lorsque l’appel n’est pas actif
stopCaptions(StopCaptionsAdapterOptions)	Fonction d’arrêter les sous-titres
stopNoiseSuppressionEffect()	Arrêtez l’effet de suppression du bruit.
stopScreenShare()	Arrêter le partage de l’écran
stopSpotlight(string[])	Arrêtez de mettre en lumière les participants locaux et distants par leurs identifiants d’utilisateur. Si aucun tableau d’identifiants d’utilisateur n’est transmis, l’action est effectuée sur le participant local.
stopVideoBackgroundEffects()	Arrêtez l’effet d’arrière-plan de la vidéo.
submitSurvey(CallSurvey)	Envoyer le résultat de l’enquête de fin d’appel
unmute()	Désactiver l’utilisateur actuel pendant l’appel ou activer le microphone localement
updateBackgroundPickerImages(VideoBackgroundImage[])	Remplacez les images du sélecteur d’arrière-plan pour un effet de remplacement de l’arrière-plan.
updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)	Mettez à jour l’effet d’arrière-plan vidéo sélectionné.

Détails de la propriété

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)

Ajoutez un participant à l’appel.

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

Paramètres

participant

PhoneNumberIdentifier

options

AddPhoneNumberOptions

Retours

Promise<void>

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

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)

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

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>

holdCall()

Suspend l’appel.

function holdCall(): Promise<void>

Retours

Promise<void>

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>

lowerHand()

main inférieure pour l’utilisateur actuel

function lowerHand(): Promise<void>

Retours

Promise<void>

mute()

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

function mute(): Promise<void>

Retours

Promise<void>

muteAllRemoteParticipants()

Muet tous les participants

function muteAllRemoteParticipants(): Promise<void>

Retours

Promise<void>

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>

onReactionClick(Reaction)

Envoyer un emoji de réaction

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

Paramètres

reaction

Reaction

Retours

Promise<void>

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>

raiseHand()

Lever la main pour l’utilisateur actuel

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 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>

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>

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>

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>

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é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>

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>

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>

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>

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>

updateBackgroundPickerImages(VideoBackgroundImage[])

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

function updateBackgroundPickerImages(backgroundImages: VideoBackgroundImage[])

Paramètres

backgroundImages

VideoBackgroundImage[]

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

updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)

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

function updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect)

Paramètres

selectedVideoBackground

VideoBackgroundEffect