共用方式為


TeamsCallingHandlers interface

包含調用元件所需的所有 teams 調用處理程式的物件。

從這個封裝呼叫相關的元件,可以從這個對象中挑選相關的處理程式。 請參閱 <xref:useHandlers> 與 usePropsFor

Extends

屬性

onStartCall

繼承的屬性

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 模式場景大小

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)

屬性詳細資料

onStartCall

onStartCall: (participants: CommunicationIdentifier[], options?: StartCallOptions) => undefined | TeamsCall

屬性值

(participants: CommunicationIdentifier[], options?: StartCallOptions) => undefined | TeamsCall

繼承的屬性詳細資料

onAcceptCall

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

屬性值

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

繼承自CommonCallingHandlers.onAcceptCall

onBlurVideoBackground

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

屬性值

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

繼承自CommonCallingHandlers.onBlurVideoBackground

onCreateLocalStreamView

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

屬性值

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

繼承自commonCallingHandlers.onCreateLocalStreamView

onCreateRemoteStreamView

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

屬性值

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

繼承自commonCallingHandlers.onCreateRemoteStreamView

onCreateTogetherModeStreamView

回調以創建同框場景模式的視圖

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

屬性值

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

繼承自CommonCallingHandlers.onCreateTogetherModeStreamView

onDisposeLocalScreenShareStreamView

onDisposeLocalScreenShareStreamView: () => Promise<void>

屬性值

() => Promise<void>

繼承自CommonCallingHandlers.onDisposeLocalScreenShareStreamView

onDisposeLocalStreamView

onDisposeLocalStreamView: () => Promise<void>

屬性值

() => Promise<void>

繼承自CommonCallingHandlers.onDisposeLocalStreamView

onDisposeRemoteScreenShareStreamView

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

屬性值

(userId: string) => Promise<void>

繼承自CommonCallingHandlers.onDisposeRemoteScreenShareStreamView

onDisposeRemoteStreamView

警告

此 API 現已淘汰。

use onDisposeRemoteVideoStreamView and onDisposeRemoteScreenShareStreamView instead.

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

屬性值

(userId: string) => Promise<void>

繼承自CommonCallingHandlers.onDisposeRemoteStreamView

onDisposeRemoteVideoStreamView

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

屬性值

(userId: string) => Promise<void>

繼承自CommonCallingHandlers.onDisposeRemoteVideoStreamView

onDisposeTogetherModeStreamView

Call back to dispose Together 模式視圖

onDisposeTogetherModeStreamView: () => Promise<void>

屬性值

() => Promise<void>

繼承自CommonCallingHandlers.onDisposeTogetherModeStreamView

onForbidAudio

禁止遠端參與者發送音訊

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

屬性值

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

繼承自CommonCallingHandlers.onForbidAudio

onForbidOthersAudio

更改會議選項:禁止遠端參與者發送音訊

onForbidOthersAudio?: () => Promise<void>

屬性值

() => Promise<void>

繼承自CommonCallingHandlers.onForbidOthersAudio

onForbidOthersVideo

更改會議選項禁止遠端參與者發送視頻

onForbidOthersVideo?: () => Promise<void>

屬性值

() => Promise<void>

繼承自CommonCallingHandlers.onForbidOthersVideo

onForbidVideo

禁止遠端參與者發送視頻

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

屬性值

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

繼承自CommonCallingHandlers.onForbidVideo

onHangUp

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

屬性值

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

繼承自CommonCallingHandlers.onHangUp

onLowerHand

onLowerHand: () => Promise<void>

屬性值

() => Promise<void>

繼承自CommonCallingHandlers.onLowerHand

onMuteAllRemoteParticipants

onMuteAllRemoteParticipants: () => Promise<void>

屬性值

() => Promise<void>

繼承自CommonCallingHandlers.onMuteAllRemoteParticipants

onMuteParticipant

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

屬性值

(userId: string) => Promise<void>

繼承自CommonCallingHandlers.onMuteParticipant

onPermitAudio

允許遠端參與者發送音訊

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

屬性值

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

繼承自CommonCallingHandlers.onPermitAudio

onPermitOthersAudio

更改會議選項:允許遠端參與者發送音訊

onPermitOthersAudio?: () => Promise<void>

屬性值

() => Promise<void>

繼承自CommonCallingHandlers.onPermitOthersAudio

onPermitOthersVideo

更改會議選項允許遠端參與者發送視頻

onPermitOthersVideo?: () => Promise<void>

屬性值

() => Promise<void>

繼承自CommonCallingHandlers.onPermitOthersVideo

onPermitVideo

允許遠端參與者發送視頻

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

屬性值

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

繼承自CommonCallingHandlers.onPermitVideo

onRaiseHand

onRaiseHand: () => Promise<void>

屬性值

() => Promise<void>

繼承自CommonCallingHandlers.onRaiseHand

onReactionClick

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

屬性值

(reaction: Reaction) => Promise<void>

繼承自CommonCallingHandlers.onReactionClick

onRejectCall

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

屬性值

(incomingCallId: string) => Promise<void>

