CallingHandlers interface

  • Reference
Package:
@azure/communication-react

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
CommonCallingHandlers

Properties

onStartCall

Inherited Properties

onCreateLocalStreamView
onCreateRemoteStreamView
onDisposeLocalStreamView
onDisposeRemoteStreamView
onHangUp
onSelectCamera
onSelectMicrophone
onSelectSpeaker
onStartLocalVideo
onStartScreenShare
onStopScreenShare
onToggleCamera
onToggleMicrophone
onToggleScreenShare

Inherited Methods

onRemoveParticipant(string)

Property Details

onStartCall 

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

Property Value

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

Inherited Property Details

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

onDisposeLocalStreamView 

onDisposeLocalStreamView: () => Promise<void>

Property Value

() => Promise<void>

Inherited From CommonCallingHandlers.onDisposeLocalStreamView

onDisposeRemoteStreamView 

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

Property Value

(userId: string) => Promise<void>

Inherited From CommonCallingHandlers.onDisposeRemoteStreamView

onHangUp 

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

Property Value

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

Inherited From CommonCallingHandlers.onHangUp

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

onStartLocalVideo 

onStartLocalVideo: () => Promise<void>

Property Value

() => Promise<void>

Inherited From CommonCallingHandlers.onStartLocalVideo

onStartScreenShare 

onStartScreenShare: () => Promise<void>

Property Value

() => Promise<void>

Inherited From CommonCallingHandlers.onStartScreenShare

onStopScreenShare 

onStopScreenShare: () => Promise<void>

Property Value

() => Promise<void>

Inherited From CommonCallingHandlers.onStopScreenShare

onToggleCamera 

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

Property Value

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

Inherited From CommonCallingHandlers.onToggleCamera

onToggleMicrophone 

onToggleMicrophone: () => Promise<void>

Property Value

() => Promise<void>

Inherited From CommonCallingHandlers.onToggleMicrophone

onToggleScreenShare 

onToggleScreenShare: () => Promise<void>

Property Value

() => Promise<void>

Inherited From CommonCallingHandlers.onToggleScreenShare

Inherited Method Details

onRemoveParticipant(string) 

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

Parameters

userId

string

Returns

Promise<void>

Inherited From CommonCallingHandlers.onRemoveParticipant