@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,452 @@
1
+ import { EventEmitter } from 'events';
2
+ import type TypedEventEmitter from 'typed-emitter';
3
+ import type { SignalClient } from '../../api/SignalClient';
4
+ import log from '../../logger';
5
+ import { TrackSource, TrackType } from '../../proto/livekit_models_pb';
6
+ import { StreamState as ProtoStreamState } from '../../proto/livekit_rtc_pb';
7
+ import { TrackEvent } from '../events';
8
+ import { isFireFox, isSafari, isWeb } from '../utils';
9
+
10
+ const BACKGROUND_REACTION_DELAY = 5000;
11
+
12
+ // keep old audio elements when detached, we would re-use them since on iOS
13
+ // Safari tracks which audio elements have been "blessed" by the user.
14
+ const recycledElements: Array<HTMLAudioElement> = [];
15
+
16
+ export abstract class Track extends (EventEmitter as new () => TypedEventEmitter<TrackEventCallbacks>) {
17
+ kind: Track.Kind;
18
+
19
+ attachedElements: HTMLMediaElement[] = [];
20
+
21
+ isMuted: boolean = false;
22
+
23
+ source: Track.Source;
24
+
25
+ /**
26
+ * sid is set after track is published to server, or if it's a remote track
27
+ */
28
+ sid?: Track.SID;
29
+
30
+ /**
31
+ * @internal
32
+ */
33
+ mediaStream?: MediaStream;
34
+
35
+ /**
36
+ * indicates current state of stream, it'll indicate `paused` if the track
37
+ * has been paused by congestion controller
38
+ */
39
+ streamState: Track.StreamState = Track.StreamState.Active;
40
+
41
+ protected _mediaStreamTrack: MediaStreamTrack;
42
+
43
+ protected _mediaStreamID: string;
44
+
45
+ protected isInBackground: boolean = false;
46
+
47
+ private backgroundTimeout: ReturnType<typeof setTimeout> | undefined;
48
+
49
+ protected _currentBitrate: number = 0;
50
+
51
+ protected monitorInterval?: ReturnType<typeof setInterval>;
52
+
53
+ protected constructor(mediaTrack: MediaStreamTrack, kind: Track.Kind) {
54
+ super();
55
+ this.setMaxListeners(100);
56
+ this.kind = kind;
57
+ this._mediaStreamTrack = mediaTrack;
58
+ this._mediaStreamID = mediaTrack.id;
59
+ this.source = Track.Source.Unknown;
60
+ }
61
+
62
+ /** current receive bits per second */
63
+ get currentBitrate(): number {
64
+ return this._currentBitrate;
65
+ }
66
+
67
+ get mediaStreamTrack() {
68
+ return this._mediaStreamTrack;
69
+ }
70
+
71
+ /**
72
+ * @internal
73
+ * used for keep mediaStream's first id, since it's id might change
74
+ * if we disable/enable a track
75
+ */
76
+ get mediaStreamID(): string {
77
+ return this._mediaStreamID;
78
+ }
79
+
80
+ /**
81
+ * creates a new HTMLAudioElement or HTMLVideoElement, attaches to it, and returns it
82
+ */
83
+ attach(): HTMLMediaElement;
84
+
85
+ /**
86
+ * attaches track to an existing HTMLAudioElement or HTMLVideoElement
87
+ */
88
+ attach(element: HTMLMediaElement): HTMLMediaElement;
89
+ attach(element?: HTMLMediaElement): HTMLMediaElement {
90
+ let elementType = 'audio';
91
+ if (this.kind === Track.Kind.Video) {
92
+ elementType = 'video';
93
+ }
94
+ if (this.attachedElements.length === 0 && Track.Kind.Video) {
95
+ this.addAppVisibilityListener();
96
+ }
97
+ if (!element) {
98
+ if (elementType === 'audio') {
99
+ recycledElements.forEach((e) => {
100
+ if (e.parentElement === null && !element) {
101
+ element = e;
102
+ }
103
+ });
104
+ if (element) {
105
+ // remove it from pool
106
+ recycledElements.splice(recycledElements.indexOf(element), 1);
107
+ }
108
+ }
109
+ if (!element) {
110
+ element = <HTMLMediaElement>document.createElement(elementType);
111
+ }
112
+ }
113
+
114
+ if (!this.attachedElements.includes(element)) {
115
+ this.attachedElements.push(element);
116
+ }
117
+
118
+ // even if we believe it's already attached to the element, it's possible
119
+ // the element's srcObject was set to something else out of band.
120
+ // we'll want to re-attach it in that case
121
+ attachToElement(this.mediaStreamTrack, element);
122
+
123
+ // handle auto playback failures
124
+ const allMediaStreamTracks = (element.srcObject as MediaStream).getTracks();
125
+ if (allMediaStreamTracks.some((tr) => tr.kind === 'audio')) {
126
+ // manually play audio to detect audio playback status
127
+ element
128
+ .play()
129
+ .then(() => {
130
+ this.emit(TrackEvent.AudioPlaybackStarted);
131
+ })
132
+ .catch((e) => {
133
+ if (e.name === 'NotAllowedError') {
134
+ this.emit(TrackEvent.AudioPlaybackFailed, e);
135
+ } else {
136
+ log.warn('could not playback audio', e);
137
+ }
138
+ // If audio playback isn't allowed make sure we still play back the video
139
+ if (
140
+ element &&
141
+ allMediaStreamTracks.some((tr) => tr.kind === 'video') &&
142
+ e.name === 'NotAllowedError'
143
+ ) {
144
+ element.muted = true;
145
+ element.play().catch(() => {
146
+ // catch for Safari, exceeded options at this point to automatically play the media element
147
+ });
148
+ }
149
+ });
150
+ }
151
+
152
+ this.emit(TrackEvent.ElementAttached, element);
153
+ return element;
154
+ }
155
+
156
+ /**
157
+ * Detaches from all attached elements
158
+ */
159
+ detach(): HTMLMediaElement[];
160
+
161
+ /**
162
+ * Detach from a single element
163
+ * @param element
164
+ */
165
+ detach(element: HTMLMediaElement): HTMLMediaElement;
166
+ detach(element?: HTMLMediaElement): HTMLMediaElement | HTMLMediaElement[] {
167
+ try {
168
+ // detach from a single element
169
+ if (element) {
170
+ detachTrack(this.mediaStreamTrack, element);
171
+ const idx = this.attachedElements.indexOf(element);
172
+ if (idx >= 0) {
173
+ this.attachedElements.splice(idx, 1);
174
+ this.recycleElement(element);
175
+ this.emit(TrackEvent.ElementDetached, element);
176
+ }
177
+ return element;
178
+ }
179
+
180
+ const detached: HTMLMediaElement[] = [];
181
+ this.attachedElements.forEach((elm) => {
182
+ detachTrack(this.mediaStreamTrack, elm);
183
+ detached.push(elm);
184
+ this.recycleElement(elm);
185
+ this.emit(TrackEvent.ElementDetached, elm);
186
+ });
187
+
188
+ // remove all tracks
189
+ this.attachedElements = [];
190
+ return detached;
191
+ } finally {
192
+ if (this.attachedElements.length === 0) {
193
+ this.removeAppVisibilityListener();
194
+ }
195
+ }
196
+ }
197
+
198
+ stop() {
199
+ this.stopMonitor();
200
+ this._mediaStreamTrack.stop();
201
+ }
202
+
203
+ protected enable() {
204
+ this._mediaStreamTrack.enabled = true;
205
+ }
206
+
207
+ protected disable() {
208
+ this._mediaStreamTrack.enabled = false;
209
+ }
210
+
211
+ /* @internal */
212
+ abstract startMonitor(signalClient?: SignalClient): void;
213
+
214
+ /* @internal */
215
+ stopMonitor() {
216
+ if (this.monitorInterval) {
217
+ clearInterval(this.monitorInterval);
218
+ }
219
+ }
220
+
221
+ private recycleElement(element: HTMLMediaElement) {
222
+ if (element instanceof HTMLAudioElement) {
223
+ // we only need to re-use a single element
224
+ let shouldCache = true;
225
+ element.pause();
226
+ recycledElements.forEach((e) => {
227
+ if (!e.parentElement) {
228
+ shouldCache = false;
229
+ }
230
+ });
231
+ if (shouldCache) {
232
+ recycledElements.push(element);
233
+ }
234
+ }
235
+ }
236
+
237
+ protected appVisibilityChangedListener = () => {
238
+ if (this.backgroundTimeout) {
239
+ clearTimeout(this.backgroundTimeout);
240
+ }
241
+ // delay app visibility update if it goes to hidden
242
+ // update immediately if it comes back to focus
243
+ if (document.visibilityState === 'hidden') {
244
+ this.backgroundTimeout = setTimeout(
245
+ () => this.handleAppVisibilityChanged(),
246
+ BACKGROUND_REACTION_DELAY,
247
+ );
248
+ } else {
249
+ this.handleAppVisibilityChanged();
250
+ }
251
+ };
252
+
253
+ protected async handleAppVisibilityChanged() {
254
+ this.isInBackground = document.visibilityState === 'hidden';
255
+ }
256
+
257
+ protected addAppVisibilityListener() {
258
+ if (isWeb()) {
259
+ this.isInBackground = document.visibilityState === 'hidden';
260
+ document.addEventListener('visibilitychange', this.appVisibilityChangedListener);
261
+ } else {
262
+ this.isInBackground = false;
263
+ }
264
+ }
265
+
266
+ protected removeAppVisibilityListener() {
267
+ if (isWeb()) {
268
+ document.removeEventListener('visibilitychange', this.appVisibilityChangedListener);
269
+ }
270
+ }
271
+ }
272
+
273
+ /** @internal */
274
+ export function attachToElement(track: MediaStreamTrack, element: HTMLMediaElement) {
275
+ let mediaStream: MediaStream;
276
+ if (element.srcObject instanceof MediaStream) {
277
+ mediaStream = element.srcObject;
278
+ } else {
279
+ mediaStream = new MediaStream();
280
+ }
281
+
282
+ // check if track matches existing track
283
+ let existingTracks: MediaStreamTrack[];
284
+ if (track.kind === 'audio') {
285
+ existingTracks = mediaStream.getAudioTracks();
286
+ } else {
287
+ existingTracks = mediaStream.getVideoTracks();
288
+ }
289
+ if (!existingTracks.includes(track)) {
290
+ existingTracks.forEach((et) => {
291
+ mediaStream.removeTrack(et);
292
+ });
293
+ mediaStream.addTrack(track);
294
+ }
295
+
296
+ element.autoplay = true;
297
+ // In case there are no audio tracks present on the mediastream, we set the element as muted to ensure autoplay works
298
+ element.muted = mediaStream.getAudioTracks().length === 0;
299
+ if (element instanceof HTMLVideoElement) {
300
+ element.playsInline = true;
301
+ }
302
+
303
+ // avoid flicker
304
+ if (element.srcObject !== mediaStream) {
305
+ element.srcObject = mediaStream;
306
+ if ((isSafari() || isFireFox()) && element instanceof HTMLVideoElement) {
307
+ // Firefox also has a timing issue where video doesn't actually get attached unless
308
+ // performed out-of-band
309
+ // Safari 15 has a bug where in certain layouts, video element renders
310
+ // black until the page is resized or other changes take place.
311
+ // Resetting the src triggers it to render.
312
+ // https://developer.apple.com/forums/thread/690523
313
+ setTimeout(() => {
314
+ element.srcObject = mediaStream;
315
+ // Safari 15 sometimes fails to start a video
316
+ // when the window is backgrounded before the first frame is drawn
317
+ // manually calling play here seems to fix that
318
+ element.play().catch(() => {
319
+ /* do nothing */
320
+ });
321
+ }, 0);
322
+ }
323
+ }
324
+ }
325
+
326
+ /** @internal */
327
+ export function detachTrack(track: MediaStreamTrack, element: HTMLMediaElement) {
328
+ if (element.srcObject instanceof MediaStream) {
329
+ const mediaStream = element.srcObject;
330
+ mediaStream.removeTrack(track);
331
+ if (mediaStream.getTracks().length > 0) {
332
+ element.srcObject = mediaStream;
333
+ } else {
334
+ element.srcObject = null;
335
+ }
336
+ }
337
+ }
338
+
339
+ export namespace Track {
340
+ export enum Kind {
341
+ Audio = 'audio',
342
+ Video = 'video',
343
+ Unknown = 'unknown',
344
+ }
345
+ export type SID = string;
346
+ export enum Source {
347
+ Camera = 'camera',
348
+ Microphone = 'microphone',
349
+ ScreenShare = 'screen_share',
350
+ ScreenShareAudio = 'screen_share_audio',
351
+ Unknown = 'unknown',
352
+ }
353
+
354
+ export enum StreamState {
355
+ Active = 'active',
356
+ Paused = 'paused',
357
+ Unknown = 'unknown',
358
+ }
359
+
360
+ export interface Dimensions {
361
+ width: number;
362
+ height: number;
363
+ }
364
+
365
+ /** @internal */
366
+ export function kindToProto(k: Kind): TrackType {
367
+ switch (k) {
368
+ case Kind.Audio:
369
+ return TrackType.AUDIO;
370
+ case Kind.Video:
371
+ return TrackType.VIDEO;
372
+ default:
373
+ // FIXME this was UNRECOGNIZED before
374
+ return TrackType.DATA;
375
+ }
376
+ }
377
+
378
+ /** @internal */
379
+ export function kindFromProto(t: TrackType): Kind | undefined {
380
+ switch (t) {
381
+ case TrackType.AUDIO:
382
+ return Kind.Audio;
383
+ case TrackType.VIDEO:
384
+ return Kind.Video;
385
+ default:
386
+ return Kind.Unknown;
387
+ }
388
+ }
389
+
390
+ /** @internal */
391
+ export function sourceToProto(s: Source): TrackSource {
392
+ switch (s) {
393
+ case Source.Camera:
394
+ return TrackSource.CAMERA;
395
+ case Source.Microphone:
396
+ return TrackSource.MICROPHONE;
397
+ case Source.ScreenShare:
398
+ return TrackSource.SCREEN_SHARE;
399
+ case Source.ScreenShareAudio:
400
+ return TrackSource.SCREEN_SHARE_AUDIO;
401
+ default:
402
+ return TrackSource.UNKNOWN;
403
+ }
404
+ }
405
+
406
+ /** @internal */
407
+ export function sourceFromProto(s: TrackSource): Source {
408
+ switch (s) {
409
+ case TrackSource.CAMERA:
410
+ return Source.Camera;
411
+ case TrackSource.MICROPHONE:
412
+ return Source.Microphone;
413
+ case TrackSource.SCREEN_SHARE:
414
+ return Source.ScreenShare;
415
+ case TrackSource.SCREEN_SHARE_AUDIO:
416
+ return Source.ScreenShareAudio;
417
+ default:
418
+ return Source.Unknown;
419
+ }
420
+ }
421
+
422
+ /** @internal */
423
+ export function streamStateFromProto(s: ProtoStreamState): StreamState {
424
+ switch (s) {
425
+ case ProtoStreamState.ACTIVE:
426
+ return StreamState.Active;
427
+ case ProtoStreamState.PAUSED:
428
+ return StreamState.Paused;
429
+ default:
430
+ return StreamState.Unknown;
431
+ }
432
+ }
433
+ }
434
+
435
+ export type TrackEventCallbacks = {
436
+ message: () => void;
437
+ muted: (track?: any) => void;
438
+ unmuted: (track?: any) => void;
439
+ restarted: (track?: any) => void;
440
+ ended: (track?: any) => void;
441
+ updateSettings: () => void;
442
+ updateSubscription: () => void;
443
+ audioPlaybackStarted: () => void;
444
+ audioPlaybackFailed: (error: Error) => void;
445
+ audioSilenceDetected: () => void;
446
+ visibilityChanged: (visible: boolean, track?: any) => void;
447
+ videoDimensionsChanged: (dimensions: Track.Dimensions, track?: any) => void;
448
+ elementAttached: (element: HTMLMediaElement) => void;
449
+ elementDetached: (element: HTMLMediaElement) => void;
450
+ upstreamPaused: (track: any) => void;
451
+ upstreamResumed: (track: any) => void;
452
+ };
@@ -0,0 +1,158 @@
1
+ import { EventEmitter } from 'events';
2
+ import type TypedEventEmitter from 'typed-emitter';
3
+ import log from '../../logger';
4
+ import { Encryption_Type } from '../../proto/livekit_models_pb';
5
+ import type { SubscriptionError, TrackInfo } from '../../proto/livekit_models_pb';
6
+ import type { UpdateSubscription, UpdateTrackSettings } from '../../proto/livekit_rtc_pb';
7
+ import { TrackEvent } from '../events';
8
+ import LocalAudioTrack from './LocalAudioTrack';
9
+ import LocalVideoTrack from './LocalVideoTrack';
10
+ import RemoteAudioTrack from './RemoteAudioTrack';
11
+ import type RemoteTrack from './RemoteTrack';
12
+ import RemoteVideoTrack from './RemoteVideoTrack';
13
+ import { Track } from './Track';
14
+
15
+ export class TrackPublication extends (EventEmitter as new () => TypedEventEmitter<PublicationEventCallbacks>) {
16
+ kind: Track.Kind;
17
+
18
+ trackName: string;
19
+
20
+ trackSid: Track.SID;
21
+
22
+ track?: Track;
23
+
24
+ source: Track.Source;
25
+
26
+ /** MimeType of the published track */
27
+ mimeType?: string;
28
+
29
+ /** dimension of the original published stream, video-only */
30
+ dimensions?: Track.Dimensions;
31
+
32
+ /** true if track was simulcasted to server, video-only */
33
+ simulcasted?: boolean;
34
+
35
+ /** @internal */
36
+ trackInfo?: TrackInfo;
37
+
38
+ protected metadataMuted: boolean = false;
39
+
40
+ protected encryption: Encryption_Type = Encryption_Type.NONE;
41
+
42
+ constructor(kind: Track.Kind, id: string, name: string) {
43
+ super();
44
+ this.setMaxListeners(100);
45
+ this.kind = kind;
46
+ this.trackSid = id;
47
+ this.trackName = name;
48
+ this.source = Track.Source.Unknown;
49
+ }
50
+
51
+ /** @internal */
52
+ setTrack(track?: Track) {
53
+ if (this.track) {
54
+ this.track.off(TrackEvent.Muted, this.handleMuted);
55
+ this.track.off(TrackEvent.Unmuted, this.handleUnmuted);
56
+ }
57
+
58
+ this.track = track;
59
+
60
+ if (track) {
61
+ // forward events
62
+ track.on(TrackEvent.Muted, this.handleMuted);
63
+ track.on(TrackEvent.Unmuted, this.handleUnmuted);
64
+ }
65
+ }
66
+
67
+ get isMuted(): boolean {
68
+ return this.metadataMuted;
69
+ }
70
+
71
+ get isEnabled(): boolean {
72
+ return true;
73
+ }
74
+
75
+ get isSubscribed(): boolean {
76
+ return this.track !== undefined;
77
+ }
78
+
79
+ get isEncrypted(): boolean {
80
+ return this.encryption !== Encryption_Type.NONE;
81
+ }
82
+
83
+ /**
84
+ * an [AudioTrack] if this publication holds an audio track
85
+ */
86
+ get audioTrack(): LocalAudioTrack | RemoteAudioTrack | undefined {
87
+ if (this.track instanceof LocalAudioTrack || this.track instanceof RemoteAudioTrack) {
88
+ return this.track;
89
+ }
90
+ }
91
+
92
+ /**
93
+ * an [VideoTrack] if this publication holds a video track
94
+ */
95
+ get videoTrack(): LocalVideoTrack | RemoteVideoTrack | undefined {
96
+ if (this.track instanceof LocalVideoTrack || this.track instanceof RemoteVideoTrack) {
97
+ return this.track;
98
+ }
99
+ }
100
+
101
+ handleMuted = () => {
102
+ this.emit(TrackEvent.Muted);
103
+ };
104
+
105
+ handleUnmuted = () => {
106
+ this.emit(TrackEvent.Unmuted);
107
+ };
108
+
109
+ /** @internal */
110
+ updateInfo(info: TrackInfo) {
111
+ this.trackSid = info.sid;
112
+ this.trackName = info.name;
113
+ this.source = Track.sourceFromProto(info.source);
114
+ this.mimeType = info.mimeType;
115
+ if (this.kind === Track.Kind.Video && info.width > 0) {
116
+ this.dimensions = {
117
+ width: info.width,
118
+ height: info.height,
119
+ };
120
+ this.simulcasted = info.simulcast;
121
+ }
122
+ this.encryption = info.encryption;
123
+ this.trackInfo = info;
124
+ log.debug('update publication info', { info });
125
+ }
126
+ }
127
+
128
+ export namespace TrackPublication {
129
+ export enum SubscriptionStatus {
130
+ Desired = 'desired',
131
+ Subscribed = 'subscribed',
132
+ Unsubscribed = 'unsubscribed',
133
+ }
134
+
135
+ export enum PermissionStatus {
136
+ Allowed = 'allowed',
137
+ NotAllowed = 'not_allowed',
138
+ }
139
+ }
140
+
141
+ export type PublicationEventCallbacks = {
142
+ muted: () => void;
143
+ unmuted: () => void;
144
+ ended: (track?: Track) => void;
145
+ updateSettings: (settings: UpdateTrackSettings) => void;
146
+ subscriptionPermissionChanged: (
147
+ status: TrackPublication.PermissionStatus,
148
+ prevStatus: TrackPublication.PermissionStatus,
149
+ ) => void;
150
+ updateSubscription: (sub: UpdateSubscription) => void;
151
+ subscribed: (track: RemoteTrack) => void;
152
+ unsubscribed: (track: RemoteTrack) => void;
153
+ subscriptionStatusChanged: (
154
+ status: TrackPublication.SubscriptionStatus,
155
+ prevStatus: TrackPublication.SubscriptionStatus,
156
+ ) => void;
157
+ subscriptionFailed: (error: SubscriptionError) => void;
158
+ };