CommonCallingHandlers interface

Paquet:

@azure/communication-react

Objet contenant tous les gestionnaires requis pour les composants appelants.

L’appel de composants associés à partir de ce package est en mesure de sélectionner des gestionnaires pertinents à partir de cet objet. Consultez <xref:useHandlers> et usePropsFor.

Propriétés

onAcceptCall
onBlurVideoBackground
onCreateLocalStreamView
onCreateRemoteStreamView
onCreateTogetherModeStreamView	Rappel pour créer une vue pour le mode ensemble
onDisposeLocalScreenShareStreamView
onDisposeLocalStreamView
onDisposeRemoteScreenShareStreamView
onDisposeRemoteStreamView
onDisposeRemoteVideoStreamView
onDisposeTogetherModeStreamView	Rappel pour disposer ensemble les vues en mode
onForbidAudio	Interdire aux participants à distance d’envoyer de l’audio
onForbidOthersAudio	Modifier l’option de réunion interdire aux participants à distance d’envoyer de l’audio
onForbidOthersVideo	Modifier l’option de réunion interdire aux participants à distance d’envoyer des vidéos
onForbidVideo	Interdire aux participants à distance d’envoyer des vidéos
onHangUp
onLowerHand
onMuteAllRemoteParticipants
onMuteParticipant
onPermitAudio	Autoriser les participants à distance à envoyer de l’audio
onPermitOthersAudio	Modifier l’option de réunion : autoriser les participants à distance à envoyer de l’audio
onPermitOthersVideo	Modifier l’option de réunion : autoriser les participants à distance à envoyer des vidéos
onPermitVideo	Autoriser les participants à distance à envoyer des vidéos
onRaiseHand
onReactionClick
onRejectCall
onRemoveVideoBackgroundEffects
onReplaceVideoBackground
onSelectCamera
onSelectMicrophone
onSelectSpeaker
onSendDtmfTone
onSendRealTimeText
onSetCaptionLanguage
onSetSpokenLanguage
onSetTogetherModeSceneSize	Taille de la scène du mode Appeler ensemble
onStartCall
onStartCaptions
onStartLocalVideo
onStartNoiseSuppressionEffect
onStartScreenShare
onStartSpotlight
onStartTogetherMode	Rappel pour créer une vue pour le mode ensemble
onStopAllSpotlight
onStopCaptions
onStopNoiseSuppressionEffect
onStopScreenShare
onStopSpotlight
onToggleCamera
onToggleHold
onToggleMicrophone
onToggleRaiseHand
onToggleScreenShare

Méthodes

onAddParticipant(CommunicationUserIdentifier)
onAddParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)
onRemoveParticipant(CommunicationIdentifier)
onRemoveParticipant(string)
onSubmitSurvey(CallSurvey)

Détails de la propriété

onAcceptCall

onAcceptCall: (incomingCallId: string, useVideo?: boolean) => Promise<void>

Valeur de propriété

(incomingCallId: string, useVideo?: boolean) => Promise<void>

onBlurVideoBackground

onBlurVideoBackground: (backgroundBlurConfig?: VideoEffectConfig) => Promise<void>

Valeur de propriété

(backgroundBlurConfig?: VideoEffectConfig) => Promise<void>

onCreateLocalStreamView

onCreateLocalStreamView: (options?: VideoStreamOptions) => Promise<void | CreateVideoStreamViewResult>

Valeur de propriété

(options?: VideoStreamOptions) => Promise<void | CreateVideoStreamViewResult>

onCreateRemoteStreamView

onCreateRemoteStreamView: (userId: string, options?: VideoStreamOptions) => Promise<void | CreateVideoStreamViewResult>

Valeur de propriété

(userId: string, options?: VideoStreamOptions) => Promise<void | CreateVideoStreamViewResult>

onCreateTogetherModeStreamView

Rappel pour créer une vue pour le mode ensemble

onCreateTogetherModeStreamView: (options?: TogetherModeStreamOptions) => Promise<void | TogetherModeStreamViewResult>

Valeur de propriété

(options?: TogetherModeStreamOptions) => Promise<void | TogetherModeStreamViewResult>

onDisposeLocalScreenShareStreamView

onDisposeLocalScreenShareStreamView: () => Promise<void>

Valeur de propriété

() => Promise<void>

onDisposeLocalStreamView

onDisposeLocalStreamView: () => Promise<void>

