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

Extends

CommonCallingHandlers

Proprietà

onStartCall

Proprietà ereditate

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

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

Dettagli proprietà

onStartCall

onStartCall: (participants: CommunicationIdentifier[], options?: StartCallOptions) => undefined | Call

Valore della proprietà

(participants: CommunicationIdentifier[], options?: StartCallOptions) => undefined | Call

Dettagli proprietà ereditate

onAcceptCall

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

Valore della proprietà

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

Ereditato daCommonCallingHandlers.onAcceptCall

onBlurVideoBackground

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

Valore della proprietà

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

Ereditato daCommonCallingHandlers.onBlurVideoBackground

onCreateLocalStreamView

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

Valore della proprietà

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

Ereditato daCommonCallingHandlers.onCreateLocalStreamView

onCreateRemoteStreamView

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

Valore della proprietà

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

ereditato daCommonCallingHandlers.onCreateRemoteStreamView

onCreateTogetherModeStreamView

Richiamare per creare una visualizzazione per la modalità insieme

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

Valore della proprietà

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

Ereditato daCommonCallingHandlers.onCreateTogetherModeStreamView

onDisposeLocalScreenShareStreamView

onDisposeLocalScreenShareStreamView: () => Promise<void>

Valore della proprietà

() => Promise<void>

Ereditato daCommonCallingHandlers.onDisposeLocalScreenShareStreamView

onDisposeLocalStreamView

onDisposeLocalStreamView: () => Promise<void>

Valore della proprietà

() => Promise<void>

Ereditato daCommonCallingHandlers.onDisposeLocalStreamView

onDisposeRemoteScreenShareStreamView

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

Valore della proprietà

(userId: string) => Promise<void>

Ereditato daCommonCallingHandlers.onDisposeRemoteScreenShareStreamView

onDisposeRemoteStreamView

Avviso

Questa API è ora deprecata.

use onDisposeRemoteVideoStreamView and onDisposeRemoteScreenShareStreamView instead.

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

Valore della proprietà

(userId: string) => Promise<void>

Ereditato daCommonCallingHandlers.onDisposeRemoteStreamView

onDisposeRemoteVideoStreamView

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

Valore della proprietà

(userId: string) => Promise<void>

Ereditato daCommonCallingHandlers.onDisposeRemoteVideoStreamView

onDisposeTogetherModeStreamView

Richiamo per eliminare le visualizzazioni in modalità Elimina insieme

onDisposeTogetherModeStreamView: () => Promise<void>

Valore della proprietà

() => Promise<void>

Ereditato daCommonCallingHandlers.onDisposeTogetherModeStreamView

onForbidAudio

Impedisci ai partecipanti remoti di inviare audio

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

Valore della proprietà

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

Ereditato daCommonCallingHandlers.onForbidAudio

onForbidOthersAudio

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

onForbidOthersAudio?: () => Promise<void>

Valore della proprietà

() => Promise<void>

Ereditato daCommonCallingHandlers.onForbidOthersAudio

onForbidOthersVideo

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

onForbidOthersVideo?: () => Promise<void>

Valore della proprietà

() => Promise<void>

Ereditato daCommonCallingHandlers.onForbidOthersVideo

onForbidVideo

Impedisci ai partecipanti remoti di inviare video

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

Valore della proprietà

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

Ereditato daCommonCallingHandlers.onForbidVideo

onHangUp

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

Valore della proprietà

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

ereditato daCommonCallingHandlers.onHangUp

onLowerHand

onLowerHand: () => Promise<void>

Valore della proprietà

() => Promise<void>

Ereditato daCommonCallingHandlers.onLowerHand

onMuteAllRemoteParticipants

onMuteAllRemoteParticipants: () => Promise<void>

Valore della proprietà

() => Promise<void>

Ereditato daCommonCallingHandlers.onMuteAllRemoteParticipants

onMuteParticipant

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

Valore della proprietà

(userId: string) => Promise<void>

Ereditato daCommonCallingHandlers.onMuteParticipant

onPermitAudio

Consenti ai partecipanti remoti di inviare audio

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

Valore della proprietà

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

Ereditato daCommonCallingHandlers.onPermitAudio

onPermitOthersAudio

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

onPermitOthersAudio?: () => Promise<void>

Valore della proprietà

() => Promise<void>

Ereditato daCommonCallingHandlers.onPermitOthersAudio

onPermitOthersVideo

Modifica opzione riunione Consenti ai partecipanti remoti di inviare video

onPermitOthersVideo?: () => Promise<void>

Valore della proprietà

() => Promise<void>

Ereditato daCommonCallingHandlers.onPermitOthersVideo

onPermitVideo

Consenti ai partecipanti remoti di inviare video

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

Valore della proprietà

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

Ereditato daCommonCallingHandlers.onPermitVideo

onRaiseHand

onRaiseHand: () => Promise<void>

Valore della proprietà

() => Promise<void>

Ereditato daCommonCallingHandlers.onRaiseHand

onReactionClick

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

Valore della proprietà

(reaction: Reaction) => Promise<void>

Ereditato daCommonCallingHandlers.onReactionClick

onRejectCall

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

Valore della proprietà

(incomingCallId: string) => Promise<void>

Ereditato daCommonCallingHandlers.onRejectCall

onRemoveVideoBackgroundEffects

onRemoveVideoBackgroundEffects: () => Promise<void>

Valore della proprietà

() => Promise<void>

