Skip to content

Commit 4bd48b6

Browse files
committed
Update README; browser support, encoding specs
1 parent 6e0aabb commit 4bd48b6

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
The SendBird Calls JavaScript SDK provides a framework to make and receive voice and video calls. “Direct calls” in the SDK refers to one-to-one calls, comparable to “direct messages” (DMs) in messaging services. To make a direct voice or video call, the caller specifies the user ID of the intended callee, and dials. Upon dialing, all of the callee’s authenticated devices will receive incoming call notifications. The callee then can choose to accept the call from any one of the devices. When the call is accepted, a connection is established between the caller and the callee. This marks the start of the direct call. Call participants may mute themselves, as well as select the audio and video hardware used in the call. Calls may be ended by either party. The SendBird Dashboard displays call logs in the Calls menu for application owners and admins to review.
1515

1616
## SDK Prerequisites
17-
* Modern browsers implementing WebRTC APIs are supported; IE is not.
17+
* [Modern browsers implementing WebRTC APIs](https://caniuse.com/#feat=rtcpeerconnection) are supported; IE is not.
1818
* Edge is not supported, though it might be supported later.
1919

2020
```javascript
@@ -331,6 +331,7 @@ The `SendBirdCall` object contains a collection of methods used to configure med
331331
|updateMediaDevices(constraints) | Manually update media devices |
332332

333333
The device specific-event handler also contains a collection of event listeners used to handle changes in media devices.
334+
334335
|Event Listener | Invocation criteria |
335336
|---------------|-------------|
336337
|onAudioInputDeviceChanged | audio input devices have changed |
@@ -433,3 +434,12 @@ Information relating the end result of a call can be obtained at any time via th
433434
|DIAL_FAILED | The dial() method call has failed. |
434435
|ACCEPT_FAILED | The accept() method call has failed.|
435436
|OTHER_DEVICE_ACCEPTED | The incoming call was accepted on a different device. This device received an incoming call notification, but the call ended when a different device accepted it.|
437+
438+
## Encoding Specs
439+
440+
| Category | Value | Note |
441+
|--------------------|--------|--------------------------|
442+
| Frames per Second | 24 fps | |
443+
| Maximum Resolution | 720p | 1280x720 px; standard HD |
444+
| Audio Codec | OPUS | |
445+
| Video Codec | VP8 | |

0 commit comments

Comments
 (0)