CommonCallingHandlers interface

Pacchetto:

@azure/communication-react

Oggetto contenente tutti i gestori necessari per chiamare i componenti.

La chiamata di componenti correlati da questo pacchetto è in grado di selezionare i gestori pertinenti da questo oggetto. Vedere <xref:useHandlers> e usePropsFor.

Proprietà

onAcceptCall
onBlurVideoBackground
onCreateLocalStreamView
onCreateRemoteStreamView
onCreateTogetherModeStreamView	Richiamare per creare una visualizzazione per la modalità insieme
onDisposeLocalScreenShareStreamView
onDisposeLocalStreamView
onDisposeRemoteScreenShareStreamView
onDisposeRemoteStreamView
onDisposeRemoteVideoStreamView
onDisposeTogetherModeStreamView	Richiamo per eliminare le visualizzazioni in modalità Elimina insieme
onForbidAudio	Impedisci ai partecipanti remoti di inviare audio
onForbidOthersAudio	Modifica l'opzione della riunione impedisce ai partecipanti remoti di inviare audio
onForbidOthersVideo	L'opzione Modifica riunione impedisce ai partecipanti remoti di inviare video
onForbidVideo	Impedisci ai partecipanti remoti di inviare video
onHangUp
onLowerHand
onMuteAllRemoteParticipants
onMuteParticipant
onPermitAudio	Consenti ai partecipanti remoti di inviare audio
onPermitOthersAudio	Modifica opzione riunione Consenti ai partecipanti remoti di inviare l'audio
onPermitOthersVideo	Modifica opzione riunione Consenti ai partecipanti remoti di inviare video
onPermitVideo	Consenti ai partecipanti remoti di inviare video
onRaiseHand
onReactionClick
onRejectCall
onRemoveVideoBackgroundEffects
onReplaceVideoBackground
onSelectCamera
onSelectMicrophone
onSelectSpeaker
onSendDtmfTone
onSendRealTimeText
onSetCaptionLanguage
onSetSpokenLanguage
onSetTogetherModeSceneSize	Dimensione della scena in modalità chiamata insieme
onStartCall
onStartCaptions
onStartLocalVideo
onStartNoiseSuppressionEffect
onStartScreenShare
onStartSpotlight
onStartTogetherMode	Richiamare per creare una visualizzazione per la modalità insieme
onStopAllSpotlight
onStopCaptions
onStopNoiseSuppressionEffect
onStopScreenShare
onStopSpotlight
onToggleCamera
onToggleHold
onToggleMicrophone
onToggleRaiseHand
onToggleScreenShare

Metodi

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

Dettagli proprietà

onAcceptCall

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

Valore della proprietà

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

onBlurVideoBackground

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

Valore della proprietà

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

onCreateLocalStreamView

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

Valore della proprietà

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

onCreateRemoteStreamView

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

Valore della proprietà

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

onCreateTogetherModeStreamView

Richiamare per creare una visualizzazione per la modalità insieme

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

Valore della proprietà

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

onDisposeLocalScreenShareStreamView

onDisposeLocalScreenShareStreamView: () => Promise<void>

Valore della proprietà

() => Promise<void>

onDisposeLocalStreamView

onDisposeLocalStreamView: () => Promise<void>

Valore della proprietà

() => Promise<void>

onDisposeRemoteScreenShareStreamView

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

Valore della proprietà

(userId: string) => Promise<void>

onDisposeRemoteStreamView

Avviso

Questa API è ora deprecata.

use onDisposeRemoteVideoStreamView and onDisposeRemoteScreenShareStreamView instead.

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

Valore della proprietà

(userId: string) => Promise<void>

onDisposeRemoteVideoStreamView

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

Valore della proprietà

(userId: string) => Promise<void>

onDisposeTogetherModeStreamView

Richiamo per eliminare le visualizzazioni in modalità Elimina insieme

onDisposeTogetherModeStreamView: () => Promise<void>

Valore della proprietà

() => Promise<void>

onForbidAudio

Impedisci ai partecipanti remoti di inviare audio

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

Valore della proprietà

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

onForbidOthersAudio

Modifica l'opzione della riunione impedisce ai partecipanti remoti di inviare audio

onForbidOthersAudio?: () => Promise<void>

Valore della proprietà

() => Promise<void>

onForbidOthersVideo

L'opzione Modifica riunione impedisce ai partecipanti remoti di inviare video

onForbidOthersVideo?: () => Promise<void>

Valore della proprietà

() => Promise<void>

onForbidVideo

Impedisci ai partecipanti remoti di inviare video

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

Valore della proprietà

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

onHangUp

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

Valore della proprietà

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

onLowerHand

onLowerHand: () => Promise<void>

