livekit-client 0.0.0-20250623161911

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (334) hide show
  1. package/LICENSE +175 -0
  2. package/README.md +413 -0
  3. package/dist/livekit-client.e2ee.worker.js +2 -0
  4. package/dist/livekit-client.e2ee.worker.js.map +1 -0
  5. package/dist/livekit-client.e2ee.worker.mjs +2069 -0
  6. package/dist/livekit-client.e2ee.worker.mjs.map +1 -0
  7. package/dist/livekit-client.esm.mjs +25665 -0
  8. package/dist/livekit-client.esm.mjs.map +1 -0
  9. package/dist/livekit-client.umd.js +2 -0
  10. package/dist/livekit-client.umd.js.map +1 -0
  11. package/dist/src/api/SignalClient.d.ts +116 -0
  12. package/dist/src/api/SignalClient.d.ts.map +1 -0
  13. package/dist/src/api/utils.d.ts +3 -0
  14. package/dist/src/api/utils.d.ts.map +1 -0
  15. package/dist/src/connectionHelper/ConnectionCheck.d.ts +29 -0
  16. package/dist/src/connectionHelper/ConnectionCheck.d.ts.map +1 -0
  17. package/dist/src/connectionHelper/checks/Checker.d.ts +62 -0
  18. package/dist/src/connectionHelper/checks/Checker.d.ts.map +1 -0
  19. package/dist/src/connectionHelper/checks/cloudRegion.d.ts +17 -0
  20. package/dist/src/connectionHelper/checks/cloudRegion.d.ts.map +1 -0
  21. package/dist/src/connectionHelper/checks/connectionProtocol.d.ts +19 -0
  22. package/dist/src/connectionHelper/checks/connectionProtocol.d.ts.map +1 -0
  23. package/dist/src/connectionHelper/checks/publishAudio.d.ts +6 -0
  24. package/dist/src/connectionHelper/checks/publishAudio.d.ts.map +1 -0
  25. package/dist/src/connectionHelper/checks/publishVideo.d.ts +7 -0
  26. package/dist/src/connectionHelper/checks/publishVideo.d.ts.map +1 -0
  27. package/dist/src/connectionHelper/checks/reconnect.d.ts +6 -0
  28. package/dist/src/connectionHelper/checks/reconnect.d.ts.map +1 -0
  29. package/dist/src/connectionHelper/checks/turn.d.ts +6 -0
  30. package/dist/src/connectionHelper/checks/turn.d.ts.map +1 -0
  31. package/dist/src/connectionHelper/checks/webrtc.d.ts +6 -0
  32. package/dist/src/connectionHelper/checks/webrtc.d.ts.map +1 -0
  33. package/dist/src/connectionHelper/checks/websocket.d.ts +6 -0
  34. package/dist/src/connectionHelper/checks/websocket.d.ts.map +1 -0
  35. package/dist/src/e2ee/E2eeManager.d.ts +60 -0
  36. package/dist/src/e2ee/E2eeManager.d.ts.map +1 -0
  37. package/dist/src/e2ee/KeyProvider.d.ts +50 -0
  38. package/dist/src/e2ee/KeyProvider.d.ts.map +1 -0
  39. package/dist/src/e2ee/constants.d.ts +16 -0
  40. package/dist/src/e2ee/constants.d.ts.map +1 -0
  41. package/dist/src/e2ee/errors.d.ts +12 -0
  42. package/dist/src/e2ee/errors.d.ts.map +1 -0
  43. package/dist/src/e2ee/events.d.ts +39 -0
  44. package/dist/src/e2ee/events.d.ts.map +1 -0
  45. package/dist/src/e2ee/index.d.ts +6 -0
  46. package/dist/src/e2ee/index.d.ts.map +1 -0
  47. package/dist/src/e2ee/types.d.ts +133 -0
  48. package/dist/src/e2ee/types.d.ts.map +1 -0
  49. package/dist/src/e2ee/utils.d.ts +27 -0
  50. package/dist/src/e2ee/utils.d.ts.map +1 -0
  51. package/dist/src/e2ee/worker/FrameCryptor.d.ts +184 -0
  52. package/dist/src/e2ee/worker/FrameCryptor.d.ts.map +1 -0
  53. package/dist/src/e2ee/worker/ParticipantKeyHandler.d.ts +83 -0
  54. package/dist/src/e2ee/worker/ParticipantKeyHandler.d.ts.map +1 -0
  55. package/dist/src/e2ee/worker/SifGuard.d.ts +11 -0
  56. package/dist/src/e2ee/worker/SifGuard.d.ts.map +1 -0
  57. package/dist/src/e2ee/worker/e2ee.worker.d.ts +2 -0
  58. package/dist/src/e2ee/worker/e2ee.worker.d.ts.map +1 -0
  59. package/dist/src/index.d.ts +51 -0
  60. package/dist/src/index.d.ts.map +1 -0
  61. package/dist/src/logger.d.ts +47 -0
  62. package/dist/src/logger.d.ts.map +1 -0
  63. package/dist/src/options.d.ts +104 -0
  64. package/dist/src/options.d.ts.map +1 -0
  65. package/dist/src/room/DefaultReconnectPolicy.d.ts +8 -0
  66. package/dist/src/room/DefaultReconnectPolicy.d.ts.map +1 -0
  67. package/dist/src/room/DeviceManager.d.ts +12 -0
  68. package/dist/src/room/DeviceManager.d.ts.map +1 -0
  69. package/dist/src/room/PCTransport.d.ts +71 -0
  70. package/dist/src/room/PCTransport.d.ts.map +1 -0
  71. package/dist/src/room/PCTransportManager.d.ts +56 -0
  72. package/dist/src/room/PCTransportManager.d.ts.map +1 -0
  73. package/dist/src/room/RTCEngine.d.ts +178 -0
  74. package/dist/src/room/RTCEngine.d.ts.map +1 -0
  75. package/dist/src/room/ReconnectPolicy.d.ts +24 -0
  76. package/dist/src/room/ReconnectPolicy.d.ts.map +1 -0
  77. package/dist/src/room/RegionUrlProvider.d.ts +18 -0
  78. package/dist/src/room/RegionUrlProvider.d.ts.map +1 -0
  79. package/dist/src/room/Room.d.ts +334 -0
  80. package/dist/src/room/Room.d.ts.map +1 -0
  81. package/dist/src/room/StreamReader.d.ts +56 -0
  82. package/dist/src/room/StreamReader.d.ts.map +1 -0
  83. package/dist/src/room/StreamWriter.d.ts +16 -0
  84. package/dist/src/room/StreamWriter.d.ts.map +1 -0
  85. package/dist/src/room/attribute-typings.d.ts +35 -0
  86. package/dist/src/room/attribute-typings.d.ts.map +1 -0
  87. package/dist/src/room/defaults.d.ts +9 -0
  88. package/dist/src/room/defaults.d.ts.map +1 -0
  89. package/dist/src/room/errors.d.ts +58 -0
  90. package/dist/src/room/errors.d.ts.map +1 -0
  91. package/dist/src/room/events.d.ts +610 -0
  92. package/dist/src/room/events.d.ts.map +1 -0
  93. package/dist/src/room/participant/LocalParticipant.d.ts +252 -0
  94. package/dist/src/room/participant/LocalParticipant.d.ts.map +1 -0
  95. package/dist/src/room/participant/Participant.d.ts +141 -0
  96. package/dist/src/room/participant/Participant.d.ts.map +1 -0
  97. package/dist/src/room/participant/ParticipantTrackPermission.d.ts +26 -0
  98. package/dist/src/room/participant/ParticipantTrackPermission.d.ts.map +1 -0
  99. package/dist/src/room/participant/RemoteParticipant.d.ts +58 -0
  100. package/dist/src/room/participant/RemoteParticipant.d.ts.map +1 -0
  101. package/dist/src/room/participant/publishUtils.d.ts +30 -0
  102. package/dist/src/room/participant/publishUtils.d.ts.map +1 -0
  103. package/dist/src/room/rpc.d.ts +96 -0
  104. package/dist/src/room/rpc.d.ts.map +1 -0
  105. package/dist/src/room/stats.d.ts +71 -0
  106. package/dist/src/room/stats.d.ts.map +1 -0
  107. package/dist/src/room/timers.d.ts +12 -0
  108. package/dist/src/room/timers.d.ts.map +1 -0
  109. package/dist/src/room/track/LocalAudioTrack.d.ts +41 -0
  110. package/dist/src/room/track/LocalAudioTrack.d.ts.map +1 -0
  111. package/dist/src/room/track/LocalTrack.d.ts +115 -0
  112. package/dist/src/room/track/LocalTrack.d.ts.map +1 -0
  113. package/dist/src/room/track/LocalTrackPublication.d.ts +42 -0
  114. package/dist/src/room/track/LocalTrackPublication.d.ts.map +1 -0
  115. package/dist/src/room/track/LocalVideoTrack.d.ts +65 -0
  116. package/dist/src/room/track/LocalVideoTrack.d.ts.map +1 -0
  117. package/dist/src/room/track/RemoteAudioTrack.d.ts +55 -0
  118. package/dist/src/room/track/RemoteAudioTrack.d.ts.map +1 -0
  119. package/dist/src/room/track/RemoteTrack.d.ts +35 -0
  120. package/dist/src/room/track/RemoteTrack.d.ts.map +1 -0
  121. package/dist/src/room/track/RemoteTrackPublication.d.ts +66 -0
  122. package/dist/src/room/track/RemoteTrackPublication.d.ts.map +1 -0
  123. package/dist/src/room/track/RemoteVideoTrack.d.ts +59 -0
  124. package/dist/src/room/track/RemoteVideoTrack.d.ts.map +1 -0
  125. package/dist/src/room/track/Track.d.ts +152 -0
  126. package/dist/src/room/track/Track.d.ts.map +1 -0
  127. package/dist/src/room/track/TrackPublication.d.ts +81 -0
  128. package/dist/src/room/track/TrackPublication.d.ts.map +1 -0
  129. package/dist/src/room/track/create.d.ts +25 -0
  130. package/dist/src/room/track/create.d.ts.map +1 -0
  131. package/dist/src/room/track/facingMode.d.ts +41 -0
  132. package/dist/src/room/track/facingMode.d.ts.map +1 -0
  133. package/dist/src/room/track/options.d.ts +355 -0
  134. package/dist/src/room/track/options.d.ts.map +1 -0
  135. package/dist/src/room/track/processor/types.d.ts +35 -0
  136. package/dist/src/room/track/processor/types.d.ts.map +1 -0
  137. package/dist/src/room/track/record.d.ts +13 -0
  138. package/dist/src/room/track/record.d.ts.map +1 -0
  139. package/dist/src/room/track/types.d.ts +28 -0
  140. package/dist/src/room/track/types.d.ts.map +1 -0
  141. package/dist/src/room/track/utils.d.ts +45 -0
  142. package/dist/src/room/track/utils.d.ts.map +1 -0
  143. package/dist/src/room/types.d.ts +94 -0
  144. package/dist/src/room/types.d.ts.map +1 -0
  145. package/dist/src/room/utils.d.ts +122 -0
  146. package/dist/src/room/utils.d.ts.map +1 -0
  147. package/dist/src/test/MockMediaStreamTrack.d.ts +26 -0
  148. package/dist/src/test/MockMediaStreamTrack.d.ts.map +1 -0
  149. package/dist/src/test/mocks.d.ts +12 -0
  150. package/dist/src/test/mocks.d.ts.map +1 -0
  151. package/dist/src/utils/AsyncQueue.d.ts +23 -0
  152. package/dist/src/utils/AsyncQueue.d.ts.map +1 -0
  153. package/dist/src/utils/browserParser.d.ts +13 -0
  154. package/dist/src/utils/browserParser.d.ts.map +1 -0
  155. package/dist/src/utils/cloneDeep.d.ts +2 -0
  156. package/dist/src/utils/cloneDeep.d.ts.map +1 -0
  157. package/dist/src/utils/dataPacketBuffer.d.ts +15 -0
  158. package/dist/src/utils/dataPacketBuffer.d.ts.map +1 -0
  159. package/dist/src/utils/ttlmap.d.ts +20 -0
  160. package/dist/src/utils/ttlmap.d.ts.map +1 -0
  161. package/dist/src/version.d.ts +3 -0
  162. package/dist/src/version.d.ts.map +1 -0
  163. package/dist/ts4.2/src/api/SignalClient.d.ts +119 -0
  164. package/dist/ts4.2/src/api/utils.d.ts +3 -0
  165. package/dist/ts4.2/src/connectionHelper/ConnectionCheck.d.ts +29 -0
  166. package/dist/ts4.2/src/connectionHelper/checks/Checker.d.ts +62 -0
  167. package/dist/ts4.2/src/connectionHelper/checks/cloudRegion.d.ts +18 -0
  168. package/dist/ts4.2/src/connectionHelper/checks/connectionProtocol.d.ts +20 -0
  169. package/dist/ts4.2/src/connectionHelper/checks/publishAudio.d.ts +6 -0
  170. package/dist/ts4.2/src/connectionHelper/checks/publishVideo.d.ts +7 -0
  171. package/dist/ts4.2/src/connectionHelper/checks/reconnect.d.ts +6 -0
  172. package/dist/ts4.2/src/connectionHelper/checks/turn.d.ts +6 -0
  173. package/dist/ts4.2/src/connectionHelper/checks/webrtc.d.ts +6 -0
  174. package/dist/ts4.2/src/connectionHelper/checks/websocket.d.ts +6 -0
  175. package/dist/ts4.2/src/e2ee/E2eeManager.d.ts +60 -0
  176. package/dist/ts4.2/src/e2ee/KeyProvider.d.ts +50 -0
  177. package/dist/ts4.2/src/e2ee/constants.d.ts +16 -0
  178. package/dist/ts4.2/src/e2ee/errors.d.ts +12 -0
  179. package/dist/ts4.2/src/e2ee/events.d.ts +39 -0
  180. package/dist/ts4.2/src/e2ee/index.d.ts +6 -0
  181. package/dist/ts4.2/src/e2ee/types.d.ts +133 -0
  182. package/dist/ts4.2/src/e2ee/utils.d.ts +27 -0
  183. package/dist/ts4.2/src/e2ee/worker/FrameCryptor.d.ts +184 -0
  184. package/dist/ts4.2/src/e2ee/worker/ParticipantKeyHandler.d.ts +83 -0
  185. package/dist/ts4.2/src/e2ee/worker/SifGuard.d.ts +11 -0
  186. package/dist/ts4.2/src/e2ee/worker/e2ee.worker.d.ts +2 -0
  187. package/dist/ts4.2/src/index.d.ts +52 -0
  188. package/dist/ts4.2/src/logger.d.ts +47 -0
  189. package/dist/ts4.2/src/options.d.ts +104 -0
  190. package/dist/ts4.2/src/room/DefaultReconnectPolicy.d.ts +8 -0
  191. package/dist/ts4.2/src/room/DeviceManager.d.ts +12 -0
  192. package/dist/ts4.2/src/room/PCTransport.d.ts +73 -0
  193. package/dist/ts4.2/src/room/PCTransportManager.d.ts +56 -0
  194. package/dist/ts4.2/src/room/RTCEngine.d.ts +179 -0
  195. package/dist/ts4.2/src/room/ReconnectPolicy.d.ts +24 -0
  196. package/dist/ts4.2/src/room/RegionUrlProvider.d.ts +18 -0
  197. package/dist/ts4.2/src/room/Room.d.ts +334 -0
  198. package/dist/ts4.2/src/room/StreamReader.d.ts +56 -0
  199. package/dist/ts4.2/src/room/StreamWriter.d.ts +16 -0
  200. package/dist/ts4.2/src/room/attribute-typings.d.ts +35 -0
  201. package/dist/ts4.2/src/room/defaults.d.ts +9 -0
  202. package/dist/ts4.2/src/room/errors.d.ts +58 -0
  203. package/dist/ts4.2/src/room/events.d.ts +610 -0
  204. package/dist/ts4.2/src/room/participant/LocalParticipant.d.ts +252 -0
  205. package/dist/ts4.2/src/room/participant/Participant.d.ts +142 -0
  206. package/dist/ts4.2/src/room/participant/ParticipantTrackPermission.d.ts +26 -0
  207. package/dist/ts4.2/src/room/participant/RemoteParticipant.d.ts +58 -0
  208. package/dist/ts4.2/src/room/participant/publishUtils.d.ts +30 -0
  209. package/dist/ts4.2/src/room/rpc.d.ts +96 -0
  210. package/dist/ts4.2/src/room/stats.d.ts +71 -0
  211. package/dist/ts4.2/src/room/timers.d.ts +12 -0
  212. package/dist/ts4.2/src/room/track/LocalAudioTrack.d.ts +41 -0
  213. package/dist/ts4.2/src/room/track/LocalTrack.d.ts +115 -0
  214. package/dist/ts4.2/src/room/track/LocalTrackPublication.d.ts +42 -0
  215. package/dist/ts4.2/src/room/track/LocalVideoTrack.d.ts +65 -0
  216. package/dist/ts4.2/src/room/track/RemoteAudioTrack.d.ts +55 -0
  217. package/dist/ts4.2/src/room/track/RemoteTrack.d.ts +35 -0
  218. package/dist/ts4.2/src/room/track/RemoteTrackPublication.d.ts +66 -0
  219. package/dist/ts4.2/src/room/track/RemoteVideoTrack.d.ts +59 -0
  220. package/dist/ts4.2/src/room/track/Track.d.ts +152 -0
  221. package/dist/ts4.2/src/room/track/TrackPublication.d.ts +81 -0
  222. package/dist/ts4.2/src/room/track/create.d.ts +25 -0
  223. package/dist/ts4.2/src/room/track/facingMode.d.ts +41 -0
  224. package/dist/ts4.2/src/room/track/options.d.ts +363 -0
  225. package/dist/ts4.2/src/room/track/processor/types.d.ts +35 -0
  226. package/dist/ts4.2/src/room/track/record.d.ts +13 -0
  227. package/dist/ts4.2/src/room/track/types.d.ts +28 -0
  228. package/dist/ts4.2/src/room/track/utils.d.ts +45 -0
  229. package/dist/ts4.2/src/room/types.d.ts +94 -0
  230. package/dist/ts4.2/src/room/utils.d.ts +122 -0
  231. package/dist/ts4.2/src/test/MockMediaStreamTrack.d.ts +26 -0
  232. package/dist/ts4.2/src/test/mocks.d.ts +12 -0
  233. package/dist/ts4.2/src/utils/AsyncQueue.d.ts +23 -0
  234. package/dist/ts4.2/src/utils/browserParser.d.ts +13 -0
  235. package/dist/ts4.2/src/utils/cloneDeep.d.ts +2 -0
  236. package/dist/ts4.2/src/utils/dataPacketBuffer.d.ts +15 -0
  237. package/dist/ts4.2/src/utils/ttlmap.d.ts +20 -0
  238. package/dist/ts4.2/src/version.d.ts +3 -0
  239. package/package.json +109 -0
  240. package/src/api/SignalClient.ts +954 -0
  241. package/src/api/utils.test.ts +119 -0
  242. package/src/api/utils.ts +23 -0
  243. package/src/connectionHelper/ConnectionCheck.ts +108 -0
  244. package/src/connectionHelper/checks/Checker.ts +196 -0
  245. package/src/connectionHelper/checks/cloudRegion.ts +94 -0
  246. package/src/connectionHelper/checks/connectionProtocol.ts +149 -0
  247. package/src/connectionHelper/checks/publishAudio.ts +44 -0
  248. package/src/connectionHelper/checks/publishVideo.ts +89 -0
  249. package/src/connectionHelper/checks/reconnect.ts +48 -0
  250. package/src/connectionHelper/checks/turn.ts +55 -0
  251. package/src/connectionHelper/checks/webrtc.ts +84 -0
  252. package/src/connectionHelper/checks/websocket.ts +28 -0
  253. package/src/e2ee/E2eeManager.ts +451 -0
  254. package/src/e2ee/KeyProvider.ts +105 -0
  255. package/src/e2ee/constants.ts +43 -0
  256. package/src/e2ee/errors.ts +23 -0
  257. package/src/e2ee/events.ts +57 -0
  258. package/src/e2ee/index.ts +5 -0
  259. package/src/e2ee/types.ts +172 -0
  260. package/src/e2ee/utils.ts +178 -0
  261. package/src/e2ee/worker/FrameCryptor.test.ts +464 -0
  262. package/src/e2ee/worker/FrameCryptor.ts +759 -0
  263. package/src/e2ee/worker/ParticipantKeyHandler.test.ts +386 -0
  264. package/src/e2ee/worker/ParticipantKeyHandler.ts +208 -0
  265. package/src/e2ee/worker/SifGuard.ts +47 -0
  266. package/src/e2ee/worker/__snapshots__/ParticipantKeyHandler.test.ts.snap +356 -0
  267. package/src/e2ee/worker/e2ee.worker.ts +275 -0
  268. package/src/e2ee/worker/tsconfig.json +14 -0
  269. package/src/index.ts +136 -0
  270. package/src/logger.ts +94 -0
  271. package/src/options.ts +128 -0
  272. package/src/room/DefaultReconnectPolicy.ts +35 -0
  273. package/src/room/DeviceManager.test.ts +105 -0
  274. package/src/room/DeviceManager.ts +114 -0
  275. package/src/room/PCTransport.ts +674 -0
  276. package/src/room/PCTransportManager.ts +373 -0
  277. package/src/room/RTCEngine.ts +1602 -0
  278. package/src/room/ReconnectPolicy.ts +27 -0
  279. package/src/room/RegionUrlProvider.ts +89 -0
  280. package/src/room/Room.test.ts +30 -0
  281. package/src/room/Room.ts +2737 -0
  282. package/src/room/StreamReader.ts +170 -0
  283. package/src/room/StreamWriter.ts +32 -0
  284. package/src/room/attribute-typings.ts +61 -0
  285. package/src/room/defaults.ts +52 -0
  286. package/src/room/errors.ts +139 -0
  287. package/src/room/events.ts +695 -0
  288. package/src/room/participant/LocalParticipant.ts +2485 -0
  289. package/src/room/participant/Participant.ts +438 -0
  290. package/src/room/participant/ParticipantTrackPermission.ts +42 -0
  291. package/src/room/participant/RemoteParticipant.ts +386 -0
  292. package/src/room/participant/publishUtils.test.ts +189 -0
  293. package/src/room/participant/publishUtils.ts +479 -0
  294. package/src/room/rpc.test.ts +301 -0
  295. package/src/room/rpc.ts +172 -0
  296. package/src/room/stats.ts +144 -0
  297. package/src/room/timers.ts +25 -0
  298. package/src/room/track/LocalAudioTrack.ts +253 -0
  299. package/src/room/track/LocalTrack.ts +642 -0
  300. package/src/room/track/LocalTrackPublication.ts +127 -0
  301. package/src/room/track/LocalVideoTrack.test.ts +133 -0
  302. package/src/room/track/LocalVideoTrack.ts +692 -0
  303. package/src/room/track/RemoteAudioTrack.ts +263 -0
  304. package/src/room/track/RemoteTrack.ts +142 -0
  305. package/src/room/track/RemoteTrackPublication.ts +323 -0
  306. package/src/room/track/RemoteVideoTrack.test.ts +152 -0
  307. package/src/room/track/RemoteVideoTrack.ts +435 -0
  308. package/src/room/track/Track.ts +533 -0
  309. package/src/room/track/TrackPublication.ts +183 -0
  310. package/src/room/track/create.ts +225 -0
  311. package/src/room/track/facingMode.test.ts +31 -0
  312. package/src/room/track/facingMode.ts +104 -0
  313. package/src/room/track/options.ts +501 -0
  314. package/src/room/track/processor/types.ts +40 -0
  315. package/src/room/track/record.ts +75 -0
  316. package/src/room/track/types.ts +30 -0
  317. package/src/room/track/utils.test.ts +137 -0
  318. package/src/room/track/utils.ts +331 -0
  319. package/src/room/types.ts +123 -0
  320. package/src/room/utils.test.ts +62 -0
  321. package/src/room/utils.ts +682 -0
  322. package/src/room/worker.d.ts +4 -0
  323. package/src/test/MockMediaStreamTrack.ts +84 -0
  324. package/src/test/mocks.ts +23 -0
  325. package/src/type-polyfills/document-pip.d.ts +12 -0
  326. package/src/utils/AsyncQueue.test.ts +100 -0
  327. package/src/utils/AsyncQueue.ts +57 -0
  328. package/src/utils/browserParser.test.ts +92 -0
  329. package/src/utils/browserParser.ts +84 -0
  330. package/src/utils/cloneDeep.test.ts +54 -0
  331. package/src/utils/cloneDeep.ts +15 -0
  332. package/src/utils/dataPacketBuffer.ts +52 -0
  333. package/src/utils/ttlmap.ts +96 -0
  334. package/src/version.ts +4 -0
