@webex/plugin-meetings 3.0.0-beta.21 → 3.0.0-beta.211

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 (422) hide show
  1. package/README.md +45 -7
  2. package/dist/annotation/annotation.types.js +7 -0
  3. package/dist/annotation/annotation.types.js.map +1 -0
  4. package/dist/annotation/constants.js +49 -0
  5. package/dist/annotation/constants.js.map +1 -0
  6. package/dist/annotation/index.js +342 -0
  7. package/dist/annotation/index.js.map +1 -0
  8. package/dist/breakouts/breakout.js +114 -14
  9. package/dist/breakouts/breakout.js.map +1 -1
  10. package/dist/breakouts/edit-lock-error.js +52 -0
  11. package/dist/breakouts/edit-lock-error.js.map +1 -0
  12. package/dist/breakouts/events.js +45 -0
  13. package/dist/breakouts/events.js.map +1 -0
  14. package/dist/breakouts/index.js +841 -19
  15. package/dist/breakouts/index.js.map +1 -1
  16. package/dist/breakouts/request.js +78 -0
  17. package/dist/breakouts/request.js.map +1 -0
  18. package/dist/breakouts/utils.js +67 -0
  19. package/dist/breakouts/utils.js.map +1 -0
  20. package/dist/common/errors/webex-errors.js +3 -2
  21. package/dist/common/errors/webex-errors.js.map +1 -1
  22. package/dist/common/logs/logger-proxy.js +1 -1
  23. package/dist/common/logs/logger-proxy.js.map +1 -1
  24. package/dist/common/queue.js +24 -9
  25. package/dist/common/queue.js.map +1 -1
  26. package/dist/config.js +3 -8
  27. package/dist/config.js.map +1 -1
  28. package/dist/constants.js +179 -30
  29. package/dist/constants.js.map +1 -1
  30. package/dist/controls-options-manager/constants.js +14 -0
  31. package/dist/controls-options-manager/constants.js.map +1 -0
  32. package/dist/controls-options-manager/enums.js +27 -0
  33. package/dist/controls-options-manager/enums.js.map +1 -0
  34. package/dist/controls-options-manager/index.js +297 -0
  35. package/dist/controls-options-manager/index.js.map +1 -0
  36. package/dist/controls-options-manager/types.js +7 -0
  37. package/dist/controls-options-manager/types.js.map +1 -0
  38. package/dist/controls-options-manager/util.js +319 -0
  39. package/dist/controls-options-manager/util.js.map +1 -0
  40. package/dist/index.js +106 -1
  41. package/dist/index.js.map +1 -1
  42. package/dist/interpretation/collection.js +23 -0
  43. package/dist/interpretation/collection.js.map +1 -0
  44. package/dist/interpretation/index.js +366 -0
  45. package/dist/interpretation/index.js.map +1 -0
  46. package/dist/interpretation/siLanguage.js +25 -0
  47. package/dist/interpretation/siLanguage.js.map +1 -0
  48. package/dist/locus-info/controlsUtils.js +91 -2
  49. package/dist/locus-info/controlsUtils.js.map +1 -1
  50. package/dist/locus-info/index.js +359 -64
  51. package/dist/locus-info/index.js.map +1 -1
  52. package/dist/locus-info/infoUtils.js +7 -1
  53. package/dist/locus-info/infoUtils.js.map +1 -1
  54. package/dist/locus-info/mediaSharesUtils.js +43 -1
  55. package/dist/locus-info/mediaSharesUtils.js.map +1 -1
  56. package/dist/locus-info/parser.js +219 -63
  57. package/dist/locus-info/parser.js.map +1 -1
  58. package/dist/locus-info/selfUtils.js +89 -14
  59. package/dist/locus-info/selfUtils.js.map +1 -1
  60. package/dist/media/index.js +48 -135
  61. package/dist/media/index.js.map +1 -1
  62. package/dist/media/properties.js +29 -90
  63. package/dist/media/properties.js.map +1 -1
  64. package/dist/mediaQualityMetrics/config.js +505 -493
  65. package/dist/mediaQualityMetrics/config.js.map +1 -1
  66. package/dist/meeting/in-meeting-actions.js +90 -2
  67. package/dist/meeting/in-meeting-actions.js.map +1 -1
  68. package/dist/meeting/index.js +2770 -2547
  69. package/dist/meeting/index.js.map +1 -1
  70. package/dist/meeting/locusMediaRequest.js +291 -0
  71. package/dist/meeting/locusMediaRequest.js.map +1 -0
  72. package/dist/meeting/muteState.js +229 -124
  73. package/dist/meeting/muteState.js.map +1 -1
  74. package/dist/meeting/request.js +199 -193
  75. package/dist/meeting/request.js.map +1 -1
  76. package/dist/meeting/util.js +532 -414
  77. package/dist/meeting/util.js.map +1 -1
  78. package/dist/meeting-info/index.js +48 -7
  79. package/dist/meeting-info/index.js.map +1 -1
  80. package/dist/meeting-info/meeting-info-v2.js +171 -51
  81. package/dist/meeting-info/meeting-info-v2.js.map +1 -1
  82. package/dist/meeting-info/utilv2.js +20 -5
  83. package/dist/meeting-info/utilv2.js.map +1 -1
  84. package/dist/meetings/collection.js +22 -0
  85. package/dist/meetings/collection.js.map +1 -1
  86. package/dist/meetings/index.js +357 -66
  87. package/dist/meetings/index.js.map +1 -1
  88. package/dist/meetings/meetings.types.js +7 -0
  89. package/dist/meetings/meetings.types.js.map +1 -0
  90. package/dist/meetings/request.js +2 -0
  91. package/dist/meetings/request.js.map +1 -1
  92. package/dist/meetings/util.js +88 -1
  93. package/dist/meetings/util.js.map +1 -1
  94. package/dist/member/index.js +49 -0
  95. package/dist/member/index.js.map +1 -1
  96. package/dist/member/types.js +25 -0
  97. package/dist/member/types.js.map +1 -0
  98. package/dist/member/util.js +121 -25
  99. package/dist/member/util.js.map +1 -1
  100. package/dist/members/collection.js +10 -0
  101. package/dist/members/collection.js.map +1 -1
  102. package/dist/members/index.js +86 -5
  103. package/dist/members/index.js.map +1 -1
  104. package/dist/members/request.js +106 -38
  105. package/dist/members/request.js.map +1 -1
  106. package/dist/members/types.js +15 -0
  107. package/dist/members/types.js.map +1 -0
  108. package/dist/members/util.js +316 -233
  109. package/dist/members/util.js.map +1 -1
  110. package/dist/metrics/constants.js +3 -5
  111. package/dist/metrics/constants.js.map +1 -1
  112. package/dist/metrics/index.js +1 -468
  113. package/dist/metrics/index.js.map +1 -1
  114. package/dist/multistream/mediaRequestManager.js +238 -49
  115. package/dist/multistream/mediaRequestManager.js.map +1 -1
  116. package/dist/multistream/receiveSlot.js +49 -16
  117. package/dist/multistream/receiveSlot.js.map +1 -1
  118. package/dist/multistream/receiveSlotManager.js +52 -34
  119. package/dist/multistream/receiveSlotManager.js.map +1 -1
  120. package/dist/multistream/remoteMedia.js +44 -18
  121. package/dist/multistream/remoteMedia.js.map +1 -1
  122. package/dist/multistream/remoteMediaGroup.js +60 -3
  123. package/dist/multistream/remoteMediaGroup.js.map +1 -1
  124. package/dist/multistream/remoteMediaManager.js +173 -59
  125. package/dist/multistream/remoteMediaManager.js.map +1 -1
  126. package/dist/networkQualityMonitor/index.js +4 -2
  127. package/dist/networkQualityMonitor/index.js.map +1 -1
  128. package/dist/reachability/index.js +72 -27
  129. package/dist/reachability/index.js.map +1 -1
  130. package/dist/reachability/request.js +12 -5
  131. package/dist/reachability/request.js.map +1 -1
  132. package/dist/reconnection-manager/index.js +196 -155
  133. package/dist/reconnection-manager/index.js.map +1 -1
  134. package/dist/recording-controller/index.js +21 -2
  135. package/dist/recording-controller/index.js.map +1 -1
  136. package/dist/recording-controller/util.js +9 -8
  137. package/dist/recording-controller/util.js.map +1 -1
  138. package/dist/roap/index.js +21 -29
  139. package/dist/roap/index.js.map +1 -1
  140. package/dist/roap/request.js +110 -89
  141. package/dist/roap/request.js.map +1 -1
  142. package/dist/roap/turnDiscovery.js +93 -36
  143. package/dist/roap/turnDiscovery.js.map +1 -1
  144. package/dist/rtcMetrics/constants.js +12 -0
  145. package/dist/rtcMetrics/constants.js.map +1 -0
  146. package/dist/rtcMetrics/index.js +117 -0
  147. package/dist/rtcMetrics/index.js.map +1 -0
  148. package/dist/statsAnalyzer/global.js +1 -93
  149. package/dist/statsAnalyzer/global.js.map +1 -1
  150. package/dist/statsAnalyzer/index.js +326 -311
  151. package/dist/statsAnalyzer/index.js.map +1 -1
  152. package/dist/statsAnalyzer/mqaUtil.js +90 -53
  153. package/dist/statsAnalyzer/mqaUtil.js.map +1 -1
  154. package/dist/types/annotation/annotation.types.d.ts +42 -0
  155. package/dist/types/annotation/constants.d.ts +31 -0
  156. package/dist/types/annotation/index.d.ts +117 -0
  157. package/dist/types/breakouts/breakout.d.ts +8 -0
  158. package/dist/types/breakouts/collection.d.ts +5 -0
  159. package/dist/types/breakouts/edit-lock-error.d.ts +15 -0
  160. package/dist/types/breakouts/events.d.ts +8 -0
  161. package/dist/types/breakouts/index.d.ts +5 -0
  162. package/dist/types/breakouts/request.d.ts +22 -0
  163. package/dist/types/breakouts/utils.d.ts +15 -0
  164. package/dist/types/common/browser-detection.d.ts +9 -0
  165. package/dist/types/common/collection.d.ts +48 -0
  166. package/dist/types/common/config.d.ts +2 -0
  167. package/dist/types/common/errors/captcha-error.d.ts +15 -0
  168. package/dist/types/common/errors/intent-to-join.d.ts +16 -0
  169. package/dist/types/common/errors/join-meeting.d.ts +17 -0
  170. package/dist/types/common/errors/media.d.ts +15 -0
  171. package/dist/types/common/errors/parameter.d.ts +15 -0
  172. package/dist/types/common/errors/password-error.d.ts +15 -0
  173. package/dist/types/common/errors/permission.d.ts +14 -0
  174. package/dist/types/common/errors/reconnection-in-progress.d.ts +9 -0
  175. package/dist/types/common/errors/reconnection.d.ts +15 -0
  176. package/dist/types/common/errors/stats.d.ts +15 -0
  177. package/dist/types/common/errors/webex-errors.d.ts +69 -0
  178. package/dist/types/common/errors/webex-meetings-error.d.ts +20 -0
  179. package/dist/types/common/events/events-scope.d.ts +17 -0
  180. package/dist/types/common/events/events.d.ts +12 -0
  181. package/dist/types/common/events/trigger-proxy.d.ts +2 -0
  182. package/dist/types/common/events/util.d.ts +2 -0
  183. package/dist/types/common/logs/logger-config.d.ts +2 -0
  184. package/dist/types/common/logs/logger-proxy.d.ts +2 -0
  185. package/dist/types/common/logs/request.d.ts +34 -0
  186. package/dist/types/common/queue.d.ts +34 -0
  187. package/dist/types/config.d.ts +72 -0
  188. package/dist/types/constants.d.ts +1020 -0
  189. package/dist/types/controls-options-manager/constants.d.ts +4 -0
  190. package/dist/types/controls-options-manager/enums.d.ts +15 -0
  191. package/dist/types/controls-options-manager/index.d.ts +136 -0
  192. package/dist/types/controls-options-manager/types.d.ts +43 -0
  193. package/dist/types/controls-options-manager/util.d.ts +1 -0
  194. package/dist/types/index.d.ts +7 -0
  195. package/dist/types/interpretation/collection.d.ts +5 -0
  196. package/dist/types/interpretation/index.d.ts +5 -0
  197. package/dist/types/interpretation/siLanguage.d.ts +5 -0
  198. package/dist/types/locus-info/controlsUtils.d.ts +2 -0
  199. package/dist/types/locus-info/embeddedAppsUtils.d.ts +2 -0
  200. package/dist/types/locus-info/fullState.d.ts +2 -0
  201. package/dist/types/locus-info/hostUtils.d.ts +2 -0
  202. package/dist/types/locus-info/index.d.ts +322 -0
  203. package/dist/types/locus-info/infoUtils.d.ts +2 -0
  204. package/dist/types/locus-info/mediaSharesUtils.d.ts +2 -0
  205. package/dist/types/locus-info/parser.d.ts +271 -0
  206. package/dist/types/locus-info/selfUtils.d.ts +2 -0
  207. package/dist/types/media/index.d.ts +34 -0
  208. package/dist/types/media/properties.d.ts +93 -0
  209. package/dist/types/media/util.d.ts +2 -0
  210. package/dist/types/mediaQualityMetrics/config.d.ts +365 -0
  211. package/dist/types/meeting/in-meeting-actions.d.ts +163 -0
  212. package/dist/types/meeting/index.d.ts +1482 -0
  213. package/dist/types/meeting/locusMediaRequest.d.ts +72 -0
  214. package/dist/types/meeting/muteState.d.ts +184 -0
  215. package/dist/types/meeting/request.d.ts +257 -0
  216. package/dist/types/meeting/request.type.d.ts +11 -0
  217. package/dist/types/meeting/state.d.ts +9 -0
  218. package/dist/types/meeting/util.d.ts +79 -0
  219. package/dist/types/meeting-info/collection.d.ts +20 -0
  220. package/dist/types/meeting-info/index.d.ts +62 -0
  221. package/dist/types/meeting-info/meeting-info-v2.d.ts +122 -0
  222. package/dist/types/meeting-info/request.d.ts +22 -0
  223. package/dist/types/meeting-info/util.d.ts +2 -0
  224. package/dist/types/meeting-info/utilv2.d.ts +2 -0
  225. package/dist/types/meetings/collection.d.ts +31 -0
  226. package/dist/types/meetings/index.d.ts +367 -0
  227. package/dist/types/meetings/meetings.types.d.ts +4 -0
  228. package/dist/types/meetings/request.d.ts +27 -0
  229. package/dist/types/meetings/util.d.ts +18 -0
  230. package/dist/types/member/index.d.ts +159 -0
  231. package/dist/types/member/types.d.ts +32 -0
  232. package/dist/types/member/util.d.ts +2 -0
  233. package/dist/types/members/collection.d.ts +29 -0
  234. package/dist/types/members/index.d.ts +353 -0
  235. package/dist/types/members/request.d.ts +114 -0
  236. package/dist/types/members/types.d.ts +24 -0
  237. package/dist/types/members/util.d.ts +210 -0
  238. package/dist/types/metrics/constants.d.ts +55 -0
  239. package/dist/types/metrics/index.d.ts +45 -0
  240. package/dist/types/multistream/mediaRequestManager.d.ts +118 -0
  241. package/dist/types/multistream/receiveSlot.d.ts +68 -0
  242. package/dist/types/multistream/receiveSlotManager.d.ts +56 -0
  243. package/dist/types/multistream/remoteMedia.d.ts +72 -0
  244. package/dist/types/multistream/remoteMediaGroup.d.ts +47 -0
  245. package/dist/types/multistream/remoteMediaManager.d.ts +277 -0
  246. package/dist/types/networkQualityMonitor/index.d.ts +70 -0
  247. package/dist/types/personal-meeting-room/index.d.ts +47 -0
  248. package/dist/types/personal-meeting-room/request.d.ts +14 -0
  249. package/dist/types/personal-meeting-room/util.d.ts +2 -0
  250. package/dist/types/reachability/index.d.ts +152 -0
  251. package/dist/types/reachability/request.d.ts +37 -0
  252. package/dist/types/reactions/constants.d.ts +3 -0
  253. package/dist/types/reactions/reactions.d.ts +4 -0
  254. package/dist/types/reactions/reactions.type.d.ts +52 -0
  255. package/dist/types/reconnection-manager/index.d.ts +126 -0
  256. package/dist/types/recording-controller/enums.d.ts +7 -0
  257. package/dist/types/recording-controller/index.d.ts +207 -0
  258. package/dist/types/recording-controller/util.d.ts +14 -0
  259. package/dist/types/roap/index.d.ts +77 -0
  260. package/dist/types/roap/request.d.ts +36 -0
  261. package/dist/types/roap/turnDiscovery.d.ts +91 -0
  262. package/dist/types/rtcMetrics/constants.d.ts +4 -0
  263. package/dist/types/rtcMetrics/index.d.ts +46 -0
  264. package/dist/types/statsAnalyzer/global.d.ts +36 -0
  265. package/dist/types/statsAnalyzer/index.d.ts +200 -0
  266. package/dist/types/statsAnalyzer/mqaUtil.d.ts +24 -0
  267. package/dist/types/transcription/index.d.ts +64 -0
  268. package/package.json +23 -20
  269. package/src/annotation/annotation.types.ts +50 -0
  270. package/src/annotation/constants.ts +36 -0
  271. package/src/annotation/index.ts +328 -0
  272. package/src/breakouts/README.md +44 -14
  273. package/src/breakouts/breakout.ts +87 -9
  274. package/src/breakouts/edit-lock-error.ts +25 -0
  275. package/src/breakouts/events.ts +56 -0
  276. package/src/breakouts/index.ts +710 -10
  277. package/src/breakouts/request.ts +55 -0
  278. package/src/breakouts/utils.ts +57 -0
  279. package/src/common/errors/webex-errors.ts +6 -2
  280. package/src/common/logs/logger-proxy.ts +1 -1
  281. package/src/common/queue.ts +22 -8
  282. package/src/config.ts +2 -7
  283. package/src/constants.ts +165 -21
  284. package/src/controls-options-manager/constants.ts +5 -0
  285. package/src/controls-options-manager/enums.ts +18 -0
  286. package/src/controls-options-manager/index.ts +278 -0
  287. package/src/controls-options-manager/types.ts +59 -0
  288. package/src/controls-options-manager/util.ts +300 -0
  289. package/src/index.ts +39 -0
  290. package/src/interpretation/README.md +60 -0
  291. package/src/interpretation/collection.ts +19 -0
  292. package/src/interpretation/index.ts +332 -0
  293. package/src/interpretation/siLanguage.ts +18 -0
  294. package/src/locus-info/controlsUtils.ts +108 -0
  295. package/src/locus-info/index.ts +383 -61
  296. package/src/locus-info/infoUtils.ts +10 -2
  297. package/src/locus-info/mediaSharesUtils.ts +48 -0
  298. package/src/locus-info/parser.ts +224 -39
  299. package/src/locus-info/selfUtils.ts +81 -5
  300. package/src/media/index.ts +87 -140
  301. package/src/media/properties.ts +49 -90
  302. package/src/mediaQualityMetrics/config.ts +379 -377
  303. package/src/meeting/in-meeting-actions.ts +179 -3
  304. package/src/meeting/index.ts +2099 -2083
  305. package/src/meeting/locusMediaRequest.ts +311 -0
  306. package/src/meeting/muteState.ts +228 -132
  307. package/src/meeting/request.ts +105 -115
  308. package/src/meeting/util.ts +511 -397
  309. package/src/meeting-info/index.ts +54 -8
  310. package/src/meeting-info/meeting-info-v2.ts +148 -14
  311. package/src/meeting-info/utilv2.ts +13 -3
  312. package/src/meetings/collection.ts +20 -0
  313. package/src/meetings/index.ts +392 -84
  314. package/src/meetings/meetings.types.ts +12 -0
  315. package/src/meetings/request.ts +2 -0
  316. package/src/meetings/util.ts +103 -4
  317. package/src/member/index.ts +49 -0
  318. package/src/member/types.ts +38 -0
  319. package/src/member/util.ts +127 -25
  320. package/src/members/collection.ts +8 -0
  321. package/src/members/index.ts +107 -6
  322. package/src/members/request.ts +97 -17
  323. package/src/members/types.ts +28 -0
  324. package/src/members/util.ts +319 -240
  325. package/src/metrics/constants.ts +2 -4
  326. package/src/metrics/index.ts +1 -490
  327. package/src/multistream/mediaRequestManager.ts +289 -79
  328. package/src/multistream/receiveSlot.ts +55 -18
  329. package/src/multistream/receiveSlotManager.ts +46 -24
  330. package/src/multistream/remoteMedia.ts +27 -2
  331. package/src/multistream/remoteMediaGroup.ts +59 -0
  332. package/src/multistream/remoteMediaManager.ts +113 -32
  333. package/src/networkQualityMonitor/index.ts +6 -6
  334. package/src/reachability/index.ts +62 -15
  335. package/src/reachability/request.ts +10 -5
  336. package/src/reconnection-manager/index.ts +68 -43
  337. package/src/recording-controller/index.ts +20 -3
  338. package/src/recording-controller/util.ts +26 -9
  339. package/src/roap/index.ts +21 -30
  340. package/src/roap/request.ts +101 -95
  341. package/src/roap/turnDiscovery.ts +47 -25
  342. package/src/rtcMetrics/constants.ts +3 -0
  343. package/src/rtcMetrics/index.ts +100 -0
  344. package/src/statsAnalyzer/global.ts +1 -94
  345. package/src/statsAnalyzer/index.ts +376 -386
  346. package/src/statsAnalyzer/mqaUtil.ts +100 -99
  347. package/test/integration/spec/converged-space-meetings.js +233 -0
  348. package/test/integration/spec/journey.js +336 -259
  349. package/test/integration/spec/space-meeting.js +77 -4
  350. package/test/unit/spec/annotation/index.ts +418 -0
  351. package/test/unit/spec/breakouts/breakout.ts +142 -24
  352. package/test/unit/spec/breakouts/edit-lock-error.ts +30 -0
  353. package/test/unit/spec/breakouts/events.ts +89 -0
  354. package/test/unit/spec/breakouts/index.ts +1545 -48
  355. package/test/unit/spec/breakouts/request.ts +104 -0
  356. package/test/unit/spec/breakouts/utils.js +72 -0
  357. package/test/unit/spec/common/queue.js +31 -2
  358. package/test/unit/spec/controls-options-manager/index.js +287 -0
  359. package/test/unit/spec/controls-options-manager/util.js +582 -0
  360. package/test/unit/spec/fixture/locus.js +1 -0
  361. package/test/unit/spec/interpretation/collection.ts +15 -0
  362. package/test/unit/spec/interpretation/index.ts +589 -0
  363. package/test/unit/spec/interpretation/siLanguage.ts +28 -0
  364. package/test/unit/spec/locus-info/controlsUtils.js +316 -43
  365. package/test/unit/spec/locus-info/index.js +1169 -36
  366. package/test/unit/spec/locus-info/infoUtils.js +37 -15
  367. package/test/unit/spec/locus-info/mediaSharesUtils.ts +22 -0
  368. package/test/unit/spec/locus-info/parser.js +62 -22
  369. package/test/unit/spec/locus-info/selfConstant.js +27 -4
  370. package/test/unit/spec/locus-info/selfUtils.js +208 -17
  371. package/test/unit/spec/media/index.ts +138 -28
  372. package/test/unit/spec/meeting/in-meeting-actions.ts +89 -3
  373. package/test/unit/spec/meeting/index.js +3573 -1663
  374. package/test/unit/spec/meeting/locusMediaRequest.ts +438 -0
  375. package/test/unit/spec/meeting/muteState.js +370 -208
  376. package/test/unit/spec/meeting/request.js +339 -44
  377. package/test/unit/spec/meeting/utils.js +456 -53
  378. package/test/unit/spec/meeting-info/index.js +181 -0
  379. package/test/unit/spec/meeting-info/meetinginfov2.js +383 -5
  380. package/test/unit/spec/meeting-info/utilv2.js +21 -0
  381. package/test/unit/spec/meetings/collection.js +14 -0
  382. package/test/unit/spec/meetings/index.js +867 -125
  383. package/test/unit/spec/meetings/utils.js +206 -2
  384. package/test/unit/spec/member/index.js +58 -4
  385. package/test/unit/spec/member/util.js +479 -35
  386. package/test/unit/spec/members/index.js +319 -1
  387. package/test/unit/spec/members/request.js +206 -27
  388. package/test/unit/spec/members/utils.js +184 -0
  389. package/test/unit/spec/metrics/index.js +1 -50
  390. package/test/unit/spec/multistream/mediaRequestManager.ts +803 -162
  391. package/test/unit/spec/multistream/receiveSlot.ts +72 -13
  392. package/test/unit/spec/multistream/receiveSlotManager.ts +58 -28
  393. package/test/unit/spec/multistream/remoteMedia.ts +30 -0
  394. package/test/unit/spec/multistream/remoteMediaGroup.ts +266 -0
  395. package/test/unit/spec/multistream/remoteMediaManager.ts +318 -0
  396. package/test/unit/spec/networkQualityMonitor/index.js +4 -4
  397. package/test/unit/spec/reachability/index.ts +125 -8
  398. package/test/unit/spec/reachability/request.js +66 -0
  399. package/test/unit/spec/reconnection-manager/index.js +59 -6
  400. package/test/unit/spec/recording-controller/index.js +294 -218
  401. package/test/unit/spec/recording-controller/util.js +223 -96
  402. package/test/unit/spec/roap/index.ts +26 -51
  403. package/test/unit/spec/roap/request.ts +196 -85
  404. package/test/unit/spec/roap/turnDiscovery.ts +30 -7
  405. package/test/unit/spec/rtcMetrics/index.ts +60 -0
  406. package/test/unit/spec/stats-analyzer/index.js +92 -41
  407. package/test/utils/constants.js +9 -0
  408. package/test/utils/integrationTestUtils.js +46 -0
  409. package/test/utils/testUtils.js +0 -45
  410. package/test/utils/webex-config.js +4 -0
  411. package/test/utils/webex-test-users.js +6 -3
  412. package/dist/meeting/effectsState.js +0 -262
  413. package/dist/meeting/effectsState.js.map +0 -1
  414. package/dist/metrics/config.js +0 -299
  415. package/dist/metrics/config.js.map +0 -1
  416. package/dist/multistream/multistreamMedia.js +0 -110
  417. package/dist/multistream/multistreamMedia.js.map +0 -1
  418. package/src/index.js +0 -16
  419. package/src/meeting/effectsState.ts +0 -211
  420. package/src/metrics/config.ts +0 -495
  421. package/src/multistream/multistreamMedia.ts +0 -97
  422. package/test/unit/spec/meeting/effectsState.js +0 -285
