CommonCallingHandlers interface

包:

@azure/communication-react

包含调用组件所需的所有处理程序的对象。

从此包调用相关组件可以从此对象中选取相关处理程序。 请参阅 <xref:useHandlers> 和 usePropsFor。

属性

onAcceptCall
onBlurVideoBackground
onCreateLocalStreamView
onCreateRemoteStreamView
onCreateTogetherModeStreamView	回调以创建同框场景模式的视图
onDisposeLocalScreenShareStreamView
onDisposeLocalStreamView
onDisposeRemoteScreenShareStreamView
onDisposeRemoteStreamView
onDisposeRemoteVideoStreamView
onDisposeTogetherModeStreamView	Call back to dispose Together 模式视图
onForbidAudio	禁止远程参与者发送音频
onForbidOthersAudio	更改会议选项：禁止远程参与者发送音频
onForbidOthersVideo	更改会议选项禁止远程参与者发送视频
onForbidVideo	禁止远程参与者发送视频
onHangUp
onLowerHand
onMuteAllRemoteParticipants
onMuteParticipant
onPermitAudio	允许远程参与者发送音频
onPermitOthersAudio	更改会议选项：允许远程参与者发送音频
onPermitOthersVideo	更改会议选项允许远程参与者发送视频
onPermitVideo	允许远程参与者发送视频
onRaiseHand
onReactionClick
onRejectCall
onRemoveVideoBackgroundEffects
onReplaceVideoBackground
onSelectCamera
onSelectMicrophone
onSelectSpeaker
onSendDtmfTone
onSendRealTimeText
onSetCaptionLanguage
onSetSpokenLanguage
onSetTogetherModeSceneSize	调用 Set Together 模式场景大小
onStartCall
onStartCaptions
onStartLocalVideo
onStartNoiseSuppressionEffect
onStartScreenShare
onStartSpotlight
onStartTogetherMode	回调以创建同框场景模式的视图
onStopAllSpotlight
onStopCaptions
onStopNoiseSuppressionEffect
onStopScreenShare
onStopSpotlight
onToggleCamera
onToggleHold
onToggleMicrophone
onToggleRaiseHand
onToggleScreenShare

方法

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

属性详细信息

onAcceptCall

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

属性值

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

onBlurVideoBackground

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

属性值

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

onCreateLocalStreamView

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

属性值

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

onCreateRemoteStreamView

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

属性值

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

onCreateTogetherModeStreamView

回调以创建同框场景模式的视图

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

属性值

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

onDisposeLocalScreenShareStreamView

onDisposeLocalScreenShareStreamView: () => Promise<void>

属性值

() => Promise<void>

onDisposeLocalStreamView

onDisposeLocalStreamView: () => Promise<void>

属性值

() => Promise<void>

onDisposeRemoteScreenShareStreamView

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

属性值

(userId: string) => Promise<void>

onDisposeRemoteStreamView

警告

现已弃用此 API。

use onDisposeRemoteVideoStreamView and onDisposeRemoteScreenShareStreamView instead.

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

属性值

(userId: string) => Promise<void>

onDisposeRemoteVideoStreamView

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

属性值

(userId: string) => Promise<void>

onDisposeTogetherModeStreamView

Call back to dispose Together 模式视图

onDisposeTogetherModeStreamView: () => Promise<void>

属性值

() => Promise<void>

onForbidAudio

禁止远程参与者发送音频

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

属性值

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

onForbidOthersAudio

更改会议选项：禁止远程参与者发送音频

onForbidOthersAudio?: () => Promise<void>

属性值

() => Promise<void>

onForbidOthersVideo

更改会议选项禁止远程参与者发送视频

onForbidOthersVideo?: () => Promise<void>

属性值

() => Promise<void>

onForbidVideo

禁止远程参与者发送视频

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

属性值

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

onHangUp

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

属性值

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

onLowerHand

onLowerHand: () => Promise<void>

属性值

() => Promise<void>

onMuteAllRemoteParticipants

