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>