CallingHandlers interface

Pakiet:

@azure/communication-react

Obiekt zawierający wszystkie programy obsługi wymagane do wywoływania składników.

Wywoływanie powiązanych składników z tego pakietu umożliwia wybranie odpowiednich procedur obsługi z tego obiektu. Zobacz <xref:useHandlers> i usePropsFor.

Rozszerzenie

CommonCallingHandlers

Właściwości

onStartCall

Właściwości dziedziczone

onAcceptCall
onBlurVideoBackground
onCreateLocalStreamView
onCreateRemoteStreamView
onCreateTogetherModeStreamView	Oddzwoń, aby utworzyć widok dla trybu razem
onDisposeLocalScreenShareStreamView
onDisposeLocalStreamView
onDisposeRemoteScreenShareStreamView
onDisposeRemoteStreamView
onDisposeRemoteVideoStreamView
onDisposeTogetherModeStreamView	Oddzwoń, aby usunąć razem widoki trybu
onForbidAudio	Zabroń uczestnikom zdalnym wysyłania dźwięku
onForbidOthersAudio	Zmień opcję spotkania, zabroń uczestnikom zdalnym wysyłania dźwięku
onForbidOthersVideo	Zmień opcję spotkania, zabroń uczestnikom zdalnym wysyłania wideo
onForbidVideo	Zabroń uczestnikom zdalnym wysyłania wideo
onHangUp
onLowerHand
onMuteAllRemoteParticipants
onMuteParticipant
onPermitAudio	Zezwalaj uczestnikom zdalnym na wysyłanie dźwięku
onPermitOthersAudio	Zmień opcję spotkania, zezwalaj uczestnikom zdalnym na wysyłanie dźwięku
onPermitOthersVideo	Zmień opcję spotkania, zezwalaj uczestnikom zdalnym na wysyłanie wideo
onPermitVideo	Zezwalaj uczestnikom zdalnym na wysyłanie wideo
onRaiseHand
onReactionClick
onRejectCall
onRemoveVideoBackgroundEffects
onReplaceVideoBackground
onSelectCamera
onSelectMicrophone
onSelectSpeaker
onSendDtmfTone
onSendRealTimeText
onSetCaptionLanguage
onSetSpokenLanguage
onSetTogetherModeSceneSize	Rozmiar sceny w trybie ustawiania połączeń
onStartCaptions
onStartLocalVideo
onStartNoiseSuppressionEffect
onStartScreenShare
onStartSpotlight
onStartTogetherMode	Oddzwoń, aby utworzyć widok dla trybu razem
onStopAllSpotlight
onStopCaptions
onStopNoiseSuppressionEffect
onStopScreenShare
onStopSpotlight
onToggleCamera
onToggleHold
onToggleMicrophone
onToggleRaiseHand
onToggleScreenShare

Metody dziedziczone

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

Szczegóły właściwości

onStartCall

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

Wartość właściwości

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

Szczegóły właściwości dziedziczonej

onAcceptCall

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

Wartość właściwości

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

Odziedziczone poCommonCallingHandlers.onAcceptCall

onBlurVideoBackground

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

Wartość właściwości

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

Odziedziczone poCommonCallingHandlers.onBlurVideoBackground

onCreateLocalStreamView

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

Wartość właściwości

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

dziedziczone zCommonCallingHandlers.onCreateLocalStreamView

onCreateRemoteStreamView

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

Wartość właściwości

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

dziedziczone zCommonCallingHandlers.onCreateRemoteStreamView

onCreateTogetherModeStreamView

Oddzwoń, aby utworzyć widok dla trybu razem

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

Wartość właściwości

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

Odziedziczone poCommonCallingHandlers.onCreateTogetherModeStreamView

onDisposeLocalScreenShareStreamView

onDisposeLocalScreenShareStreamView: () => Promise<void>

Wartość właściwości

() => Promise<void>

Odziedziczone poCommonCallingHandlers.onDisposeLocalScreenShareStreamView

onDisposeLocalStreamView

onDisposeLocalStreamView: () => Promise<void>

Wartość właściwości

() => Promise<void>

dziedziczone zCommonCallingHandlers.onDisposeLocalStreamView

onDisposeRemoteScreenShareStreamView

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

Wartość właściwości

(userId: string) => Promise<void>

Odziedziczone poCommonCallingHandlers.onDisposeRemoteScreenShareStreamView

onDisposeRemoteStreamView

Ostrzeżenie

Ten interfejs API jest już przestarzały.

use onDisposeRemoteVideoStreamView and onDisposeRemoteScreenShareStreamView instead.

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

Wartość właściwości

(userId: string) => Promise<void>

dziedziczone zCommonCallingHandlers.onDisposeRemoteStreamView

