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
| on |
Property Details
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>
onDisposeLocalStreamView
onDisposeLocalStreamView: () => Promise<void>Property Value
() => Promise<void>
onDisposeRemoteStreamView
onDisposeRemoteStreamView: (userId: string) => Promise<void>Property Value
(userId: string) => Promise<void>
onHangUp
onHangUp: (forEveryone?: boolean) => Promise<void>Property Value
(forEveryone?: boolean) => 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>
onStartCall
onStartCall: (participants: (CommunicationUserIdentifier | PhoneNumberIdentifier | UnknownIdentifier)[], options?: StartCallOptions) => voidProperty Value
(participants: (CommunicationUserIdentifier | PhoneNumberIdentifier | UnknownIdentifier)[], options?: StartCallOptions) => void
onStartLocalVideo
onStartLocalVideo: () => Promise<void>Property Value
() => Promise<void>
onStartScreenShare
onStartScreenShare: () => Promise<void>Property Value
() => Promise<void>
onStopScreenShare
onStopScreenShare: () => Promise<void>Property Value
() => Promise<void>
onToggleCamera
onToggleCamera: (options?: VideoStreamOptions) => Promise<void>Property Value
(options?: VideoStreamOptions) => Promise<void>
onToggleMicrophone
onToggleMicrophone: () => Promise<void>Property Value
() => Promise<void>
onToggleScreenShare
onToggleScreenShare: () => Promise<void>Property Value
() => Promise<void>
Method Details
onRemoveParticipant(string)
function onRemoveParticipant(userId: string): Promise<void>Parameters
- userId
-
string
Returns
Promise<void>