CommonCallingHandlers interface

Paket:

@azure/communication-react

Objekt mit allen Handlern, die zum Aufrufen von Komponenten erforderlich sind.

Das Aufrufen verwandter Komponenten aus diesem Paket kann relevante Handler aus diesem Objekt auswählen. Siehe <xref:useHandlers> und usePropsFor.

Eigenschaften

onAcceptCall
onBlurVideoBackground
onCreateLocalStreamView
onCreateRemoteStreamView
onCreateTogetherModeStreamView	Rufen Sie zurück, um eine Ansicht für den Zusammen-Modus zu erstellen
onDisposeLocalScreenShareStreamView
onDisposeLocalStreamView
onDisposeRemoteScreenShareStreamView
onDisposeRemoteStreamView
onDisposeRemoteVideoStreamView
onDisposeTogetherModeStreamView	Rufen Sie zurück, um Ansichten im gemeinsamen Modus zu verwerfen
onForbidAudio	Remote-Teilnehmern das Senden von Audio verbieten
onForbidOthersAudio	Meeting-Option ändern, um Remote-Teilnehmern das Senden von Audio zu verbieten
onForbidOthersVideo	Ändern Sie die Meeting-Option, um Remote-Teilnehmern das Senden von Videos zu verbieten
onForbidVideo	Remote-Teilnehmern das Senden von Videos verbieten
onHangUp
onLowerHand
onMuteAllRemoteParticipants
onMuteParticipant
onPermitAudio	Zulassen, dass Remote-Teilnehmer Audio senden
onPermitOthersAudio	Ändern der Meeting-Option: Remote-Teilnehmern das Senden von Audio erlauben
onPermitOthersVideo	Ändern der Meeting-Option: Remote-Teilnehmern das Senden von Videos erlauben
onPermitVideo	Zulassen, dass Remote-Teilnehmer Videos senden
onRaiseHand
onReactionClick
onRejectCall
onRemoveVideoBackgroundEffects
onReplaceVideoBackground
onSelectCamera
onSelectMicrophone
onSelectSpeaker
onSendDtmfTone
onSendRealTimeText
onSetCaptionLanguage
onSetSpokenLanguage
onSetTogetherModeSceneSize	Szenengröße im Modus "Zusammensetzen von Anrufen"
onStartCall
onStartCaptions
onStartLocalVideo
onStartNoiseSuppressionEffect
onStartScreenShare
onStartSpotlight
onStartTogetherMode	Rufen Sie zurück, um eine Ansicht für den Zusammen-Modus zu erstellen
onStopAllSpotlight
onStopCaptions
onStopNoiseSuppressionEffect
onStopScreenShare
onStopSpotlight
onToggleCamera
onToggleHold
onToggleMicrophone
onToggleRaiseHand
onToggleScreenShare

Methoden

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

Details zur Eigenschaft

onAcceptCall

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

Eigenschaftswert

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

onBlurVideoBackground

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

Eigenschaftswert

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

onCreateLocalStreamView

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

Eigenschaftswert

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

onCreateRemoteStreamView

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

Eigenschaftswert

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

onCreateTogetherModeStreamView

Rufen Sie zurück, um eine Ansicht für den Zusammen-Modus zu erstellen

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

Eigenschaftswert

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

onDisposeLocalScreenShareStreamView

onDisposeLocalScreenShareStreamView: () => Promise<void>

Eigenschaftswert

() => Promise<void>

onDisposeLocalStreamView

onDisposeLocalStreamView: () => Promise<void>

Eigenschaftswert

() => Promise<void>

onDisposeRemoteScreenShareStreamView

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

Eigenschaftswert

(userId: string) => Promise<void>

onDisposeRemoteStreamView

Warnung

Diese API ist nun veraltet.

use onDisposeRemoteVideoStreamView and onDisposeRemoteScreenShareStreamView instead.

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

Eigenschaftswert

(userId: string) => Promise<void>

onDisposeRemoteVideoStreamView

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

Eigenschaftswert

(userId: string) => Promise<void>

onDisposeTogetherModeStreamView

Rufen Sie zurück, um Ansichten im gemeinsamen Modus zu verwerfen

onDisposeTogetherModeStreamView: () => Promise<void>

Eigenschaftswert

() => Promise<void>

onForbidAudio

Remote-Teilnehmern das Senden von Audio verbieten

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

Eigenschaftswert

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

onForbidOthersAudio

Meeting-Option ändern, um Remote-Teilnehmern das Senden von Audio zu verbieten

onForbidOthersAudio?: () => Promise<void>

Eigenschaftswert

() => Promise<void>

onForbidOthersVideo

Ändern Sie die Meeting-Option, um Remote-Teilnehmern das Senden von Videos zu verbieten

onForbidOthersVideo?: () => Promise<void>

Eigenschaftswert

() => Promise<void>

onForbidVideo

Remote-Teilnehmern das Senden von Videos verbieten

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

Eigenschaftswert

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

onHangUp

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

Eigenschaftswert

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

