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

Właściwości

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ń
onStartCall
onStartCaptions
onStartLocalVideo
onStartNoiseSuppressionEffect
onStartScreenShare
onStartSpotlight
onStartTogetherMode	Oddzwoń, aby utworzyć widok dla trybu razem
onStopAllSpotlight
onStopCaptions
onStopNoiseSuppressionEffect
onStopScreenShare
onStopSpotlight
onToggleCamera
onToggleHold
onToggleMicrophone
onToggleRaiseHand
onToggleScreenShare

Metody

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

Szczegóły właściwości

onAcceptCall

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

Wartość właściwości

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

onBlurVideoBackground

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

Wartość właściwości

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

onCreateLocalStreamView

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

Wartość właściwości

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

onCreateRemoteStreamView

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

Wartość właściwości

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

onCreateTogetherModeStreamView

Oddzwoń, aby utworzyć widok dla trybu razem

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

Wartość właściwości

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

onDisposeLocalScreenShareStreamView

onDisposeLocalScreenShareStreamView: () => Promise<void>

Wartość właściwości

() => Promise<void>

onDisposeLocalStreamView

onDisposeLocalStreamView: () => Promise<void>

Wartość właściwości

() => Promise<void>

onDisposeRemoteScreenShareStreamView

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

Wartość właściwości

(userId: string) => Promise<void>

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>

onDisposeRemoteVideoStreamView

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

Wartość właściwości

(userId: string) => Promise<void>

onDisposeTogetherModeStreamView

Oddzwoń, aby usunąć razem widoki trybu

onDisposeTogetherModeStreamView: () => Promise<void>

Wartość właściwości

() => Promise<void>

onForbidAudio

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

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

Wartość właściwości

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

onForbidOthersAudio

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

onForbidOthersAudio?: () => Promise<void>

Wartość właściwości

() => Promise<void>

onForbidOthersVideo

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

onForbidOthersVideo?: () => Promise<void>

Wartość właściwości

() => Promise<void>

onForbidVideo

Zabroń uczestnikom zdalnym wysyłania wideo

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

Wartość właściwości

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

onHangUp

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

Wartość właściwości

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

onLowerHand

onLowerHand: () => Promise<void>

Wartość właściwości

() => Promise<void>

onMuteAllRemoteParticipants

onMuteAllRemoteParticipants: () => Promise<void>

Wartość właściwości

() => Promise<void>

onMuteParticipant

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

Wartość właściwości

(userId: string) => Promise<void>

onPermitAudio

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

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

Wartość właściwości

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

onPermitOthersAudio

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

onPermitOthersAudio?: () => Promise<void>

Wartość właściwości

() => Promise<void>

onPermitOthersVideo

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

onPermitOthersVideo?: () => Promise<void>

Wartość właściwości

() => Promise<void>

onPermitVideo

Zezwalaj uczestnikom zdalnym na wysyłanie wideo

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

Wartość właściwości

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

onRaiseHand

onRaiseHand: () => Promise<void>

Wartość właściwości

() => Promise<void>

onReactionClick

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

Wartość właściwości

(reaction: Reaction) => Promise<void>

onRejectCall

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

Wartość właściwości

(incomingCallId: string) => Promise<void>

onRemoveVideoBackgroundEffects

onRemoveVideoBackgroundEffects: () => Promise<void>

Wartość właściwości

() => Promise<void>

onReplaceVideoBackground

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

Wartość właściwości

(backgroundReplacementConfig: BackgroundReplacementConfig) => Promise<void>

onSelectCamera

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

Wartość właściwości

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

onSelectMicrophone

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

Wartość właściwości

(device: AudioDeviceInfo) => Promise<void>

onSelectSpeaker

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

Wartość właściwości

(device: AudioDeviceInfo) => Promise<void>

onSendDtmfTone

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

Wartość właściwości

(dtmfTone: DtmfTone) => Promise<void>

onSendRealTimeText

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

Wartość właściwości

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

onSetCaptionLanguage

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

Wartość właściwości

(language: string) => Promise<void>

onSetSpokenLanguage

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

Wartość właściwości

(language: string) => Promise<void>

onSetTogetherModeSceneSize

Rozmiar sceny w trybie ustawiania połączeń

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

Wartość właściwości

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

onStartCall

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

Wartość właściwości

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

onStartCaptions

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

Wartość właściwości

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

onStartLocalVideo

onStartLocalVideo: () => Promise<void>

Wartość właściwości

() => Promise<void>

onStartNoiseSuppressionEffect

onStartNoiseSuppressionEffect: () => Promise<void>

Wartość właściwości

() => Promise<void>

onStartScreenShare

onStartScreenShare: () => Promise<void>

Wartość właściwości

() => Promise<void>

onStartSpotlight

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

Wartość właściwości

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

onStartTogetherMode

Oddzwoń, aby utworzyć widok dla trybu razem

onStartTogetherMode: () => Promise<void>

Wartość właściwości

() => Promise<void>

onStopAllSpotlight

onStopAllSpotlight: () => Promise<void>

Wartość właściwości

() => Promise<void>

onStopCaptions

onStopCaptions: () => Promise<void>

Wartość właściwości

() => Promise<void>

onStopNoiseSuppressionEffect

onStopNoiseSuppressionEffect: () => Promise<void>

Wartość właściwości

() => Promise<void>

onStopScreenShare

onStopScreenShare: () => Promise<void>

Wartość właściwości

() => Promise<void>

onStopSpotlight

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

Wartość właściwości

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

onToggleCamera

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

Wartość właściwości

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

onToggleHold

onToggleHold: () => Promise<void>

Wartość właściwości

() => Promise<void>

onToggleMicrophone

onToggleMicrophone: () => Promise<void>

Wartość właściwości

() => Promise<void>

onToggleRaiseHand

onToggleRaiseHand: () => Promise<void>

Wartość właściwości

() => Promise<void>

onToggleScreenShare

onToggleScreenShare: () => Promise<void>

Wartość właściwości

() => Promise<void>

Szczegóły metody

onAddParticipant(CommunicationUserIdentifier)

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

Parametry

participant

CommunicationUserIdentifier

Zwraca

Promise<void>

onAddParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

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

Parametry

participant

PhoneNumberIdentifier

options

AddPhoneNumberOptions

Zwraca

Promise<void>

onRemoveParticipant(CommunicationIdentifier)

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

Parametry

participant

CommunicationIdentifier

Zwraca

Promise<void>

onRemoveParticipant(string)

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

Parametry

userId

string

Zwraca

Promise<void>

onSubmitSurvey(CallSurvey)

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

Parametry

survey

CallSurvey

Zwraca

Promise<undefined | CallSurveyResponse>