onDisposeRemoteVideoStreamView

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

Wartość właściwości

(userId: string) => Promise<void>

Odziedziczone poCommonCallingHandlers.onDisposeRemoteVideoStreamView

onDisposeTogetherModeStreamView

Oddzwoń, aby usunąć razem widoki trybu

onDisposeTogetherModeStreamView: () => Promise<void>

Wartość właściwości

() => Promise<void>

Odziedziczone poCommonCallingHandlers.onDisposeTogetherModeStreamView

onForbidAudio

Zabroń uczestnikom zdalnym wysyłania dźwięku

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

Wartość właściwości

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

Odziedziczone poCommonCallingHandlers.onForbidAudio

onForbidOthersAudio

Zmień opcję spotkania, zabroń uczestnikom zdalnym wysyłania dźwięku

onForbidOthersAudio?: () => Promise<void>

Wartość właściwości

() => Promise<void>

Odziedziczone poCommonCallingHandlers.onForbidOthersAudio

onForbidOthersVideo

Zmień opcję spotkania, zabroń uczestnikom zdalnym wysyłania wideo

onForbidOthersVideo?: () => Promise<void>

Wartość właściwości

() => Promise<void>

Odziedziczone poCommonCallingHandlers.onForbidOthersVideo

onForbidVideo

Zabroń uczestnikom zdalnym wysyłania wideo

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

Wartość właściwości

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

Odziedziczone poCommonCallingHandlers.onForbidVideo

onHangUp

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

Wartość właściwości

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

dziedziczone zCommonCallingHandlers.onHangUp

onLowerHand

onLowerHand: () => Promise<void>

Wartość właściwości

() => Promise<void>

Odziedziczone poCommonCallingHandlers.onLowerHand

onMuteAllRemoteParticipants

onMuteAllRemoteParticipants: () => Promise<void>

Wartość właściwości

() => Promise<void>

Odziedziczone poCommonCallingHandlers.onMuteAllRemoteParticipants

onMuteParticipant

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

Wartość właściwości

(userId: string) => Promise<void>

Odziedziczone poCommonCallingHandlers.onMuteParticipant

onPermitAudio

Zezwalaj uczestnikom zdalnym na wysyłanie dźwięku

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

Wartość właściwości

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

Odziedziczone poCommonCallingHandlers.onPermitAudio

onPermitOthersAudio

Zmień opcję spotkania, zezwalaj uczestnikom zdalnym na wysyłanie dźwięku

onPermitOthersAudio?: () => Promise<void>

Wartość właściwości

() => Promise<void>

Odziedziczone poCommonCallingHandlers.onPermitOthersAudio

onPermitOthersVideo

Zmień opcję spotkania, zezwalaj uczestnikom zdalnym na wysyłanie wideo

onPermitOthersVideo?: () => Promise<void>

Wartość właściwości

() => Promise<void>

Odziedziczone poCommonCallingHandlers.onPermitOthersVideo

onPermitVideo

Zezwalaj uczestnikom zdalnym na wysyłanie wideo

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

Wartość właściwości

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

Odziedziczone poCommonCallingHandlers.onPermitVideo

onRaiseHand

onRaiseHand: () => Promise<void>

Wartość właściwości

() => Promise<void>

Odziedziczone poCommonCallingHandlers.onRaiseHand

onReactionClick

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

Wartość właściwości

(reaction: Reaction) => Promise<void>

Odziedziczone poCommonCallingHandlers.onReactionClick

onRejectCall

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

Wartość właściwości

(incomingCallId: string) => Promise<void>

Odziedziczone poCommonCallingHandlers.onRejectCall

onRemoveVideoBackgroundEffects

onRemoveVideoBackgroundEffects: () => Promise<void>

Wartość właściwości

() => Promise<void>

Odziedziczone poCommonCallingHandlers.onRemoveVideoBackgroundEffects

onReplaceVideoBackground

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

Wartość właściwości

(backgroundReplacementConfig: BackgroundReplacementConfig) => Promise<void>

Odziedziczone poCommonCallingHandlers.onReplaceVideoBackground

onSelectCamera

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

Wartość właściwości

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

dziedziczone zCommonCallingHandlers.onSelectCamera

onSelectMicrophone

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

Wartość właściwości

(device: AudioDeviceInfo) => Promise<void>

dziedziczone zCommonCallingHandlers.onSelectMicrophone

onSelectSpeaker

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

Wartość właściwości

(device: AudioDeviceInfo) => Promise<void>

dziedziczone zCommonCallingHandlers.onSelectSpeaker

onSendDtmfTone

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

Wartość właściwości

(dtmfTone: DtmfTone) => Promise<void>

