CommonCallingHandlers interface

Balíček:

@azure/communication-react

Objekt obsahující všechny obslužné rutiny vyžadované pro volání komponent.

Volání souvisejících komponent z tohoto balíčku je možné vybrat relevantní obslužné rutiny z tohoto objektu. Viz <xref:useHandlers> a usePropsFor.

Vlastnosti

onAcceptCall
onBlurVideoBackground
onCreateLocalStreamView
onCreateRemoteStreamView
onCreateTogetherModeStreamView	Zpětné volání pro vytvoření zobrazení pro režim Společně
onDisposeLocalScreenShareStreamView
onDisposeLocalStreamView
onDisposeRemoteScreenShareStreamView
onDisposeRemoteStreamView
onDisposeRemoteVideoStreamView
onDisposeTogetherModeStreamView	Zpětné volání pro společné odstranění zobrazení režimu
onForbidAudio	Zakažte vzdáleným účastníkům odesílání zvuku
onForbidOthersAudio	Změňte možnost schůzky zakazující vzdáleným účastníkům odesílat zvuk
onForbidOthersVideo	Změňte možnost schůzky zakazující vzdáleným účastníkům odesílat video
onForbidVideo	Zakázat vzdáleným účastníkům odesílání videa
onHangUp
onLowerHand
onMuteAllRemoteParticipants
onMuteParticipant
onPermitAudio	Povolení vzdáleným účastníkům odesílat zvuk
onPermitOthersAudio	Změnit možnost schůzky povolit vzdáleným účastníkům odesílat zvuk
onPermitOthersVideo	Změnit možnost schůzky povolit vzdáleným účastníkům odesílat video
onPermitVideo	Povolit vzdáleným účastníkům odesílat video
onRaiseHand
onReactionClick
onRejectCall
onRemoveVideoBackgroundEffects
onReplaceVideoBackground
onSelectCamera
onSelectMicrophone
onSelectSpeaker
onSendDtmfTone
onSendRealTimeText
onSetCaptionLanguage
onSetSpokenLanguage
onSetTogetherModeSceneSize	Režim nastavení hovoru v režimu společné scény Velikost
onStartCall
onStartCaptions
onStartLocalVideo
onStartNoiseSuppressionEffect
onStartScreenShare
onStartSpotlight
onStartTogetherMode	Zpětné volání pro vytvoření zobrazení pro režim Společně
onStopAllSpotlight
onStopCaptions
onStopNoiseSuppressionEffect
onStopScreenShare
onStopSpotlight
onToggleCamera
onToggleHold
onToggleMicrophone
onToggleRaiseHand
onToggleScreenShare

Metody

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

Podrobnosti vlastnosti

onAcceptCall

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

Hodnota vlastnosti

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

onBlurVideoBackground

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

Hodnota vlastnosti

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

onCreateLocalStreamView

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

Hodnota vlastnosti

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

onCreateRemoteStreamView

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

Hodnota vlastnosti

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

onCreateTogetherModeStreamView

Zpětné volání pro vytvoření zobrazení pro režim Společně

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

Hodnota vlastnosti

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

onDisposeLocalScreenShareStreamView

onDisposeLocalScreenShareStreamView: () => Promise<void>

Hodnota vlastnosti

() => Promise<void>

onDisposeLocalStreamView

onDisposeLocalStreamView: () => Promise<void>

Hodnota vlastnosti

() => Promise<void>

onDisposeRemoteScreenShareStreamView

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

Hodnota vlastnosti

(userId: string) => Promise<void>

onDisposeRemoteStreamView

Upozornění

Toto rozhraní API je teď zastaralé.

use onDisposeRemoteVideoStreamView and onDisposeRemoteScreenShareStreamView instead.

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

Hodnota vlastnosti

(userId: string) => Promise<void>

onDisposeRemoteVideoStreamView

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

Hodnota vlastnosti

(userId: string) => Promise<void>

onDisposeTogetherModeStreamView

Zpětné volání pro společné odstranění zobrazení režimu

onDisposeTogetherModeStreamView: () => Promise<void>

Hodnota vlastnosti

() => Promise<void>

onForbidAudio

Zakažte vzdáleným účastníkům odesílání zvuku

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

Hodnota vlastnosti

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

onForbidOthersAudio

Změňte možnost schůzky zakazující vzdáleným účastníkům odesílat zvuk

onForbidOthersAudio?: () => Promise<void>

Hodnota vlastnosti

() => Promise<void>

onForbidOthersVideo

Změňte možnost schůzky zakazující vzdáleným účastníkům odesílat video

onForbidOthersVideo?: () => Promise<void>

Hodnota vlastnosti

() => Promise<void>

onForbidVideo

Zakázat vzdáleným účastníkům odesílání videa

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

Hodnota vlastnosti

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

onHangUp

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

Hodnota vlastnosti

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

onLowerHand

onLowerHand: () => Promise<void>

Hodnota vlastnosti

() => Promise<void>

