@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,152 @@
1
+ import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
2
+ import MockMediaStreamTrack from '../../test/MockMediaStreamTrack';
3
+ import { TrackEvent } from '../events';
4
+ import RemoteVideoTrack, { ElementInfo } from './RemoteVideoTrack';
5
+ import type { Track } from './Track';
6
+
7
+ vi.useFakeTimers();
8
+
9
+ describe('RemoteVideoTrack', () => {
10
+ let track: RemoteVideoTrack;
11
+
12
+ beforeEach(() => {
13
+ track = new RemoteVideoTrack(new MockMediaStreamTrack(), 'sid', undefined, {});
14
+ });
15
+ describe('element visibility', () => {
16
+ let events: boolean[] = [];
17
+
18
+ beforeEach(() => {
19
+ track.on(TrackEvent.VisibilityChanged, (visible) => {
20
+ events.push(visible);
21
+ });
22
+ });
23
+ afterEach(() => {
24
+ events = [];
25
+ });
26
+
27
+ it('emits a visibility event upon observing visible element', () => {
28
+ const elementInfo = new MockElementInfo();
29
+ elementInfo.visible = true;
30
+
31
+ track.observeElementInfo(elementInfo);
32
+
33
+ expect(events).toHaveLength(1);
34
+ expect(events[0]).toBeTruthy();
35
+ });
36
+
37
+ it('emits a visibility event upon element becoming visible', () => {
38
+ const elementInfo = new MockElementInfo();
39
+ track.observeElementInfo(elementInfo);
40
+
41
+ elementInfo.setVisible(true);
42
+
43
+ expect(events).toHaveLength(2);
44
+ expect(events[1]).toBeTruthy();
45
+ });
46
+
47
+ it('emits a visibility event upon removing only visible element', () => {
48
+ const elementInfo = new MockElementInfo();
49
+ elementInfo.visible = true;
50
+
51
+ track.observeElementInfo(elementInfo);
52
+ track.stopObservingElementInfo(elementInfo);
53
+
54
+ expect(events).toHaveLength(2);
55
+ expect(events[1]).toBeFalsy();
56
+ });
57
+ });
58
+
59
+ describe('element dimensions', () => {
60
+ let events: Track.Dimensions[] = [];
61
+
62
+ beforeEach(() => {
63
+ track.on(TrackEvent.VideoDimensionsChanged, (dimensions) => {
64
+ events.push(dimensions);
65
+ });
66
+ });
67
+
68
+ afterEach(() => {
69
+ events = [];
70
+ });
71
+
72
+ it('emits a dimensions event upon observing element', () => {
73
+ const elementInfo = new MockElementInfo();
74
+ elementInfo.setDimensions(100, 100);
75
+
76
+ track.observeElementInfo(elementInfo);
77
+ vi.runAllTimers();
78
+
79
+ expect(events).toHaveLength(1);
80
+ expect(events[0].width).toBe(100);
81
+ expect(events[0].height).toBe(100);
82
+ });
83
+
84
+ it('emits a dimensions event upon element resize', () => {
85
+ const elementInfo = new MockElementInfo();
86
+ elementInfo.setDimensions(100, 100);
87
+
88
+ track.observeElementInfo(elementInfo);
89
+ vi.runAllTimers();
90
+
91
+ elementInfo.setDimensions(200, 200);
92
+ vi.runAllTimers();
93
+
94
+ expect(events).toHaveLength(2);
95
+ expect(events[1].width).toBe(200);
96
+ expect(events[1].height).toBe(200);
97
+ });
98
+ });
99
+ });
100
+
101
+ class MockElementInfo implements ElementInfo {
102
+ element: object = {};
103
+
104
+ private _width = 0;
105
+
106
+ private _height = 0;
107
+
108
+ setDimensions(width: number, height: number) {
109
+ let shouldEmit = false;
110
+ if (this._width !== width) {
111
+ this._width = width;
112
+ shouldEmit = true;
113
+ }
114
+ if (this._height !== height) {
115
+ this._height = height;
116
+ shouldEmit = true;
117
+ }
118
+
119
+ if (shouldEmit) {
120
+ this.handleResize?.();
121
+ }
122
+ }
123
+
124
+ width(): number {
125
+ return this._width;
126
+ }
127
+
128
+ height(): number {
129
+ return this._height;
130
+ }
131
+
132
+ visible = false;
133
+
134
+ pictureInPicture = false;
135
+
136
+ setVisible = (visible: boolean) => {
137
+ if (this.visible !== visible) {
138
+ this.visible = visible;
139
+ this.handleVisibilityChanged?.();
140
+ }
141
+ };
142
+
143
+ visibilityChangedAt = 0;
144
+
145
+ handleResize?: () => void;
146
+
147
+ handleVisibilityChanged?: () => void;
148
+
149
+ observe(): void {}
150
+
151
+ stopObserving(): void {}
152
+ }
@@ -0,0 +1,410 @@
1
+ import { debounce } from 'ts-debounce';
2
+ import log from '../../logger';
3
+ import { TrackEvent } from '../events';
4
+ import type { VideoReceiverStats } from '../stats';
5
+ import { computeBitrate } from '../stats';
6
+ import CriticalTimers from '../timers';
7
+ import type { ObservableMediaElement } from '../utils';
8
+ import { getDevicePixelRatio, getIntersectionObserver, getResizeObserver, isWeb } from '../utils';
9
+ import RemoteTrack from './RemoteTrack';
10
+ import { Track, attachToElement, detachTrack } from './Track';
11
+ import type { AdaptiveStreamSettings } from './types';
12
+
13
+ const REACTION_DELAY = 100;
14
+
15
+ export default class RemoteVideoTrack extends RemoteTrack {
16
+ private prevStats?: VideoReceiverStats;
17
+
18
+ private elementInfos: ElementInfo[] = [];
19
+
20
+ private adaptiveStreamSettings?: AdaptiveStreamSettings;
21
+
22
+ private lastVisible?: boolean;
23
+
24
+ private lastDimensions?: Track.Dimensions;
25
+
26
+ constructor(
27
+ mediaTrack: MediaStreamTrack,
28
+ sid: string,
29
+ receiver?: RTCRtpReceiver,
30
+ adaptiveStreamSettings?: AdaptiveStreamSettings,
31
+ ) {
32
+ super(mediaTrack, sid, Track.Kind.Video, receiver);
33
+ this.adaptiveStreamSettings = adaptiveStreamSettings;
34
+ }
35
+
36
+ get isAdaptiveStream(): boolean {
37
+ return this.adaptiveStreamSettings !== undefined;
38
+ }
39
+
40
+ /**
41
+ * Note: When using adaptiveStream, you need to use remoteVideoTrack.attach() to add the track to a HTMLVideoElement, otherwise your video tracks might never start
42
+ */
43
+ get mediaStreamTrack() {
44
+ return this._mediaStreamTrack;
45
+ }
46
+
47
+ /** @internal */
48
+ setMuted(muted: boolean) {
49
+ super.setMuted(muted);
50
+
51
+ this.attachedElements.forEach((element) => {
52
+ // detach or attach
53
+ if (muted) {
54
+ detachTrack(this._mediaStreamTrack, element);
55
+ } else {
56
+ attachToElement(this._mediaStreamTrack, element);
57
+ }
58
+ });
59
+ }
60
+
61
+ attach(): HTMLMediaElement;
62
+ attach(element: HTMLMediaElement): HTMLMediaElement;
63
+ attach(element?: HTMLMediaElement): HTMLMediaElement {
64
+ if (!element) {
65
+ element = super.attach();
66
+ } else {
67
+ super.attach(element);
68
+ }
69
+
70
+ // It's possible attach is called multiple times on an element. When that's
71
+ // the case, we'd want to avoid adding duplicate elementInfos
72
+ if (
73
+ this.adaptiveStreamSettings &&
74
+ this.elementInfos.find((info) => info.element === element) === undefined
75
+ ) {
76
+ const elementInfo = new HTMLElementInfo(element);
77
+ this.observeElementInfo(elementInfo);
78
+ }
79
+ return element;
80
+ }
81
+
82
+ /**
83
+ * Observe an ElementInfo for changes when adaptive streaming.
84
+ * @param elementInfo
85
+ * @internal
86
+ */
87
+ observeElementInfo(elementInfo: ElementInfo) {
88
+ if (
89
+ this.adaptiveStreamSettings &&
90
+ this.elementInfos.find((info) => info === elementInfo) === undefined
91
+ ) {
92
+ elementInfo.handleResize = () => {
93
+ this.debouncedHandleResize();
94
+ };
95
+ elementInfo.handleVisibilityChanged = () => {
96
+ this.updateVisibility();
97
+ };
98
+ this.elementInfos.push(elementInfo);
99
+ elementInfo.observe();
100
+ // trigger the first resize update cycle
101
+ // if the tab is backgrounded, the initial resize event does not fire until
102
+ // the tab comes into focus for the first time.
103
+ this.debouncedHandleResize();
104
+ this.updateVisibility();
105
+ } else {
106
+ log.warn('visibility resize observer not triggered');
107
+ }
108
+ }
109
+
110
+ /**
111
+ * Stop observing an ElementInfo for changes.
112
+ * @param elementInfo
113
+ * @internal
114
+ */
115
+ stopObservingElementInfo(elementInfo: ElementInfo) {
116
+ if (!this.isAdaptiveStream) {
117
+ log.warn('stopObservingElementInfo ignored');
118
+ return;
119
+ }
120
+ const stopElementInfos = this.elementInfos.filter((info) => info === elementInfo);
121
+ for (const info of stopElementInfos) {
122
+ info.stopObserving();
123
+ }
124
+ this.elementInfos = this.elementInfos.filter((info) => info !== elementInfo);
125
+ this.updateVisibility();
126
+ this.debouncedHandleResize();
127
+ }
128
+
129
+ detach(): HTMLMediaElement[];
130
+ detach(element: HTMLMediaElement): HTMLMediaElement;
131
+ detach(element?: HTMLMediaElement): HTMLMediaElement | HTMLMediaElement[] {
132
+ let detachedElements: HTMLMediaElement[] = [];
133
+ if (element) {
134
+ this.stopObservingElement(element);
135
+ return super.detach(element);
136
+ }
137
+ detachedElements = super.detach();
138
+
139
+ for (const e of detachedElements) {
140
+ this.stopObservingElement(e);
141
+ }
142
+
143
+ return detachedElements;
144
+ }
145
+
146
+ /** @internal */
147
+ getDecoderImplementation(): string | undefined {
148
+ return this.prevStats?.decoderImplementation;
149
+ }
150
+
151
+ protected monitorReceiver = async () => {
152
+ if (!this.receiver) {
153
+ this._currentBitrate = 0;
154
+ return;
155
+ }
156
+ const stats = await this.getReceiverStats();
157
+
158
+ if (stats && this.prevStats && this.receiver) {
159
+ this._currentBitrate = computeBitrate(stats, this.prevStats);
160
+ }
161
+
162
+ this.prevStats = stats;
163
+ };
164
+
165
+ private async getReceiverStats(): Promise<VideoReceiverStats | undefined> {
166
+ if (!this.receiver || !this.receiver.getStats) {
167
+ return;
168
+ }
169
+
170
+ const stats = await this.receiver.getStats();
171
+ let receiverStats: VideoReceiverStats | undefined;
172
+ stats.forEach((v) => {
173
+ if (v.type === 'inbound-rtp') {
174
+ receiverStats = {
175
+ type: 'video',
176
+ framesDecoded: v.framesDecoded,
177
+ framesDropped: v.framesDropped,
178
+ framesReceived: v.framesReceived,
179
+ packetsReceived: v.packetsReceived,
180
+ packetsLost: v.packetsLost,
181
+ frameWidth: v.frameWidth,
182
+ frameHeight: v.frameHeight,
183
+ pliCount: v.pliCount,
184
+ firCount: v.firCount,
185
+ nackCount: v.nackCount,
186
+ jitter: v.jitter,
187
+ timestamp: v.timestamp,
188
+ bytesReceived: v.bytesReceived,
189
+ decoderImplementation: v.decoderImplementation,
190
+ };
191
+ }
192
+ });
193
+ return receiverStats;
194
+ }
195
+
196
+ private stopObservingElement(element: HTMLMediaElement) {
197
+ const stopElementInfos = this.elementInfos.filter((info) => info.element === element);
198
+ for (const info of stopElementInfos) {
199
+ this.stopObservingElementInfo(info);
200
+ }
201
+ }
202
+
203
+ protected async handleAppVisibilityChanged() {
204
+ await super.handleAppVisibilityChanged();
205
+ if (!this.isAdaptiveStream) return;
206
+ this.updateVisibility();
207
+ }
208
+
209
+ private readonly debouncedHandleResize = debounce(() => {
210
+ this.updateDimensions();
211
+ }, REACTION_DELAY);
212
+
213
+ private updateVisibility() {
214
+ const lastVisibilityChange = this.elementInfos.reduce(
215
+ (prev, info) => Math.max(prev, info.visibilityChangedAt || 0),
216
+ 0,
217
+ );
218
+
219
+ const backgroundPause =
220
+ this.adaptiveStreamSettings?.pauseVideoInBackground ?? true // default to true
221
+ ? this.isInBackground
222
+ : false;
223
+ const isPiPMode = this.elementInfos.some((info) => info.pictureInPicture);
224
+ const isVisible =
225
+ (this.elementInfos.some((info) => info.visible) && !backgroundPause) || isPiPMode;
226
+
227
+ if (this.lastVisible === isVisible) {
228
+ return;
229
+ }
230
+
231
+ if (!isVisible && Date.now() - lastVisibilityChange < REACTION_DELAY) {
232
+ // delay hidden events
233
+ CriticalTimers.setTimeout(() => {
234
+ this.updateVisibility();
235
+ }, REACTION_DELAY);
236
+ return;
237
+ }
238
+
239
+ this.lastVisible = isVisible;
240
+ this.emit(TrackEvent.VisibilityChanged, isVisible, this);
241
+ }
242
+
243
+ private updateDimensions() {
244
+ let maxWidth = 0;
245
+ let maxHeight = 0;
246
+ const pixelDensity = this.getPixelDensity();
247
+ for (const info of this.elementInfos) {
248
+ const currentElementWidth = info.width() * pixelDensity;
249
+ const currentElementHeight = info.height() * pixelDensity;
250
+ if (currentElementWidth + currentElementHeight > maxWidth + maxHeight) {
251
+ maxWidth = currentElementWidth;
252
+ maxHeight = currentElementHeight;
253
+ }
254
+ }
255
+
256
+ if (this.lastDimensions?.width === maxWidth && this.lastDimensions?.height === maxHeight) {
257
+ return;
258
+ }
259
+
260
+ this.lastDimensions = {
261
+ width: maxWidth,
262
+ height: maxHeight,
263
+ };
264
+
265
+ this.emit(TrackEvent.VideoDimensionsChanged, this.lastDimensions, this);
266
+ }
267
+
268
+ private getPixelDensity(): number {
269
+ const pixelDensity = this.adaptiveStreamSettings?.pixelDensity;
270
+ if (pixelDensity === 'screen') {
271
+ return getDevicePixelRatio();
272
+ } else if (!pixelDensity) {
273
+ // when unset, we'll pick a sane default here.
274
+ // for higher pixel density devices (mobile phones, etc), we'll use 2
275
+ // otherwise it defaults to 1
276
+ const devicePixelRatio = getDevicePixelRatio();
277
+ if (devicePixelRatio > 2) {
278
+ return 2;
279
+ } else {
280
+ return 1;
281
+ }
282
+ }
283
+ return pixelDensity;
284
+ }
285
+ }
286
+
287
+ export interface ElementInfo {
288
+ element: object;
289
+ width(): number;
290
+ height(): number;
291
+ visible: boolean;
292
+ pictureInPicture: boolean;
293
+ visibilityChangedAt: number | undefined;
294
+
295
+ handleResize?: () => void;
296
+ handleVisibilityChanged?: () => void;
297
+ observe(): void;
298
+ stopObserving(): void;
299
+ }
300
+
301
+ class HTMLElementInfo implements ElementInfo {
302
+ element: HTMLMediaElement;
303
+
304
+ get visible(): boolean {
305
+ return this.isPiP || this.isIntersecting;
306
+ }
307
+
308
+ get pictureInPicture(): boolean {
309
+ return this.isPiP;
310
+ }
311
+
312
+ visibilityChangedAt: number | undefined;
313
+
314
+ handleResize?: () => void;
315
+
316
+ handleVisibilityChanged?: () => void;
317
+
318
+ private isPiP: boolean;
319
+
320
+ private isIntersecting: boolean;
321
+
322
+ constructor(element: HTMLMediaElement, visible?: boolean) {
323
+ this.element = element;
324
+ this.isIntersecting = visible ?? isElementInViewport(element);
325
+ this.isPiP = isWeb() && document.pictureInPictureElement === element;
326
+ this.visibilityChangedAt = 0;
327
+ }
328
+
329
+ width(): number {
330
+ return this.element.clientWidth;
331
+ }
332
+
333
+ height(): number {
334
+ return this.element.clientHeight;
335
+ }
336
+
337
+ observe() {
338
+ // make sure we update the current visible state once we start to observe
339
+ this.isIntersecting = isElementInViewport(this.element);
340
+ this.isPiP = document.pictureInPictureElement === this.element;
341
+
342
+ (this.element as ObservableMediaElement).handleResize = () => {
343
+ this.handleResize?.();
344
+ };
345
+ (this.element as ObservableMediaElement).handleVisibilityChanged = this.onVisibilityChanged;
346
+
347
+ getIntersectionObserver().observe(this.element);
348
+ getResizeObserver().observe(this.element);
349
+ (this.element as HTMLVideoElement).addEventListener('enterpictureinpicture', this.onEnterPiP);
350
+ (this.element as HTMLVideoElement).addEventListener('leavepictureinpicture', this.onLeavePiP);
351
+ }
352
+
353
+ private onVisibilityChanged = (entry: IntersectionObserverEntry) => {
354
+ const { target, isIntersecting } = entry;
355
+ if (target === this.element) {
356
+ this.isIntersecting = isIntersecting;
357
+ this.visibilityChangedAt = Date.now();
358
+ this.handleVisibilityChanged?.();
359
+ }
360
+ };
361
+
362
+ private onEnterPiP = () => {
363
+ this.isPiP = true;
364
+ this.handleVisibilityChanged?.();
365
+ };
366
+
367
+ private onLeavePiP = () => {
368
+ this.isPiP = false;
369
+ this.handleVisibilityChanged?.();
370
+ };
371
+
372
+ stopObserving() {
373
+ getIntersectionObserver()?.unobserve(this.element);
374
+ getResizeObserver()?.unobserve(this.element);
375
+ (this.element as HTMLVideoElement).removeEventListener(
376
+ 'enterpictureinpicture',
377
+ this.onEnterPiP,
378
+ );
379
+ (this.element as HTMLVideoElement).removeEventListener(
380
+ 'leavepictureinpicture',
381
+ this.onLeavePiP,
382
+ );
383
+ }
384
+ }
385
+
386
+ // does not account for occlusion by other elements
387
+ function isElementInViewport(el: HTMLElement) {
388
+ let top = el.offsetTop;
389
+ let left = el.offsetLeft;
390
+ const width = el.offsetWidth;
391
+ const height = el.offsetHeight;
392
+ const { hidden } = el;
393
+ const { opacity, display } = getComputedStyle(el);
394
+
395
+ while (el.offsetParent) {
396
+ el = el.offsetParent as HTMLElement;
397
+ top += el.offsetTop;
398
+ left += el.offsetLeft;
399
+ }
400
+
401
+ return (
402
+ top < window.pageYOffset + window.innerHeight &&
403
+ left < window.pageXOffset + window.innerWidth &&
404
+ top + height > window.pageYOffset &&
405
+ left + width > window.pageXOffset &&
406
+ !hidden &&
407
+ (opacity !== '' ? parseFloat(opacity) > 0 : true) &&
408
+ display !== 'none'
409
+ );
410
+ }