Ereditato daCommonCallingHandlers.onRemoveVideoBackgroundEffects

onReplaceVideoBackground

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

Valore della proprietà

(backgroundReplacementConfig: BackgroundReplacementConfig) => Promise<void>

Ereditato daCommonCallingHandlers.onReplaceVideoBackground

onSelectCamera

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

Valore della proprietà

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

ereditato daCommonCallingHandlers.onSelectCamera

onSelectMicrophone

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

Valore della proprietà

(device: AudioDeviceInfo) => Promise<void>

ereditato daCommonCallingHandlers.onSelectMicrophone

onSelectSpeaker

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

Valore della proprietà

(device: AudioDeviceInfo) => Promise<void>

Ereditato daCommonCallingHandlers.onSelectSpeaker

onSendDtmfTone

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

Valore della proprietà

(dtmfTone: DtmfTone) => Promise<void>

Ereditato daCommonCallingHandlers.onSendDtmfTone

onSendRealTimeText

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

Valore della proprietà

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

Ereditato daCommonCallingHandlers.onSendRealTimeText

onSetCaptionLanguage

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

Valore della proprietà

(language: string) => Promise<void>

Ereditato daCommonCallingHandlers.onSetCaptionLanguage

onSetSpokenLanguage

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

Valore della proprietà

(language: string) => Promise<void>

Ereditato daCommonCallingHandlers.onSetSpokenLanguage

onSetTogetherModeSceneSize

Dimensione della scena in modalità chiamata insieme

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

Valore della proprietà

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

Ereditato daCommonCallingHandlers.onSetTogetherModeSceneSize

onStartCaptions

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

Valore della proprietà

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

Ereditato daCommonCallingHandlers.onStartCaptions

onStartLocalVideo

onStartLocalVideo: () => Promise<void>

Valore della proprietà

() => Promise<void>

Ereditato daCommonCallingHandlers.onStartLocalVideo

onStartNoiseSuppressionEffect

onStartNoiseSuppressionEffect: () => Promise<void>

Valore della proprietà

() => Promise<void>

Ereditato daCommonCallingHandlers.onStartNoiseSuppressionEffect

onStartScreenShare

onStartScreenShare: () => Promise<void>

Valore della proprietà

() => Promise<void>

Ereditato daCommonCallingHandlers.onStartScreenShare

onStartSpotlight

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

Valore della proprietà

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

Ereditato daCommonCallingHandlers.onStartSpotlight

onStartTogetherMode

Richiamare per creare una visualizzazione per la modalità insieme

onStartTogetherMode: () => Promise<void>

Valore della proprietà

() => Promise<void>

Ereditato daCommonCallingHandlers.onStartTogetherMode

onStopAllSpotlight

onStopAllSpotlight: () => Promise<void>

Valore della proprietà

() => Promise<void>

Ereditato daCommonCallingHandlers.onStopAllSpotlight

onStopCaptions

onStopCaptions: () => Promise<void>

Valore della proprietà

() => Promise<void>

Ereditato daCommonCallingHandlers.onStopCaptions

onStopNoiseSuppressionEffect

onStopNoiseSuppressionEffect: () => Promise<void>

Valore della proprietà

() => Promise<void>

Ereditato daCommonCallingHandlers.onStopNoiseSuppressionEffect

onStopScreenShare

onStopScreenShare: () => Promise<void>

Valore della proprietà

() => Promise<void>

ereditato daCommonCallingHandlers.onStopScreenShare

onStopSpotlight

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

Valore della proprietà

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

Ereditato daCommonCallingHandlers.onStopSpotlight

onToggleCamera

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

Valore della proprietà

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

ereditato daCommonCallingHandlers.onToggleCamera

onToggleHold

onToggleHold: () => Promise<void>

Valore della proprietà

() => Promise<void>

Ereditato daCommonCallingHandlers.onToggleHold

onToggleMicrophone

onToggleMicrophone: () => Promise<void>

Valore della proprietà

() => Promise<void>

Ereditato daCommonCallingHandlers.onToggleMicrophone

onToggleRaiseHand

onToggleRaiseHand: () => Promise<void>

Valore della proprietà

() => Promise<void>

Ereditato daCommonCallingHandlers.onToggleRaiseHand

onToggleScreenShare

onToggleScreenShare: () => Promise<void>

Valore della proprietà

() => Promise<void>

Ereditato daCommonCallingHandlers.onToggleScreenShare

Dettagli dei metodi ereditati

onAddParticipant(CommunicationUserIdentifier)

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

Parametri

participant

CommunicationUserIdentifier

Restituisce

Promise<void>

Ereditato daCommonCallingHandlers.onAddParticipant

onAddParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

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

Parametri

participant

PhoneNumberIdentifier

options

AddPhoneNumberOptions

Restituisce

Promise<void>

Ereditato daCommonCallingHandlers.onAddParticipant

onRemoveParticipant(CommunicationIdentifier)

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

Parametri

participant

CommunicationIdentifier

Restituisce

Promise<void>

ereditato daCommonCallingHandlers.onRemoveParticipant

onRemoveParticipant(string)

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

Parametri

userId

string

Restituisce

Promise<void>

ereditato daCommonCallingHandlers.onRemoveParticipant

onSubmitSurvey(CallSurvey)

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

Parametri

survey

CallSurvey

Restituisce

Promise<undefined | CallSurveyResponse>

Ereditato daCommonCallingHandlers.onSubmitSurvey