@@ -0,0 +1,24 @@
1
+ export declare enum ServerRoles {
2
+ Cohost = "COHOST",
3
+ Moderator = "MODERATOR",
4
+ Presenter = "PRESENTER"
5
+ }
6
+ export type ServerRoleShape = {
7
+ type: ServerRoles;
8
+ hasRole: boolean;
9
+ };
10
+ export type RoleAssignmentOptions = {
11
+ roles: Array<ServerRoleShape>;
12
+ locusUrl: string;
13
+ memberId: string;
14
+ };
15
+ export type RoleAssignmentBody = {
16
+ role: {
17
+ roles: Array<ServerRoleShape>;
18
+ };
19
+ };
20
+ export type RoleAssignmentRequest = {
21
+ method: string;
22
+ uri: string;
23
+ body: RoleAssignmentBody;
24
+ };
@@ -0,0 +1,210 @@
1
+ import { RoleAssignmentOptions, RoleAssignmentRequest, ServerRoleShape } from './types';
2
+ declare const MembersUtil: {
3
+ /**
4
+ * @param {Object} invitee with emailAddress, email or phoneNumber
5
+ * @param {String} locusUrl
6
+ * @param {Boolean} alertIfActive
7
+ * @returns {Object} the format object
8
+ */
9
+ generateAddMemberOptions: (invitee: object, locusUrl: string, alertIfActive: boolean) => {
10
+ invitee: object;
11
+ locusUrl: string;
12
+ alertIfActive: boolean;
13
+ };
14
+ /**
15
+ * @param {Array} memberIds
16
+ * @param {String} locusUrl
17
+ * @returns {Object} the format object
18
+ */
19
+ generateAdmitMemberOptions: (memberIds: Array<any>, locusUrl: string) => {
20
+ locusUrl: string;
21
+ memberIds: any[];
22
+ };
23
+ /**
24
+ * @param {Object} options with {invitee: {emailAddress, email, phoneNumber}, alertIfActive}
25
+ * @returns {Object} with {invitees: [{address}], alertIfActive}
26
+ */
27
+ getAddMemberBody: (options: any) => {
28
+ invitees: {
29
+ address: any;
30
+ }[];
31
+ alertIfActive: any;
32
+ };
33
+ /**
34
+ * @param {Object} options with {memberIds, authorizingLocusUrl}
35
+ * @returns {Object} admit with {memberIds}
36
+ */
37
+ getAdmitMemberRequestBody: (options: any) => any;
38
+ /**
39
+ * @param {Object} format with {memberIds, locusUrl, sessionLocusUrls}
40
+ * @returns {Object} the request parameters (method, uri, body) needed to make a admitMember request
41
+ * if a host/cohost is in a breakout session, the locus url should be the main session locus url
42
+ */
43
+ getAdmitMemberRequestParams: (format: any) => {
44
+ method: string;
45
+ uri: string;
46
+ body: any;
47
+ };
48
+ /**
49
+ * @param {Object} format with {invitee {emailAddress, email, phoneNumber}, locusUrl, alertIfActive}
50
+ * @returns {Object} the request parameters (method, uri, body) needed to make a addMember request
51
+ */
52
+ getAddMemberRequestParams: (format: any) => {
53
+ method: string;
54
+ uri: any;
55
+ body: {
56
+ invitees: {
57
+ address: any;
58
+ }[];
59
+ alertIfActive: any;
60
+ };
61
+ };
62
+ isInvalidInvitee: (invitee: any) => boolean;
63
+ getRemoveMemberRequestParams: (options: any) => {
64
+ method: string;
65
+ uri: string;
66
+ body: {
67
+ reason: any;
68
+ };
69
+ };
70
+ generateTransferHostMemberOptions: (transfer: any, moderator: any, locusUrl: any) => {
71
+ moderator: any;
72
+ locusUrl: any;
73
+ memberId: any;
74
+ };
75
+ generateRemoveMemberOptions: (removal: any, locusUrl: any) => {
76
+ reason: string;
77
+ memberId: any;
78
+ locusUrl: any;
79
+ };
80
+ generateMuteMemberOptions: (memberId: any, status: any, locusUrl: any, isAudio: any) => {
81
+ memberId: any;
82
+ muted: any;
83
+ locusUrl: any;
84
+ isAudio: any;
85
+ };
86
+ generateRaiseHandMemberOptions: (memberId: any, status: any, locusUrl: any) => {
87
+ memberId: any;
88
+ raised: any;
89
+ locusUrl: any;
90
+ };
91
+ /**
92
+ * @param {String} memberId
93
+ * @param {[ServerRoleShape]} roles
94
+ * @param {String} locusUrl
95
+ * @returns {RoleAssignmentOptions}
96
+ */
97
+ generateRoleAssignmentMemberOptions: (memberId: string, roles: Array<ServerRoleShape>, locusUrl: string) => RoleAssignmentOptions;
98
+ generateLowerAllHandsMemberOptions: (requestingParticipantId: any, locusUrl: any) => {
99
+ requestingParticipantId: any;
100
+ locusUrl: any;
101
+ };
102
+ /**
103
+ * @param {String} memberId id of the participant who is receiving request
104
+ * @param {String} requestingParticipantId id of the participant who is sending request (optional)
105
+ * @param {String} alias alias name
106
+ * @param {String} locusUrl url
107
+ * @returns {Object} consists of {memberID: string, requestingParticipantId: string, alias: string, locusUrl: string}
108
+ */
109
+ generateEditDisplayNameMemberOptions: (memberId: any, requestingParticipantId: any, alias: any, locusUrl: any) => {
110
+ memberId: any;
111
+ requestingParticipantId: any;
112
+ alias: any;
113
+ locusUrl: any;
114
+ };
115
+ getMuteMemberRequestParams: (options: any) => {
116
+ method: string;
117
+ uri: string;
118
+ body: {
119
+ [x: string]: {
120
+ muted: any;
121
+ };
122
+ };
123
+ };
124
+ /**
125
+ * @param {RoleAssignmentOptions} options
126
+ * @returns {RoleAssignmentRequest} the request parameters (method, uri, body) needed to make a addMember request
127
+ */
128
+ getRoleAssignmentMemberRequestParams: (options: RoleAssignmentOptions) => RoleAssignmentRequest;
129
+ getRaiseHandMemberRequestParams: (options: any) => {
130
+ method: string;
131
+ uri: string;
132
+ body: {
133
+ hand: {
134
+ raised: any;
135
+ };
136
+ };
137
+ };
138
+ getLowerAllHandsMemberRequestParams: (options: any) => {
139
+ method: string;
140
+ uri: string;
141
+ body: {
142
+ hand: {
143
+ raised: boolean;
144
+ };
145
+ requestingParticipantId: any;
146
+ };
147
+ };
148
+ /**
149
+ * @param {Object} options with format of {locusUrl: string, requestingParticipantId: string}
150
+ * @returns {Object} request parameters (method, uri, body) needed to make a editDisplayName request
151
+ */
152
+ editDisplayNameMemberRequestParams: (options: any) => {
153
+ method: string;
154
+ uri: string;
155
+ body: {
156
+ aliasValue: any;
157
+ requestingParticipantId: any;
158
+ };
159
+ };
160
+ getTransferHostToMemberRequestParams: (options: any) => {
161
+ method: string;
162
+ uri: string;
163
+ body: {
164
+ role: {
165
+ moderator: any;
166
+ };
167
+ };
168
+ };
169
+ genderateSendDTMFOptions: (url: any, tones: any, memberId: any, locusUrl: any) => {
170
+ url: any;
171
+ tones: any;
172
+ memberId: any;
173
+ locusUrl: any;
174
+ };
175
+ generateSendDTMFRequestParams: ({ url, tones, memberId, locusUrl }: {
176
+ url: any;
177
+ tones: any;
178
+ memberId: any;
179
+ locusUrl: any;
180
+ }) => {
181
+ method: string;
182
+ uri: string;
183
+ body: {
184
+ device: {
185
+ url: any;
186
+ };
187
+ memberId: any;
188
+ dtmf: {
189
+ correlationId: any;
190
+ tones: any;
191
+ direction: string;
192
+ };
193
+ };
194
+ };
195
+ cancelPhoneInviteOptions: (invitee: any, locusUrl: any) => {
196
+ invitee: any;
197
+ locusUrl: any;
198
+ };
199
+ generateCancelInviteRequestParams: (options: any) => {
200
+ method: string;
201
+ uri: any;
202
+ body: {
203
+ actionType: string;
204
+ invitees: {
205
+ address: any;
206
+ }[];
207
+ };
208
+ };
209
+ };
210
+ export default MembersUtil;
@@ -0,0 +1,55 @@
1
+ declare const BEHAVIORAL_METRICS: {
2
+ MEETINGS_REGISTRATION_FAILED: string;
3
+ MEETINGS_REGISTRATION_SUCCESS: string;
4
+ MERCURY_CONNECTION_FAILURE: string;
5
+ MERCURY_CONNECTION_RESTORED: string;
6
+ JOIN_SUCCESS: string;
7
+ JOIN_FAILURE: string;
8
+ ADD_MEDIA_SUCCESS: string;
9
+ ADD_MEDIA_FAILURE: string;
10
+ ROAP_MERCURY_EVENT_RECEIVED: string;
11
+ CONNECTION_SUCCESS: string;
12
+ CONNECTION_FAILURE: string;
13
+ MEETING_LEAVE_FAILURE: string;
14
+ MEETING_END_ALL_FAILURE: string;
15
+ MEETING_END_ALL_INITIATED: string;
16
+ GET_USER_MEDIA_FAILURE: string;
17
+ GET_DISPLAY_MEDIA_FAILURE: string;
18
+ JOIN_WITH_MEDIA_FAILURE: string;
19
+ DISCONNECT_DUE_TO_INACTIVITY: string;
20
+ MEETING_MEDIA_INACTIVE: string;
21
+ MEETING_RECONNECT_FAILURE: string;
22
+ MEETING_MAX_REJOIN_FAILURE: string;
23
+ MEETING_SHARE_FAILURE: string;
24
+ MEETING_START_WHITEBOARD_SHARE_FAILURE: string;
25
+ MEETING_STOP_WHITEBOARD_SHARE_FAILURE: string;
26
+ MUTE_AUDIO_FAILURE: string;
27
+ MUTE_VIDEO_FAILURE: string;
28
+ SET_MEETING_QUALITY_FAILURE: string;
29
+ STOP_FLOOR_REQUEST_FAILURE: string;
30
+ ADD_DIAL_IN_FAILURE: string;
31
+ ADD_DIAL_OUT_FAILURE: string;
32
+ UPDATE_MEDIA_FAILURE: string;
33
+ UNMUTE_AUDIO_FAILURE: string;
34
+ UNMUTE_VIDEO_FAILURE: string;
35
+ ROAP_ANSWER_FAILURE: string;
36
+ ROAP_GLARE_CONDITION: string;
37
+ PEERCONNECTION_FAILURE: string;
38
+ INVALID_ICE_CANDIDATE: string;
39
+ UPLOAD_LOGS_FAILURE: string;
40
+ RECEIVE_TRANSCRIPTION_FAILURE: string;
41
+ FETCH_MEETING_INFO_V1_SUCCESS: string;
42
+ FETCH_MEETING_INFO_V1_FAILURE: string;
43
+ ADHOC_MEETING_SUCCESS: string;
44
+ ADHOC_MEETING_FAILURE: string;
45
+ VERIFY_PASSWORD_SUCCESS: string;
46
+ VERIFY_PASSWORD_ERROR: string;
47
+ VERIFY_CAPTCHA_ERROR: string;
48
+ MOVE_TO_SUCCESS: string;
49
+ MOVE_TO_FAILURE: string;
50
+ MOVE_FROM_SUCCESS: string;
51
+ MOVE_FROM_FAILURE: string;
52
+ TURN_DISCOVERY_FAILURE: string;
53
+ MEETING_INFO_POLICY_ERROR: string;
54
+ };
55
+ export { BEHAVIORAL_METRICS as default };
@@ -0,0 +1,45 @@
1
+ /*!
2
+ * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
3
+ */
4
+ /**
5
+ * @description Metrics handles all the call metrics events
6
+ * @export
7
+ * @class Metrics
8
+ */
9
+ declare class Metrics {
10
+ static instance: Metrics;
11
+ webex: any;
12
+ /**
13
+ * Create Metrics Object
14
+ * @constructor
15
+ * @public
16
+ * @memberof Meetings
17
+ */
18
+ constructor();
19
+ /**
20
+ * Initializes the Metrics singleton with a meeting Collection.
21
+ *
22
+ * @param {Object} webex webex SDK object
23
+ *
24
+ * @returns {void}
25
+ */
26
+ initialSetup(webex: object): void;
27
+ /**
28
+ * Uploads given metric to the Metrics service as an Behavioral metric.
29
+ * Metadata about the environment such as browser, OS, SDK and their versions
30
+ * are automatically added when the metric is sent.
31
+ *
32
+ * The Metrics service will send an Behavioral metric to InfluxDB for
33
+ * aggregation.
34
+ * See https://confluence-eng-gpk2.cisco.com/conf/display/WBXT/Getting+started+with+Metrics+Service.
35
+ *
36
+ * @param {string} metricName Name of the metric (measurement) to send
37
+ * @param {Object} metricFields Key-valye pairs of data or values about this metric
38
+ * @param {Object} metricTags Key-value pairs of metric metadata
39
+ *
40
+ * @returns {void}
41
+ */
42
+ sendBehavioralMetric(metricName: string, metricFields?: object, metricTags?: object): void;
43
+ }
44
+ declare const instance: Metrics;
45
+ export default instance;
@@ -0,0 +1,118 @@
1
+ import { StreamRequest } from '@webex/internal-media-core';
2
+ import { ReceiveSlot } from './receiveSlot';
3
+ export interface ActiveSpeakerPolicyInfo {
4
+ policy: 'active-speaker';
5
+ priority: number;
6
+ crossPriorityDuplication: boolean;
7
+ crossPolicyDuplication: boolean;
8
+ preferLiveVideo: boolean;
9
+ }
10
+ export interface ReceiverSelectedPolicyInfo {
11
+ policy: 'receiver-selected';
12
+ csi: number;
13
+ }
14
+ export type PolicyInfo = ActiveSpeakerPolicyInfo | ReceiverSelectedPolicyInfo;
15
+ export interface H264CodecInfo {
16
+ codec: 'h264';
17
+ maxFs?: number;
18
+ maxFps?: number;
19
+ maxMbps?: number;
20
+ maxWidth?: number;
21
+ maxHeight?: number;
22
+ }
23
+ export type CodecInfo = H264CodecInfo;
24
+ export interface MediaRequest {
25
+ policyInfo: PolicyInfo;
26
+ receiveSlots: Array<ReceiveSlot>;
27
+ codecInfo?: CodecInfo;
28
+ preferredMaxFs?: number;
29
+ handleMaxFs?: ({ maxFs }: {
30
+ maxFs: number;
31
+ }) => void;
32
+ }
33
+ export type MediaRequestId = string;
34
+ type DegradationPreferences = {
35
+ maxMacroblocksLimit: number;
36
+ };
37
+ type SendMediaRequestsCallback = (streamRequests: StreamRequest[]) => void;
38
+ type Kind = 'audio' | 'video';
39
+ type Options = {
40
+ degradationPreferences: DegradationPreferences;
41
+ kind: Kind;
42
+ trimRequestsToNumOfSources: boolean;
43
+ };
44
+ export declare class MediaRequestManager {
45
+ private sendMediaRequestsCallback;
46
+ private kind;
47
+ private counter;
48
+ private clientRequests;
49
+ private degradationPreferences;
50
+ private sourceUpdateListener;
51
+ private debouncedSourceUpdateListener;
52
+ private previousStreamRequests;
53
+ private trimRequestsToNumOfSources;
54
+ private numTotalSources;
55
+ private numLiveSources;
56
+ constructor(sendMediaRequestsCallback: SendMediaRequestsCallback, options: Options);
57
+ setDegradationPreferences(degradationPreferences: DegradationPreferences): void;
58
+ private getDegradedClientRequests;
59
+ /**
60
+ * Returns true if two stream requests are the same, false otherwise.
61
+ *
62
+ * @param {StreamRequest} streamRequestA - Stream request A for comparison.
63
+ * @param {StreamRequest} streamRequestB - Stream request B for comparison.
64
+ * @returns {boolean} - Whether they are equal.
65
+ */
66
+ isEqual(streamRequestA: StreamRequest, streamRequestB: StreamRequest): boolean;
67
+ /**
68
+ * Compares new stream requests to previous ones and determines
69
+ * if they are the same.
70
+ *
71
+ * @param {StreamRequest[]} newRequests - Array with new requests.
72
+ * @returns {boolean} - True if they are equal, false otherwise.
73
+ */
74
+ private checkIsNewRequestsEqualToPrev;
75
+ /**
76
+ * Returns the maxPayloadBitsPerSecond per Stream
77
+ *
78
+ * If MediaRequestManager kind is "audio", a constant bitrate will be returned.
79
+ * If MediaRequestManager kind is "video", the bitrate will be calculated based
80
+ * on maxFs (default h264 maxFs as fallback if maxFs is not defined)
81
+ *
82
+ * @param {MediaRequest} mediaRequest - mediaRequest to take data from
83
+ * @returns {number} maxPayloadBitsPerSecond
84
+ */
85
+ private getMaxPayloadBitsPerSecond;
86
+ /**
87
+ * Returns the max Macro Blocks per second (maxMbps) per H264 Stream
88
+ *
89
+ * The maxMbps will be calculated based on maxFs and maxFps
90
+ * (default h264 maxFps as fallback if maxFps is not defined)
91
+ *
92
+ * @param {MediaRequest} mediaRequest - mediaRequest to take data from
93
+ * @returns {number} maxMbps
94
+ */
95
+ private getH264MaxMbps;
96
+ /**
97
+ * Clears the previous stream requests.
98
+ *
99
+ * @returns {void}
100
+ */
101
+ clearPreviousRequests(): void;
102
+ /** Modifies the passed in clientRequests and makes sure that in total they don't ask
103
+ * for more streams than there are available.
104
+ *
105
+ * @param {Object} clientRequests
106
+ * @returns {void}
107
+ */
108
+ private trimRequests;
109
+ private getPreferLiveVideo;
110
+ private cloneClientRequests;
111
+ private sendRequests;
112
+ addRequest(mediaRequest: MediaRequest, commit?: boolean): MediaRequestId;
113
+ cancelRequest(requestId: MediaRequestId, commit?: boolean): void;
114
+ commit(): void;
115
+ reset(): void;
116
+ setNumCurrentSources(numTotalSources: number, numLiveSources: number): void;
117
+ }
118
+ export {};
@@ -0,0 +1,68 @@
1
+ import { MediaType, ReceiveSlot as WcmeReceiveSlot, StreamState } from '@webex/internal-media-core';
2
+ import EventsScope from '../common/events/events-scope';
3
+ export declare const ReceiveSlotEvents: {
4
+ SourceUpdate: string;
5
+ MaxFsUpdate: string;
6
+ };
7
+ export type { StreamState } from '@webex/internal-media-core';
8
+ export type CSI = number;
9
+ export type MemberId = string;
10
+ export type ReceiveSlotId = string;
11
+ export type FindMemberIdCallback = (csi: CSI) => MemberId | undefined;
12
+ /**
13
+ * Class representing a receive slot. A single receive slot is able to receive a single track
14
+ * for example some participant's main video or audio
15
+ */
16
+ export declare class ReceiveSlot extends EventsScope {
17
+ #private;
18
+ private readonly mcReceiveSlot;
19
+ private readonly findMemberIdCallback;
20
+ readonly id: ReceiveSlotId;
21
+ readonly mediaType: MediaType;
22
+ /**
23
+ * constructor - don't use it directly, you should always use meeting.receiveSlotManager.allocateSlot()
24
+ * to create any receive slots
25
+ *
26
+ * @param {MediaType} mediaType
27
+ * @param {ReceiveSlot} mcReceiveSlot
28
+ * @param {FindMemberIdCallback} findMemberIdCallback callback for finding memberId for given CSI
29
+ */
30
+ constructor(mediaType: MediaType, mcReceiveSlot: WcmeReceiveSlot, findMemberIdCallback: FindMemberIdCallback);
31
+ /**
32
+ * Getter for memberId
33
+ */
34
+ get memberId(): string;
35
+ /**
36
+ * Getter for csi
37
+ */
38
+ get csi(): number;
39
+ /**
40
+ * Set the max frame size for this slot
41
+ * @param newFs frame size
42
+ */
43
+ setMaxFs(newFs: any): void;
44
+ /**
45
+ * Getter for sourceState
46
+ */
47
+ get sourceState(): StreamState;
48
+ /**
49
+ * registers event handlers with the underlying ReceiveSlot
50
+ */
51
+ private setupEventListeners;
52
+ /** Tries to find the member id for this receive slot if it hasn't got one */
53
+ findMemberId(): void;
54
+ /**
55
+ * @returns {string} a log message used to identify the receive slot
56
+ */
57
+ get logString(): string;
58
+ /**
59
+ * The MediaStream object associated with this slot.
60
+ *
61
+ * @returns {MediaStream} The MediaStreamTrack.
62
+ */
63
+ get stream(): MediaStream;
64
+ /**
65
+ * The underlying WCME receive slot
66
+ */
67
+ get wcmeReceiveSlot(): WcmeReceiveSlot;
68
+ }
@@ -0,0 +1,56 @@
1
+ import { MediaType, ReceiveSlot as WcmeReceiveSlot } from '@webex/internal-media-core';
2
+ import { FindMemberIdCallback, ReceiveSlot } from './receiveSlot';
3
+ export type CreateSlotCallback = (mediaType: MediaType) => Promise<WcmeReceiveSlot>;
4
+ export type { CSI, FindMemberIdCallback } from './receiveSlot';
5
+ /**
6
+ * Manages all receive slots used by a meeting. WMCE receive slots cannot be ever deleted,
7
+ * so this manager has a pool in order to re-use the slots that were released earlier.
8
+ */
9
+ export declare class ReceiveSlotManager {
10
+ private allocatedSlots;
11
+ private freeSlots;
12
+ private createSlotCallback;
13
+ private findMemberIdByCsiCallback;
14
+ /**
15
+ * Constructor
16
+ * @param {Meeting} meeting
17
+ */
18
+ constructor(createSlotCallback: CreateSlotCallback, findMemberIdByCsiCallback: FindMemberIdCallback);
19
+ /**
20
+ * Creates a new receive slot or returns one from the existing pool of free slots
21
+ *
22
+ * @param {MediaType} mediaType
23
+ * @returns {Promise<ReceiveSlot>}
24
+ */
25
+ allocateSlot(mediaType: MediaType): Promise<ReceiveSlot>;
26
+ /**
27
+ * Releases the slot back to the pool so it can be re-used by others in the future
28
+ * @param {ReceiveSlot} slot
29
+ */
30
+ releaseSlot(slot: ReceiveSlot): void;
31
+ /**
32
+ * Resets the slot manager - this method should be called when the media connection is torn down
33
+ */
34
+ reset(): void;
35
+ /**
36
+ * Returns statistics about the managed slots
37
+ *
38
+ * @returns {Object}
39
+ */
40
+ getStats(): {
41
+ numAllocatedSlots: {};
42
+ numFreeSlots: {};
43
+ };
44
+ /**
45
+ * Tries to find the member id on all allocated receive slots
46
+ * This function should be called when new members are added to the meeting.
47
+ */
48
+ updateMemberIds(): void;
49
+ /**
50
+ * Find a receive slot by a ssrc.
51
+ *
52
+ * @param ssrc - The ssrc of the receive slot to find.
53
+ * @returns - The receive slot with this ssrc, undefined if not found.
54
+ */
55
+ findReceiveSlotBySsrc(ssrc: number): ReceiveSlot | undefined;
56
+ }
@@ -0,0 +1,72 @@
1
+ import { MediaType, StreamState } from '@webex/internal-media-core';
2
+ import EventsScope from '../common/events/events-scope';
3
+ import { MediaRequestManager } from './mediaRequestManager';
4
+ import { ReceiveSlot } from './receiveSlot';
5
+ export declare const RemoteMediaEvents: {
6
+ SourceUpdate: string;
7
+ Stopped: string;
8
+ };
9
+ export type RemoteVideoResolution = 'thumbnail' | 'very small' | 'small' | 'medium' | 'large' | 'best';
10
+ /**
11
+ * Converts pane size into h264 maxFs
12
+ * @param {PaneSize} paneSize
13
+ * @returns {number}
14
+ */
15
+ export declare function getMaxFs(paneSize: RemoteVideoResolution): number;
16
+ type Options = {
17
+ resolution?: RemoteVideoResolution;
18
+ };
19
+ export type RemoteMediaId = string;
20
+ /**
21
+ * Class representing a remote audio/video stream.
22
+ *
23
+ * Internally it is associated with a specific receive slot
24
+ * and a media request for it.
25
+ */
26
+ export declare class RemoteMedia extends EventsScope {
27
+ private receiveSlot?;
28
+ private readonly mediaRequestManager;
29
+ private readonly options;
30
+ private mediaRequestId?;
31
+ readonly id: RemoteMediaId;
32
+ /**
33
+ * Constructs RemoteMedia instance
34
+ *
35
+ * @param receiveSlot
36
+ * @param mediaRequestManager
37
+ * @param options
38
+ */
39
+ constructor(receiveSlot: ReceiveSlot, mediaRequestManager: MediaRequestManager, options?: Options);
40
+ /**
41
+ * Supply the width and height of the video element
42
+ * to restrict the requested resolution to this size
43
+ * @param width width of the video element
44
+ * @param height height of the video element
45
+ */
46
+ setSizeHint(width: any, height: any): void;
47
+ /**
48
+ * registers event listeners on the receive slot and forwards all the events
49
+ */
50
+ private setupEventListeners;
51
+ /**
52
+ * Getter for mediaType
53
+ */
54
+ get mediaType(): MediaType;
55
+ /**
56
+ * Getter for memberId
57
+ */
58
+ get memberId(): string;
59
+ /**
60
+ * Getter for csi
61
+ */
62
+ get csi(): number;
63
+ /**
64
+ * Getter for source state
65
+ */
66
+ get sourceState(): StreamState;
67
+ /**
68
+ * Getter for remote media stream
69
+ */
70
+ get stream(): MediaStream;
71
+ }
72
+ export {};
@@ -0,0 +1,47 @@
1
+ import { RemoteMedia, RemoteVideoResolution } from './remoteMedia';
2
+ import { MediaRequestManager } from './mediaRequestManager';
3
+ import { CSI, ReceiveSlot } from './receiveSlot';
4
+ type Options = {
5
+ resolution?: RemoteVideoResolution;
6
+ preferLiveVideo?: boolean;
7
+ };
8
+ export declare class RemoteMediaGroup {
9
+ private mediaRequestManager;
10
+ private priority;
11
+ private options;
12
+ private unpinnedRemoteMedia;
13
+ private mediaRequestId?;
14
+ private pinnedRemoteMedia;
15
+ constructor(mediaRequestManager: MediaRequestManager, receiveSlots: ReceiveSlot[], priority: number, commitMediaRequest: boolean, options?: Options);
16
+ /**
17
+ * Gets the array of remote media elements from the group
18
+ *
19
+ * @param {string} filter - 'all' (default) returns both pinned and unpinned
20
+ * @returns {Array<RemoteMedia>}
21
+ */
22
+ getRemoteMedia(filter?: 'all' | 'pinned' | 'unpinned'): RemoteMedia[];
23
+ /**
24
+ * Pins a specific remote media instance to a specfic CSI, so the media will
25
+ * no longer come from active speaker, but from that CSI.
26
+ * If no CSI is given, the current CSI value is used.
27
+ *
28
+ */
29
+ pin(remoteMedia: RemoteMedia, csi?: CSI): void;
30
+ /**
31
+ * Unpins a remote media instance, so that it will again provide media from active speakers
32
+ *
33
+ */
34
+ unpin(remoteMedia: RemoteMedia): void;
35
+ isPinned(remoteMedia: RemoteMedia): boolean;
36
+ private sendActiveSpeakerMediaRequest;
37
+ private cancelActiveSpeakerMediaRequest;
38
+ /**
39
+ * Checks if a given RemoteMedia instance belongs to this group.
40
+ *
41
+ * @param remoteMedia RemoteMedia instance to check
42
+ * @param filter controls which remote media from the group to check
43
+ * @returns true if remote media is found
44
+ */
45
+ includes(remoteMedia: RemoteMedia, filter?: 'all' | 'pinned' | 'unpinned'): boolean;
46
+ }
47
+ export {};