onMuteAllRemoteParticipants

onMuteAllRemoteParticipants: () => Promise<void>

Hodnota vlastnosti

() => Promise<void>

onMuteParticipant

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

Hodnota vlastnosti

(userId: string) => Promise<void>

onPermitAudio

Povolení vzdáleným účastníkům odesílat zvuk

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

Hodnota vlastnosti

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

onPermitOthersAudio

Změnit možnost schůzky povolit vzdáleným účastníkům odesílat zvuk

onPermitOthersAudio?: () => Promise<void>

Hodnota vlastnosti

() => Promise<void>

onPermitOthersVideo

Změnit možnost schůzky povolit vzdáleným účastníkům odesílat video

onPermitOthersVideo?: () => Promise<void>

Hodnota vlastnosti

() => Promise<void>

onPermitVideo

Povolit vzdáleným účastníkům odesílat video

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

Hodnota vlastnosti

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

onRaiseHand

onRaiseHand: () => Promise<void>

Hodnota vlastnosti

() => Promise<void>

onReactionClick

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

Hodnota vlastnosti

(reaction: Reaction) => Promise<void>

onRejectCall

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

Hodnota vlastnosti

(incomingCallId: string) => Promise<void>

onRemoveVideoBackgroundEffects

onRemoveVideoBackgroundEffects: () => Promise<void>

Hodnota vlastnosti

() => Promise<void>

onReplaceVideoBackground

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

Hodnota vlastnosti

(backgroundReplacementConfig: BackgroundReplacementConfig) => Promise<void>

onSelectCamera

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

Hodnota vlastnosti

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

onSelectMicrophone

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

Hodnota vlastnosti

(device: AudioDeviceInfo) => Promise<void>

onSelectSpeaker

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

Hodnota vlastnosti

(device: AudioDeviceInfo) => Promise<void>

onSendDtmfTone

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

Hodnota vlastnosti

(dtmfTone: DtmfTone) => Promise<void>

onSendRealTimeText

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

Hodnota vlastnosti

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

onSetCaptionLanguage

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

Hodnota vlastnosti

(language: string) => Promise<void>

onSetSpokenLanguage

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

Hodnota vlastnosti

(language: string) => Promise<void>

onSetTogetherModeSceneSize

Režim nastavení hovoru v režimu společné scény Velikost

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

Hodnota vlastnosti

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

onStartCall

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

Hodnota vlastnosti

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

onStartCaptions

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

Hodnota vlastnosti

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

onStartLocalVideo

onStartLocalVideo: () => Promise<void>

Hodnota vlastnosti

() => Promise<void>

onStartNoiseSuppressionEffect

onStartNoiseSuppressionEffect: () => Promise<void>

Hodnota vlastnosti

() => Promise<void>

onStartScreenShare

onStartScreenShare: () => Promise<void>

Hodnota vlastnosti

() => Promise<void>

onStartSpotlight

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

Hodnota vlastnosti

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

onStartTogetherMode

Zpětné volání pro vytvoření zobrazení pro režim Společně

onStartTogetherMode: () => Promise<void>

Hodnota vlastnosti

() => Promise<void>

onStopAllSpotlight

onStopAllSpotlight: () => Promise<void>

Hodnota vlastnosti

() => Promise<void>

onStopCaptions

onStopCaptions: () => Promise<void>

Hodnota vlastnosti

() => Promise<void>

onStopNoiseSuppressionEffect

onStopNoiseSuppressionEffect: () => Promise<void>

Hodnota vlastnosti

() => Promise<void>

onStopScreenShare

onStopScreenShare: () => Promise<void>

Hodnota vlastnosti

() => Promise<void>

onStopSpotlight

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

Hodnota vlastnosti

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

onToggleCamera

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

Hodnota vlastnosti

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

onToggleHold

onToggleHold: () => Promise<void>

Hodnota vlastnosti

() => Promise<void>

onToggleMicrophone

onToggleMicrophone: () => Promise<void>

Hodnota vlastnosti

() => Promise<void>

onToggleRaiseHand

onToggleRaiseHand: () => Promise<void>

Hodnota vlastnosti

() => Promise<void>

onToggleScreenShare

onToggleScreenShare: () => Promise<void>

Hodnota vlastnosti

() => Promise<void>

Podrobnosti metody

onAddParticipant(CommunicationUserIdentifier)

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

Parametry

participant

CommunicationUserIdentifier

Návraty

Promise<void>

onAddParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

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

Parametry

participant

PhoneNumberIdentifier

options

AddPhoneNumberOptions

Návraty

Promise<void>

onRemoveParticipant(CommunicationIdentifier)

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

Parametry

participant

CommunicationIdentifier

Návraty

Promise<void>

onRemoveParticipant(string)

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

Parametry

userId

string

Návraty

Promise<void>

onSubmitSurvey(CallSurvey)

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

Parametry

survey

CallSurvey

Návraty

Promise<undefined | CallSurveyResponse>