onMuteAllRemoteParticipants: () => Promise<void>

属性值

() => Promise<void>

onMuteParticipant

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

属性值

(userId: string) => Promise<void>

onPermitAudio

允许远程参与者发送音频

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

属性值

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

onPermitOthersAudio

更改会议选项：允许远程参与者发送音频

onPermitOthersAudio?: () => Promise<void>

属性值

() => Promise<void>

onPermitOthersVideo

更改会议选项允许远程参与者发送视频

onPermitOthersVideo?: () => Promise<void>

属性值

() => Promise<void>

onPermitVideo

允许远程参与者发送视频

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

属性值

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

onRaiseHand

onRaiseHand: () => Promise<void>

属性值

() => Promise<void>

onReactionClick

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

属性值

(reaction: Reaction) => Promise<void>

onRejectCall

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

属性值

(incomingCallId: string) => Promise<void>

onRemoveVideoBackgroundEffects

onRemoveVideoBackgroundEffects: () => Promise<void>

属性值

() => Promise<void>

onReplaceVideoBackground

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

属性值

(backgroundReplacementConfig: BackgroundReplacementConfig) => Promise<void>

onSelectCamera

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

属性值

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

onSelectMicrophone

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

属性值

(device: AudioDeviceInfo) => Promise<void>

onSelectSpeaker

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

属性值

(device: AudioDeviceInfo) => Promise<void>

onSendDtmfTone

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

属性值

(dtmfTone: DtmfTone) => Promise<void>

onSendRealTimeText

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

属性值

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

onSetCaptionLanguage

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

属性值

(language: string) => Promise<void>

onSetSpokenLanguage

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

属性值

(language: string) => Promise<void>

onSetTogetherModeSceneSize

调用 Set Together 模式场景大小

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

属性值

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

onStartCall

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

属性值

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

onStartCaptions

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

属性值

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

onStartLocalVideo

onStartLocalVideo: () => Promise<void>

属性值

() => Promise<void>

onStartNoiseSuppressionEffect

onStartNoiseSuppressionEffect: () => Promise<void>

属性值

() => Promise<void>

onStartScreenShare

onStartScreenShare: () => Promise<void>

属性值

() => Promise<void>

onStartSpotlight

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

属性值

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

onStartTogetherMode

回调以创建同框场景模式的视图

onStartTogetherMode: () => Promise<void>

属性值

() => Promise<void>

onStopAllSpotlight

onStopAllSpotlight: () => Promise<void>

属性值

() => Promise<void>

onStopCaptions

onStopCaptions: () => Promise<void>

属性值

() => Promise<void>

onStopNoiseSuppressionEffect

onStopNoiseSuppressionEffect: () => Promise<void>

属性值

() => Promise<void>

onStopScreenShare

onStopScreenShare: () => Promise<void>

属性值

() => Promise<void>

onStopSpotlight

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

属性值

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

onToggleCamera

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

属性值

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

onToggleHold

onToggleHold: () => Promise<void>

属性值

() => Promise<void>

onToggleMicrophone

onToggleMicrophone: () => Promise<void>

属性值

() => Promise<void>

onToggleRaiseHand

onToggleRaiseHand: () => Promise<void>

属性值

() => Promise<void>

onToggleScreenShare

onToggleScreenShare: () => Promise<void>

属性值

() => Promise<void>

方法详细信息

onAddParticipant(CommunicationUserIdentifier)

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

参数

participant

CommunicationUserIdentifier

返回

Promise<void>

onAddParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

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

参数

participant

PhoneNumberIdentifier

options

AddPhoneNumberOptions

返回

Promise<void>

onRemoveParticipant(CommunicationIdentifier)

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

参数

participant

CommunicationIdentifier

返回

Promise<void>

onRemoveParticipant(string)

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

参数

userId

string

返回

Promise<void>

onSubmitSurvey(CallSurvey)

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

参数

survey

CallSurvey

返回

Promise<undefined | CallSurveyResponse>