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