@dtelecom/livekit-client 1.12.1

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 (279) hide show
  1. package/LICENSE +175 -0
  2. package/README.md +315 -0
  3. package/dist/@dtelecom/livekit-client.e2ee.worker.js +2 -0
  4. package/dist/@dtelecom/livekit-client.e2ee.worker.js.map +1 -0
  5. package/dist/@dtelecom/livekit-client.e2ee.worker.mjs +1633 -0
  6. package/dist/@dtelecom/livekit-client.e2ee.worker.mjs.map +1 -0
  7. package/dist/@dtelecom/livekit-client.esm.mjs +22545 -0
  8. package/dist/@dtelecom/livekit-client.esm.mjs.map +1 -0
  9. package/dist/@dtelecom/livekit-client.umd.js +2 -0
  10. package/dist/@dtelecom/livekit-client.umd.js.map +1 -0
  11. package/dist/@dtelecom/src/api/SignalClient.d.ts +102 -0
  12. package/dist/@dtelecom/src/api/SignalClient.d.ts.map +1 -0
  13. package/dist/@dtelecom/src/connectionHelper/ConnectionCheck.d.ts +26 -0
  14. package/dist/@dtelecom/src/connectionHelper/ConnectionCheck.d.ts.map +1 -0
  15. package/dist/@dtelecom/src/connectionHelper/checks/Checker.d.ts +59 -0
  16. package/dist/@dtelecom/src/connectionHelper/checks/Checker.d.ts.map +1 -0
  17. package/dist/@dtelecom/src/connectionHelper/checks/publishAudio.d.ts +6 -0
  18. package/dist/@dtelecom/src/connectionHelper/checks/publishAudio.d.ts.map +1 -0
  19. package/dist/@dtelecom/src/connectionHelper/checks/publishVideo.d.ts +6 -0
  20. package/dist/@dtelecom/src/connectionHelper/checks/publishVideo.d.ts.map +1 -0
  21. package/dist/@dtelecom/src/connectionHelper/checks/reconnect.d.ts +6 -0
  22. package/dist/@dtelecom/src/connectionHelper/checks/reconnect.d.ts.map +1 -0
  23. package/dist/@dtelecom/src/connectionHelper/checks/turn.d.ts +6 -0
  24. package/dist/@dtelecom/src/connectionHelper/checks/turn.d.ts.map +1 -0
  25. package/dist/@dtelecom/src/connectionHelper/checks/webrtc.d.ts +6 -0
  26. package/dist/@dtelecom/src/connectionHelper/checks/webrtc.d.ts.map +1 -0
  27. package/dist/@dtelecom/src/connectionHelper/checks/websocket.d.ts +6 -0
  28. package/dist/@dtelecom/src/connectionHelper/checks/websocket.d.ts.map +1 -0
  29. package/dist/@dtelecom/src/e2ee/E2eeManager.d.ts +47 -0
  30. package/dist/@dtelecom/src/e2ee/E2eeManager.d.ts.map +1 -0
  31. package/dist/@dtelecom/src/e2ee/KeyProvider.d.ts +44 -0
  32. package/dist/@dtelecom/src/e2ee/KeyProvider.d.ts.map +1 -0
  33. package/dist/@dtelecom/src/e2ee/constants.d.ts +15 -0
  34. package/dist/@dtelecom/src/e2ee/constants.d.ts.map +1 -0
  35. package/dist/@dtelecom/src/e2ee/errors.d.ts +11 -0
  36. package/dist/@dtelecom/src/e2ee/errors.d.ts.map +1 -0
  37. package/dist/@dtelecom/src/e2ee/index.d.ts +4 -0
  38. package/dist/@dtelecom/src/e2ee/index.d.ts.map +1 -0
  39. package/dist/@dtelecom/src/e2ee/types.d.ts +130 -0
  40. package/dist/@dtelecom/src/e2ee/types.d.ts.map +1 -0
  41. package/dist/@dtelecom/src/e2ee/utils.d.ts +24 -0
  42. package/dist/@dtelecom/src/e2ee/utils.d.ts.map +1 -0
  43. package/dist/@dtelecom/src/e2ee/worker/FrameCryptor.d.ts +176 -0
  44. package/dist/@dtelecom/src/e2ee/worker/FrameCryptor.d.ts.map +1 -0
  45. package/dist/@dtelecom/src/e2ee/worker/ParticipantKeyHandler.d.ts +65 -0
  46. package/dist/@dtelecom/src/e2ee/worker/ParticipantKeyHandler.d.ts.map +1 -0
  47. package/dist/@dtelecom/src/e2ee/worker/e2ee.worker.d.ts +2 -0
  48. package/dist/@dtelecom/src/e2ee/worker/e2ee.worker.d.ts.map +1 -0
  49. package/dist/@dtelecom/src/index.d.ts +38 -0
  50. package/dist/@dtelecom/src/index.d.ts.map +1 -0
  51. package/dist/@dtelecom/src/logger.d.ts +29 -0
  52. package/dist/@dtelecom/src/logger.d.ts.map +1 -0
  53. package/dist/@dtelecom/src/options.d.ts +104 -0
  54. package/dist/@dtelecom/src/options.d.ts.map +1 -0
  55. package/dist/@dtelecom/src/proto/livekit_models_pb.d.ts +1264 -0
  56. package/dist/@dtelecom/src/proto/livekit_models_pb.d.ts.map +1 -0
  57. package/dist/@dtelecom/src/proto/livekit_rtc_pb.d.ts +1373 -0
  58. package/dist/@dtelecom/src/proto/livekit_rtc_pb.d.ts.map +1 -0
  59. package/dist/@dtelecom/src/room/DefaultReconnectPolicy.d.ts +8 -0
  60. package/dist/@dtelecom/src/room/DefaultReconnectPolicy.d.ts.map +1 -0
  61. package/dist/@dtelecom/src/room/DeviceManager.d.ts +9 -0
  62. package/dist/@dtelecom/src/room/DeviceManager.d.ts.map +1 -0
  63. package/dist/@dtelecom/src/room/PCTransport.d.ts +41 -0
  64. package/dist/@dtelecom/src/room/PCTransport.d.ts.map +1 -0
  65. package/dist/@dtelecom/src/room/RTCEngine.d.ts +143 -0
  66. package/dist/@dtelecom/src/room/RTCEngine.d.ts.map +1 -0
  67. package/dist/@dtelecom/src/room/ReconnectPolicy.d.ts +24 -0
  68. package/dist/@dtelecom/src/room/ReconnectPolicy.d.ts.map +1 -0
  69. package/dist/@dtelecom/src/room/RegionUrlProvider.d.ts +17 -0
  70. package/dist/@dtelecom/src/room/RegionUrlProvider.d.ts.map +1 -0
  71. package/dist/@dtelecom/src/room/Room.d.ts +248 -0
  72. package/dist/@dtelecom/src/room/Room.d.ts.map +1 -0
  73. package/dist/@dtelecom/src/room/defaults.d.ts +8 -0
  74. package/dist/@dtelecom/src/room/defaults.d.ts.map +1 -0
  75. package/dist/@dtelecom/src/room/errors.d.ts +43 -0
  76. package/dist/@dtelecom/src/room/errors.d.ts.map +1 -0
  77. package/dist/@dtelecom/src/room/events.d.ts +477 -0
  78. package/dist/@dtelecom/src/room/events.d.ts.map +1 -0
  79. package/dist/@dtelecom/src/room/participant/LocalParticipant.d.ts +177 -0
  80. package/dist/@dtelecom/src/room/participant/LocalParticipant.d.ts.map +1 -0
  81. package/dist/@dtelecom/src/room/participant/Participant.d.ts +95 -0
  82. package/dist/@dtelecom/src/room/participant/Participant.d.ts.map +1 -0
  83. package/dist/@dtelecom/src/room/participant/ParticipantTrackPermission.d.ts +26 -0
  84. package/dist/@dtelecom/src/room/participant/ParticipantTrackPermission.d.ts.map +1 -0
  85. package/dist/@dtelecom/src/room/participant/RemoteParticipant.d.ts +55 -0
  86. package/dist/@dtelecom/src/room/participant/RemoteParticipant.d.ts.map +1 -0
  87. package/dist/@dtelecom/src/room/participant/publishUtils.d.ts +28 -0
  88. package/dist/@dtelecom/src/room/participant/publishUtils.d.ts.map +1 -0
  89. package/dist/@dtelecom/src/room/stats.d.ts +67 -0
  90. package/dist/@dtelecom/src/room/stats.d.ts.map +1 -0
  91. package/dist/@dtelecom/src/room/timers.d.ts +13 -0
  92. package/dist/@dtelecom/src/room/timers.d.ts.map +1 -0
  93. package/dist/@dtelecom/src/room/track/LocalAudioTrack.d.ts +25 -0
  94. package/dist/@dtelecom/src/room/track/LocalAudioTrack.d.ts.map +1 -0
  95. package/dist/@dtelecom/src/room/track/LocalTrack.d.ts +78 -0
  96. package/dist/@dtelecom/src/room/track/LocalTrack.d.ts.map +1 -0
  97. package/dist/@dtelecom/src/room/track/LocalTrackPublication.d.ts +38 -0
  98. package/dist/@dtelecom/src/room/track/LocalTrackPublication.d.ts.map +1 -0
  99. package/dist/@dtelecom/src/room/track/LocalVideoTrack.d.ts +54 -0
  100. package/dist/@dtelecom/src/room/track/LocalVideoTrack.d.ts.map +1 -0
  101. package/dist/@dtelecom/src/room/track/RemoteAudioTrack.d.ts +53 -0
  102. package/dist/@dtelecom/src/room/track/RemoteAudioTrack.d.ts.map +1 -0
  103. package/dist/@dtelecom/src/room/track/RemoteTrack.d.ts +15 -0
  104. package/dist/@dtelecom/src/room/track/RemoteTrack.d.ts.map +1 -0
  105. package/dist/@dtelecom/src/room/track/RemoteTrackPublication.d.ts +64 -0
  106. package/dist/@dtelecom/src/room/track/RemoteTrackPublication.d.ts.map +1 -0
  107. package/dist/@dtelecom/src/room/track/RemoteVideoTrack.d.ts +56 -0
  108. package/dist/@dtelecom/src/room/track/RemoteVideoTrack.d.ts.map +1 -0
  109. package/dist/@dtelecom/src/room/track/Track.d.ts +125 -0
  110. package/dist/@dtelecom/src/room/track/Track.d.ts.map +1 -0
  111. package/dist/@dtelecom/src/room/track/TrackPublication.d.ts +72 -0
  112. package/dist/@dtelecom/src/room/track/TrackPublication.d.ts.map +1 -0
  113. package/dist/@dtelecom/src/room/track/create.d.ts +24 -0
  114. package/dist/@dtelecom/src/room/track/create.d.ts.map +1 -0
  115. package/dist/@dtelecom/src/room/track/facingMode.d.ts +41 -0
  116. package/dist/@dtelecom/src/room/track/facingMode.d.ts.map +1 -0
  117. package/dist/@dtelecom/src/room/track/options.d.ts +272 -0
  118. package/dist/@dtelecom/src/room/track/options.d.ts.map +1 -0
  119. package/dist/@dtelecom/src/room/track/processor/types.d.ts +19 -0
  120. package/dist/@dtelecom/src/room/track/processor/types.d.ts.map +1 -0
  121. package/dist/@dtelecom/src/room/track/types.d.ts +24 -0
  122. package/dist/@dtelecom/src/room/track/types.d.ts.map +1 -0
  123. package/dist/@dtelecom/src/room/track/utils.d.ts +27 -0
  124. package/dist/@dtelecom/src/room/track/utils.d.ts.map +1 -0
  125. package/dist/@dtelecom/src/room/types.d.ts +26 -0
  126. package/dist/@dtelecom/src/room/types.d.ts.map +1 -0
  127. package/dist/@dtelecom/src/room/utils.d.ts +92 -0
  128. package/dist/@dtelecom/src/room/utils.d.ts.map +1 -0
  129. package/dist/@dtelecom/src/test/MockMediaStreamTrack.d.ts +26 -0
  130. package/dist/@dtelecom/src/test/MockMediaStreamTrack.d.ts.map +1 -0
  131. package/dist/@dtelecom/src/test/mocks.d.ts +12 -0
  132. package/dist/@dtelecom/src/test/mocks.d.ts.map +1 -0
  133. package/dist/@dtelecom/src/utils/AsyncQueue.d.ts +23 -0
  134. package/dist/@dtelecom/src/utils/AsyncQueue.d.ts.map +1 -0
  135. package/dist/@dtelecom/src/utils/browserParser.d.ts +12 -0
  136. package/dist/@dtelecom/src/utils/browserParser.d.ts.map +1 -0
  137. package/dist/@dtelecom/src/version.d.ts +3 -0
  138. package/dist/@dtelecom/src/version.d.ts.map +1 -0
  139. package/dist/ts4.2/@dtelecom/src/api/SignalClient.d.ts +105 -0
  140. package/dist/ts4.2/@dtelecom/src/connectionHelper/ConnectionCheck.d.ts +26 -0
  141. package/dist/ts4.2/@dtelecom/src/connectionHelper/checks/Checker.d.ts +59 -0
  142. package/dist/ts4.2/@dtelecom/src/connectionHelper/checks/publishAudio.d.ts +6 -0
  143. package/dist/ts4.2/@dtelecom/src/connectionHelper/checks/publishVideo.d.ts +6 -0
  144. package/dist/ts4.2/@dtelecom/src/connectionHelper/checks/reconnect.d.ts +6 -0
  145. package/dist/ts4.2/@dtelecom/src/connectionHelper/checks/turn.d.ts +6 -0
  146. package/dist/ts4.2/@dtelecom/src/connectionHelper/checks/webrtc.d.ts +6 -0
  147. package/dist/ts4.2/@dtelecom/src/connectionHelper/checks/websocket.d.ts +6 -0
  148. package/dist/ts4.2/@dtelecom/src/e2ee/E2eeManager.d.ts +47 -0
  149. package/dist/ts4.2/@dtelecom/src/e2ee/KeyProvider.d.ts +44 -0
  150. package/dist/ts4.2/@dtelecom/src/e2ee/constants.d.ts +15 -0
  151. package/dist/ts4.2/@dtelecom/src/e2ee/errors.d.ts +11 -0
  152. package/dist/ts4.2/@dtelecom/src/e2ee/index.d.ts +4 -0
  153. package/dist/ts4.2/@dtelecom/src/e2ee/types.d.ts +130 -0
  154. package/dist/ts4.2/@dtelecom/src/e2ee/utils.d.ts +24 -0
  155. package/dist/ts4.2/@dtelecom/src/e2ee/worker/FrameCryptor.d.ts +176 -0
  156. package/dist/ts4.2/@dtelecom/src/e2ee/worker/ParticipantKeyHandler.d.ts +65 -0
  157. package/dist/ts4.2/@dtelecom/src/e2ee/worker/e2ee.worker.d.ts +2 -0
  158. package/dist/ts4.2/@dtelecom/src/index.d.ts +38 -0
  159. package/dist/ts4.2/@dtelecom/src/logger.d.ts +29 -0
  160. package/dist/ts4.2/@dtelecom/src/options.d.ts +104 -0
  161. package/dist/ts4.2/@dtelecom/src/proto/livekit_models_pb.d.ts +1264 -0
  162. package/dist/ts4.2/@dtelecom/src/proto/livekit_rtc_pb.d.ts +1373 -0
  163. package/dist/ts4.2/@dtelecom/src/room/DefaultReconnectPolicy.d.ts +8 -0
  164. package/dist/ts4.2/@dtelecom/src/room/DeviceManager.d.ts +9 -0
  165. package/dist/ts4.2/@dtelecom/src/room/PCTransport.d.ts +43 -0
  166. package/dist/ts4.2/@dtelecom/src/room/RTCEngine.d.ts +143 -0
  167. package/dist/ts4.2/@dtelecom/src/room/ReconnectPolicy.d.ts +24 -0
  168. package/dist/ts4.2/@dtelecom/src/room/RegionUrlProvider.d.ts +17 -0
  169. package/dist/ts4.2/@dtelecom/src/room/Room.d.ts +248 -0
  170. package/dist/ts4.2/@dtelecom/src/room/defaults.d.ts +8 -0
  171. package/dist/ts4.2/@dtelecom/src/room/errors.d.ts +43 -0
  172. package/dist/ts4.2/@dtelecom/src/room/events.d.ts +477 -0
  173. package/dist/ts4.2/@dtelecom/src/room/participant/LocalParticipant.d.ts +177 -0
  174. package/dist/ts4.2/@dtelecom/src/room/participant/Participant.d.ts +95 -0
  175. package/dist/ts4.2/@dtelecom/src/room/participant/ParticipantTrackPermission.d.ts +26 -0
  176. package/dist/ts4.2/@dtelecom/src/room/participant/RemoteParticipant.d.ts +55 -0
  177. package/dist/ts4.2/@dtelecom/src/room/participant/publishUtils.d.ts +28 -0
  178. package/dist/ts4.2/@dtelecom/src/room/stats.d.ts +67 -0
  179. package/dist/ts4.2/@dtelecom/src/room/timers.d.ts +13 -0
  180. package/dist/ts4.2/@dtelecom/src/room/track/LocalAudioTrack.d.ts +25 -0
  181. package/dist/ts4.2/@dtelecom/src/room/track/LocalTrack.d.ts +78 -0
  182. package/dist/ts4.2/@dtelecom/src/room/track/LocalTrackPublication.d.ts +38 -0
  183. package/dist/ts4.2/@dtelecom/src/room/track/LocalVideoTrack.d.ts +54 -0
  184. package/dist/ts4.2/@dtelecom/src/room/track/RemoteAudioTrack.d.ts +53 -0
  185. package/dist/ts4.2/@dtelecom/src/room/track/RemoteTrack.d.ts +15 -0
  186. package/dist/ts4.2/@dtelecom/src/room/track/RemoteTrackPublication.d.ts +64 -0
  187. package/dist/ts4.2/@dtelecom/src/room/track/RemoteVideoTrack.d.ts +56 -0
  188. package/dist/ts4.2/@dtelecom/src/room/track/Track.d.ts +125 -0
  189. package/dist/ts4.2/@dtelecom/src/room/track/TrackPublication.d.ts +72 -0
  190. package/dist/ts4.2/@dtelecom/src/room/track/create.d.ts +24 -0
  191. package/dist/ts4.2/@dtelecom/src/room/track/facingMode.d.ts +41 -0
  192. package/dist/ts4.2/@dtelecom/src/room/track/options.d.ts +280 -0
  193. package/dist/ts4.2/@dtelecom/src/room/track/processor/types.d.ts +19 -0
  194. package/dist/ts4.2/@dtelecom/src/room/track/types.d.ts +24 -0
  195. package/dist/ts4.2/@dtelecom/src/room/track/utils.d.ts +27 -0
  196. package/dist/ts4.2/@dtelecom/src/room/types.d.ts +26 -0
  197. package/dist/ts4.2/@dtelecom/src/room/utils.d.ts +92 -0
  198. package/dist/ts4.2/@dtelecom/src/test/MockMediaStreamTrack.d.ts +26 -0
  199. package/dist/ts4.2/@dtelecom/src/test/mocks.d.ts +12 -0
  200. package/dist/ts4.2/@dtelecom/src/utils/AsyncQueue.d.ts +23 -0
  201. package/dist/ts4.2/@dtelecom/src/utils/browserParser.d.ts +12 -0
  202. package/dist/ts4.2/@dtelecom/src/version.d.ts +3 -0
  203. package/package.json +102 -0
  204. package/src/api/SignalClient.ts +790 -0
  205. package/src/connectionHelper/ConnectionCheck.ts +90 -0
  206. package/src/connectionHelper/checks/Checker.ts +163 -0
  207. package/src/connectionHelper/checks/publishAudio.ts +33 -0
  208. package/src/connectionHelper/checks/publishVideo.ts +33 -0
  209. package/src/connectionHelper/checks/reconnect.ts +45 -0
  210. package/src/connectionHelper/checks/turn.ts +54 -0
  211. package/src/connectionHelper/checks/webrtc.ts +82 -0
  212. package/src/connectionHelper/checks/websocket.ts +27 -0
  213. package/src/e2ee/E2eeManager.ts +375 -0
  214. package/src/e2ee/KeyProvider.ts +78 -0
  215. package/src/e2ee/constants.ts +44 -0
  216. package/src/e2ee/errors.ts +16 -0
  217. package/src/e2ee/index.ts +3 -0
  218. package/src/e2ee/types.ts +161 -0
  219. package/src/e2ee/utils.ts +127 -0
  220. package/src/e2ee/worker/FrameCryptor.test.ts +19 -0
  221. package/src/e2ee/worker/FrameCryptor.ts +612 -0
  222. package/src/e2ee/worker/ParticipantKeyHandler.ts +175 -0
  223. package/src/e2ee/worker/e2ee.worker.ts +223 -0
  224. package/src/e2ee/worker/tsconfig.json +6 -0
  225. package/src/index.ts +85 -0
  226. package/src/logger.ts +64 -0
  227. package/src/options.ts +127 -0
  228. package/src/proto/livekit_models_pb.ts +2096 -0
  229. package/src/proto/livekit_rtc_pb.ts +2332 -0
  230. package/src/room/DefaultReconnectPolicy.ts +35 -0
  231. package/src/room/DeviceManager.ts +88 -0
  232. package/src/room/PCTransport.ts +452 -0
  233. package/src/room/RTCEngine.ts +1421 -0
  234. package/src/room/ReconnectPolicy.ts +27 -0
  235. package/src/room/RegionUrlProvider.ts +82 -0
  236. package/src/room/Room.test.ts +30 -0
  237. package/src/room/Room.ts +1907 -0
  238. package/src/room/defaults.ts +49 -0
  239. package/src/room/errors.ts +90 -0
  240. package/src/room/events.ts +535 -0
  241. package/src/room/participant/LocalParticipant.ts +1350 -0
  242. package/src/room/participant/Participant.ts +299 -0
  243. package/src/room/participant/ParticipantTrackPermission.ts +42 -0
  244. package/src/room/participant/RemoteParticipant.ts +359 -0
  245. package/src/room/participant/publishUtils.test.ts +189 -0
  246. package/src/room/participant/publishUtils.ts +399 -0
  247. package/src/room/stats.ts +136 -0
  248. package/src/room/timers.ts +16 -0
  249. package/src/room/track/LocalAudioTrack.ts +171 -0
  250. package/src/room/track/LocalTrack.ts +430 -0
  251. package/src/room/track/LocalTrackPublication.ts +87 -0
  252. package/src/room/track/LocalVideoTrack.test.ts +73 -0
  253. package/src/room/track/LocalVideoTrack.ts +513 -0
  254. package/src/room/track/RemoteAudioTrack.ts +248 -0
  255. package/src/room/track/RemoteTrack.ts +62 -0
  256. package/src/room/track/RemoteTrackPublication.ts +311 -0
  257. package/src/room/track/RemoteVideoTrack.test.ts +152 -0
  258. package/src/room/track/RemoteVideoTrack.ts +410 -0
  259. package/src/room/track/Track.ts +452 -0
  260. package/src/room/track/TrackPublication.ts +158 -0
  261. package/src/room/track/create.ts +143 -0
  262. package/src/room/track/facingMode.test.ts +31 -0
  263. package/src/room/track/facingMode.ts +103 -0
  264. package/src/room/track/options.ts +362 -0
  265. package/src/room/track/processor/types.ts +20 -0
  266. package/src/room/track/types.ts +25 -0
  267. package/src/room/track/utils.test.ts +111 -0
  268. package/src/room/track/utils.ts +183 -0
  269. package/src/room/types.ts +39 -0
  270. package/src/room/utils.test.ts +16 -0
  271. package/src/room/utils.ts +501 -0
  272. package/src/room/worker.d.ts +4 -0
  273. package/src/test/MockMediaStreamTrack.ts +84 -0
  274. package/src/test/mocks.ts +19 -0
  275. package/src/utils/AsyncQueue.test.ts +100 -0
  276. package/src/utils/AsyncQueue.ts +57 -0
  277. package/src/utils/browserParser.test.ts +88 -0
  278. package/src/utils/browserParser.ts +74 -0
  279. package/src/version.ts +4 -0
