CallWithChatAdapterManagement interface

Paquet:

@azure/communication-react

Fonctionnalités de gestion de l’appel actuel avec conversation.

Méthodes

askDevicePermission(PermissionConstraints)	Demandez les autorisations des appareils.
createStreamView(string, VideoStreamOptions)	Créez l’affichage html pour un flux.
deleteMessage(string)	Supprimez un message dans le thread.
disposeStreamView(string, VideoStreamOptions)	Supprimer l’affichage html d’un flux.
fetchInitialData()	Récupérez l’état initial de l’adaptateur De conversation. Effectue l’extraction minimale nécessaire pour les méthodes ChatComposite et API.
joinCall(boolean)	Joignez l’appel avec le microphone initialement activé/désactivé.
leaveCall(boolean)	Laissez l’appel.
loadPreviousChatMessages(number)	Chargez d’autres messages précédents dans l’historique des threads de conversation.
mute()	Désactivez l’utilisateur actuel pendant l’appel ou désactivez le microphone localement.
queryCameras()	Recherchez les appareils photo disponibles.
queryMicrophones()	Recherchez les périphériques microphone disponibles.
querySpeakers()	Recherchez les périphériques microphone disponibles.
removeParticipant(string)	Supprimer un participant d’un appel.
sendMessage(string, SendMessageOptions)	Envoyez un message dans le thread.
sendReadReceipt(string)	Envoyer un accusé de lecture pour un message.
sendTypingIndicator()	Envoyer l’indicateur de saisie dans le thread.
setCamera(VideoDeviceInfo, VideoStreamOptions)	Définissez la caméra à utiliser dans l’appel.
setMicrophone(AudioDeviceInfo)	Définissez le microphone à utiliser dans l’appel.
setSpeaker(AudioDeviceInfo)	Définissez l’orateur à utiliser dans l’appel.
startCall(string[], StartCallOptions)	Démarrez l’appel.
startCamera(VideoStreamOptions)	Démarrez l’appareil photo. Cette méthode commence à afficher une vue de caméra locale lorsque l’appel n’est pas actif.
startScreenShare()	Commencez à partager l’écran pendant un appel.
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.
stopScreenShare()	Arrêtez le partage de l’écran.
unmute()	Désactivez l’utilisateur actuel pendant l’appel ou activez le microphone localement.
updateMessage(string, string, Record<string, string>)	Mettre à jour le contenu d’un message.

Détails de la méthode

askDevicePermission(PermissionConstraints)

Demandez les autorisations des appareils.

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

Paramètres

constrain

PermissionConstraints

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

Retours

Promise<void>

Remarques

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

createStreamView(string, VideoStreamOptions)

Créez l’affichage 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 la caméra locale

options

VideoStreamOptions

Options permettant de 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 les composites.

deleteMessage(string)

Supprimez un message dans le thread.

function deleteMessage(messageId: string): Promise<void>

Paramètres

messageId

string

Retours

Promise<void>

disposeStreamView(string, VideoStreamOptions)

Supprimer l’affichage 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 permettant de 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 les composites.

fetchInitialData()

Récupérez l’état initial de l’adaptateur De conversation.

Effectue l’extraction minimale nécessaire pour les méthodes ChatComposite et API.

function fetchInitialData(): Promise<void>

Retours

Promise<void>

joinCall(boolean)

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

function joinCall(microphoneOn?: boolean): undefined | Call

Paramètres

microphoneOn

boolean

Si le microphone est activé initialement

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 l’extraction incrémentielle/le défilement infini.

mute()

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

function mute(): Promise<void>

Retours

Promise<void>

queryCameras()

Recherchez les appareils photo disponibles.

function queryCameras(): Promise<VideoDeviceInfo[]>

Retours

Promise<VideoDeviceInfo[]>

Tableau d’entités d’informations sur les appareils vidéo <xref:%40azure%2Fcommunication-calling%23VideoDeviceInfo>

Remarques

Cette méthode doit être appelée après askDevicePermission()

queryMicrophones()

Recherchez les périphériques microphone disponibles.

function queryMicrophones(): Promise<AudioDeviceInfo[]>

Retours

Promise<AudioDeviceInfo[]>

Tableau d’entités d’informations sur les appareils audio <xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo>

Remarques

Cette méthode doit être appelée après askDevicePermission()

querySpeakers()

Recherchez les périphériques microphone disponibles.

function querySpeakers(): Promise<AudioDeviceInfo[]>

Retours

Promise<AudioDeviceInfo[]>

Tableau d’entités d’informations sur les appareils audio <xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo>

Remarques

Cette méthode doit être appelée après askDevicePermission()

removeParticipant(string)

Supprimer un participant d’un appel.

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

Paramètres

userId

string

UserId du participant à supprimer.

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)

Envoyer un accusé de lecture pour un message.

function sendReadReceipt(chatMessageId: string): Promise<void>

Paramètres

chatMessageId

string

Retours

Promise<void>

sendTypingIndicator()

Envoyer 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 d’appareil photo <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Retours

Promise<void>

setMicrophone(AudioDeviceInfo)

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

function setMicrophone(sourceInfo: AudioDeviceInfo): Promise<void>

Paramètres

sourceInfo

AudioDeviceInfo

Périphérique de microphone à choisir, choisissez-en un retourné par requêteMicrophones

Retours

Promise<void>

setSpeaker(AudioDeviceInfo)

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

function setSpeaker(sourceInfo: AudioDeviceInfo): Promise<void>

Paramètres

sourceInfo

AudioDeviceInfo

Appareil d’orateur à choisir, choisissez-en un retourné par querySpeakers

Retours

Promise<void>

startCall(string[], StartCallOptions)

Démarrez l’appel.

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

Paramètres

participants

string[]

Tableau d’ID de participant à rejoindre

options

StartCallOptions

Retours

undefined | Call

startCamera(VideoStreamOptions)

Démarrez l’appareil photo.

Cette méthode commence à afficher une vue de caméra locale lorsque l’appel n’est pas actif.

function startCamera(options?: VideoStreamOptions): Promise<void>

Paramètres

options

VideoStreamOptions

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

Retours

Promise<void>

startScreenShare()

Commencez à partager l’écran pendant un appel.

function startScreenShare(): 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>

stopScreenShare()

Arrêtez le partage de l’écran.

function stopScreenShare(): Promise<void>

Retours

Promise<void>

unmute()

Désactivez l’utilisateur actuel pendant l’appel ou activez le microphone localement.

function unmute(): Promise<void>

Retours

Promise<void>

updateMessage(string, string, Record<string, string>)

Mettre à jour le contenu d’un message.

function updateMessage(messageId: string, content: string, metadata?: Record<string, string>): Promise<void>

Paramètres

messageId

string

content

string

metadata

Record<string, string>

Retours

Promise<void>