Valeur de propriété

() => Promise<void>

onDisposeRemoteScreenShareStreamView

onDisposeRemoteScreenShareStreamView: (userId: string) => Promise<void>

Valeur de propriété

(userId: string) => Promise<void>

onDisposeRemoteStreamView

Avertissement

Cette API est à présent déconseillée.

use onDisposeRemoteVideoStreamView and onDisposeRemoteScreenShareStreamView instead.

onDisposeRemoteStreamView: (userId: string) => Promise<void>

Valeur de propriété

(userId: string) => Promise<void>

onDisposeRemoteVideoStreamView

onDisposeRemoteVideoStreamView: (userId: string) => Promise<void>

Valeur de propriété

(userId: string) => Promise<void>

onDisposeTogetherModeStreamView

Rappel pour disposer ensemble les vues en mode

onDisposeTogetherModeStreamView: () => Promise<void>

Valeur de propriété

() => Promise<void>

onForbidAudio

Interdire aux participants à distance d’envoyer de l’audio

onForbidAudio?: (userIds: string[]) => Promise<void>

Valeur de propriété

(userIds: string[]) => Promise<void>

onForbidOthersAudio

Modifier l’option de réunion interdire aux participants à distance d’envoyer de l’audio

onForbidOthersAudio?: () => Promise<void>

Valeur de propriété

() => Promise<void>

onForbidOthersVideo

Modifier l’option de réunion interdire aux participants à distance d’envoyer des vidéos

onForbidOthersVideo?: () => Promise<void>

Valeur de propriété

() => Promise<void>

onForbidVideo

Interdire aux participants à distance d’envoyer des vidéos

onForbidVideo?: (userIds: string[]) => Promise<void>

Valeur de propriété

(userIds: string[]) => Promise<void>

onHangUp

onHangUp: (forEveryone?: boolean) => Promise<void>

Valeur de propriété

(forEveryone?: boolean) => Promise<void>

onLowerHand

onLowerHand: () => Promise<void>

Valeur de propriété

() => Promise<void>

onMuteAllRemoteParticipants

onMuteAllRemoteParticipants: () => Promise<void>

Valeur de propriété

() => Promise<void>

onMuteParticipant

onMuteParticipant: (userId: string) => Promise<void>

Valeur de propriété

(userId: string) => Promise<void>

onPermitAudio

Autoriser les participants à distance à envoyer de l’audio

onPermitAudio?: (userIds: string[]) => Promise<void>

Valeur de propriété

(userIds: string[]) => Promise<void>

onPermitOthersAudio

Modifier l’option de réunion : autoriser les participants à distance à envoyer de l’audio

onPermitOthersAudio?: () => Promise<void>

Valeur de propriété

() => Promise<void>

onPermitOthersVideo

Modifier l’option de réunion : autoriser les participants à distance à envoyer des vidéos

onPermitOthersVideo?: () => Promise<void>

Valeur de propriété

() => Promise<void>

onPermitVideo

Autoriser les participants à distance à envoyer des vidéos

onPermitVideo?: (userIds: string[]) => Promise<void>

Valeur de propriété

(userIds: string[]) => Promise<void>

onRaiseHand

onRaiseHand: () => Promise<void>

Valeur de propriété

() => Promise<void>

onReactionClick

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

Valeur de propriété

(reaction: Reaction) => Promise<void>

onRejectCall

onRejectCall: (incomingCallId: string) => Promise<void>

Valeur de propriété

(incomingCallId: string) => Promise<void>

onRemoveVideoBackgroundEffects

onRemoveVideoBackgroundEffects: () => Promise<void>

Valeur de propriété

() => Promise<void>

onReplaceVideoBackground

onReplaceVideoBackground: (backgroundReplacementConfig: BackgroundReplacementConfig) => Promise<void>

Valeur de propriété

(backgroundReplacementConfig: BackgroundReplacementConfig) => Promise<void>

onSelectCamera

onSelectCamera: (device: VideoDeviceInfo, options?: VideoStreamOptions) => Promise<void>

Valeur de propriété

(device: VideoDeviceInfo, options?: VideoStreamOptions) => Promise<void>

onSelectMicrophone

onSelectMicrophone: (device: AudioDeviceInfo) => Promise<void>

Valeur de propriété

(device: AudioDeviceInfo) => Promise<void>

onSelectSpeaker

