Intro
General Overview
Table of content πβ
- Description
- Features
- Installation
- Usage
- API
- Browser Support
- Known Issues
- Release Notes
- Further Help
- Versioning
Descriptionβ
This library is developed by the Docplanner Telemedicine team.
The main goal of this library is to provide a seamless integration of our teleconferencing solution to the Docplanner SaaS application, as well as to the software of our white label customers.
Once it is integrated, participants (doctors and patients) can join in the secure video calls based on the given appointment information. The video calls could be between a doctor and a patient, whereas it is also possible multiple participants to join in the video calls.
In addition to the standard teleconferencing features, it also provides extra capabilities such as End-to-End Encrypted File Sharing and Note-Taking.
Aiming to perform secure peer-to-peer teleconferencing, without requiring that the user install plug-ins or any other third-party software, the library utilizes Vonage Video API with its underlying WebRTC API.
The library was written with Angular CLI and supports Angular v13+.
There is also a custom element (web component) version built as a wrapper around Angular library and that supports JavaScript applications written with any frameworks other than Angular. The library packages are published to Patientus' private npm registry and could be installed only with provided credentials by Patientus.
How it worksβ
With the initialization of the library, a request is sent to the Telemedicine API (or to the wrapper API created by our backend SDK) via sessionApiEndpoint specified in the library configuration to fetch Vonage session credentials. Upon the request, API checks if the requested session with the unique identifier (participant token or appointment id) was already created. In case the session exists, API returns existing session credentials. Otherwise, before returning, it will first create the session in the Vonage cloud. After retrieval of session credentials, it attempts to connect to the session. When connection is established, it starts interacting with the session via a persistent event (or signaling) connection (WebSocket). At this point client is ready to initialize a WebRTC connection directly with other clients connected to the session. At last, upon a successful WebRTC connection between clients, they begin sending and receiving media streams.
In case of inability to connect directly to their peer, mostly because peers are located behind a firewall, media streams are transferred through TURN servers.
On the other hand, IP Proxy allows peers to hide their public IP address and not directly communicate with Vonage API by forwarding the requests through our custom server. Besides, the network restrictions scenario, while establishing peer-to-peer connections we encourage usage of TURN servers and IP Proxy in order to ensure a secure communication between participants.
Likewise, those are some requirements to obtain a data security certification for online service providers in Germany (See Datenschutz-GΓΌtesiegel ips).
Featuresβ
Core featuresβ
- 1-to-1 and multi-participant video calls
- Pre-join screen to adjust the camera and mic
- Network and audio/video quality tests
- In-call device settings with camera preview
- Screen sharing with participants
- Peer-to-peer sessions with custom TURN servers (relayed mode)
- Routed sessions via Vonage's Media Servers (routed mode)
- IP Proxy to forward Vonage API requests
Extra featuresβ
- End-to-End Encrypted File Sharing (1:1)
- E2EE File Sharing (Multi-user)
- Note Taking
- Multi-language translations
- In-call messaging with participants
Upcoming featuresβ
- Custom theming
- Adjustable layouts
- In-call appointment information
- Host controls for doctors
- Blurry and other video effects