CallingHandlers interface
Object containing all the handlers required for calling components.
Calling related components from this package are able to pick out relevant handlers from this object. See <xref:useHandlers> and usePropsFor.
- Extends
Properties
| on |
Inherited Properties
Inherited Methods
Property Details
onStartCall
onStartCall: (participants: CommunicationIdentifier[], options?: StartCallOptions) => undefined | CallProperty Value
(participants: CommunicationIdentifier[], options?: StartCallOptions) => undefined | Call
Inherited Property Details
onAcceptCall
onAcceptCall: (incomingCallId: string, useVideo?: boolean) => Promise<void>Property Value
(incomingCallId: string, useVideo?: boolean) => Promise<void>
Inherited From CommonCallingHandlers.onAcceptCall
onBlurVideoBackground
onBlurVideoBackground: (backgroundBlurConfig?: VideoEffectConfig) => Promise<void>Property Value
(backgroundBlurConfig?: VideoEffectConfig) => Promise<void>
Inherited From CommonCallingHandlers.onBlurVideoBackground
onCreateLocalStreamView
onCreateLocalStreamView: (options?: VideoStreamOptions) => Promise<void | CreateVideoStreamViewResult>Property Value
(options?: VideoStreamOptions) => Promise<void | CreateVideoStreamViewResult>
Inherited From CommonCallingHandlers.onCreateLocalStreamView
onCreateRemoteStreamView
onCreateRemoteStreamView: (userId: string, options?: VideoStreamOptions) => Promise<void | CreateVideoStreamViewResult>Property Value
(userId: string, options?: VideoStreamOptions) => Promise<void | CreateVideoStreamViewResult>
Inherited From CommonCallingHandlers.onCreateRemoteStreamView
onCreateTogetherModeStreamView
Call back to create a view for together mode
onCreateTogetherModeStreamView: (options?: TogetherModeStreamOptions) => Promise<void | TogetherModeStreamViewResult>Property Value
(options?: TogetherModeStreamOptions) => Promise<void | TogetherModeStreamViewResult>
Inherited From CommonCallingHandlers.onCreateTogetherModeStreamView
onDisposeLocalScreenShareStreamView
onDisposeLocalScreenShareStreamView: () => Promise<void>Property Value
() => Promise<void>
Inherited From CommonCallingHandlers.onDisposeLocalScreenShareStreamView
onDisposeLocalStreamView
onDisposeLocalStreamView: () => Promise<void>Property Value
() => Promise<void>
Inherited From CommonCallingHandlers.onDisposeLocalStreamView
onDisposeRemoteScreenShareStreamView
onDisposeRemoteScreenShareStreamView: (userId: string) => Promise<void>Property Value
(userId: string) => Promise<void>
Inherited From CommonCallingHandlers.onDisposeRemoteScreenShareStreamView
onDisposeRemoteStreamView
Warning
This API is now deprecated.
use onDisposeRemoteVideoStreamView and onDisposeRemoteScreenShareStreamView instead.
onDisposeRemoteStreamView: (userId: string) => Promise<void>Property Value
(userId: string) => Promise<void>
Inherited From CommonCallingHandlers.onDisposeRemoteStreamView
onDisposeRemoteVideoStreamView
onDisposeRemoteVideoStreamView: (userId: string) => Promise<void>Property Value
(userId: string) => Promise<void>
Inherited From CommonCallingHandlers.onDisposeRemoteVideoStreamView
onDisposeTogetherModeStreamView
Call back to dispose together mode views
onDisposeTogetherModeStreamView: () => Promise<void>Property Value
() => Promise<void>
Inherited From CommonCallingHandlers.onDisposeTogetherModeStreamView
onForbidAudio
Forbid remote participants from sending audio
onForbidAudio?: (userIds: string[]) => Promise<void>Property Value
(userIds: string[]) => Promise<void>
Inherited From CommonCallingHandlers.onForbidAudio
onForbidOthersAudio
Change meeting option forbid remote participants from sending audio
onForbidOthersAudio?: () => Promise<void>Property Value
() => Promise<void>
Inherited From CommonCallingHandlers.onForbidOthersAudio
onForbidOthersVideo
Change meeting option forbid remote participants from sending video
onForbidOthersVideo?: () => Promise<void>Property Value
() => Promise<void>
Inherited From CommonCallingHandlers.onForbidOthersVideo
onForbidVideo
Forbid remote participants from sending video
onForbidVideo?: (userIds: string[]) => Promise<void>Property Value
(userIds: string[]) => Promise<void>
Inherited From CommonCallingHandlers.onForbidVideo
onHangUp
onHangUp: (forEveryone?: boolean) => Promise<void>Property Value
(forEveryone?: boolean) => Promise<void>
Inherited From CommonCallingHandlers.onHangUp
onLowerHand
onLowerHand: () => Promise<void>Property Value
() => Promise<void>
Inherited From CommonCallingHandlers.onLowerHand
onMuteAllRemoteParticipants
onMuteAllRemoteParticipants: () => Promise<void>Property Value
() => Promise<void>
Inherited From CommonCallingHandlers.onMuteAllRemoteParticipants
onMuteParticipant
onMuteParticipant: (userId: string) => Promise<void>Property Value
(userId: string) => Promise<void>
Inherited From CommonCallingHandlers.onMuteParticipant
onPermitAudio
Permit remote participants to send audio
onPermitAudio?: (userIds: string[]) => Promise<void>Property Value
(userIds: string[]) => Promise<void>
Inherited From CommonCallingHandlers.onPermitAudio
onPermitOthersAudio
Change meeting option permit remote participants to send audio
onPermitOthersAudio?: () => Promise<void>Property Value
() => Promise<void>
Inherited From CommonCallingHandlers.onPermitOthersAudio
onPermitOthersVideo
Change meeting option permit remote participants to send video
onPermitOthersVideo?: () => Promise<void>Property Value
() => Promise<void>
Inherited From CommonCallingHandlers.onPermitOthersVideo
onPermitVideo
Permit remote participants to send video
onPermitVideo?: (userIds: string[]) => Promise<void>Property Value
(userIds: string[]) => Promise<void>
Inherited From CommonCallingHandlers.onPermitVideo
onRaiseHand
onRaiseHand: () => Promise<void>Property Value
() => Promise<void>
Inherited From CommonCallingHandlers.onRaiseHand
onReactionClick
onReactionClick: (reaction: Reaction) => Promise<void>Property Value
(reaction: Reaction) => Promise<void>
Inherited From CommonCallingHandlers.onReactionClick
onRejectCall
onRejectCall: (incomingCallId: string) => Promise<void>Property Value
(incomingCallId: string) => Promise<void>
Inherited From CommonCallingHandlers.onRejectCall
onRemoveVideoBackgroundEffects
onRemoveVideoBackgroundEffects: () => Promise<void>Property Value
() => Promise<void>
Inherited From CommonCallingHandlers.onRemoveVideoBackgroundEffects
onReplaceVideoBackground
onReplaceVideoBackground: (backgroundReplacementConfig: BackgroundReplacementConfig) => Promise<void>Property Value
(backgroundReplacementConfig: BackgroundReplacementConfig) => Promise<void>
Inherited From CommonCallingHandlers.onReplaceVideoBackground
onSelectCamera
onSelectCamera: (device: VideoDeviceInfo, options?: VideoStreamOptions) => Promise<void>Property Value
(device: VideoDeviceInfo, options?: VideoStreamOptions) => Promise<void>
Inherited From CommonCallingHandlers.onSelectCamera
onSelectMicrophone
onSelectMicrophone: (device: AudioDeviceInfo) => Promise<void>Property Value
(device: AudioDeviceInfo) => Promise<void>
Inherited From CommonCallingHandlers.onSelectMicrophone
onSelectSpeaker
onSelectSpeaker: (device: AudioDeviceInfo) => Promise<void>Property Value
(device: AudioDeviceInfo) => Promise<void>
Inherited From CommonCallingHandlers.onSelectSpeaker
onSendDtmfTone
onSendDtmfTone: (dtmfTone: DtmfTone) => Promise<void>Property Value
(dtmfTone: DtmfTone) => Promise<void>
Inherited From CommonCallingHandlers.onSendDtmfTone
onSendRealTimeText
onSendRealTimeText: (text: string, isFinalized: boolean) => Promise<void>Property Value
(text: string, isFinalized: boolean) => Promise<void>
Inherited From CommonCallingHandlers.onSendRealTimeText
onSetCaptionLanguage
onSetCaptionLanguage: (language: string) => Promise<void>Property Value
(language: string) => Promise<void>
Inherited From CommonCallingHandlers.onSetCaptionLanguage
onSetSpokenLanguage
onSetSpokenLanguage: (language: string) => Promise<void>Property Value
(language: string) => Promise<void>
Inherited From CommonCallingHandlers.onSetSpokenLanguage
onSetTogetherModeSceneSize
Call set together mode scene size
onSetTogetherModeSceneSize: (width: number, height: number) => voidProperty Value
(width: number, height: number) => void
Inherited From CommonCallingHandlers.onSetTogetherModeSceneSize
onStartCaptions
onStartCaptions: (options?: CaptionsOptions) => Promise<void>Property Value
(options?: CaptionsOptions) => Promise<void>
Inherited From CommonCallingHandlers.onStartCaptions
onStartLocalVideo
onStartLocalVideo: () => Promise<void>Property Value
() => Promise<void>
Inherited From CommonCallingHandlers.onStartLocalVideo
onStartNoiseSuppressionEffect
onStartNoiseSuppressionEffect: () => Promise<void>Property Value
() => Promise<void>
Inherited From CommonCallingHandlers.onStartNoiseSuppressionEffect
onStartScreenShare
onStartScreenShare: () => Promise<void>Property Value
() => Promise<void>
Inherited From CommonCallingHandlers.onStartScreenShare
onStartSpotlight
onStartSpotlight: (userIds?: string[]) => Promise<void>Property Value
(userIds?: string[]) => Promise<void>
Inherited From CommonCallingHandlers.onStartSpotlight
onStartTogetherMode
Call back to create a view for together mode
onStartTogetherMode: () => Promise<void>Property Value
() => Promise<void>
Inherited From CommonCallingHandlers.onStartTogetherMode
onStopAllSpotlight
onStopAllSpotlight: () => Promise<void>Property Value
() => Promise<void>
Inherited From CommonCallingHandlers.onStopAllSpotlight
onStopCaptions
onStopCaptions: () => Promise<void>Property Value
() => Promise<void>
Inherited From CommonCallingHandlers.onStopCaptions
onStopNoiseSuppressionEffect
onStopNoiseSuppressionEffect: () => Promise<void>Property Value
() => Promise<void>
Inherited From CommonCallingHandlers.onStopNoiseSuppressionEffect
onStopScreenShare
onStopScreenShare: () => Promise<void>Property Value
() => Promise<void>
Inherited From CommonCallingHandlers.onStopScreenShare
onStopSpotlight
onStopSpotlight: (userIds?: string[]) => Promise<void>Property Value
(userIds?: string[]) => Promise<void>
Inherited From CommonCallingHandlers.onStopSpotlight
onToggleCamera
onToggleCamera: (options?: VideoStreamOptions) => Promise<void>Property Value
(options?: VideoStreamOptions) => Promise<void>
Inherited From CommonCallingHandlers.onToggleCamera
onToggleHold
onToggleHold: () => Promise<void>Property Value
() => Promise<void>
Inherited From CommonCallingHandlers.onToggleHold
onToggleMicrophone
onToggleMicrophone: () => Promise<void>Property Value
() => Promise<void>
Inherited From CommonCallingHandlers.onToggleMicrophone
onToggleRaiseHand
onToggleRaiseHand: () => Promise<void>Property Value
() => Promise<void>
Inherited From CommonCallingHandlers.onToggleRaiseHand
onToggleScreenShare
onToggleScreenShare: () => Promise<void>Property Value
() => Promise<void>
Inherited From CommonCallingHandlers.onToggleScreenShare
Inherited Method Details
onAddParticipant(CommunicationUserIdentifier)
function onAddParticipant(participant: CommunicationUserIdentifier): Promise<void>Parameters
- participant
- CommunicationUserIdentifier
Returns
Promise<void>
Inherited From CommonCallingHandlers.onAddParticipant
onAddParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)
function onAddParticipant(participant: PhoneNumberIdentifier, options: AddPhoneNumberOptions): Promise<void>Parameters
- participant
- PhoneNumberIdentifier
- options
- AddPhoneNumberOptions
Returns
Promise<void>
Inherited From CommonCallingHandlers.onAddParticipant
onRemoveParticipant(CommunicationIdentifier)
function onRemoveParticipant(participant: CommunicationIdentifier): Promise<void>Parameters
- participant
- CommunicationIdentifier
Returns
Promise<void>
Inherited From CommonCallingHandlers.onRemoveParticipant
onRemoveParticipant(string)
function onRemoveParticipant(userId: string): Promise<void>Parameters
- userId
-
string
Returns
Promise<void>
Inherited From CommonCallingHandlers.onRemoveParticipant
onSubmitSurvey(CallSurvey)
function onSubmitSurvey(survey: CallSurvey): Promise<undefined | CallSurveyResponse>Parameters
- survey
- CallSurvey
Returns
Promise<undefined | CallSurveyResponse>
Inherited From CommonCallingHandlers.onSubmitSurvey