Valore della proprietà

() => Promise<void>

onMuteAllRemoteParticipants

onMuteAllRemoteParticipants: () => Promise<void>

Valore della proprietà

() => Promise<void>

onMuteParticipant

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

Valore della proprietà

(userId: string) => Promise<void>

onPermitAudio

Consenti ai partecipanti remoti di inviare audio

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

Valore della proprietà

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

onPermitOthersAudio

Modifica opzione riunione Consenti ai partecipanti remoti di inviare l'audio

onPermitOthersAudio?: () => Promise<void>

Valore della proprietà

() => Promise<void>

onPermitOthersVideo

Modifica opzione riunione Consenti ai partecipanti remoti di inviare video

onPermitOthersVideo?: () => Promise<void>

Valore della proprietà

() => Promise<void>

onPermitVideo

Consenti ai partecipanti remoti di inviare video

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

Valore della proprietà

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

onRaiseHand

onRaiseHand: () => Promise<void>

Valore della proprietà

() => Promise<void>

onReactionClick

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

Valore della proprietà

(reaction: Reaction) => Promise<void>

onRejectCall

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

Valore della proprietà

(incomingCallId: string) => Promise<void>

onRemoveVideoBackgroundEffects

onRemoveVideoBackgroundEffects: () => Promise<void>

Valore della proprietà

() => Promise<void>

onReplaceVideoBackground

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

Valore della proprietà

(backgroundReplacementConfig: BackgroundReplacementConfig) => Promise<void>

onSelectCamera

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

Valore della proprietà

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

onSelectMicrophone

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

Valore della proprietà

(device: AudioDeviceInfo) => Promise<void>

onSelectSpeaker

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

Valore della proprietà

(device: AudioDeviceInfo) => Promise<void>

onSendDtmfTone

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

Valore della proprietà

(dtmfTone: DtmfTone) => Promise<void>

onSendRealTimeText

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

Valore della proprietà

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

onSetCaptionLanguage

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

Valore della proprietà

(language: string) => Promise<void>

onSetSpokenLanguage

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

Valore della proprietà

(language: string) => Promise<void>

onSetTogetherModeSceneSize

Dimensione della scena in modalità chiamata insieme

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

Valore della proprietà

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

onStartCall

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

Valore della proprietà

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

onStartCaptions

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

Valore della proprietà

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

onStartLocalVideo

onStartLocalVideo: () => Promise<void>

Valore della proprietà

() => Promise<void>

onStartNoiseSuppressionEffect

onStartNoiseSuppressionEffect: () => Promise<void>

Valore della proprietà

() => Promise<void>

onStartScreenShare

onStartScreenShare: () => Promise<void>

Valore della proprietà

() => Promise<void>

onStartSpotlight

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

Valore della proprietà

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

onStartTogetherMode

Richiamare per creare una visualizzazione per la modalità insieme

onStartTogetherMode: () => Promise<void>

Valore della proprietà

() => Promise<void>

onStopAllSpotlight

onStopAllSpotlight: () => Promise<void>

Valore della proprietà

() => Promise<void>

onStopCaptions

onStopCaptions: () => Promise<void>

Valore della proprietà

() => Promise<void>

onStopNoiseSuppressionEffect

onStopNoiseSuppressionEffect: () => Promise<void>

Valore della proprietà

() => Promise<void>

onStopScreenShare

onStopScreenShare: () => Promise<void>

Valore della proprietà

() => Promise<void>

onStopSpotlight

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

Valore della proprietà

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

onToggleCamera

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

Valore della proprietà

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

onToggleHold

onToggleHold: () => Promise<void>

Valore della proprietà

() => Promise<void>

onToggleMicrophone

onToggleMicrophone: () => Promise<void>

Valore della proprietà

() => Promise<void>

onToggleRaiseHand

onToggleRaiseHand: () => Promise<void>

Valore della proprietà

() => Promise<void>

onToggleScreenShare

onToggleScreenShare: () => Promise<void>

Valore della proprietà

() => Promise<void>

Dettagli metodo

onAddParticipant(CommunicationUserIdentifier)

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

Parametri

participant

CommunicationUserIdentifier

Restituisce

Promise<void>

onAddParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

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

Parametri

participant

PhoneNumberIdentifier

options

AddPhoneNumberOptions

Restituisce

Promise<void>

onRemoveParticipant(CommunicationIdentifier)

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

Parametri

participant

CommunicationIdentifier

Restituisce

Promise<void>

onRemoveParticipant(string)

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

Parametri

userId

string

Restituisce

Promise<void>

onSubmitSurvey(CallSurvey)

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

Parametri

survey

CallSurvey

Restituisce

Promise<undefined | CallSurveyResponse>