package/LICENSE ADDED
@@ -0,0 +1,175 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
package/README.md ADDED
@@ -0,0 +1,413 @@
1
+ <!--BEGIN_BANNER_IMAGE-->
2
+
3
+ <picture>
4
+ <source media="(prefers-color-scheme: dark)" srcset="/.github/banner_dark.png">
5
+ <source media="(prefers-color-scheme: light)" srcset="/.github/banner_light.png">
6
+ <img style="width:100%;" alt="The LiveKit icon, the name of the repository and some sample code in the background." src="https://raw.githubusercontent.com/livekit/client-sdk-js/main/.github/banner_light.png">
7
+ </picture>
8
+
9
+ <!--END_BANNER_IMAGE-->
10
+
11
+ # JavaScript/TypeScript client SDK for LiveKit
12
+
13
+ <!--BEGIN_DESCRIPTION-->
14
+ Use this SDK to add realtime video, audio and data features to your JavaScript/TypeScript app. By connecting to <a href="https://livekit.io/">LiveKit</a> Cloud or a self-hosted server, you can quickly build applications such as multi-modal AI, live streaming, or video calls with just a few lines of code.
15
+ <!--END_DESCRIPTION-->
16
+
17
+ ## Docs
18
+
19
+ Docs and guides at [https://docs.livekit.io](https://docs.livekit.io)
20
+
21
+ [SDK reference](https://docs.livekit.io/client-sdk-js/)
22
+
23
+ > [!NOTE]
24
+ > This is v2 of `livekit-client`. When migrating from v1.x to v2.x you might encounter a small set of breaking changes.
25
+ > Read the [migration guide](https://docs.livekit.io/recipes/migrate-from-v1/) for a detailed overview of what has changed.
26
+
27
+ ## Installation
28
+
29
+ ### Yarn
30
+
31
+ ```shell
32
+ yarn add livekit-client
33
+ ```
34
+
35
+ ### NPM
36
+
37
+ ```shell
38
+ npm install livekit-client --save
39
+ ```
40
+
41
+ ### Minified JS
42
+
43
+ To use the SDK without a package manager, you can include it with a script tag:
44
+
45
+ ```html
46
+ <script src="https://cdn.jsdelivr.net/npm/livekit-client/dist/livekit-client.umd.min.js"></script>
47
+ ```
48
+
49
+ The module will be exported under `LivekitClient` in the global namespace. When
50
+ accessing symbols from the class, you'd need to prefix them with `LivekitClient.`.
51
+ For example, `Room` becomes `LivekitClient.Room`.
52
+
53
+ ## Usage
54
+
55
+ Examples below are in TypeScript, if using JS/CommonJS imports replace import with:
56
+
57
+ ```javascript
58
+ const livekit = require('livekit-client');
59
+
60
+ const room = new livekit.Room(...);
61
+
62
+ // call this some time before actually connecting to speed up the actual connection
63
+ room.prepareConnection(url, token);
64
+
65
+ await room.connect(...);
66
+ ```
67
+
68
+ ### Connecting to a room, publish video & audio
69
+
70
+ ```typescript
71
+ import {
72
+ LocalParticipant,
73
+ LocalTrackPublication,
74
+ Participant,
75
+ RemoteParticipant,
76
+ RemoteTrack,
77
+ RemoteTrackPublication,
78
+ Room,
79
+ RoomEvent,
80
+ Track,
81
+ VideoPresets,
82
+ } from 'livekit-client';
83
+
84
+ // creates a new room with options
85
+ const room = new Room({
86
+ // automatically manage subscribed video quality
87
+ adaptiveStream: true,
88
+
89
+ // optimize publishing bandwidth and CPU for published tracks
90
+ dynacast: true,
91
+
92
+ // default capture settings
93
+ videoCaptureDefaults: {
94
+ resolution: VideoPresets.h720.resolution,
95
+ },
96
+ });
97
+
98
+ // pre-warm connection, this can be called as early as your page is loaded
99
+ room.prepareConnection(url, token);
100
+
101
+ // set up event listeners
102
+ room
103
+ .on(RoomEvent.TrackSubscribed, handleTrackSubscribed)
104
+ .on(RoomEvent.TrackUnsubscribed, handleTrackUnsubscribed)
105
+ .on(RoomEvent.ActiveSpeakersChanged, handleActiveSpeakerChange)
106
+ .on(RoomEvent.Disconnected, handleDisconnect)
107
+ .on(RoomEvent.LocalTrackUnpublished, handleLocalTrackUnpublished);
108
+
109
+ // connect to room
110
+ await room.connect('ws://localhost:7800', token);
111
+ console.log('connected to room', room.name);
112
+
113
+ // publish local camera and mic tracks
114
+ await room.localParticipant.enableCameraAndMicrophone();
115
+
116
+ function handleTrackSubscribed(
117
+ track: RemoteTrack,
118
+ publication: RemoteTrackPublication,
119
+ participant: RemoteParticipant,
120
+ ) {
121
+ if (track.kind === Track.Kind.Video || track.kind === Track.Kind.Audio) {
122
+ // attach it to a new HTMLVideoElement or HTMLAudioElement
123
+ const element = track.attach();
124
+ parentElement.appendChild(element);
125
+ }
126
+ }
127
+
128
+ function handleTrackUnsubscribed(
129
+ track: RemoteTrack,
130
+ publication: RemoteTrackPublication,
131
+ participant: RemoteParticipant,
132
+ ) {
133
+ // remove tracks from all attached elements
134
+ track.detach();
135
+ }
136
+
137
+ function handleLocalTrackUnpublished(
138
+ publication: LocalTrackPublication,
139
+ participant: LocalParticipant,
140
+ ) {
141
+ // when local tracks are ended, update UI to remove them from rendering
142
+ publication.track.detach();
143
+ }
144
+
145
+ function handleActiveSpeakerChange(speakers: Participant[]) {
146
+ // show UI indicators when participant is speaking
147
+ }
148
+
149
+ function handleDisconnect() {
150
+ console.log('disconnected from room');
151
+ }
152
+ ```
153
+
154
+ In order to connect to a room, you need to first create an access token.
155
+
156
+ See [authentication docs](https://docs.livekit.io/home/get-started/authentication/) for details
157
+
158
+ ### Handling common track types
159
+
160
+ While LiveKit is designed to be flexible, we've added a few shortcuts that makes working with common track types simple. For a user's camera, microphone, and screen share, you can enable them with the following `LocalParticipant` methods:
161
+
162
+ ```typescript
163
+ const p = room.localParticipant;
164
+ // turn on the local user's camera and mic, this may trigger a browser prompt
165
+ // to ensure permissions are granted
166
+ await p.setCameraEnabled(true);
167
+ await p.setMicrophoneEnabled(true);
168
+
169
+ // start sharing the user's screen, this will trigger a browser prompt to select
170
+ // the screen to share.
171
+ await p.setScreenShareEnabled(true);
172
+
173
+ // disable camera to mute them, when muted, the user's camera indicator will be turned off
174
+ await p.setCameraEnabled(false);
175
+ ```
176
+
177
+ Similarly, you can access these common track types on the other participants' end.
178
+
179
+ ```typescript
180
+ // get a RemoteParticipant by their identity
181
+ const p = room.remoteParticipants.get('participant-identity');
182
+ if (p) {
183
+ // if the other user has enabled their camera, attach it to a new HTMLVideoElement
184
+ if (p.isCameraEnabled) {
185
+ const publication = p.getTrackPublication(Track.Source.Camera);
186
+ if (publication?.isSubscribed) {
187
+ const videoElement = publication.videoTrack?.attach();
188
+ // do something with the element
189
+ }
190
+ }
191
+ }
192
+ ```
193
+
194
+ ### Creating a track prior to creating a room
195
+
196
+ In some cases, it may be useful to create a track before creating a room. For
197
+ example, when building a staging area so the user may check their own camera.
198
+
199
+ You can use our global track creation functions for this:
200
+
201
+ ```typescript
202
+ const tracks = await createLocalTracks({
203
+ audio: true,
204
+ video: true,
205
+ });
206
+ ```
207
+
208
+ ### Publish tracks from any source
209
+
210
+ LiveKit lets you publish any track as long as it can be represented by a MediaStreamTrack. You can specify a name on the track in order to identify it later.
211
+
212
+ ```typescript
213
+ const pub = await room.localParticipant.publishTrack(mediaStreamTrack, {
214
+ name: 'mytrack',
215
+ simulcast: true,
216
+ // if this should be treated like a camera feed, tag it as such
217
+ // supported known sources are .Camera, .Microphone, .ScreenShare
218
+ source: Track.Source.Camera,
219
+ });
220
+
221
+ // you may mute or unpublish the track later
222
+ pub.setMuted(true);
223
+
224
+ room.localParticipant.unpublishTrack(mediaStreamTrack);
225
+ ```
226
+
227
+ ### Device management APIs
228
+
229
+ Users may have multiple input and output devices available. LiveKit will automatically use the one that's deemed as the `default` device on the system. You may also list and specify an alternative device to use.
230
+
231
+ We use the same deviceId as one returned by [MediaDevices.enumerateDevices()](https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/enumerateDevices).
232
+
233
+ #### Example listing and selecting a camera device
234
+
235
+ ```typescript
236
+ // list all microphone devices
237
+ const devices = await Room.getLocalDevices('audioinput');
238
+
239
+ // select last device
240
+ const device = devices[devices.length - 1];
241
+
242
+ // in the current room, switch to the selected device and set
243
+ // it as default audioinput in the future.
244
+ await room.switchActiveDevice('audioinput', device.deviceId);
245
+ ```
246
+
247
+ You can also switch devices given a constraint. This could be useful on mobile devices to switch to a back-facing camera:
248
+
249
+ ```typescript
250
+ await videoTrack.restartTrack({
251
+ facingMode: 'environment',
252
+ });
253
+ ```
254
+
255
+ #### Handling device failures
256
+
257
+ When creating tracks using LiveKit APIs (`connect`, `createLocalTracks`, `setCameraEnabled`, etc), it's possible to encounter errors with the underlying media device. In those cases, LiveKit will emit `RoomEvent.MediaDevicesError`.
258
+
259
+ You can use the helper `MediaDeviceFailure.getFailure(error)` to determine specific reason for the error.
260
+
261
+ - `PermissionDenied` - the user disallowed capturing devices
262
+ - `NotFound` - the particular device isn't available
263
+ - `DeviceInUse` - device is in use by another process (happens on Windows)
264
+
265
+ These distinctions enables you to provide more specific messaging to the user.
266
+
267
+ You could also retrieve the last error with `LocalParticipant.lastCameraError` and `LocalParticipant.lastMicrophoneError`.
268
+
269
+ ### Audio playback
270
+
271
+ Browsers can be restrictive with regards to audio playback that is not initiated by user interaction. What each browser considers as user interaction can vary by vendor (for example, Safari on iOS is very restrictive).
272
+
273
+ LiveKit will attempt to autoplay all audio tracks when you attach them to audio elements. However, if that fails, we'll notify you via `RoomEvent.AudioPlaybackStatusChanged`. `Room.canPlaybackAudio` will indicate if audio playback is permitted. LiveKit takes an optimistic approach so it's possible for this value to change from `true` to `false` when we encounter a browser error.
274
+
275
+ In the case user interaction is required, LiveKit provides `Room.startAudio` to start audio playback. This function must be triggered in an onclick or ontap event handler. In the same session, once audio playback is successful, additional audio tracks can be played without further user interactions.
276
+
277
+ ```typescript
278
+ room.on(RoomEvent.AudioPlaybackStatusChanged, () => {
279
+ if (!room.canPlaybackAudio) {
280
+ // UI is necessary.
281
+ ...
282
+ button.onclick = () => {
283
+ // startAudio *must* be called in an click/tap handler.
284
+ room.startAudio().then(() => {
285
+ // successful, UI can be removed now
286
+ button.remove();
287
+ });
288
+ }
289
+ }
290
+ });
291
+ ```
292
+
293
+ ### Configuring logging
294
+
295
+ This library uses [loglevel](https://github.com/pimterry/loglevel) for its internal logs. You can change the effective log level with the `logLevel` field in `ConnectOptions`.
296
+ The method `setLogExtension` allows to hook into the livekit internal logs and send them to some third party logging service
297
+
298
+ ```ts
299
+ setLogExtension((level: LogLevel, msg: string, context: object) => {
300
+ const enhancedContext = { ...context, timeStamp: Date.now() };
301
+ if (level >= LogLevel.debug) {
302
+ console.log(level, msg, enhancedContext);
303
+ }
304
+ });
305
+ ```
306
+
307
+ ### RPC
308
+
309
+ Perform your own predefined method calls from one participant to another.
310
+
311
+ This feature is especially powerful when used with [Agents](https://docs.livekit.io/agents), for instance to forward LLM function calls to your client application.
312
+
313
+ #### Registering an RPC method
314
+
315
+ The participant who implements the method and will receive its calls must first register support:
316
+
317
+ ```typescript
318
+ room.localParticipant?.registerRpcMethod(
319
+ // method name - can be any string that makes sense for your application
320
+ 'greet',
321
+
322
+ // method handler - will be called when the method is invoked by a RemoteParticipant
323
+ async (data: RpcInvocationData) => {
324
+ console.log(`Received greeting from ${data.callerIdentity}: ${data.payload}`);
325
+ return `Hello, ${data.callerIdentity}!`;
326
+ },
327
+ );
328
+ ```
329
+
330
+ In addition to the payload, your handler will also receive `responseTimeout`, which informs you the maximum time available to return a response. If you are unable to respond in time, the call will result in an error on the caller's side.
331
+
332
+ #### Performing an RPC request
333
+
334
+ The caller may then initiate an RPC call like so:
335
+
336
+ ```typescript
337
+ try {
338
+ const response = await room.localParticipant!.performRpc({
339
+ destinationIdentity: 'recipient-identity',
340
+ method: 'greet',
341
+ payload: 'Hello from RPC!',
342
+ });
343
+ console.log('RPC response:', response);
344
+ } catch (error) {
345
+ console.error('RPC call failed:', error);
346
+ }
347
+ ```
348
+
349
+ You may find it useful to adjust the `responseTimeout` parameter, which indicates the amount of time you will wait for a response. We recommend keeping this value as low as possible while still satisfying the constraints of your application.
350
+
351
+ #### Errors
352
+
353
+ LiveKit is a dynamic realtime environment and calls can fail for various reasons.
354
+
355
+ You may throw errors of the type `RpcError` with a string `message` in an RPC method handler and they will be received on the caller's side with the message intact. Other errors will not be transmitted and will instead arrive to the caller as `1500` ("Application Error"). Other built-in errors are detailed in `RpcError`.
356
+
357
+ ## Error Codes
358
+
359
+ | Code | Name | Reason |
360
+ | ----- | --------------------------- | ------------------ |
361
+ | 1 | `ConnectionError` | 0: `NotAllowed`<br>1: `ServerUnreachable`<br>2: `InternalError`<br>3: `Cancelled`<br>4:`LeaveRequest` |
362
+ | 10 | `UnsupportedServer` | |
363
+ | 12 | `UnexpectedConnectionState` | |
364
+ | 13 | `NegotiationError` | |
365
+ | 14 | `PublishDataError` | |
366
+ | 15 | `SignalRequestError` | |
367
+ | 20 | `TrackInvalidError` | |
368
+ | 21 | `DeviceUnsupportedError` | |
369
+ | 40 | `CryptorError` | |
370
+
371
+ ## Examples
372
+
373
+ ### Demo App
374
+
375
+ [examples/demo](examples/demo/) contains a demo webapp that uses the SDK. Run it with `pnpm install && pnpm examples:demo`
376
+
377
+ ### RPC Demo
378
+
379
+ [examples/rpc](examples/rpc/) contains a demo webapp that uses the SDK to showcase the RPC capabilities. Run it with `pnpm install && pnpm dev` from the `examples/rpc` directory.
380
+
381
+ ## Browser Support
382
+
383
+ | Browser | Desktop OS | Mobile OS |
384
+ | --------------- | --------------------- | --------- |
385
+ | Chrome | Windows, macOS, Linux | Android |
386
+ | Firefox | Windows, macOS, Linux | Android |
387
+ | Safari | macOS | iOS |
388
+ | Edge (Chromium) | Windows, macOS | |
389
+
390
+ We aim to support a broad range of browser versions by transpiling the library code with babel.
391
+ You can have a look at the `"browerslist"` section of `package.json` for more details.
392
+
393
+ > Note that the library requires some specific browser APIs to be present.
394
+ > You can check general compatibility with the helper function `isBrowserSupported()`.
395
+ > Support for more modern features like adaptiveStream and dynacast can be checked for with `supportsAdaptiveStream()` and `supportsDynacast()`.
396
+
397
+ If you are targeting legacy browsers, but still want adaptiveStream functionality you'll likely need to use polyfills for [ResizeObserver](https://www.npmjs.com/package/resize-observer-polyfill) and [IntersectionObserver](https://www.npmjs.com/package/intersection-observer).
398
+
399
+ Also when targeting legacy browsers, older than the ones specified in our browserslist target, make sure to transpile the library code to your desired target and include required polyfills with babel and/or corejs.
400
+
401
+ <!--BEGIN_REPO_NAV-->
402
+ <br/><table>
403
+ <thead><tr><th colspan="2">LiveKit Ecosystem</th></tr></thead>
404
+ <tbody>
405
+ <tr><td>LiveKit SDKs</td><td><b>Browser</b> · <a href="https://github.com/livekit/client-sdk-swift">iOS/macOS/visionOS</a> · <a href="https://github.com/livekit/client-sdk-android">Android</a> · <a href="https://github.com/livekit/client-sdk-flutter">Flutter</a> · <a href="https://github.com/livekit/client-sdk-react-native">React Native</a> · <a href="https://github.com/livekit/rust-sdks">Rust</a> · <a href="https://github.com/livekit/node-sdks">Node.js</a> · <a href="https://github.com/livekit/python-sdks">Python</a> · <a href="https://github.com/livekit/client-sdk-unity">Unity</a> · <a href="https://github.com/livekit/client-sdk-unity-web">Unity (WebGL)</a></td></tr><tr></tr>
406
+ <tr><td>Server APIs</td><td><a href="https://github.com/livekit/node-sdks">Node.js</a> · <a href="https://github.com/livekit/server-sdk-go">Golang</a> · <a href="https://github.com/livekit/server-sdk-ruby">Ruby</a> · <a href="https://github.com/livekit/server-sdk-kotlin">Java/Kotlin</a> · <a href="https://github.com/livekit/python-sdks">Python</a> · <a href="https://github.com/livekit/rust-sdks">Rust</a> · <a href="https://github.com/agence104/livekit-server-sdk-php">PHP (community)</a> · <a href="https://github.com/pabloFuente/livekit-server-sdk-dotnet">.NET (community)</a></td></tr><tr></tr>
407
+ <tr><td>UI Components</td><td><a href="https://github.com/livekit/components-js">React</a> · <a href="https://github.com/livekit/components-android">Android Compose</a> · <a href="https://github.com/livekit/components-swift">SwiftUI</a></td></tr><tr></tr>
408
+ <tr><td>Agents Frameworks</td><td><a href="https://github.com/livekit/agents">Python</a> · <a href="https://github.com/livekit/agents-js">Node.js</a> · <a href="https://github.com/livekit/agent-playground">Playground</a></td></tr><tr></tr>
409
+ <tr><td>Services</td><td><a href="https://github.com/livekit/livekit">LiveKit server</a> · <a href="https://github.com/livekit/egress">Egress</a> · <a href="https://github.com/livekit/ingress">Ingress</a> · <a href="https://github.com/livekit/sip">SIP</a></td></tr><tr></tr>
410
+ <tr><td>Resources</td><td><a href="https://docs.livekit.io">Docs</a> · <a href="https://github.com/livekit-examples">Example apps</a> · <a href="https://livekit.io/cloud">Cloud</a> · <a href="https://docs.livekit.io/home/self-hosting/deployment">Self-hosting</a> · <a href="https://github.com/livekit/livekit-cli">CLI</a></td></tr>
411
+ </tbody>
412
+ </table>
413
+ <!--END_REPO_NAV-->
@@ -0,0 +1,2 @@
1
+ !function(e){"function"==typeof define&&define.amd?define(e):e()}((function(){"use strict";function e(e,t,n,r){return new(n||(n=Promise))((function(i,o){function s(e){try{c(r.next(e))}catch(e){o(e)}}function a(e){try{c(r.throw(e))}catch(e){o(e)}}function c(e){var t;e.done?i(e.value):(t=e.value,t instanceof n?t:new n((function(e){e(t)}))).then(s,a)}c((r=r.apply(e,t||[])).next())}))}"function"==typeof SuppressedError&&SuppressedError;var t,n={exports:{}};var r,i,o,s,a,c=(t||(t=1,i=n.exports,o=function(){var e=function(){},t="undefined",n=typeof window!==t&&typeof window.navigator!==t&&/Trident\/|MSIE /.test(window.navigator.userAgent),r=["trace","debug","info","warn","error"],i={},o=null;function s(e,t){var n=e[t];if("function"==typeof n.bind)return n.bind(e);try{return Function.prototype.bind.call(n,e)}catch(t){return function(){return Function.prototype.apply.apply(n,[e,arguments])}}}function a(){console.log&&(console.log.apply?console.log.apply(console,arguments):Function.prototype.apply.apply(console.log,[console,arguments])),console.trace&&console.trace()}function c(){for(var n=this.getLevel(),i=0;i<r.length;i++){var o=r[i];this[o]=i<n?e:this.methodFactory(o,n,this.name)}if(this.log=this.debug,typeof console===t&&n<this.levels.SILENT)return"No console available for logging"}function d(e){return function(){typeof console!==t&&(c.call(this),this[e].apply(this,arguments))}}function u(r,i,o){return function(r){return"debug"===r&&(r="log"),typeof console!==t&&("trace"===r&&n?a:void 0!==console[r]?s(console,r):void 0!==console.log?s(console,"log"):e)}(r)||d.apply(this,arguments)}function l(e,n){var s,a,d,l=this,y="loglevel";function p(){var e;if(typeof window!==t&&y){try{e=window.localStorage[y]}catch(e){}if(typeof e===t)try{var n=window.document.cookie,r=encodeURIComponent(y),i=n.indexOf(r+"=");-1!==i&&(e=/^([^;]+)/.exec(n.slice(i+r.length+1))[1])}catch(e){}return void 0===l.levels[e]&&(e=void 0),e}}function h(e){var t=e;if("string"==typeof t&&void 0!==l.levels[t.toUpperCase()]&&(t=l.levels[t.toUpperCase()]),"number"==typeof t&&t>=0&&t<=l.levels.SILENT)return t;throw new TypeError("log.setLevel() called with invalid level: "+e)}"string"==typeof e?y+=":"+e:"symbol"==typeof e&&(y=void 0),l.name=e,l.levels={TRACE:0,DEBUG:1,INFO:2,WARN:3,ERROR:4,SILENT:5},l.methodFactory=n||u,l.getLevel=function(){return null!=d?d:null!=a?a:s},l.setLevel=function(e,n){return d=h(e),!1!==n&&function(e){var n=(r[e]||"silent").toUpperCase();if(typeof window!==t&&y){try{return void(window.localStorage[y]=n)}catch(e){}try{window.document.cookie=encodeURIComponent(y)+"="+n+";"}catch(e){}}}(d),c.call(l)},l.setDefaultLevel=function(e){a=h(e),p()||l.setLevel(e,!1)},l.resetLevel=function(){d=null,function(){if(typeof window!==t&&y){try{window.localStorage.removeItem(y)}catch(e){}try{window.document.cookie=encodeURIComponent(y)+"=; expires=Thu, 01 Jan 1970 00:00:00 UTC"}catch(e){}}}(),c.call(l)},l.enableAll=function(e){l.setLevel(l.levels.TRACE,e)},l.disableAll=function(e){l.setLevel(l.levels.SILENT,e)},l.rebuild=function(){if(o!==l&&(s=h(o.getLevel())),c.call(l),o===l)for(var e in i)i[e].rebuild()},s=h(o?o.getLevel():"WARN");var f=p();null!=f&&(d=h(f)),c.call(l)}(o=new l).getLogger=function(e){if("symbol"!=typeof e&&"string"!=typeof e||""===e)throw new TypeError("You must supply a name when creating a logger.");var t=i[e];return t||(t=i[e]=new l(e,o.methodFactory)),t};var y=typeof window!==t?window.log:void 0;return o.noConflict=function(){return typeof window!==t&&window.log===o&&(window.log=y),o},o.getLoggers=function(){return i},o.default=o,o},(r=n).exports?r.exports=o():i.log=o()),n.exports);!function(e){e[e.trace=0]="trace",e[e.debug=1]="debug",e[e.info=2]="info",e[e.warn=3]="warn",e[e.error=4]="error",e[e.silent=5]="silent"}(s||(s={})),function(e){e.Default="livekit",e.Room="livekit-room",e.Participant="livekit-participant",e.Track="livekit-track",e.Publication="livekit-track-publication",e.Engine="livekit-engine",e.Signal="livekit-signal",e.PCManager="livekit-pc-manager",e.PCTransport="livekit-pc-transport",e.E2EE="lk-e2ee"}(a||(a={}));let d=c.getLogger("livekit");Object.values(a).map((e=>c.getLogger(e))),d.setDefaultLevel(s.info);const u=c.getLogger("lk-e2ee");var l,y=Object.defineProperty,p=(e,t,n)=>((e,t,n)=>t in e?y(e,t,{enumerable:!0,configurable:!0,writable:!0,value:n}):e[t]=n)(e,"symbol"!=typeof t?t+"":t,n);class h{constructor(){p(this,"_locking"),p(this,"_locks"),this._locking=Promise.resolve(),this._locks=0}isLocked(){return this._locks>0}lock(){let e;this._locks+=1;const t=new Promise((t=>e=()=>{this._locks-=1,t()})),n=this._locking.then((()=>e));return this._locking=this._locking.then((()=>t)),n}}!function(e){e[e.WAITING=0]="WAITING",e[e.RUNNING=1]="RUNNING",e[e.COMPLETED=2]="COMPLETED"}(l||(l={}));const f="AES-GCM",v={key:10,delta:3,audio:1,empty:0},g={sharedKey:!1,ratchetSalt:"LKFrameEncryptionKey",ratchetWindowSize:8,failureTolerance:10,keyringSize:16};class m extends Error{constructor(e,t){super(t||"an error has occured"),this.name="LiveKitError",this.code=e}}var w,I,b,k,S,L,E;!function(e){e[e.NotAllowed=0]="NotAllowed",e[e.ServerUnreachable=1]="ServerUnreachable",e[e.InternalError=2]="InternalError",e[e.Cancelled=3]="Cancelled",e[e.LeaveRequest=4]="LeaveRequest",e[e.Timeout=5]="Timeout"}(w||(w={})),function(e){e.PermissionDenied="PermissionDenied",e.NotFound="NotFound",e.DeviceInUse="DeviceInUse",e.Other="Other"}(I||(I={})),function(e){e.getFailure=function(t){if(t&&"name"in t)return"NotFoundError"===t.name||"DevicesNotFoundError"===t.name?e.NotFound:"NotAllowedError"===t.name||"PermissionDeniedError"===t.name?e.PermissionDenied:"NotReadableError"===t.name||"TrackStartError"===t.name?e.DeviceInUse:e.Other}}(I||(I={})),function(e){e[e.InvalidKey=0]="InvalidKey",e[e.MissingKey=1]="MissingKey",e[e.InternalError=2]="InternalError"}(b||(b={}));class C extends m{constructor(e){let t=arguments.length>1&&void 0!==arguments[1]?arguments[1]:b.InternalError,n=arguments.length>2?arguments[2]:void 0;super(40,e),this.reason=t,this.participantIdentity=n}}!function(e){e.SetKey="setKey",e.RatchetRequest="ratchetRequest",e.KeyRatcheted="keyRatcheted"}(k||(k={})),function(e){e.KeyRatcheted="keyRatcheted"}(S||(S={})),function(e){e.ParticipantEncryptionStatusChanged="participantEncryptionStatusChanged",e.EncryptionError="encryptionError"}(L||(L={})),function(e){e.Error="cryptorError"}(E||(E={}));var T,A={exports:{}};var K=function(){if(T)return A.exports;T=1;var e,t="object"==typeof Reflect?Reflect:null,n=t&&"function"==typeof t.apply?t.apply:function(e,t,n){return Function.prototype.apply.call(e,t,n)};e=t&&"function"==typeof t.ownKeys?t.ownKeys:Object.getOwnPropertySymbols?function(e){return Object.getOwnPropertyNames(e).concat(Object.getOwnPropertySymbols(e))}:function(e){return Object.getOwnPropertyNames(e)};var r=Number.isNaN||function(e){return e!=e};function i(){i.init.call(this)}A.exports=i,A.exports.once=function(e,t){return new Promise((function(n,r){function i(n){e.removeListener(t,o),r(n)}function o(){"function"==typeof e.removeListener&&e.removeListener("error",i),n([].slice.call(arguments))}h(e,t,o,{once:!0}),"error"!==t&&function(e,t,n){"function"==typeof e.on&&h(e,"error",t,n)}(e,i,{once:!0})}))},i.EventEmitter=i,i.prototype._events=void 0,i.prototype._eventsCount=0,i.prototype._maxListeners=void 0;var o=10;function s(e){if("function"!=typeof e)throw new TypeError('The "listener" argument must be of type Function. Received type '+typeof e)}function a(e){return void 0===e._maxListeners?i.defaultMaxListeners:e._maxListeners}function c(e,t,n,r){var i,o,c,d;if(s(n),void 0===(o=e._events)?(o=e._events=Object.create(null),e._eventsCount=0):(void 0!==o.newListener&&(e.emit("newListener",t,n.listener?n.listener:n),o=e._events),c=o[t]),void 0===c)c=o[t]=n,++e._eventsCount;else if("function"==typeof c?c=o[t]=r?[n,c]:[c,n]:r?c.unshift(n):c.push(n),(i=a(e))>0&&c.length>i&&!c.warned){c.warned=!0;var u=new Error("Possible EventEmitter memory leak detected. "+c.length+" "+String(t)+" listeners added. Use emitter.setMaxListeners() to increase limit");u.name="MaxListenersExceededWarning",u.emitter=e,u.type=t,u.count=c.length,d=u,console&&console.warn&&console.warn(d)}return e}function d(){if(!this.fired)return this.target.removeListener(this.type,this.wrapFn),this.fired=!0,0===arguments.length?this.listener.call(this.target):this.listener.apply(this.target,arguments)}function u(e,t,n){var r={fired:!1,wrapFn:void 0,target:e,type:t,listener:n},i=d.bind(r);return i.listener=n,r.wrapFn=i,i}function l(e,t,n){var r=e._events;if(void 0===r)return[];var i=r[t];return void 0===i?[]:"function"==typeof i?n?[i.listener||i]:[i]:n?function(e){for(var t=new Array(e.length),n=0;n<t.length;++n)t[n]=e[n].listener||e[n];return t}(i):p(i,i.length)}function y(e){var t=this._events;if(void 0!==t){var n=t[e];if("function"==typeof n)return 1;if(void 0!==n)return n.length}return 0}function p(e,t){for(var n=new Array(t),r=0;r<t;++r)n[r]=e[r];return n}function h(e,t,n,r){if("function"==typeof e.on)r.once?e.once(t,n):e.on(t,n);else{if("function"!=typeof e.addEventListener)throw new TypeError('The "emitter" argument must be of type EventEmitter. Received type '+typeof e);e.addEventListener(t,(function i(o){r.once&&e.removeEventListener(t,i),n(o)}))}}return Object.defineProperty(i,"defaultMaxListeners",{enumerable:!0,get:function(){return o},set:function(e){if("number"!=typeof e||e<0||r(e))throw new RangeError('The value of "defaultMaxListeners" is out of range. It must be a non-negative number. Received '+e+".");o=e}}),i.init=function(){void 0!==this._events&&this._events!==Object.getPrototypeOf(this)._events||(this._events=Object.create(null),this._eventsCount=0),this._maxListeners=this._maxListeners||void 0},i.prototype.setMaxListeners=function(e){if("number"!=typeof e||e<0||r(e))throw new RangeError('The value of "n" is out of range. It must be a non-negative number. Received '+e+".");return this._maxListeners=e,this},i.prototype.getMaxListeners=function(){return a(this)},i.prototype.emit=function(e){for(var t=[],r=1;r<arguments.length;r++)t.push(arguments[r]);var i="error"===e,o=this._events;if(void 0!==o)i=i&&void 0===o.error;else if(!i)return!1;if(i){var s;if(t.length>0&&(s=t[0]),s instanceof Error)throw s;var a=new Error("Unhandled error."+(s?" ("+s.message+")":""));throw a.context=s,a}var c=o[e];if(void 0===c)return!1;if("function"==typeof c)n(c,this,t);else{var d=c.length,u=p(c,d);for(r=0;r<d;++r)n(u[r],this,t)}return!0},i.prototype.addListener=function(e,t){return c(this,e,t,!1)},i.prototype.on=i.prototype.addListener,i.prototype.prependListener=function(e,t){return c(this,e,t,!0)},i.prototype.once=function(e,t){return s(t),this.on(e,u(this,e,t)),this},i.prototype.prependOnceListener=function(e,t){return s(t),this.prependListener(e,u(this,e,t)),this},i.prototype.removeListener=function(e,t){var n,r,i,o,a;if(s(t),void 0===(r=this._events))return this;if(void 0===(n=r[e]))return this;if(n===t||n.listener===t)0==--this._eventsCount?this._events=Object.create(null):(delete r[e],r.removeListener&&this.emit("removeListener",e,n.listener||t));else if("function"!=typeof n){for(i=-1,o=n.length-1;o>=0;o--)if(n[o]===t||n[o].listener===t){a=n[o].listener,i=o;break}if(i<0)return this;0===i?n.shift():function(e,t){for(;t+1<e.length;t++)e[t]=e[t+1];e.pop()}(n,i),1===n.length&&(r[e]=n[0]),void 0!==r.removeListener&&this.emit("removeListener",e,a||t)}return this},i.prototype.off=i.prototype.removeListener,i.prototype.removeAllListeners=function(e){var t,n,r;if(void 0===(n=this._events))return this;if(void 0===n.removeListener)return 0===arguments.length?(this._events=Object.create(null),this._eventsCount=0):void 0!==n[e]&&(0==--this._eventsCount?this._events=Object.create(null):delete n[e]),this;if(0===arguments.length){var i,o=Object.keys(n);for(r=0;r<o.length;++r)"removeListener"!==(i=o[r])&&this.removeAllListeners(i);return this.removeAllListeners("removeListener"),this._events=Object.create(null),this._eventsCount=0,this}if("function"==typeof(t=n[e]))this.removeListener(e,t);else if(void 0!==t)for(r=t.length-1;r>=0;r--)this.removeListener(e,t[r]);return this},i.prototype.listeners=function(e){return l(this,e,!0)},i.prototype.rawListeners=function(e){return l(this,e,!1)},i.listenerCount=function(e,t){return"function"==typeof e.listenerCount?e.listenerCount(t):y.call(e,t)},i.prototype.listenerCount=y,i.prototype.eventNames=function(){return this._eventsCount>0?e(this._events):[]},A.exports}();function x(e,t){const n=(new TextEncoder).encode(t);switch(e){case"HKDF":return{name:"HKDF",salt:n,hash:"SHA-256",info:new ArrayBuffer(128)};case"PBKDF2":return{name:"PBKDF2",salt:n,hash:"SHA-256",iterations:1e5};default:throw new Error("algorithm ".concat(e," is currently unsupported"))}}function _(t,n){return e(this,void 0,void 0,(function*(){const e=x(t.algorithm.name,n),r=yield crypto.subtle.deriveKey(e,t,{name:f,length:128},!1,["encrypt","decrypt"]);return{material:t,encryptionKey:r}}))}class P{constructor(){this.consecutiveSifCount=0,this.lastSifReceivedAt=0,this.userFramesSinceSif=0}recordSif(){var e;this.consecutiveSifCount+=1,null!==(e=this.sifSequenceStartedAt)&&void 0!==e||(this.sifSequenceStartedAt=Date.now()),this.lastSifReceivedAt=Date.now()}recordUserFrame(){void 0!==this.sifSequenceStartedAt&&(this.userFramesSinceSif+=1,(this.userFramesSinceSif>this.consecutiveSifCount||Date.now()-this.lastSifReceivedAt>2e3)&&this.reset())}isSifAllowed(){return this.consecutiveSifCount<100&&(void 0===this.sifSequenceStartedAt||Date.now()-this.sifSequenceStartedAt<2e3)}reset(){this.userFramesSinceSif=0,this.consecutiveSifCount=0,this.sifSequenceStartedAt=void 0}}const R=new Map;class O extends K.EventEmitter{encodeFunction(e,t){throw Error("not implemented for subclass")}decodeFunction(e,t){throw Error("not implemented for subclass")}}class F extends O{constructor(e){var t;super(),this.isTransformActive=!1,this.sendCounts=new Map,this.keys=e.keys,this.participantIdentity=e.participantIdentity,this.rtpMap=new Map,this.keyProviderOptions=e.keyProviderOptions,this.sifTrailer=null!==(t=e.sifTrailer)&&void 0!==t?t:Uint8Array.from([]),this.sifGuard=new P}get logContext(){return{participant:this.participantIdentity,mediaTrackId:this.trackId,fallbackCodec:this.videoCodec}}setParticipant(e,t){u.debug("setting new participant on cryptor",Object.assign(Object.assign({},this.logContext),{participant:e})),this.participantIdentity&&u.error("cryptor has already a participant set, participant should have been unset before",Object.assign({},this.logContext)),this.participantIdentity=e,this.keys=t,this.sifGuard.reset()}unsetParticipant(){u.debug("unsetting participant",this.logContext),this.participantIdentity=void 0}isEnabled(){return this.participantIdentity?R.get(this.participantIdentity):void 0}getParticipantIdentity(){return this.participantIdentity}getTrackId(){return this.trackId}setVideoCodec(e){this.videoCodec=e}setRtpMap(e){this.rtpMap=e}setupTransform(e,t,n,r,i,o){if(o&&(u.info("setting codec on cryptor to",{codec:o}),this.videoCodec=o),u.debug("Setting up frame cryptor transform",Object.assign({operation:e,passedTrackId:r,codec:o},this.logContext)),i&&this.isTransformActive)return void u.debug("reuse transform",Object.assign({},this.logContext));const s="encode"===e?this.encodeFunction:this.decodeFunction,a=new TransformStream({transform:s.bind(this)});this.isTransformActive=!0,t.pipeThrough(a).pipeTo(n).catch((e=>{u.warn(e),this.emit(E.Error,e instanceof C?e:new C(e.message,void 0,this.participantIdentity))})).finally((()=>{this.isTransformActive=!1})),this.trackId=r}setSifTrailer(e){u.debug("setting SIF trailer",Object.assign(Object.assign({},this.logContext),{trailer:e})),this.sifTrailer=e}encodeFunction(t,n){return e(this,void 0,void 0,(function*(){var e;if(!this.isEnabled()||0===t.data.byteLength)return n.enqueue(t);const r=this.keys.getKeySet();if(!r)return void this.emit(E.Error,new C("key set not found for ".concat(this.participantIdentity," at index ").concat(this.keys.getCurrentKeyIndex()),b.MissingKey,this.participantIdentity));const{encryptionKey:i}=r,o=this.keys.getCurrentKeyIndex();if(i){const r=this.makeIV(null!==(e=t.getMetadata().synchronizationSource)&&void 0!==e?e:-1,t.timestamp);let a=this.getUnencryptedBytes(t);const c=new Uint8Array(t.data,0,a.unencryptedBytes),d=new Uint8Array(2);d[0]=12,d[1]=o;try{const e=yield crypto.subtle.encrypt({name:f,iv:r,additionalData:new Uint8Array(t.data,0,c.byteLength)},i,new Uint8Array(t.data,a.unencryptedBytes));let o=new Uint8Array(e.byteLength+r.byteLength+d.byteLength);o.set(new Uint8Array(e)),o.set(new Uint8Array(r),e.byteLength),o.set(d,e.byteLength+r.byteLength),a.isH264&&(o=function(e){const t=[];for(var n=0,r=0;r<e.length;++r){var i=e[r];i<=3&&n>=2&&(t.push(3),n=0),t.push(i),0==i?++n:n=0}return new Uint8Array(t)}(o));var s=new Uint8Array(c.byteLength+o.byteLength);return s.set(c),s.set(o,c.byteLength),t.data=s.buffer,n.enqueue(t)}catch(e){u.error(e)}}else u.debug("failed to encrypt, emitting error",this.logContext),this.emit(E.Error,new C("encryption key missing for encoding",b.MissingKey,this.participantIdentity))}))}decodeFunction(t,n){return e(this,void 0,void 0,(function*(){if(!this.isEnabled()||0===t.data.byteLength)return u.debug("skipping empty frame",this.logContext),this.sifGuard.recordUserFrame(),n.enqueue(t);if(function(e,t){if(0===t.byteLength)return!1;const n=new Uint8Array(e.slice(e.byteLength-t.byteLength));return t.every(((e,t)=>e===n[t]))}(t.data,this.sifTrailer))return u.debug("enqueue SIF",this.logContext),this.sifGuard.recordSif(),this.sifGuard.isSifAllowed()?(t.data=t.data.slice(0,t.data.byteLength-this.sifTrailer.byteLength),n.enqueue(t)):void u.warn("SIF limit reached, dropping frame");this.sifGuard.recordUserFrame();const e=new Uint8Array(t.data)[t.data.byteLength-1];if(!this.keys.hasInvalidKeyAtIndex(e))if(this.keys.getKeySet(e))try{const r=yield this.decryptFrame(t,e);if(this.keys.decryptionSuccess(e),r)return n.enqueue(r)}catch(t){t instanceof C&&t.reason===b.InvalidKey?this.keys.hasValidKey&&(this.emit(E.Error,t),this.keys.decryptionFailure(e)):u.warn("decoding frame failed",{error:t})}else u.warn("skipping decryption due to missing key at index ".concat(e)),this.emit(E.Error,new C("missing key at index ".concat(e," for participant ").concat(this.participantIdentity),b.MissingKey,this.participantIdentity)),this.keys.decryptionFailure(e)}))}decryptFrame(t,n){return e(this,arguments,void 0,(function(e,t){var n=this;let r=arguments.length>2&&void 0!==arguments[2]?arguments[2]:void 0,i=arguments.length>3&&void 0!==arguments[3]?arguments[3]:{ratchetCount:0};return function*(){var o;const s=n.keys.getKeySet(t);if(!i.encryptionKey&&!s)throw new TypeError("no encryption key found for decryption of ".concat(n.participantIdentity));let a=n.getUnencryptedBytes(e);try{const t=new Uint8Array(e.data,0,a.unencryptedBytes);var c=new Uint8Array(e.data,t.length,e.data.byteLength-t.length);if(a.isH264&&function(e){for(var t=0;t<e.length-3;t++)if(0==e[t]&&0==e[t+1]&&3==e[t+2])return!0;return!1}(c)){c=function(e){const t=[];for(var n=e.length,r=0;r<e.length;)n-r>=3&&!e[r]&&!e[r+1]&&3==e[r+2]?(t.push(e[r++]),t.push(e[r++]),r++):t.push(e[r++]);return new Uint8Array(t)}(c);const n=new Uint8Array(t.byteLength+c.byteLength);n.set(t),n.set(c,t.byteLength),e.data=n.buffer}const n=new Uint8Array(e.data,e.data.byteLength-2,2),r=n[0],d=new Uint8Array(e.data,e.data.byteLength-r-n.byteLength,r),u=t.byteLength,l=e.data.byteLength-(t.byteLength+r+n.byteLength),y=yield crypto.subtle.decrypt({name:f,iv:d,additionalData:new Uint8Array(e.data,0,t.byteLength)},null!==(o=i.encryptionKey)&&void 0!==o?o:s.encryptionKey,new Uint8Array(e.data,u,l)),p=new ArrayBuffer(t.byteLength+y.byteLength),h=new Uint8Array(p);return h.set(new Uint8Array(e.data,0,t.byteLength)),h.set(new Uint8Array(y),t.byteLength),e.data=p,e}catch(o){if(n.keyProviderOptions.ratchetWindowSize>0){if(i.ratchetCount<n.keyProviderOptions.ratchetWindowSize){let o,a;u.debug("ratcheting key attempt ".concat(i.ratchetCount," of ").concat(n.keyProviderOptions.ratchetWindowSize,", for kind ").concat(e instanceof RTCEncodedAudioFrame?"audio":"video")),(null!=r?r:s)===n.keys.getKeySet(t)&&(a=yield n.keys.ratchetKey(t,!1),o=yield _(a.cryptoKey,n.keyProviderOptions.ratchetSalt));const c=yield n.decryptFrame(e,t,r||s,{ratchetCount:i.ratchetCount+1,encryptionKey:null==o?void 0:o.encryptionKey});return c&&o&&(null!=r?r:s)===n.keys.getKeySet(t)&&(n.keys.setKeySet(o,t,a),n.keys.setCurrentKeyIndex(t)),c}throw u.warn("maximum ratchet attempts exceeded"),new C("valid key missing for participant ".concat(n.participantIdentity),b.InvalidKey,n.participantIdentity)}throw new C("Decryption failed: ".concat(o.message),b.InvalidKey,n.participantIdentity)}}()}))}makeIV(e,t){var n;const r=new ArrayBuffer(12),i=new DataView(r);this.sendCounts.has(e)||this.sendCounts.set(e,Math.floor(65535*Math.random()));const o=null!==(n=this.sendCounts.get(e))&&void 0!==n?n:0;return i.setUint32(0,e),i.setUint32(4,t),i.setUint32(8,t-o%65535),this.sendCounts.set(e,o+1),r}getUnencryptedBytes(e){var t,n={unencryptedBytes:0,isH264:!1};if(function(e){return"type"in e}(e)){let r=null!==(t=this.getVideoCodec(e))&&void 0!==t?t:this.videoCodec;if(r!==this.detectedCodec&&(u.debug("detected different codec",Object.assign({detectedCodec:r,oldCodec:this.detectedCodec},this.logContext)),this.detectedCodec=r),"av1"===r)throw new Error("".concat(r," is not yet supported for end to end encryption"));if("vp8"===r)n.unencryptedBytes=v[e.type];else if("vp9"===r)return n.unencryptedBytes=0,n;const i=new Uint8Array(e.data);try{const e=function(e){const t=[];let n=0,r=0,i=e.length-2;for(;r<i;){for(;r<i&&(0!==e[r]||0!==e[r+1]||1!==e[r+2]);)r++;r>=i&&(r=e.length);let o=r;for(;o>n&&0===e[o-1];)o--;if(0===n){if(o!==n)throw TypeError("byte stream contains leading data")}else t.push(n);n=r+=3}return t}(i);if(n.isH264="h264"===r||e.some((e=>[M.SLICE_IDR,M.SLICE_NON_IDR].includes(U(i[e])))),n.isH264){for(const t of e){switch(U(i[t])){case M.SLICE_IDR:case M.SLICE_NON_IDR:return n.unencryptedBytes=t+2,n}}throw new TypeError("Could not find NALU")}}catch(e){}return n.unencryptedBytes=v[e.type],n}return n.unencryptedBytes=v.audio,n}getVideoCodec(e){if(0===this.rtpMap.size)return;const t=e.getMetadata().payloadType;return t?this.rtpMap.get(t):void 0}}function U(e){return e&N}const N=31;var M;!function(e){e[e.SLICE_NON_IDR=1]="SLICE_NON_IDR",e[e.SLICE_PARTITION_A=2]="SLICE_PARTITION_A",e[e.SLICE_PARTITION_B=3]="SLICE_PARTITION_B",e[e.SLICE_PARTITION_C=4]="SLICE_PARTITION_C",e[e.SLICE_IDR=5]="SLICE_IDR",e[e.SEI=6]="SEI",e[e.SPS=7]="SPS",e[e.PPS=8]="PPS",e[e.AUD=9]="AUD",e[e.END_SEQ=10]="END_SEQ",e[e.END_STREAM=11]="END_STREAM",e[e.FILLER_DATA=12]="FILLER_DATA",e[e.SPS_EXT=13]="SPS_EXT",e[e.PREFIX_NALU=14]="PREFIX_NALU",e[e.SUBSET_SPS=15]="SUBSET_SPS",e[e.DPS=16]="DPS",e[e.SLICE_AUX=19]="SLICE_AUX",e[e.SLICE_EXT=20]="SLICE_EXT",e[e.SLICE_LAYER_EXT=21]="SLICE_LAYER_EXT"}(M||(M={}));class D extends K.EventEmitter{get hasValidKey(){return!this.hasInvalidKeyAtIndex(this.currentKeyIndex)}constructor(e,t){if(super(),this.currentKeyIndex=0,t.keyringSize<1||t.keyringSize>256)throw new TypeError("Keyring size needs to be between 1 and 256");this.cryptoKeyRing=new Array(t.keyringSize).fill(void 0),this.decryptionFailureCounts=new Array(t.keyringSize).fill(0),this.keyProviderOptions=t,this.ratchetPromiseMap=new Map,this.participantIdentity=e}hasInvalidKeyAtIndex(e){return this.keyProviderOptions.failureTolerance>=0&&this.decryptionFailureCounts[e]>this.keyProviderOptions.failureTolerance}decryptionFailure(){let e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:this.currentKeyIndex;this.keyProviderOptions.failureTolerance<0||(this.decryptionFailureCounts[e]+=1,this.decryptionFailureCounts[e]>this.keyProviderOptions.failureTolerance&&u.warn("key for ".concat(this.participantIdentity," at index ").concat(e," is being marked as invalid")))}decryptionSuccess(){let e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:this.currentKeyIndex;this.resetKeyStatus(e)}resetKeyStatus(e){void 0===e?this.decryptionFailureCounts.fill(0):this.decryptionFailureCounts[e]=0}ratchetKey(t){let n=!(arguments.length>1&&void 0!==arguments[1])||arguments[1];const r=null!=t?t:this.getCurrentKeyIndex(),i=this.ratchetPromiseMap.get(r);if(void 0!==i)return i;const o=new Promise(((t,i)=>e(this,void 0,void 0,(function*(){try{const i=this.getKeySet(r);if(!i)throw new TypeError("Cannot ratchet key without a valid keyset of participant ".concat(this.participantIdentity));const o=i.material,s=yield function(t,n){return e(this,void 0,void 0,(function*(){const e=x(t.algorithm.name,n);return crypto.subtle.deriveBits(e,t,256)}))}(o,this.keyProviderOptions.ratchetSalt),a=yield function(t){return e(this,arguments,void 0,(function(e){let t=arguments.length>1&&void 0!==arguments[1]?arguments[1]:{name:f},n=arguments.length>2&&void 0!==arguments[2]?arguments[2]:"encrypt";return function*(){return crypto.subtle.importKey("raw",e,t,!1,"derive"===n?["deriveBits","deriveKey"]:["encrypt","decrypt"])}()}))}(s,o.algorithm.name,"derive"),c={chainKey:s,cryptoKey:a};n&&(yield this.setKeyFromMaterial(a,r,c)),t(c)}catch(e){i(e)}finally{this.ratchetPromiseMap.delete(r)}}))));return this.ratchetPromiseMap.set(r,o),o}setKey(t){return e(this,arguments,void 0,(function(e){var t=this;let n=arguments.length>1&&void 0!==arguments[1]?arguments[1]:0;return function*(){yield t.setKeyFromMaterial(e,n),t.resetKeyStatus(n)}()}))}setKeyFromMaterial(t,n){return e(this,arguments,void 0,(function(e,t){var n=this;let r=arguments.length>2&&void 0!==arguments[2]?arguments[2]:null;return function*(){const i=yield _(e,n.keyProviderOptions.ratchetSalt),o=t>=0?t%n.cryptoKeyRing.length:n.currentKeyIndex;u.debug("setting new key with index ".concat(t),{usage:e.usages,algorithm:e.algorithm,ratchetSalt:n.keyProviderOptions.ratchetSalt}),n.setKeySet(i,o,r),o>=0&&(n.currentKeyIndex=o)}()}))}setKeySet(e,t){let n=arguments.length>2&&void 0!==arguments[2]?arguments[2]:null;this.cryptoKeyRing[t%this.cryptoKeyRing.length]=e,n&&this.emit(S.KeyRatcheted,n,this.participantIdentity,t)}setCurrentKeyIndex(t){return e(this,void 0,void 0,(function*(){this.currentKeyIndex=t%this.cryptoKeyRing.length,this.resetKeyStatus(t)}))}getCurrentKeyIndex(){return this.currentKeyIndex}getKeySet(e){return this.cryptoKeyRing[null!=e?e:this.currentKeyIndex]}}const j=[],B=new Map;let q,G,z=new class{constructor(){this.pendingTasks=new Map,this.taskMutex=new h,this.nextTaskIndex=0}run(t){return e(this,void 0,void 0,(function*(){const e={id:this.nextTaskIndex++,enqueuedAt:Date.now(),status:l.WAITING};this.pendingTasks.set(e.id,e);const n=yield this.taskMutex.lock();try{return e.executedAt=Date.now(),e.status=l.RUNNING,yield t()}finally{e.status=l.COMPLETED,this.pendingTasks.delete(e.id),n()}}))}flush(){return e(this,void 0,void 0,(function*(){return this.run((()=>e(this,void 0,void 0,(function*(){}))))}))}snapshot(){return Array.from(this.pendingTasks.values())}},W=!1,X=g,H=new Map;function V(e,t){let n=j.filter((e=>e.getTrackId()===t));if(n.length>1){const r=n.map((e=>({participant:e.getParticipantIdentity()}))).join(",");u.error("Found multiple cryptors for the same trackID ".concat(t,". target participant: ").concat(e," "),{participants:r})}let r=n[0];if(r)e!==r.getParticipantIdentity()&&r.setParticipant(e,Y(e));else{if(u.info("creating new cryptor for",{participantIdentity:e}),!X)throw Error("Missing keyProvider options");r=new F({participantIdentity:e,keys:Y(e),keyProviderOptions:X,sifTrailer:G}),r.setRtpMap(H),function(e){e.on(E.Error,(e=>{const t={kind:"error",data:{error:new Error("".concat(b[e.reason],": ").concat(e.message))}};postMessage(t)}))}(r),j.push(r)}return r}function Y(e){if(W)return Q();let t=B.get(e);return t||(t=new D(e,X),t.on(S.KeyRatcheted,J),B.set(e,t)),t}function Q(){return q||(u.debug("creating new shared key handler"),q=new D("shared-key",X)),q}function J(e,t,n){postMessage({kind:"ratchetKey",data:{participantIdentity:t,keyIndex:n,ratchetResult:e}})}u.setDefaultLevel("info"),onmessage=t=>{z.run((()=>e(void 0,void 0,void 0,(function*(){const{kind:n,data:r}=t.data;switch(n){case"init":u.setLevel(r.loglevel),u.info("worker initialized"),X=r.keyProviderOptions,W=!!r.keyProviderOptions.sharedKey;postMessage({kind:"initAck",data:{enabled:false}});break;case"enable":o=r.enabled,s=r.participantIdentity,u.debug("setting encryption enabled for all tracks of ".concat(s),{enable:o}),R.set(s,o),u.info("updated e2ee enabled status for ".concat(r.participantIdentity," to ").concat(r.enabled)),postMessage(t.data);break;case"decode":V(r.participantIdentity,r.trackId).setupTransform(n,r.readableStream,r.writableStream,r.trackId,r.isReuse,r.codec);break;case"encode":V(r.participantIdentity,r.trackId).setupTransform(n,r.readableStream,r.writableStream,r.trackId,r.isReuse,r.codec);break;case"setKey":W?yield function(t,n){return e(this,void 0,void 0,(function*(){u.info("set shared key",{index:n}),yield Q().setKey(t,n)}))}(r.key,r.keyIndex):r.participantIdentity?(u.info("set participant sender key ".concat(r.participantIdentity," index ").concat(r.keyIndex)),yield Y(r.participantIdentity).setKey(r.key,r.keyIndex)):u.error("no participant Id was provided and shared key usage is disabled");break;case"removeTransform":!function(e,t){const n=j.filter((n=>n.getParticipantIdentity()===t&&n.getTrackId()===e));n.length>1&&u.error("Found multiple cryptors for the same participant and trackID combination",{trackId:e,participantIdentity:t});const r=n[0];r?r.unsetParticipant():u.warn("Could not unset participant on cryptor",{trackId:e,participantIdentity:t})}(r.trackId,r.participantIdentity);break;case"updateCodec":V(r.participantIdentity,r.trackId).setVideoCodec(r.codec);break;case"setRTPMap":H=r.map,j.forEach((e=>{e.getParticipantIdentity()===r.participantIdentity&&e.setRtpMap(r.map)}));break;case"ratchetRequest":!function(t){e(this,void 0,void 0,(function*(){if(W){const e=Q();yield e.ratchetKey(t.keyIndex),e.resetKeyStatus()}else if(t.participantIdentity){const e=Y(t.participantIdentity);yield e.ratchetKey(t.keyIndex),e.resetKeyStatus()}else u.error("no participant Id was provided for ratchet request and shared key usage is disabled")}))}(r);break;case"setSifTrailer":i=r.trailer,G=i,j.forEach((e=>{e.setSifTrailer(i)}))}var i,o,s}))))},self.RTCTransformEvent&&(u.debug("setup transform event"),self.onrtctransform=e=>{const t=e.transformer;u.debug("transformer",t),t.handled=!0;const{kind:n,participantIdentity:r,trackId:i,codec:o}=t.options,s=V(r,i);u.debug("transform",{codec:o}),s.setupTransform(n,t.readable,t.writable,i,o)})}));
2
+ //# sourceMappingURL=livekit-client.e2ee.worker.js.map