onLowerHand

onLowerHand: () => Promise<void>

Eigenschaftswert

() => Promise<void>

onMuteAllRemoteParticipants

onMuteAllRemoteParticipants: () => Promise<void>

Eigenschaftswert

() => Promise<void>

onMuteParticipant

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

Eigenschaftswert

(userId: string) => Promise<void>

onPermitAudio

Zulassen, dass Remote-Teilnehmer Audio senden

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

Eigenschaftswert

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

onPermitOthersAudio

Ändern der Meeting-Option: Remote-Teilnehmern das Senden von Audio erlauben

onPermitOthersAudio?: () => Promise<void>

Eigenschaftswert

() => Promise<void>

onPermitOthersVideo

Ändern der Meeting-Option: Remote-Teilnehmern das Senden von Videos erlauben

onPermitOthersVideo?: () => Promise<void>

Eigenschaftswert

() => Promise<void>

onPermitVideo

Zulassen, dass Remote-Teilnehmer Videos senden

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

Eigenschaftswert

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

onRaiseHand

onRaiseHand: () => Promise<void>

Eigenschaftswert

() => Promise<void>

onReactionClick

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

Eigenschaftswert

(reaction: Reaction) => Promise<void>

onRejectCall

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

Eigenschaftswert

(incomingCallId: string) => Promise<void>

onRemoveVideoBackgroundEffects

onRemoveVideoBackgroundEffects: () => Promise<void>

Eigenschaftswert

() => Promise<void>

onReplaceVideoBackground

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

Eigenschaftswert

(backgroundReplacementConfig: BackgroundReplacementConfig) => Promise<void>

onSelectCamera

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

Eigenschaftswert

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

onSelectMicrophone

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

Eigenschaftswert

(device: AudioDeviceInfo) => Promise<void>

onSelectSpeaker

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

Eigenschaftswert

(device: AudioDeviceInfo) => Promise<void>

onSendDtmfTone

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

Eigenschaftswert

(dtmfTone: DtmfTone) => Promise<void>

onSendRealTimeText

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

Eigenschaftswert

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

onSetCaptionLanguage

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

Eigenschaftswert

(language: string) => Promise<void>

onSetSpokenLanguage

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

Eigenschaftswert

(language: string) => Promise<void>

onSetTogetherModeSceneSize

Szenengröße im Modus "Zusammensetzen von Anrufen"

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

Eigenschaftswert

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

onStartCall

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

Eigenschaftswert

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

onStartCaptions

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

Eigenschaftswert

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

onStartLocalVideo

onStartLocalVideo: () => Promise<void>

Eigenschaftswert

() => Promise<void>

onStartNoiseSuppressionEffect

onStartNoiseSuppressionEffect: () => Promise<void>

Eigenschaftswert

() => Promise<void>

onStartScreenShare

onStartScreenShare: () => Promise<void>

Eigenschaftswert

() => Promise<void>

onStartSpotlight

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

Eigenschaftswert

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

onStartTogetherMode

Rufen Sie zurück, um eine Ansicht für den Zusammen-Modus zu erstellen

onStartTogetherMode: () => Promise<void>

Eigenschaftswert

() => Promise<void>

onStopAllSpotlight

onStopAllSpotlight: () => Promise<void>

Eigenschaftswert

() => Promise<void>

onStopCaptions

onStopCaptions: () => Promise<void>

Eigenschaftswert

() => Promise<void>

onStopNoiseSuppressionEffect

onStopNoiseSuppressionEffect: () => Promise<void>

Eigenschaftswert

() => Promise<void>

onStopScreenShare

onStopScreenShare: () => Promise<void>

Eigenschaftswert

() => Promise<void>

onStopSpotlight

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

Eigenschaftswert

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

onToggleCamera

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

Eigenschaftswert

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

onToggleHold

onToggleHold: () => Promise<void>

Eigenschaftswert

() => Promise<void>

onToggleMicrophone

onToggleMicrophone: () => Promise<void>

Eigenschaftswert

() => Promise<void>

onToggleRaiseHand

onToggleRaiseHand: () => Promise<void>

Eigenschaftswert

() => Promise<void>

onToggleScreenShare

onToggleScreenShare: () => Promise<void>

Eigenschaftswert

() => Promise<void>

Details zur Methode

onAddParticipant(CommunicationUserIdentifier)

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

Parameter

participant

CommunicationUserIdentifier

Gibt zurück

Promise<void>

onAddParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

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

Parameter

participant

PhoneNumberIdentifier

options

AddPhoneNumberOptions

Gibt zurück

Promise<void>

onRemoveParticipant(CommunicationIdentifier)

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

Parameter

participant

CommunicationIdentifier

Gibt zurück

Promise<void>

onRemoveParticipant(string)

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

Parameter

userId

string

Gibt zurück

Promise<void>

onSubmitSurvey(CallSurvey)

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

Parameter

survey

CallSurvey

Gibt zurück

Promise<undefined | CallSurveyResponse>