https://github.com/cybex-dev/web_callkit
https://github.com/cybex-dev/web_callkit
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/cybex-dev/web_callkit
- Owner: cybex-dev
- License: mit
- Created: 2024-09-26T13:39:38.000Z (9 months ago)
- Default Branch: master
- Last Pushed: 2025-02-14T09:06:50.000Z (4 months ago)
- Last Synced: 2025-02-14T10:23:28.631Z (4 months ago)
- Size: 83 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# web_callkit
**This project is a Web Flutter plugin that facilitates handling of calls.**
Inspired by the iOS CallKit framework, this plugin provides the boilerplate to manage calls via a
simple API and provides a browser call control mechanism through browser notifications.
### Notes
Due to many voip providers e.g. twilio-voice.js providing their own SDKs and audio handling (
incoming ringing, etc), this plugin is intended to be used as a boilerplate for call management and
not as a full-fledged voip solution.
A bird's eye overview/usage of the plugin:
- Notify callkit of an incoming call
- Update state of call from VOIP/SIP provider
- Add/update call capabilities (hold, mute, etc)
## Features
- Boilerplate for call management
- Integration with browser notifications
- Support background calls
- Custom audio sounds for incoming calls, etc.
### Call State flow
## Limitations
### Browser notifications
Use native browser integration, the following limitations apply to each platform. Usage of Flutter
package [js_notifications](https://pub.dev/packages/js_notifications) is assist in browser
notification integration to native systems. See [js_notifications > platform limitations](https://github.com/cybex-dev/js_notifications?tab=readme-ov-file#platform-limitations)
for more information
## Installation
### Import the package
```dart
import 'package:web_callkit/web_callkit.dart';
```
### Display the system call screen
Inform the plugin that an incoming call is being received. This will hook into the browser
notification system.
```dart
WebCallKit.instance.displayIncomingCall(
uuid: '1234',
handle: 'John Doe',
);
```
### End the call
End the call by calling the `endCall` method. This will remove the call screen and stop the browser
notification. Calls are disconnected for various reasons, via local user requests or remote errors
or disconnects with VoIP calls due to internet disruptions.
The CallKit supports `DisconnectResponse` enum to specify the reason for the call disconnection.
e.g. `WebCallKit.instance.reportCallDisconnected('1234', response: DisconnectResponse.local);`
| Reason | Description |
|----------|---------------------------------------------------------------------------------------|
| local | Disconnect due to a local end call request. |
| remote | Disconnect due to a remote end call request or remote party failed to answer in time. |
| canceled | Disconnect due to a call was cancelled. |
| missed | Disconnect due to a incoming call was not answered in time. |
| rejected | Disconnect due to incoming call was rejected. |
| busy | Disconnect due to remote party being busy. |
| error | Disconnect due to an error. |
| unknown | Disconnect response is unknown. |
### Features
#### Call Management
CallKit provides a simple API to manage calls. The plugin provides methods to report incoming calls,
end calls, and update call information. Futher, inspiration is taken from Android's ConnectionService
providing a set of capabilities to manage calls, such as:
| Reason | Description |
|--------------|-------------------------------------------------------------|
| hold | Ability to place a call on hold after the call has started. |
| supportHold | Ability to place a call on hold from the start of the call. |
| mute | Ability to mute a call. |
##### Incoming Calls
Incoming calls are displayed on the screen with the caller's name and number. The call screen can be
customized with the caller's name, number, and profile picture.
```dart
WebCallKit.instance.reportNewCall(
uuid: '1234',
handle: 'John Doe',
);
```
#### Notification Integration
#### Capabilities
## Limitations / Future work
- Support video & desktop streaming natively