onSelectSpeaker: (device: AudioDeviceInfo) => Promise<void>

Valeur de propriété

(device: AudioDeviceInfo) => Promise<void>

onSendDtmfTone

onSendDtmfTone: (dtmfTone: DtmfTone) => Promise<void>

Valeur de propriété

(dtmfTone: DtmfTone) => Promise<void>

onSendRealTimeText

onSendRealTimeText: (text: string, isFinalized: boolean) => Promise<void>

Valeur de propriété

(text: string, isFinalized: boolean) => Promise<void>

onSetCaptionLanguage

onSetCaptionLanguage: (language: string) => Promise<void>

Valeur de propriété

(language: string) => Promise<void>

onSetSpokenLanguage

onSetSpokenLanguage: (language: string) => Promise<void>

Valeur de propriété

(language: string) => Promise<void>

onSetTogetherModeSceneSize

Taille de la scène du mode Appeler ensemble

onSetTogetherModeSceneSize: (width: number, height: number) => void

Valeur de propriété

(width: number, height: number) => void

onStartCall

onStartCall: (participants: CommunicationIdentifier[], options?: StartCallOptions) => void

Valeur de propriété

(participants: CommunicationIdentifier[], options?: StartCallOptions) => void

onStartCaptions

onStartCaptions: (options?: CaptionsOptions) => Promise<void>

Valeur de propriété

(options?: CaptionsOptions) => Promise<void>

onStartLocalVideo

onStartLocalVideo: () => Promise<void>

Valeur de propriété

() => Promise<void>

onStartNoiseSuppressionEffect

onStartNoiseSuppressionEffect: () => Promise<void>

Valeur de propriété

() => Promise<void>

onStartScreenShare

onStartScreenShare: () => Promise<void>

Valeur de propriété

() => Promise<void>

onStartSpotlight

onStartSpotlight: (userIds?: string[]) => Promise<void>

Valeur de propriété

(userIds?: string[]) => Promise<void>

onStartTogetherMode

Rappel pour créer une vue pour le mode ensemble

onStartTogetherMode: () => Promise<void>

Valeur de propriété

() => Promise<void>

onStopAllSpotlight

onStopAllSpotlight: () => Promise<void>

Valeur de propriété

() => Promise<void>

onStopCaptions

onStopCaptions: () => Promise<void>

Valeur de propriété

() => Promise<void>

onStopNoiseSuppressionEffect

onStopNoiseSuppressionEffect: () => Promise<void>

Valeur de propriété

() => Promise<void>

onStopScreenShare

onStopScreenShare: () => Promise<void>

Valeur de propriété

() => Promise<void>

onStopSpotlight

onStopSpotlight: (userIds?: string[]) => Promise<void>

Valeur de propriété

(userIds?: string[]) => Promise<void>

onToggleCamera

onToggleCamera: (options?: VideoStreamOptions) => Promise<void>

Valeur de propriété

(options?: VideoStreamOptions) => Promise<void>

onToggleHold

onToggleHold: () => Promise<void>

Valeur de propriété

() => Promise<void>

onToggleMicrophone

onToggleMicrophone: () => Promise<void>

Valeur de propriété

() => Promise<void>

onToggleRaiseHand

onToggleRaiseHand: () => Promise<void>

Valeur de propriété

() => Promise<void>

onToggleScreenShare

onToggleScreenShare: () => Promise<void>

Valeur de propriété

() => Promise<void>

Détails de la méthode

onAddParticipant(CommunicationUserIdentifier)

function onAddParticipant(participant: CommunicationUserIdentifier): Promise<void>

Paramètres

participant

CommunicationUserIdentifier

Retours

Promise<void>

onAddParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

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

Paramètres

participant

PhoneNumberIdentifier

options

AddPhoneNumberOptions

Retours

Promise<void>

onRemoveParticipant(CommunicationIdentifier)

function onRemoveParticipant(participant: CommunicationIdentifier): Promise<void>

Paramètres

participant

CommunicationIdentifier

Retours

Promise<void>

onRemoveParticipant(string)

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

Paramètres

userId

string

Retours

Promise<void>

onSubmitSurvey(CallSurvey)

function onSubmitSurvey(survey: CallSurvey): Promise<undefined | CallSurveyResponse>

Paramètres

survey

CallSurvey

Retours

Promise<undefined | CallSurveyResponse>