繼承自CommonCallingHandlers.onRejectCall

onRemoveVideoBackgroundEffects

onRemoveVideoBackgroundEffects: () => Promise<void>

屬性值

() => Promise<void>

繼承自CommonCallingHandlers.onRemoveVideoBackgroundEffects

onReplaceVideoBackground

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

屬性值

(backgroundReplacementConfig: BackgroundReplacementConfig) => Promise<void>

繼承自CommonCallingHandlers.onReplaceVideoBackground

onSelectCamera

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

屬性值

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

繼承自CommonCallingHandlers.onSelectCamera

onSelectMicrophone

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

屬性值

(device: AudioDeviceInfo) => Promise<void>

繼承自commonCallingHandlers.onSelectMicrophone

onSelectSpeaker

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

屬性值

(device: AudioDeviceInfo) => Promise<void>

繼承自CommonCallingHandlers.onSelectSpeaker

onSendDtmfTone

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

屬性值

(dtmfTone: DtmfTone) => Promise<void>

繼承自CommonCallingHandlers.onSendDtmfTone

onSendRealTimeText

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

屬性值

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

繼承自CommonCallingHandlers.onSendRealTimeText

onSetCaptionLanguage

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

屬性值

(language: string) => Promise<void>

繼承自CommonCallingHandlers.onSetCaptionLanguage

onSetSpokenLanguage

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

屬性值

(language: string) => Promise<void>

繼承自CommonCallingHandlers.onSetSpokenLanguage

onSetTogetherModeSceneSize

調用 Set Together 模式場景大小

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

屬性值

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

繼承自CommonCallingHandlers.onSetTogetherModeSceneSize

onStartCaptions

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

屬性值

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

繼承自CommonCallingHandlers.onStartCaptions

onStartLocalVideo

onStartLocalVideo: () => Promise<void>

屬性值

() => Promise<void>

繼承自CommonCallingHandlers.onStartLocalVideo

onStartNoiseSuppressionEffect

onStartNoiseSuppressionEffect: () => Promise<void>

屬性值

() => Promise<void>

繼承自CommonCallingHandlers.onStartNoiseSuppressionEffect

onStartScreenShare

onStartScreenShare: () => Promise<void>

屬性值

() => Promise<void>

繼承自CommonCallingHandlers.onStartScreenShare

onStartSpotlight

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

屬性值

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

繼承自CommonCallingHandlers.onStartSpotlight

onStartTogetherMode

回調以創建同框場景模式的視圖

onStartTogetherMode: () => Promise<void>

屬性值

() => Promise<void>

繼承自CommonCallingHandlers.onStartTogetherMode

onStopAllSpotlight

onStopAllSpotlight: () => Promise<void>

屬性值

() => Promise<void>

繼承自CommonCallingHandlers.onStopAllSpotlight

onStopCaptions

onStopCaptions: () => Promise<void>

屬性值

() => Promise<void>

繼承自CommonCallingHandlers.onStopCaptions

onStopNoiseSuppressionEffect

onStopNoiseSuppressionEffect: () => Promise<void>

屬性值

() => Promise<void>

繼承自CommonCallingHandlers.onStopNoiseSuppressionEffect

onStopScreenShare

onStopScreenShare: () => Promise<void>

屬性值

() => Promise<void>

繼承自commonCallingHandlers.onStopScreenShare

onStopSpotlight

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

屬性值

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

繼承自CommonCallingHandlers.onStopSpotlight

onToggleCamera

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

屬性值

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

繼承自commonCallingHandlers.onToggleCamera

onToggleHold

onToggleHold: () => Promise<void>

屬性值

() => Promise<void>

繼承自CommonCallingHandlers.onToggleHold

onToggleMicrophone

onToggleMicrophone: () => Promise<void>

屬性值

() => Promise<void>

繼承自CommonCallingHandlers.onToggleMicrophone

onToggleRaiseHand

onToggleRaiseHand: () => Promise<void>

屬性值

() => Promise<void>

繼承自CommonCallingHandlers.onToggleRaiseHand

onToggleScreenShare

onToggleScreenShare: () => Promise<void>

屬性值

() => Promise<void>

繼承自commonCallingHandlers.onToggleScreenShare

繼承的方法的詳細資料

onAddParticipant(CommunicationUserIdentifier)

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

參數

傳回

Promise<void>

繼承自CommonCallingHandlers.onAddParticipant

onAddParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

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

參數

participant
PhoneNumberIdentifier

傳回

Promise<void>

繼承自CommonCallingHandlers.onAddParticipant

onRemoveParticipant(CommunicationIdentifier)

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

參數

傳回

Promise<void>

繼承自commonCallingHandlers.onRemoveParticipant

onRemoveParticipant(string)

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

參數

userId

string

傳回

Promise<void>

繼承自commonCallingHandlers.onRemoveParticipant

onSubmitSurvey(CallSurvey)

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

參數

survey
CallSurvey

傳回

Promise<undefined | CallSurveyResponse>

繼承自CommonCallingHandlers.onSubmitSurvey