@@ -0,0 +1,430 @@
1
+ import log from '../../logger';
2
+ import { getBrowser } from '../../utils/browserParser';
3
+ import DeviceManager from '../DeviceManager';
4
+ import { DeviceUnsupportedError, TrackInvalidError } from '../errors';
5
+ import { TrackEvent } from '../events';
6
+ import { Mutex, compareVersions, isMobile, sleep } from '../utils';
7
+ import { Track, attachToElement, detachTrack } from './Track';
8
+ import type { VideoCodec } from './options';
9
+ import type { TrackProcessor } from './processor/types';
10
+
11
+ const defaultDimensionsTimeout = 1000;
12
+
13
+ export default abstract class LocalTrack extends Track {
14
+ /** @internal */
15
+ sender?: RTCRtpSender;
16
+
17
+ /** @internal */
18
+ codec?: VideoCodec;
19
+
20
+ get constraints() {
21
+ return this._constraints;
22
+ }
23
+
24
+ protected _constraints: MediaTrackConstraints;
25
+
26
+ protected reacquireTrack: boolean;
27
+
28
+ protected providedByUser: boolean;
29
+
30
+ protected muteLock: Mutex;
31
+
32
+ protected pauseUpstreamLock: Mutex;
33
+
34
+ protected processorElement?: HTMLMediaElement;
35
+
36
+ protected processor?: TrackProcessor<typeof this.kind>;
37
+
38
+ protected processorLock: Mutex;
39
+
40
+ /**
41
+ *
42
+ * @param mediaTrack
43
+ * @param kind
44
+ * @param constraints MediaTrackConstraints that are being used when restarting or reacquiring tracks
45
+ * @param userProvidedTrack Signals to the SDK whether or not the mediaTrack should be managed (i.e. released and reacquired) internally by the SDK
46
+ */
47
+ protected constructor(
48
+ mediaTrack: MediaStreamTrack,
49
+ kind: Track.Kind,
50
+ constraints?: MediaTrackConstraints,
51
+ userProvidedTrack = false,
52
+ ) {
53
+ super(mediaTrack, kind);
54
+ this.reacquireTrack = false;
55
+ this.providedByUser = userProvidedTrack;
56
+ this.muteLock = new Mutex();
57
+ this.pauseUpstreamLock = new Mutex();
58
+ this.processorLock = new Mutex();
59
+ this.setMediaStreamTrack(mediaTrack, true);
60
+
61
+ // added to satisfy TS compiler, constraints are synced with MediaStreamTrack
62
+ this._constraints = mediaTrack.getConstraints();
63
+ if (constraints) {
64
+ this._constraints = constraints;
65
+ }
66
+ }
67
+
68
+ get id(): string {
69
+ return this._mediaStreamTrack.id;
70
+ }
71
+
72
+ get dimensions(): Track.Dimensions | undefined {
73
+ if (this.kind !== Track.Kind.Video) {
74
+ return undefined;
75
+ }
76
+
77
+ const { width, height } = this._mediaStreamTrack.getSettings();
78
+ if (width && height) {
79
+ return {
80
+ width,
81
+ height,
82
+ };
83
+ }
84
+ return undefined;
85
+ }
86
+
87
+ private _isUpstreamPaused: boolean = false;
88
+
89
+ get isUpstreamPaused() {
90
+ return this._isUpstreamPaused;
91
+ }
92
+
93
+ get isUserProvided() {
94
+ return this.providedByUser;
95
+ }
96
+
97
+ get mediaStreamTrack() {
98
+ return this.processor?.processedTrack ?? this._mediaStreamTrack;
99
+ }
100
+
101
+ private async setMediaStreamTrack(newTrack: MediaStreamTrack, force?: boolean) {
102
+ if (newTrack === this._mediaStreamTrack && !force) {
103
+ return;
104
+ }
105
+ if (this._mediaStreamTrack) {
106
+ // detach
107
+ this.attachedElements.forEach((el) => {
108
+ detachTrack(this._mediaStreamTrack, el);
109
+ });
110
+ this._mediaStreamTrack.removeEventListener('ended', this.handleEnded);
111
+ this._mediaStreamTrack.removeEventListener('mute', this.pauseUpstream);
112
+ this._mediaStreamTrack.removeEventListener('unmute', this.resumeUpstream);
113
+ if (!this.providedByUser && this._mediaStreamTrack !== newTrack) {
114
+ this._mediaStreamTrack.stop();
115
+ }
116
+ }
117
+
118
+ this.mediaStream = new MediaStream([newTrack]);
119
+ if (newTrack) {
120
+ newTrack.addEventListener('ended', this.handleEnded);
121
+ // when underlying track emits mute, it indicates that the device is unable
122
+ // to produce media. In this case we'll need to signal with remote that
123
+ // the track is "muted"
124
+ // note this is different from LocalTrack.mute because we do not want to
125
+ // touch MediaStreamTrack.enabled
126
+ newTrack.addEventListener('mute', this.pauseUpstream);
127
+ newTrack.addEventListener('unmute', this.resumeUpstream);
128
+ this._constraints = newTrack.getConstraints();
129
+ }
130
+ if (this.sender) {
131
+ await this.sender.replaceTrack(newTrack);
132
+ }
133
+ this._mediaStreamTrack = newTrack;
134
+ if (newTrack) {
135
+ // sync muted state with the enabled state of the newly provided track
136
+ this._mediaStreamTrack.enabled = !this.isMuted;
137
+ // when a valid track is replace, we'd want to start producing
138
+ await this.resumeUpstream();
139
+ this.attachedElements.forEach((el) => {
140
+ attachToElement(newTrack, el);
141
+ });
142
+ }
143
+ }
144
+
145
+ async waitForDimensions(timeout = defaultDimensionsTimeout): Promise<Track.Dimensions> {
146
+ if (this.kind === Track.Kind.Audio) {
147
+ throw new Error('cannot get dimensions for audio tracks');
148
+ }
149
+
150
+ const started = Date.now();
151
+ while (Date.now() - started < timeout) {
152
+ const dims = this.dimensions;
153
+ if (dims) {
154
+ return dims;
155
+ }
156
+ await sleep(50);
157
+ }
158
+ throw new TrackInvalidError('unable to get track dimensions after timeout');
159
+ }
160
+
161
+ /**
162
+ * @returns DeviceID of the device that is currently being used for this track
163
+ */
164
+ async getDeviceId(): Promise<string | undefined> {
165
+ // screen share doesn't have a usable device id
166
+ if (this.source === Track.Source.ScreenShare) {
167
+ return;
168
+ }
169
+ const { deviceId, groupId } = this._mediaStreamTrack.getSettings();
170
+ const kind = this.kind === Track.Kind.Audio ? 'audioinput' : 'videoinput';
171
+
172
+ return DeviceManager.getInstance().normalizeDeviceId(kind, deviceId, groupId);
173
+ }
174
+
175
+ async mute(): Promise<LocalTrack> {
176
+ this.setTrackMuted(true);
177
+ return this;
178
+ }
179
+
180
+ async unmute(): Promise<LocalTrack> {
181
+ this.setTrackMuted(false);
182
+ return this;
183
+ }
184
+
185
+ async replaceTrack(track: MediaStreamTrack, userProvidedTrack = true): Promise<LocalTrack> {
186
+ if (!this.sender) {
187
+ throw new TrackInvalidError('unable to replace an unpublished track');
188
+ }
189
+
190
+ log.debug('replace MediaStreamTrack');
191
+ await this.setMediaStreamTrack(track);
192
+ // this must be synced *after* setting mediaStreamTrack above, since it relies
193
+ // on the previous state in order to cleanup
194
+ this.providedByUser = userProvidedTrack;
195
+
196
+ if (this.processor) {
197
+ await this.stopProcessor();
198
+ }
199
+ return this;
200
+ }
201
+
202
+ protected async restart(constraints?: MediaTrackConstraints): Promise<LocalTrack> {
203
+ if (!constraints) {
204
+ constraints = this._constraints;
205
+ }
206
+ log.debug('restarting track with constraints', constraints);
207
+
208
+ const streamConstraints: MediaStreamConstraints = {
209
+ audio: false,
210
+ video: false,
211
+ };
212
+
213
+ if (this.kind === Track.Kind.Video) {
214
+ streamConstraints.video = constraints;
215
+ } else {
216
+ streamConstraints.audio = constraints;
217
+ }
218
+
219
+ // these steps are duplicated from setMediaStreamTrack because we must stop
220
+ // the previous tracks before new tracks can be acquired
221
+ this.attachedElements.forEach((el) => {
222
+ detachTrack(this.mediaStreamTrack, el);
223
+ });
224
+ this._mediaStreamTrack.removeEventListener('ended', this.handleEnded);
225
+ // on Safari, the old audio track must be stopped before attempting to acquire
226
+ // the new track, otherwise the new track will stop with
227
+ // 'A MediaStreamTrack ended due to a capture failure`
228
+ this._mediaStreamTrack.stop();
229
+
230
+ // create new track and attach
231
+ const mediaStream = await navigator.mediaDevices.getUserMedia(streamConstraints);
232
+ const newTrack = mediaStream.getTracks()[0];
233
+ newTrack.addEventListener('ended', this.handleEnded);
234
+ log.debug('re-acquired MediaStreamTrack');
235
+
236
+ await this.setMediaStreamTrack(newTrack);
237
+ this._constraints = constraints;
238
+ if (this.processor) {
239
+ const processor = this.processor;
240
+ await this.setProcessor(processor);
241
+ } else {
242
+ this.attachedElements.forEach((el) => {
243
+ attachToElement(this._mediaStreamTrack, el);
244
+ });
245
+ }
246
+ this.emit(TrackEvent.Restarted, this);
247
+ return this;
248
+ }
249
+
250
+ protected setTrackMuted(muted: boolean) {
251
+ log.debug(`setting ${this.kind} track ${muted ? 'muted' : 'unmuted'}`);
252
+
253
+ if (this.isMuted === muted && this._mediaStreamTrack.enabled !== muted) {
254
+ return;
255
+ }
256
+
257
+ this.isMuted = muted;
258
+ this._mediaStreamTrack.enabled = !muted;
259
+ this.emit(muted ? TrackEvent.Muted : TrackEvent.Unmuted, this);
260
+ }
261
+
262
+ protected get needsReAcquisition(): boolean {
263
+ return (
264
+ this._mediaStreamTrack.readyState !== 'live' ||
265
+ this._mediaStreamTrack.muted ||
266
+ !this._mediaStreamTrack.enabled ||
267
+ this.reacquireTrack
268
+ );
269
+ }
270
+
271
+ protected async handleAppVisibilityChanged() {
272
+ await super.handleAppVisibilityChanged();
273
+ if (!isMobile()) return;
274
+ log.debug(`visibility changed, is in Background: ${this.isInBackground}`);
275
+
276
+ if (!this.isInBackground && this.needsReAcquisition && !this.isUserProvided && !this.isMuted) {
277
+ log.debug(`track needs to be reaquired, restarting ${this.source}`);
278
+ await this.restart();
279
+ this.reacquireTrack = false;
280
+ }
281
+ }
282
+
283
+ private handleEnded = () => {
284
+ if (this.isInBackground) {
285
+ this.reacquireTrack = true;
286
+ }
287
+ this._mediaStreamTrack.removeEventListener('mute', this.pauseUpstream);
288
+ this._mediaStreamTrack.removeEventListener('unmute', this.resumeUpstream);
289
+ this.emit(TrackEvent.Ended, this);
290
+ };
291
+
292
+ stop() {
293
+ super.stop();
294
+
295
+ this._mediaStreamTrack.removeEventListener('ended', this.handleEnded);
296
+ this._mediaStreamTrack.removeEventListener('mute', this.pauseUpstream);
297
+ this._mediaStreamTrack.removeEventListener('unmute', this.resumeUpstream);
298
+ this.processor?.destroy();
299
+ this.processor = undefined;
300
+ }
301
+
302
+ /**
303
+ * pauses publishing to the server without disabling the local MediaStreamTrack
304
+ * this is used to display a user's own video locally while pausing publishing to
305
+ * the server.
306
+ * this API is unsupported on Safari < 12 due to a bug
307
+ **/
308
+ pauseUpstream = async () => {
309
+ const unlock = await this.pauseUpstreamLock.lock();
310
+ try {
311
+ if (this._isUpstreamPaused === true) {
312
+ return;
313
+ }
314
+ if (!this.sender) {
315
+ log.warn('unable to pause upstream for an unpublished track');
316
+ return;
317
+ }
318
+
319
+ this._isUpstreamPaused = true;
320
+ this.emit(TrackEvent.UpstreamPaused, this);
321
+ const browser = getBrowser();
322
+ if (browser?.name === 'Safari' && compareVersions(browser.version, '12.0') < 0) {
323
+ // https://bugs.webkit.org/show_bug.cgi?id=184911
324
+ throw new DeviceUnsupportedError('pauseUpstream is not supported on Safari < 12.');
325
+ }
326
+ await this.sender.replaceTrack(null);
327
+ } finally {
328
+ unlock();
329
+ }
330
+ };
331
+
332
+ resumeUpstream = async () => {
333
+ const unlock = await this.pauseUpstreamLock.lock();
334
+ try {
335
+ if (this._isUpstreamPaused === false) {
336
+ return;
337
+ }
338
+ if (!this.sender) {
339
+ log.warn('unable to resume upstream for an unpublished track');
340
+ return;
341
+ }
342
+ this._isUpstreamPaused = false;
343
+ this.emit(TrackEvent.UpstreamResumed, this);
344
+
345
+ // this operation is noop if mediastreamtrack is already being sent
346
+ await this.sender.replaceTrack(this._mediaStreamTrack);
347
+ } finally {
348
+ unlock();
349
+ }
350
+ };
351
+
352
+ /**
353
+ * Sets a processor on this track.
354
+ * See https://github.com/livekit/track-processors-js for example usage
355
+ *
356
+ * @experimental
357
+ *
358
+ * @param processor
359
+ * @param showProcessedStreamLocally
360
+ * @returns
361
+ */
362
+ async setProcessor(
363
+ processor: TrackProcessor<typeof this.kind>,
364
+ showProcessedStreamLocally = true,
365
+ ) {
366
+ const unlock = await this.processorLock.lock();
367
+ try {
368
+ log.debug('setting up processor');
369
+ if (this.processor) {
370
+ await this.stopProcessor();
371
+ }
372
+ if (this.kind === 'unknown') {
373
+ throw TypeError('cannot set processor on track of unknown kind');
374
+ }
375
+ this.processorElement = this.processorElement ?? document.createElement(this.kind);
376
+ this.processorElement.muted = true;
377
+
378
+ attachToElement(this._mediaStreamTrack, this.processorElement);
379
+ this.processorElement
380
+ .play()
381
+ .catch((error) => log.error('failed to play processor element', { error }));
382
+
383
+ const processorOptions = {
384
+ kind: this.kind,
385
+ track: this._mediaStreamTrack,
386
+ element: this.processorElement,
387
+ };
388
+
389
+ await processor.init(processorOptions);
390
+ this.processor = processor;
391
+ if (this.processor.processedTrack) {
392
+ for (const el of this.attachedElements) {
393
+ if (el !== this.processorElement && showProcessedStreamLocally) {
394
+ detachTrack(this._mediaStreamTrack, el);
395
+ attachToElement(this.processor.processedTrack, el);
396
+ }
397
+ }
398
+ await this.sender?.replaceTrack(this.processor.processedTrack);
399
+ }
400
+ } finally {
401
+ unlock();
402
+ }
403
+ }
404
+
405
+ getProcessor() {
406
+ return this.processor;
407
+ }
408
+
409
+ /**
410
+ * Stops the track processor
411
+ * See https://github.com/livekit/track-processors-js for example usage
412
+ *
413
+ * @experimental
414
+ * @returns
415
+ */
416
+ async stopProcessor() {
417
+ if (!this.processor) return;
418
+
419
+ log.debug('stopping processor');
420
+ this.processor.processedTrack?.stop();
421
+ await this.processor.destroy();
422
+ this.processor = undefined;
423
+ this.processorElement?.remove();
424
+ this.processorElement = undefined;
425
+
426
+ await this.restart();
427
+ }
428
+
429
+ protected abstract monitorSender(): void;
430
+ }
@@ -0,0 +1,87 @@
1
+ import type { TrackInfo } from '../../proto/livekit_models_pb';
2
+ import { TrackEvent } from '../events';
3
+ import type LocalAudioTrack from './LocalAudioTrack';
4
+ import type LocalTrack from './LocalTrack';
5
+ import type LocalVideoTrack from './LocalVideoTrack';
6
+ import type { Track } from './Track';
7
+ import { TrackPublication } from './TrackPublication';
8
+ import type { TrackPublishOptions } from './options';
9
+
10
+ export default class LocalTrackPublication extends TrackPublication {
11
+ track?: LocalTrack = undefined;
12
+
13
+ options?: TrackPublishOptions;
14
+
15
+ get isUpstreamPaused() {
16
+ return this.track?.isUpstreamPaused;
17
+ }
18
+
19
+ constructor(kind: Track.Kind, ti: TrackInfo, track?: LocalTrack) {
20
+ super(kind, ti.sid, ti.name);
21
+
22
+ this.updateInfo(ti);
23
+ this.setTrack(track);
24
+ }
25
+
26
+ setTrack(track?: Track) {
27
+ if (this.track) {
28
+ this.track.off(TrackEvent.Ended, this.handleTrackEnded);
29
+ }
30
+
31
+ super.setTrack(track);
32
+
33
+ if (track) {
34
+ track.on(TrackEvent.Ended, this.handleTrackEnded);
35
+ }
36
+ }
37
+
38
+ get isMuted(): boolean {
39
+ if (this.track) {
40
+ return this.track.isMuted;
41
+ }
42
+ return super.isMuted;
43
+ }
44
+
45
+ get audioTrack(): LocalAudioTrack | undefined {
46
+ return super.audioTrack as LocalAudioTrack | undefined;
47
+ }
48
+
49
+ get videoTrack(): LocalVideoTrack | undefined {
50
+ return super.videoTrack as LocalVideoTrack | undefined;
51
+ }
52
+
53
+ /**
54
+ * Mute the track associated with this publication
55
+ */
56
+ async mute() {
57
+ return this.track?.mute();
58
+ }
59
+
60
+ /**
61
+ * Unmute track associated with this publication
62
+ */
63
+ async unmute() {
64
+ return this.track?.unmute();
65
+ }
66
+
67
+ /**
68
+ * Pauses the media stream track associated with this publication from being sent to the server
69
+ * and signals "muted" event to other participants
70
+ * Useful if you want to pause the stream without pausing the local media stream track
71
+ */
72
+ async pauseUpstream() {
73
+ await this.track?.pauseUpstream();
74
+ }
75
+
76
+ /**
77
+ * Resumes sending the media stream track associated with this publication to the server after a call to [[pauseUpstream()]]
78
+ * and signals "unmuted" event to other participants (unless the track is explicitly muted)
79
+ */
80
+ async resumeUpstream() {
81
+ await this.track?.resumeUpstream();
82
+ }
83
+
84
+ handleTrackEnded = () => {
85
+ this.emit(TrackEvent.Ended);
86
+ };
87
+ }
@@ -0,0 +1,73 @@
1
+ import { describe, expect, it } from 'vitest';
2
+ import { VideoQuality } from '../../proto/livekit_models_pb';
3
+ import { videoLayersFromEncodings } from './LocalVideoTrack';
4
+
5
+ describe('videoLayersFromEncodings', () => {
6
+ it('returns single layer for no encoding', () => {
7
+ const layers = videoLayersFromEncodings(640, 360);
8
+ expect(layers).toHaveLength(1);
9
+ expect(layers[0].quality).toBe(VideoQuality.HIGH);
10
+ expect(layers[0].width).toBe(640);
11
+ expect(layers[0].height).toBe(360);
12
+ });
13
+
14
+ it('returns single layer for explicit encoding', () => {
15
+ const layers = videoLayersFromEncodings(640, 360, [
16
+ {
17
+ maxBitrate: 200_000,
18
+ },
19
+ ]);
20
+ expect(layers).toHaveLength(1);
21
+ expect(layers[0].quality).toBe(VideoQuality.HIGH);
22
+ expect(layers[0].bitrate).toBe(200_000);
23
+ });
24
+
25
+ it('returns three layers for simulcast', () => {
26
+ const layers = videoLayersFromEncodings(1280, 720, [
27
+ {
28
+ scaleResolutionDownBy: 4,
29
+ rid: 'q',
30
+ maxBitrate: 125_000,
31
+ },
32
+ {
33
+ scaleResolutionDownBy: 2,
34
+ rid: 'h',
35
+ maxBitrate: 500_000,
36
+ },
37
+ {
38
+ rid: 'f',
39
+ maxBitrate: 1_200_000,
40
+ },
41
+ ]);
42
+
43
+ expect(layers).toHaveLength(3);
44
+ expect(layers[0].quality).toBe(VideoQuality.LOW);
45
+ expect(layers[0].width).toBe(320);
46
+ expect(layers[2].quality).toBe(VideoQuality.HIGH);
47
+ expect(layers[2].height).toBe(720);
48
+ });
49
+
50
+ it('handles portrait', () => {
51
+ const layers = videoLayersFromEncodings(720, 1280, [
52
+ {
53
+ scaleResolutionDownBy: 4,
54
+ rid: 'q',
55
+ maxBitrate: 125_000,
56
+ },
57
+ {
58
+ scaleResolutionDownBy: 2,
59
+ rid: 'h',
60
+ maxBitrate: 500_000,
61
+ },
62
+ {
63
+ rid: 'f',
64
+ maxBitrate: 1_200_000,
65
+ },
66
+ ]);
67
+ expect(layers).toHaveLength(3);
68
+ expect(layers[0].quality).toBe(VideoQuality.LOW);
69
+ expect(layers[0].height).toBe(320);
70
+ expect(layers[2].quality).toBe(VideoQuality.HIGH);
71
+ expect(layers[2].width).toBe(720);
72
+ });
73
+ });