# Formant Realtime SDK

A library for accessing realtime connections your Formant devices/fleet.

## Get Started

```bash
$ npm install --save @formant/realtime-sdk@latest

# or with

$ yarn add @formant/realtime-sdk@latest
```

## License

Distributed under the MIT License. See LICENSE.txt for more information.

## Changelog

### **1.3.0** - 2024-09-09

#### Fixed

-   Redact sensitive ICE credentials.

### **1.2.0** - 2023-08-18

#### Added

-   Exporting `IRtcPeer` and `RtcStreamType`.

### **1.1.0** - 2023-08-18

#### Fixed

-   Fixed debug logging level output.

### **1.0.0** - 2023-07-19

#### Added

-   Odometry over teleop
-   Add support for eventing on all event trigger types

#### Changed

-   Reduce ICE gathering timeout to 3s

#### Fixed

-   Workaround for lack of getConfiguration method on RTCPeerConnection
-   Project de-cycling
-   Fix Odom
-   Use previously implemented util for detecting STUN vs TURN
-   Partition connections in a single step…
-   Immediately eject a disconnected connection from the connection set
-   More cleanup on rtcClient shutdown
-   Record RTC connection type metric (host, relay, etc)
-   Make best-effort to _release_ the RtcPeerConnection on close
-   `isConnectionInitiator` never gets cleared, keeping RtcConnections alive
-   Add prettier plugin to deterministically sort import ordering
-   Dependency updates
-   Resolve realtime-sdk build warnings about re-exporting types