Odziedziczone poCommonCallingHandlers.onSendDtmfTone

onSendRealTimeText

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

Wartość właściwości

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

Odziedziczone poCommonCallingHandlers.onSendRealTimeText

onSetCaptionLanguage

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

Wartość właściwości

(language: string) => Promise<void>

Odziedziczone zCommonCallingHandlers.onSetCaptionLanguage

onSetSpokenLanguage

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

Wartość właściwości

(language: string) => Promise<void>

Odziedziczone poCommonCallingHandlers.onSetSpokenLanguage

onSetTogetherModeSceneSize

Rozmiar sceny w trybie ustawiania połączeń

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

Wartość właściwości

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

Odziedziczone poCommonCallingHandlers.onSetTogetherModeSceneSize

onStartCaptions

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

Wartość właściwości

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

Odziedziczone poCommonCallingHandlers.onStartCaptions

onStartLocalVideo

onStartLocalVideo: () => Promise<void>

Wartość właściwości

() => Promise<void>

dziedziczone zCommonCallingHandlers.onStartLocalVideo

onStartNoiseSuppressionEffect

onStartNoiseSuppressionEffect: () => Promise<void>

Wartość właściwości

() => Promise<void>

Odziedziczone poCommonCallingHandlers.onStartNoiseSuppressionEffect

onStartScreenShare

onStartScreenShare: () => Promise<void>

Wartość właściwości

() => Promise<void>

dziedziczone zCommonCallingHandlers.onStartScreenShare

onStartSpotlight

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

Wartość właściwości

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

Odziedziczone poCommonCallingHandlers.onStartSpotlight

onStartTogetherMode

Oddzwoń, aby utworzyć widok dla trybu razem

onStartTogetherMode: () => Promise<void>

Wartość właściwości

() => Promise<void>

Odziedziczone poCommonCallingHandlers.onStartTogetherMode

onStopAllSpotlight

onStopAllSpotlight: () => Promise<void>

Wartość właściwości

() => Promise<void>

Odziedziczone poCommonCallingHandlers.onStopAllSpotlight

onStopCaptions

onStopCaptions: () => Promise<void>

Wartość właściwości

() => Promise<void>

Odziedziczone poCommonCallingHandlers.onStopCaptions

onStopNoiseSuppressionEffect

onStopNoiseSuppressionEffect: () => Promise<void>

Wartość właściwości

() => Promise<void>

Odziedziczone poCommonCallingHandlers.onStopNoiseSuppressionEffect

onStopScreenShare

onStopScreenShare: () => Promise<void>

Wartość właściwości

() => Promise<void>

dziedziczone zCommonCallingHandlers.onStopScreenShare

onStopSpotlight

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

Wartość właściwości

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

Odziedziczone poCommonCallingHandlers.onStopSpotlight

onToggleCamera

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

Wartość właściwości

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

dziedziczone zCommonCallingHandlers.onToggleCamera

onToggleHold

onToggleHold: () => Promise<void>

Wartość właściwości

() => Promise<void>

Odziedziczone poCommonCallingHandlers.onToggleHold

onToggleMicrophone

onToggleMicrophone: () => Promise<void>

Wartość właściwości

() => Promise<void>

dziedziczone zCommonCallingHandlers.onToggleMicrophone

onToggleRaiseHand

onToggleRaiseHand: () => Promise<void>

Wartość właściwości

() => Promise<void>

Odziedziczone poCommonCallingHandlers.onToggleRaiseHand

onToggleScreenShare

onToggleScreenShare: () => Promise<void>

Wartość właściwości

() => Promise<void>

dziedziczone zCommonCallingHandlers.onToggleScreenShare

Szczegóły metody dziedziczonej

onAddParticipant(CommunicationUserIdentifier)

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

Parametry

participant

CommunicationUserIdentifier

Zwraca

Promise<void>

Odziedziczone poCommonCallingHandlers.onAddParticipant

onAddParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

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

Parametry

participant

PhoneNumberIdentifier

options

AddPhoneNumberOptions

Zwraca

Promise<void>

Odziedziczone poCommonCallingHandlers.onAddParticipant

onRemoveParticipant(CommunicationIdentifier)

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

Parametry

participant

CommunicationIdentifier

Zwraca

Promise<void>

dziedziczone zCommonCallingHandlers.onRemoveParticipant

onRemoveParticipant(string)

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

Parametry

userId

string

Zwraca

Promise<void>

dziedziczone zCommonCallingHandlers.onRemoveParticipant

onSubmitSurvey(CallSurvey)

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

Parametry

survey

CallSurvey

Zwraca

Promise<undefined | CallSurveyResponse>

Odziedziczone poCommonCallingHandlers.onSubmitSurvey