agora-electron-sdk 4.1.1-rc.1 → 4.2.0-dev.13

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 (358) hide show
  1. package/LICENSE +21 -21
  2. package/README.md +143 -143
  3. package/gulpfile.js +5 -4
  4. package/js/AgoraSdk.js +62 -60
  5. package/js/Private/AgoraBase.js +4575 -3269
  6. package/js/Private/AgoraMediaBase.js +968 -564
  7. package/js/Private/AgoraMediaPlayerTypes.js +422 -310
  8. package/js/Private/IAgoraLog.js +86 -74
  9. package/js/Private/IAgoraMediaEngine.js +32 -32
  10. package/js/Private/IAgoraMediaPlayer.js +16 -16
  11. package/js/Private/IAgoraMediaPlayerSource.js +3 -3
  12. package/js/Private/IAgoraMediaRecorder.js +12 -12
  13. package/js/Private/IAgoraMediaStreamingSource.js +84 -0
  14. package/js/Private/IAgoraMusicContentCenter.js +239 -81
  15. package/js/Private/IAgoraRhythmPlayer.js +70 -62
  16. package/js/Private/IAgoraRtcEngine.js +1807 -948
  17. package/js/Private/IAgoraRtcEngineEx.js +26 -18
  18. package/js/Private/IAgoraSpatialAudio.js +74 -30
  19. package/js/Private/IAudioDeviceManager.js +20 -20
  20. package/js/Private/extension/AgoraBaseExtension.js +2 -2
  21. package/js/Private/extension/AgoraMediaBaseExtension.js +2 -2
  22. package/js/Private/extension/AgoraMediaPlayerTypesExtension.js +2 -2
  23. package/js/Private/extension/IAgoraLogExtension.js +2 -2
  24. package/js/Private/extension/IAgoraMediaEngineExtension.js +2 -2
  25. package/js/Private/extension/IAgoraMediaPlayerExtension.js +2 -2
  26. package/js/Private/extension/IAgoraMediaPlayerSourceExtension.js +2 -2
  27. package/js/Private/extension/IAgoraMediaRecorderExtension.js +2 -2
  28. package/js/Private/extension/IAgoraMusicContentCenterExtension.js +2 -2
  29. package/js/Private/extension/IAgoraRhythmPlayerExtension.js +2 -2
  30. package/js/Private/extension/IAgoraRtcEngineExExtension.js +2 -2
  31. package/js/Private/extension/IAgoraRtcEngineExtension.js +2 -2
  32. package/js/Private/extension/IAgoraSpatialAudioExtension.js +2 -2
  33. package/js/Private/extension/IAudioDeviceManagerExtension.js +2 -2
  34. package/js/Private/impl/AgoraBaseImpl.js +23 -23
  35. package/js/Private/impl/AgoraMediaBaseImpl.js +118 -138
  36. package/js/Private/impl/IAgoraMediaEngineImpl.js +287 -325
  37. package/js/Private/impl/IAgoraMediaPlayerImpl.js +932 -938
  38. package/js/Private/impl/IAgoraMediaPlayerSourceImpl.js +63 -63
  39. package/js/Private/impl/IAgoraMediaRecorderImpl.js +47 -67
  40. package/js/Private/impl/IAgoraMusicContentCenterImpl.js +353 -323
  41. package/js/Private/impl/IAgoraRtcEngineExImpl.js +945 -907
  42. package/js/Private/impl/IAgoraRtcEngineImpl.js +4742 -4702
  43. package/js/Private/impl/IAgoraSpatialAudioImpl.js +362 -362
  44. package/js/Private/impl/IAudioDeviceManagerImpl.js +375 -375
  45. package/js/Private/internal/AudioDeviceManagerInternal.js +44 -44
  46. package/js/Private/internal/IrisApiEngine.js +391 -382
  47. package/js/Private/internal/LocalSpatialAudioEngineInternal.js +46 -46
  48. package/js/Private/internal/MediaEngineInternal.js +119 -123
  49. package/js/Private/internal/MediaPlayerInternal.js +215 -213
  50. package/js/Private/internal/MediaRecorderInternal.js +82 -81
  51. package/js/Private/internal/MusicContentCenterInternal.js +128 -130
  52. package/js/Private/internal/RtcEngineExInternal.js +422 -363
  53. package/js/Private/internal/emitter/EventEmitter.js +111 -111
  54. package/js/Private/ti/AgoraBase-ti.js +40 -40
  55. package/js/Private/ti/AgoraMediaBase-ti.js +71 -73
  56. package/js/Private/ti/AgoraMediaPlayerTypes-ti.js +5 -5
  57. package/js/Private/ti/IAgoraLog-ti.js +5 -5
  58. package/js/Private/ti/IAgoraMediaEngine-ti.js +5 -5
  59. package/js/Private/ti/IAgoraMediaPlayer-ti.js +38 -42
  60. package/js/Private/ti/IAgoraMediaPlayerSource-ti.js +48 -48
  61. package/js/Private/ti/IAgoraMediaRecorder-ti.js +5 -5
  62. package/js/Private/ti/IAgoraMediaStreamingSource-ti.js +5 -0
  63. package/js/Private/ti/IAgoraMusicContentCenter-ti.js +41 -41
  64. package/js/Private/ti/IAgoraRhythmPlayer-ti.js +5 -5
  65. package/js/Private/ti/IAgoraRtcEngine-ti.js +139 -139
  66. package/js/Private/ti/IAgoraRtcEngineEx-ti.js +5 -5
  67. package/js/Private/ti/IAgoraSpatialAudio-ti.js +5 -5
  68. package/js/Private/ti/IAudioDeviceManager-ti.js +5 -5
  69. package/js/Renderer/AgoraView.js +128 -131
  70. package/js/Renderer/IRenderer.js +40 -48
  71. package/js/Renderer/IRendererManager.js +9 -0
  72. package/js/Renderer/RendererManager.js +479 -392
  73. package/js/Renderer/{GlRenderer → WebGLRenderer}/index.js +469 -473
  74. package/js/Renderer/{GlRenderer → WebGLRenderer}/webgl-utils.js +1337 -1337
  75. package/js/Renderer/YUVCanvasRenderer/index.js +195 -185
  76. package/js/Renderer/index.js +18 -0
  77. package/js/Types.js +17 -29
  78. package/js/Utils.js +168 -173
  79. package/package.json +61 -103
  80. package/scripts/bootstrap.js +1 -1
  81. package/scripts/build.js +1 -0
  82. package/scripts/buildJS.js +3 -3
  83. package/scripts/clean.js +2 -1
  84. package/scripts/downloadPrebuild.js +5 -5
  85. package/scripts/getConfig.js +3 -2
  86. package/scripts/synclib.js +8 -5
  87. package/scripts/util.js +3 -2
  88. package/scripts/zipBuild.js +2 -1
  89. package/ts/AgoraSdk.ts +9 -6
  90. package/ts/Private/AgoraBase.ts +278 -173
  91. package/ts/Private/AgoraMediaBase.ts +167 -100
  92. package/ts/Private/AgoraMediaPlayerTypes.ts +1 -1
  93. package/ts/Private/IAgoraMediaEngine.ts +43 -56
  94. package/ts/Private/IAgoraMediaPlayer.ts +90 -104
  95. package/ts/Private/IAgoraMediaPlayerSource.ts +3 -8
  96. package/ts/Private/IAgoraMediaRecorder.ts +8 -35
  97. package/ts/Private/IAgoraMediaStreamingSource.ts +80 -0
  98. package/ts/Private/IAgoraMusicContentCenter.ts +93 -12
  99. package/ts/Private/IAgoraRtcEngine.ts +807 -910
  100. package/ts/Private/IAgoraRtcEngineEx.ts +187 -191
  101. package/ts/Private/IAgoraSpatialAudio.ts +40 -22
  102. package/ts/Private/IAudioDeviceManager.ts +35 -13
  103. package/ts/Private/extension/IAgoraMediaEngineExtension.ts +1 -1
  104. package/ts/Private/extension/IAgoraMediaPlayerExtension.ts +4 -7
  105. package/ts/Private/extension/IAgoraMediaRecorderExtension.ts +6 -1
  106. package/ts/Private/extension/IAgoraMusicContentCenterExtension.ts +1 -1
  107. package/ts/Private/extension/IAgoraRtcEngineExtension.ts +4 -4
  108. package/ts/Private/impl/AgoraBaseImpl.ts +3 -3
  109. package/ts/Private/impl/AgoraMediaBaseImpl.ts +36 -42
  110. package/ts/Private/impl/IAgoraMediaEngineImpl.ts +79 -127
  111. package/ts/Private/impl/IAgoraMediaPlayerImpl.ts +106 -106
  112. package/ts/Private/impl/IAgoraMediaRecorderImpl.ts +13 -45
  113. package/ts/Private/impl/IAgoraMusicContentCenterImpl.ts +61 -16
  114. package/ts/Private/impl/IAgoraRtcEngineExImpl.ts +129 -59
  115. package/ts/Private/impl/IAgoraRtcEngineImpl.ts +490 -416
  116. package/ts/Private/impl/IAgoraSpatialAudioImpl.ts +5 -3
  117. package/ts/Private/impl/IAudioDeviceManagerImpl.ts +4 -2
  118. package/ts/Private/internal/AudioDeviceManagerInternal.ts +6 -5
  119. package/ts/Private/internal/IrisApiEngine.ts +41 -32
  120. package/ts/Private/internal/LocalSpatialAudioEngineInternal.ts +17 -13
  121. package/ts/Private/internal/MediaEngineInternal.ts +9 -11
  122. package/ts/Private/internal/MediaPlayerInternal.ts +42 -31
  123. package/ts/Private/internal/MediaRecorderInternal.ts +24 -22
  124. package/ts/Private/internal/MusicContentCenterInternal.ts +16 -18
  125. package/ts/Private/internal/RtcEngineExInternal.ts +189 -66
  126. package/ts/Private/ti/AgoraMediaBase-ti.ts +9 -10
  127. package/ts/Private/ti/IAgoraMediaPlayer-ti.ts +0 -5
  128. package/{js/Private/ti/AgoraMediaPlayerTypes-ti.d.ts → ts/Private/ti/IAgoraMediaStreamingSource-ti.ts} +11 -6
  129. package/ts/Private/ti/IAgoraMusicContentCenter-ti.ts +4 -4
  130. package/ts/Private/ti/IAgoraRtcEngine-ti.ts +4 -4
  131. package/ts/Renderer/AgoraView.ts +12 -7
  132. package/ts/Renderer/IRenderer.ts +11 -16
  133. package/ts/Renderer/IRendererManager.ts +35 -0
  134. package/ts/Renderer/RendererManager.ts +146 -82
  135. package/ts/Renderer/{GlRenderer → WebGLRenderer}/index.ts +36 -51
  136. package/ts/Renderer/YUVCanvasRenderer/index.ts +41 -25
  137. package/ts/Renderer/index.ts +2 -0
  138. package/ts/Types.ts +43 -23
  139. package/ts/Utils.ts +7 -12
  140. package/types/AgoraSdk.d.ts +38 -36
  141. package/types/AgoraSdk.d.ts.map +1 -0
  142. package/types/Private/AgoraBase.d.ts +4455 -4358
  143. package/types/Private/AgoraBase.d.ts.map +1 -0
  144. package/types/Private/AgoraMediaBase.d.ts +1125 -1070
  145. package/types/Private/AgoraMediaBase.d.ts.map +1 -0
  146. package/types/Private/AgoraMediaPlayerTypes.d.ts +409 -408
  147. package/types/Private/AgoraMediaPlayerTypes.d.ts.map +1 -0
  148. package/types/Private/IAgoraLog.d.ts +81 -80
  149. package/types/Private/IAgoraLog.d.ts.map +1 -0
  150. package/types/Private/IAgoraMediaEngine.d.ts +184 -193
  151. package/types/Private/IAgoraMediaEngine.d.ts.map +1 -0
  152. package/types/Private/IAgoraMediaPlayer.d.ts +533 -546
  153. package/types/Private/IAgoraMediaPlayer.d.ts.map +1 -0
  154. package/types/Private/IAgoraMediaPlayerSource.d.ts +83 -88
  155. package/types/Private/IAgoraMediaPlayerSource.d.ts.map +1 -0
  156. package/types/Private/IAgoraMediaRecorder.d.ts +29 -49
  157. package/types/Private/IAgoraMediaRecorder.d.ts.map +1 -0
  158. package/types/Private/IAgoraMediaStreamingSource.d.ts +42 -0
  159. package/types/Private/IAgoraMediaStreamingSource.d.ts.map +1 -0
  160. package/types/Private/IAgoraMusicContentCenter.d.ts +336 -255
  161. package/types/Private/IAgoraMusicContentCenter.d.ts.map +1 -0
  162. package/types/Private/IAgoraRhythmPlayer.d.ts +65 -64
  163. package/types/Private/IAgoraRhythmPlayer.d.ts.map +1 -0
  164. package/types/Private/IAgoraRtcEngine.d.ts +4948 -5058
  165. package/types/Private/IAgoraRtcEngine.d.ts.map +1 -0
  166. package/types/Private/IAgoraRtcEngineEx.d.ts +554 -570
  167. package/types/Private/IAgoraRtcEngineEx.d.ts.map +1 -0
  168. package/types/Private/IAgoraSpatialAudio.d.ts +266 -248
  169. package/types/Private/IAgoraSpatialAudio.d.ts.map +1 -0
  170. package/types/Private/IAudioDeviceManager.d.ts +255 -233
  171. package/types/Private/IAudioDeviceManager.d.ts.map +1 -0
  172. package/types/Private/extension/AgoraBaseExtension.d.ts +2 -1
  173. package/types/Private/extension/AgoraBaseExtension.d.ts.map +1 -0
  174. package/types/Private/extension/AgoraMediaBaseExtension.d.ts +2 -1
  175. package/types/Private/extension/AgoraMediaBaseExtension.d.ts.map +1 -0
  176. package/types/Private/extension/AgoraMediaPlayerTypesExtension.d.ts +2 -1
  177. package/types/Private/extension/AgoraMediaPlayerTypesExtension.d.ts.map +1 -0
  178. package/types/Private/extension/IAgoraLogExtension.d.ts +2 -1
  179. package/types/Private/extension/IAgoraLogExtension.d.ts.map +1 -0
  180. package/types/Private/extension/IAgoraMediaEngineExtension.d.ts +41 -40
  181. package/types/Private/extension/IAgoraMediaEngineExtension.d.ts.map +1 -0
  182. package/types/Private/extension/IAgoraMediaPlayerExtension.d.ts +47 -46
  183. package/types/Private/extension/IAgoraMediaPlayerExtension.d.ts.map +1 -0
  184. package/types/Private/extension/IAgoraMediaPlayerSourceExtension.d.ts +2 -1
  185. package/types/Private/extension/IAgoraMediaPlayerSourceExtension.d.ts.map +1 -0
  186. package/types/Private/extension/IAgoraMediaRecorderExtension.d.ts +45 -40
  187. package/types/Private/extension/IAgoraMediaRecorderExtension.d.ts.map +1 -0
  188. package/types/Private/extension/IAgoraMusicContentCenterExtension.d.ts +21 -20
  189. package/types/Private/extension/IAgoraMusicContentCenterExtension.d.ts.map +1 -0
  190. package/types/Private/extension/IAgoraRhythmPlayerExtension.d.ts +2 -1
  191. package/types/Private/extension/IAgoraRhythmPlayerExtension.d.ts.map +1 -0
  192. package/types/Private/extension/IAgoraRtcEngineExExtension.d.ts +2 -1
  193. package/types/Private/extension/IAgoraRtcEngineExExtension.d.ts.map +1 -0
  194. package/types/Private/extension/IAgoraRtcEngineExtension.d.ts +43 -42
  195. package/types/Private/extension/IAgoraRtcEngineExtension.d.ts.map +1 -0
  196. package/types/Private/extension/IAgoraSpatialAudioExtension.d.ts +2 -1
  197. package/types/Private/extension/IAgoraSpatialAudioExtension.d.ts.map +1 -0
  198. package/types/Private/extension/IAudioDeviceManagerExtension.d.ts +2 -1
  199. package/types/Private/extension/IAudioDeviceManagerExtension.d.ts.map +1 -0
  200. package/types/Private/impl/AgoraBaseImpl.d.ts +3 -2
  201. package/types/Private/impl/AgoraBaseImpl.d.ts.map +1 -0
  202. package/types/Private/impl/AgoraMediaBaseImpl.d.ts +9 -7
  203. package/types/Private/impl/AgoraMediaBaseImpl.d.ts.map +1 -0
  204. package/types/Private/impl/IAgoraMediaEngineImpl.d.ts +40 -43
  205. package/types/Private/impl/IAgoraMediaEngineImpl.d.ts.map +1 -0
  206. package/types/Private/impl/IAgoraMediaPlayerImpl.d.ts +141 -141
  207. package/types/Private/impl/IAgoraMediaPlayerImpl.d.ts.map +1 -0
  208. package/types/Private/impl/IAgoraMediaPlayerSourceImpl.d.ts +3 -2
  209. package/types/Private/impl/IAgoraMediaPlayerSourceImpl.d.ts.map +1 -0
  210. package/types/Private/impl/IAgoraMediaRecorderImpl.d.ts +11 -13
  211. package/types/Private/impl/IAgoraMediaRecorderImpl.d.ts.map +1 -0
  212. package/types/Private/impl/IAgoraMusicContentCenterImpl.d.ts +59 -51
  213. package/types/Private/impl/IAgoraMusicContentCenterImpl.d.ts.map +1 -0
  214. package/types/Private/impl/IAgoraRtcEngineExImpl.d.ts +106 -101
  215. package/types/Private/impl/IAgoraRtcEngineExImpl.d.ts.map +1 -0
  216. package/types/Private/impl/IAgoraRtcEngineImpl.d.ts +570 -566
  217. package/types/Private/impl/IAgoraRtcEngineImpl.d.ts.map +1 -0
  218. package/types/Private/impl/IAgoraSpatialAudioImpl.d.ts +49 -48
  219. package/types/Private/impl/IAgoraSpatialAudioImpl.d.ts.map +1 -0
  220. package/types/Private/impl/IAudioDeviceManagerImpl.d.ts +65 -64
  221. package/types/Private/impl/IAudioDeviceManagerImpl.d.ts.map +1 -0
  222. package/types/Private/internal/AudioDeviceManagerInternal.d.ts +9 -8
  223. package/types/Private/internal/AudioDeviceManagerInternal.d.ts.map +1 -0
  224. package/types/Private/internal/IrisApiEngine.d.ts +148 -146
  225. package/types/Private/internal/IrisApiEngine.d.ts.map +1 -0
  226. package/types/Private/internal/LocalSpatialAudioEngineInternal.d.ts +19 -18
  227. package/types/Private/internal/LocalSpatialAudioEngineInternal.d.ts.map +1 -0
  228. package/types/Private/internal/MediaEngineInternal.d.ts +22 -21
  229. package/types/Private/internal/MediaEngineInternal.d.ts.map +1 -0
  230. package/types/Private/internal/MediaPlayerInternal.d.ts +34 -33
  231. package/types/Private/internal/MediaPlayerInternal.d.ts.map +1 -0
  232. package/types/Private/internal/MediaRecorderInternal.d.ts +18 -15
  233. package/types/Private/internal/MediaRecorderInternal.d.ts.map +1 -0
  234. package/types/Private/internal/MusicContentCenterInternal.d.ts +40 -39
  235. package/types/Private/internal/MusicContentCenterInternal.d.ts.map +1 -0
  236. package/types/Private/internal/RtcEngineExInternal.d.ts +80 -73
  237. package/types/Private/internal/RtcEngineExInternal.d.ts.map +1 -0
  238. package/{js → types}/Private/internal/emitter/EventEmitter.d.ts +60 -59
  239. package/types/Private/internal/emitter/EventEmitter.d.ts.map +1 -0
  240. package/types/Private/ti/AgoraBase-ti.d.ts +8 -7
  241. package/types/Private/ti/AgoraBase-ti.d.ts.map +1 -0
  242. package/types/Private/ti/AgoraMediaBase-ti.d.ts +14 -12
  243. package/types/Private/ti/AgoraMediaBase-ti.d.ts.map +1 -0
  244. package/types/Private/ti/AgoraMediaPlayerTypes-ti.d.ts +7 -6
  245. package/types/Private/ti/AgoraMediaPlayerTypes-ti.d.ts.map +1 -0
  246. package/types/Private/ti/IAgoraLog-ti.d.ts +7 -6
  247. package/types/Private/ti/IAgoraLog-ti.d.ts.map +1 -0
  248. package/types/Private/ti/IAgoraMediaEngine-ti.d.ts +7 -6
  249. package/types/Private/ti/IAgoraMediaEngine-ti.d.ts.map +1 -0
  250. package/types/Private/ti/IAgoraMediaPlayer-ti.d.ts +8 -8
  251. package/types/Private/ti/IAgoraMediaPlayer-ti.d.ts.map +1 -0
  252. package/types/Private/ti/IAgoraMediaPlayerSource-ti.d.ts +8 -7
  253. package/types/Private/ti/IAgoraMediaPlayerSource-ti.d.ts.map +1 -0
  254. package/types/Private/ti/IAgoraMediaRecorder-ti.d.ts +7 -6
  255. package/types/Private/ti/IAgoraMediaRecorder-ti.d.ts.map +1 -0
  256. package/{js/Private/ti/IAgoraMediaRecorder-ti.d.ts → types/Private/ti/IAgoraMediaStreamingSource-ti.d.ts} +7 -6
  257. package/types/Private/ti/IAgoraMediaStreamingSource-ti.d.ts.map +1 -0
  258. package/types/Private/ti/IAgoraMusicContentCenter-ti.d.ts +8 -7
  259. package/types/Private/ti/IAgoraMusicContentCenter-ti.d.ts.map +1 -0
  260. package/types/Private/ti/IAgoraRhythmPlayer-ti.d.ts +7 -6
  261. package/types/Private/ti/IAgoraRhythmPlayer-ti.d.ts.map +1 -0
  262. package/types/Private/ti/IAgoraRtcEngine-ti.d.ts +10 -9
  263. package/types/Private/ti/IAgoraRtcEngine-ti.d.ts.map +1 -0
  264. package/types/Private/ti/IAgoraRtcEngineEx-ti.d.ts +7 -6
  265. package/types/Private/ti/IAgoraRtcEngineEx-ti.d.ts.map +1 -0
  266. package/types/Private/ti/IAgoraSpatialAudio-ti.d.ts +7 -6
  267. package/types/Private/ti/IAgoraSpatialAudio-ti.d.ts.map +1 -0
  268. package/types/Private/ti/IAudioDeviceManager-ti.d.ts +7 -6
  269. package/types/Private/ti/IAudioDeviceManager-ti.d.ts.map +1 -0
  270. package/types/Renderer/AgoraView.d.ts +70 -70
  271. package/types/Renderer/AgoraView.d.ts.map +1 -0
  272. package/types/Renderer/IRenderer.d.ts +22 -21
  273. package/types/Renderer/IRenderer.d.ts.map +1 -0
  274. package/types/Renderer/IRendererManager.d.ts +18 -0
  275. package/types/Renderer/IRendererManager.d.ts.map +1 -0
  276. package/types/Renderer/RendererManager.d.ts +154 -71
  277. package/types/Renderer/RendererManager.d.ts.map +1 -0
  278. package/types/Renderer/{GlRenderer → WebGLRenderer}/index.d.ts +49 -59
  279. package/types/Renderer/WebGLRenderer/index.d.ts.map +1 -0
  280. package/types/Renderer/WebGLRenderer/webgl-utils.d.ts +1 -0
  281. package/types/Renderer/WebGLRenderer/webgl-utils.d.ts.map +1 -0
  282. package/types/Renderer/YUVCanvasRenderer/index.d.ts +16 -16
  283. package/types/Renderer/YUVCanvasRenderer/index.d.ts.map +1 -0
  284. package/types/Renderer/index.d.ts +3 -0
  285. package/types/Renderer/index.d.ts.map +1 -0
  286. package/types/Types.d.ts +280 -260
  287. package/types/Types.d.ts.map +1 -0
  288. package/types/Utils.d.ts +59 -58
  289. package/types/Utils.d.ts.map +1 -0
  290. package/js/AgoraSdk.d.ts +0 -36
  291. package/js/Private/AgoraBase.d.ts +0 -4358
  292. package/js/Private/AgoraMediaBase.d.ts +0 -1070
  293. package/js/Private/AgoraMediaPlayerTypes.d.ts +0 -408
  294. package/js/Private/IAgoraLog.d.ts +0 -80
  295. package/js/Private/IAgoraMediaEngine.d.ts +0 -193
  296. package/js/Private/IAgoraMediaPlayer.d.ts +0 -546
  297. package/js/Private/IAgoraMediaPlayerSource.d.ts +0 -88
  298. package/js/Private/IAgoraMediaRecorder.d.ts +0 -49
  299. package/js/Private/IAgoraMusicContentCenter.d.ts +0 -255
  300. package/js/Private/IAgoraRhythmPlayer.d.ts +0 -64
  301. package/js/Private/IAgoraRtcEngine.d.ts +0 -5058
  302. package/js/Private/IAgoraRtcEngineEx.d.ts +0 -570
  303. package/js/Private/IAgoraSpatialAudio.d.ts +0 -248
  304. package/js/Private/IAudioDeviceManager.d.ts +0 -233
  305. package/js/Private/extension/AgoraBaseExtension.d.ts +0 -1
  306. package/js/Private/extension/AgoraMediaBaseExtension.d.ts +0 -1
  307. package/js/Private/extension/AgoraMediaPlayerTypesExtension.d.ts +0 -1
  308. package/js/Private/extension/IAgoraLogExtension.d.ts +0 -1
  309. package/js/Private/extension/IAgoraMediaEngineExtension.d.ts +0 -40
  310. package/js/Private/extension/IAgoraMediaPlayerExtension.d.ts +0 -46
  311. package/js/Private/extension/IAgoraMediaPlayerSourceExtension.d.ts +0 -1
  312. package/js/Private/extension/IAgoraMediaRecorderExtension.d.ts +0 -40
  313. package/js/Private/extension/IAgoraMusicContentCenterExtension.d.ts +0 -20
  314. package/js/Private/extension/IAgoraRhythmPlayerExtension.d.ts +0 -1
  315. package/js/Private/extension/IAgoraRtcEngineExExtension.d.ts +0 -1
  316. package/js/Private/extension/IAgoraRtcEngineExtension.d.ts +0 -42
  317. package/js/Private/extension/IAgoraSpatialAudioExtension.d.ts +0 -1
  318. package/js/Private/extension/IAudioDeviceManagerExtension.d.ts +0 -1
  319. package/js/Private/impl/AgoraBaseImpl.d.ts +0 -2
  320. package/js/Private/impl/AgoraMediaBaseImpl.d.ts +0 -7
  321. package/js/Private/impl/IAgoraMediaEngineImpl.d.ts +0 -43
  322. package/js/Private/impl/IAgoraMediaPlayerImpl.d.ts +0 -141
  323. package/js/Private/impl/IAgoraMediaPlayerSourceImpl.d.ts +0 -2
  324. package/js/Private/impl/IAgoraMediaRecorderImpl.d.ts +0 -13
  325. package/js/Private/impl/IAgoraMusicContentCenterImpl.d.ts +0 -51
  326. package/js/Private/impl/IAgoraRtcEngineExImpl.d.ts +0 -101
  327. package/js/Private/impl/IAgoraRtcEngineImpl.d.ts +0 -566
  328. package/js/Private/impl/IAgoraSpatialAudioImpl.d.ts +0 -48
  329. package/js/Private/impl/IAudioDeviceManagerImpl.d.ts +0 -64
  330. package/js/Private/internal/AudioDeviceManagerInternal.d.ts +0 -8
  331. package/js/Private/internal/IrisApiEngine.d.ts +0 -146
  332. package/js/Private/internal/LocalSpatialAudioEngineInternal.d.ts +0 -18
  333. package/js/Private/internal/MediaEngineInternal.d.ts +0 -21
  334. package/js/Private/internal/MediaPlayerInternal.d.ts +0 -33
  335. package/js/Private/internal/MediaRecorderInternal.d.ts +0 -15
  336. package/js/Private/internal/MusicContentCenterInternal.d.ts +0 -39
  337. package/js/Private/internal/RtcEngineExInternal.d.ts +0 -73
  338. package/js/Private/ti/AgoraBase-ti.d.ts +0 -7
  339. package/js/Private/ti/AgoraMediaBase-ti.d.ts +0 -12
  340. package/js/Private/ti/IAgoraLog-ti.d.ts +0 -6
  341. package/js/Private/ti/IAgoraMediaEngine-ti.d.ts +0 -6
  342. package/js/Private/ti/IAgoraMediaPlayer-ti.d.ts +0 -8
  343. package/js/Private/ti/IAgoraMediaPlayerSource-ti.d.ts +0 -7
  344. package/js/Private/ti/IAgoraMusicContentCenter-ti.d.ts +0 -7
  345. package/js/Private/ti/IAgoraRhythmPlayer-ti.d.ts +0 -6
  346. package/js/Private/ti/IAgoraRtcEngine-ti.d.ts +0 -9
  347. package/js/Private/ti/IAgoraRtcEngineEx-ti.d.ts +0 -6
  348. package/js/Private/ti/IAgoraSpatialAudio-ti.d.ts +0 -6
  349. package/js/Private/ti/IAudioDeviceManager-ti.d.ts +0 -6
  350. package/js/Renderer/AgoraView.d.ts +0 -70
  351. package/js/Renderer/GlRenderer/index.d.ts +0 -59
  352. package/js/Renderer/GlRenderer/webgl-utils.d.ts +0 -0
  353. package/js/Renderer/IRenderer.d.ts +0 -21
  354. package/js/Renderer/RendererManager.d.ts +0 -71
  355. package/js/Renderer/YUVCanvasRenderer/index.d.ts +0 -16
  356. package/js/Types.d.ts +0 -260
  357. package/js/Utils.d.ts +0 -58
  358. /package/ts/Renderer/{GlRenderer → WebGLRenderer}/webgl-utils.js +0 -0
@@ -0,0 +1 @@
1
+ {"version":3,"file":"IAgoraRtcEngineEx.d.ts","sourceRoot":"","sources":["../../ts/Private/IAgoraRtcEngineEx.ts"],"names":[],"mappings":"AAAA,OAAO,wCAAwC,CAAC;AAChD,OAAO,EACL,8BAA8B,EAC9B,mBAAmB,EACnB,gBAAgB,EAChB,gBAAgB,EAChB,eAAe,EACf,qBAAqB,EACrB,mBAAmB,EACnB,kBAAkB,EAClB,QAAQ,EACR,WAAW,EACX,yBAAyB,EACzB,mBAAmB,EACnB,eAAe,EACf,wBAAwB,EACxB,gBAAgB,EACjB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EACL,mBAAmB,EACnB,UAAU,EACV,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,mBAAmB,CAAC;AAE3B;;GAEG;AACH,qBAAa,aAAa;IACxB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;GAGG;AACH,8BAAsB,YAAa,SAAQ,UAAU;IACnD;;;;;;;;;;;;;;;;;;OAkBG;IACH,QAAQ,CAAC,aAAa,CACpB,KAAK,EAAE,MAAM,EACb,UAAU,EAAE,aAAa,EACzB,OAAO,EAAE,mBAAmB,GAC3B,MAAM;IAET;;;;;;;;;OASG;IACH,QAAQ,CAAC,cAAc,CACrB,UAAU,EAAE,aAAa,EACzB,OAAO,CAAC,EAAE,mBAAmB,GAC5B,MAAM;IAET;;;;;;;;OAQG;IACH,QAAQ,CAAC,2BAA2B,CAClC,OAAO,EAAE,mBAAmB,EAC5B,UAAU,EAAE,aAAa,GACxB,MAAM;IAET;;;;;;;;;OASG;IACH,QAAQ,CAAC,8BAA8B,CACrC,MAAM,EAAE,yBAAyB,EACjC,UAAU,EAAE,aAAa,GACxB,MAAM;IAET;;;;;;;;;OASG;IACH,QAAQ,CAAC,kBAAkB,CACzB,MAAM,EAAE,WAAW,EACnB,UAAU,EAAE,aAAa,GACxB,MAAM;IAET;;;;;;;;;OASG;IACH,QAAQ,CAAC,uBAAuB,CAC9B,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,OAAO,EACb,UAAU,EAAE,aAAa,GACxB,MAAM;IAET;;;;;;;;;OASG;IACH,QAAQ,CAAC,uBAAuB,CAC9B,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,OAAO,EACb,UAAU,EAAE,aAAa,GACxB,MAAM;IAET;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,0BAA0B,CACjC,GAAG,EAAE,MAAM,EACX,UAAU,EAAE,eAAe,EAC3B,UAAU,EAAE,aAAa,GACxB,MAAM;IAET;;;;;;;;;OASG;IACH,QAAQ,CAAC,sBAAsB,CAC7B,IAAI,EAAE,OAAO,EACb,UAAU,EAAE,aAAa,GACxB,MAAM;IAET;;;;;;;;;OASG;IACH,QAAQ,CAAC,sBAAsB,CAC7B,IAAI,EAAE,OAAO,EACb,UAAU,EAAE,aAAa,GACxB,MAAM;IAET;;;;;;;;;OASG;IACH,QAAQ,CAAC,2BAA2B,CAClC,IAAI,EAAE,OAAO,EACb,UAAU,EAAE,aAAa,GACxB,MAAM;IAET;;;;;;;;;OASG;IACH,QAAQ,CAAC,2BAA2B,CAClC,IAAI,EAAE,OAAO,EACb,UAAU,EAAE,aAAa,GACxB,MAAM;IAET;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,4BAA4B,CACnC,OAAO,EAAE,MAAM,EAAE,EACjB,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,aAAa,GACxB,MAAM;IAET;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,4BAA4B,CACnC,OAAO,EAAE,MAAM,EAAE,EACjB,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,aAAa,GACxB,MAAM;IAET;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,4BAA4B,CACnC,OAAO,EAAE,MAAM,EAAE,EACjB,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,aAAa,GACxB,MAAM;IAET;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,4BAA4B,CACnC,OAAO,EAAE,MAAM,EAAE,EACjB,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,aAAa,GACxB,MAAM;IAET;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,mCAAmC,CAC1C,GAAG,EAAE,MAAM,EACX,OAAO,EAAE,wBAAwB,EACjC,UAAU,EAAE,aAAa,GACxB,MAAM;IAET;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,wBAAwB,CAC/B,GAAG,EAAE,MAAM,EACX,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,MAAM,EACZ,UAAU,EAAE,aAAa,GACxB,MAAM;IAET;;OAEG;IACH,QAAQ,CAAC,iCAAiC,CACxC,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,kBAAkB,EAC1B,UAAU,EAAE,aAAa,GACxB,MAAM;IAET;;OAEG;IACH,QAAQ,CAAC,qBAAqB,CAC5B,GAAG,EAAE,MAAM,EACX,UAAU,EAAE,cAAc,EAC1B,UAAU,EAAE,mBAAmB,EAC/B,UAAU,EAAE,aAAa,GACxB,MAAM;IAET;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,yBAAyB,CAChC,UAAU,EAAE,aAAa,EACzB,OAAO,EAAE,OAAO,EAChB,UAAU,CAAC,EAAE,MAAM,GAClB,MAAM;IAET;;OAEG;IACH,QAAQ,CAAC,6BAA6B,CACpC,MAAM,EAAE,MAAM,EACd,UAAU,EAAE,aAAa,GACxB,MAAM;IAET;;;;;;;;;OASG;IACH,QAAQ,CAAC,qBAAqB,CAC5B,IAAI,EAAE,OAAO,EACb,UAAU,EAAE,aAAa,GACxB,MAAM;IAET;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,gCAAgC,CACvC,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,MAAM,EACd,UAAU,EAAE,aAAa,GACxB,MAAM;IAET;;;;;;;;OAQG;IACH,QAAQ,CAAC,oBAAoB,CAAC,UAAU,EAAE,aAAa,GAAG,mBAAmB;IAE7E;;OAEG;IACH,QAAQ,CAAC,kBAAkB,CACzB,UAAU,EAAE,aAAa,EACzB,OAAO,EAAE,OAAO,EAChB,MAAM,EAAE,gBAAgB,GACvB,MAAM;IAET;;;;;;;;;OASG;IACH,QAAQ,CAAC,kBAAkB,CACzB,MAAM,EAAE,gBAAgB,EACxB,UAAU,EAAE,aAAa,GACxB,MAAM;IAET;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,mBAAmB,CAC1B,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,UAAU,EAChB,MAAM,EAAE,MAAM,EACd,UAAU,EAAE,aAAa,GACxB,MAAM;IAET;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,mBAAmB,CAC1B,YAAY,EAAE,MAAM,EACpB,OAAO,EAAE,gBAAgB,EACzB,UAAU,EAAE,aAAa,GACxB,MAAM;IAET;;;;;;;OAOG;IACH,QAAQ,CAAC,qBAAqB,CAAC,UAAU,EAAE,aAAa,GAAG,MAAM;IAEjE;;;OAGG;IACH,QAAQ,CAAC,yBAAyB,CAChC,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,MAAM,EACb,UAAU,EAAE,aAAa,GACxB,MAAM;IAET;;;;;;;;;;;;;;;;OAgBG;IACH,QAAQ,CAAC,6BAA6B,CACpC,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,OAAO,EAClB,UAAU,EAAE,aAAa,GACxB,MAAM;IAET;;;;;;;;;;;;;;;;;OAiBG;IACH,QAAQ,CAAC,mCAAmC,CAC1C,GAAG,EAAE,MAAM,EACX,UAAU,EAAE,aAAa,GACxB,MAAM;IAET;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,gCAAgC,CACvC,GAAG,EAAE,MAAM,EACX,WAAW,EAAE,eAAe,EAC5B,UAAU,EAAE,aAAa,GACxB,MAAM;IAET;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,uBAAuB,CAC9B,WAAW,EAAE,eAAe,EAC5B,UAAU,EAAE,aAAa,GACxB,MAAM;IAET;;;;;;;;;;;;;;;;;OAiBG;IACH,QAAQ,CAAC,gBAAgB,CAAC,GAAG,EAAE,MAAM,EAAE,UAAU,EAAE,aAAa,GAAG,MAAM;IAEzE;;OAEG;IACH,QAAQ,CAAC,gCAAgC,CACvC,aAAa,EAAE,8BAA8B,EAC7C,UAAU,EAAE,aAAa,GACxB,MAAM;IAET;;;;;;OAMG;IACH,QAAQ,CAAC,wBAAwB,CAC/B,aAAa,EAAE,8BAA8B,EAC7C,UAAU,EAAE,aAAa,GACxB,MAAM;IAET;;;;;;OAMG;IACH,QAAQ,CAAC,yBAAyB,CAChC,aAAa,EAAE,8BAA8B,EAC7C,UAAU,EAAE,aAAa,GACxB,MAAM;IAET;;;;;;;;OAQG;IACH,QAAQ,CAAC,uBAAuB,CAAC,UAAU,EAAE,aAAa,GAAG,MAAM;IAEnE;;;;;;;;OAQG;IACH,QAAQ,CAAC,2BAA2B,CAAC,UAAU,EAAE,aAAa,GAAG,MAAM;IAEvE;;;;;;;;OAQG;IACH,QAAQ,CAAC,4BAA4B,CAAC,UAAU,EAAE,aAAa,GAAG,MAAM;IAExE;;OAEG;IACH,QAAQ,CAAC,0BAA0B,CACjC,WAAW,EAAE,MAAM,EACnB,UAAU,EAAE,aAAa,GACxB,QAAQ;IAEX;;;;;;OAMG;IACH,QAAQ,CAAC,kBAAkB,CAAC,GAAG,EAAE,MAAM,EAAE,UAAU,EAAE,aAAa,GAAG,QAAQ;IAE7E;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,sBAAsB,CAC7B,OAAO,EAAE,OAAO,EAChB,YAAY,EAAE,qBAAqB,EACnC,UAAU,EAAE,aAAa,GACxB,MAAM;IAET;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,mBAAmB,CAC1B,IAAI,EAAE,mBAAmB,EACzB,YAAY,EAAE,qBAAqB,EACnC,UAAU,EAAE,aAAa,GACxB,MAAM;IAET;;OAEG;IACH,QAAQ,CAAC,yBAAyB,CAChC,OAAO,EAAE,MAAM,EAAE,EACjB,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,qBAAqB,EAC7B,UAAU,EAAE,aAAa,GACxB,MAAM;IAET;;;;;;;;;;;;;;;;OAgBG;IACH,QAAQ,CAAC,cAAc,CACrB,UAAU,EAAE,aAAa,EACzB,GAAG,EAAE,MAAM,EACX,QAAQ,EAAE,MAAM,GACf,MAAM;IAET;;;;;;;;OAQG;IACH,QAAQ,CAAC,4BAA4B,CAAC,UAAU,EAAE,aAAa,GAAG,MAAM;CACzE"}
@@ -1,248 +1,266 @@
1
- import './extension/IAgoraSpatialAudioExtension';
2
- import { RtcConnection } from './IAgoraRtcEngineEx';
3
- /**
4
- * The spatial position of the remote user or the media player.
5
- */
6
- export declare class RemoteVoicePositionInfo {
7
- /**
8
- * The coordinates in the world coordinate system. This parameter is an array of length 3, and the three values represent the front, right, and top coordinates in turn.
9
- */
10
- position?: number[];
11
- /**
12
- * The unit vector of the x axis in the coordinate system. This parameter is an array of length 3, and the three values represent the front, right, and top coordinates in turn.
13
- */
14
- forward?: number[];
15
- }
16
- /**
17
- * Sound insulation area settings.
18
- */
19
- export declare class SpatialAudioZone {
20
- /**
21
- * The ID of the sound insulation area.
22
- */
23
- zoneSetId?: number;
24
- /**
25
- * The spatial center point of the sound insulation area. This parameter is an array of length 3, and the three values represent the front, right, and top coordinates in turn.
26
- */
27
- position?: number[];
28
- /**
29
- * Starting at position, the forward unit vector. This parameter is an array of length 3, and the three values represent the front, right, and top coordinates in turn.
30
- */
31
- forward?: number[];
32
- /**
33
- * Starting at position, the right unit vector. This parameter is an array of length 3, and the three values represent the front, right, and top coordinates in turn.
34
- */
35
- right?: number[];
36
- /**
37
- * Starting at position, the up unit vector. This parameter is an array of length 3, and the three values represent the front, right, and top coordinates in turn.
38
- */
39
- up?: number[];
40
- /**
41
- * The entire sound insulation area is regarded as a cube; this represents the length of the forward side in the unit length of the game engine.
42
- */
43
- forwardLength?: number;
44
- /**
45
- * The entire sound insulation area is regarded as a cube; this represents the length of the right side in the unit length of the game engine.
46
- */
47
- rightLength?: number;
48
- /**
49
- * The entire sound insulation area is regarded as a cube; this represents the length of the up side in the unit length of the game engine.
50
- */
51
- upLength?: number;
52
- /**
53
- * The sound attenuation coefficient when users within the sound insulation area communicate with external users. The value range is [0,1]. The values are as follows:0: Broadcast mode, where the volume and timbre are not attenuated with distance, and the volume and timbre heard by local users do not change regardless of distance.(0,0.5): Weak attenuation mode, that is, the volume and timbre are only weakly attenuated during the propagation process, and the sound can travel farther than the real environment.0.5: (Default) simulates the attenuation of the volume in the real environment; the effect is equivalent to not setting the audioAttenuation parameter.(0.5,1]: Strong attenuation mode (default value is 1), that is, the volume and timbre attenuate rapidly during propagation.
54
- */
55
- audioAttenuation?: number;
56
- }
57
- /**
58
- * This class contains some of the APIs in the ILocalSpatialAudioEngine class.
59
- * The ILocalSpatialAudioEngine class inherits from IBaseSpatialAudioEngine.
60
- */
61
- export declare abstract class IBaseSpatialAudioEngine {
62
- /**
63
- * Destroys IBaseSpatialAudioEngine .
64
- * This method releases all resources under IBaseSpatialAudioEngine. When the user does not need to use the spatial audio effect, you can call this method to release resources for other operations.After calling this method, you can no longer use any of the APIs under IBaseSpatialAudioEngine.Call this method before the release method under IRtcEngine .
65
- */
66
- abstract release(): void;
67
- /**
68
- * Sets the maximum number of streams that a user can receive in a specified audio reception range.
69
- * If the number of receivable streams exceeds the set value, the local user receives the maxCount streams that are closest to the local user. If there are users who belong to the same team as the local user in the room, the local user receives the audio of the teammates first. For example, when maxCount is set to 3, if there are five remote users in the room, two of whom belong to the same team as the local user, and three of whom belong to different teams but are within the audio reception range of the local user, the local user can hear the two teammates and the one user from a different team closest to the local user.
70
- *
71
- * @param maxCount The maximum number of streams that a user can receive within a specified audio reception range.
72
- *
73
- * @returns
74
- * 0: Success.< 0: Failure.
75
- */
76
- abstract setMaxAudioRecvCount(maxCount: number): number;
77
- /**
78
- * Sets the audio reception range of the local user.
79
- * After the setting is successful, the local user can only hear the remote users within the setting range or belonging to the same team. You can call this method at any time to update the audio reception range.
80
- *
81
- * @param range The maximum audio reception range. The unit is meters. The value must be greater than 0.
82
- *
83
- * @returns
84
- * 0: Success.< 0: Failure.
85
- */
86
- abstract setAudioRecvRange(range: number): number;
87
- /**
88
- * Sets the length (in meters) of the game engine distance per unit.
89
- * In a game engine, the unit of distance is customized, while in the Agora spatial audio algorithm, distance is measured in meters. By default, the SDK converts the game engine distance per unit to one meter. You can call this method to convert the game engine distance per unit to a specified number of meters.
90
- *
91
- * @param unit The number of meters that the game engine distance per unit is equal to. This parameter must be greater than 0.00. For example, setting unit as 2.00 means the game engine distance per unit equals 2 meters.The larger the value is, the faster the sound heard by the local user attenuates when the remote user moves far away from the local user.
92
- *
93
- * @returns
94
- * 0: Success.< 0: Failure.
95
- */
96
- abstract setDistanceUnit(unit: number): number;
97
- /**
98
- * Updates the spatial position of the local user.
99
- * Under the ILocalSpatialAudioEngine class, this method needs to be used with updateRemotePosition . The SDK calculates the relative position between the local and remote users according to this method and the parameter settings in updateRemotePosition, and then calculates the user's spatial audio effect parameters.
100
- *
101
- * @param position The coordinates in the world coordinate system. This parameter is an array of length 3, and the three values represent the front, right, and top coordinates in turn.
102
- *
103
- * @param axisForward The unit vector of the x axis in the coordinate system. This parameter is an array of length 3, and the three values represent the front, right, and top coordinates in turn.
104
- *
105
- * @param axisRight The unit vector of the y axis in the coordinate system. This parameter is an array of length 3, and the three values represent the front, right, and top coordinates in turn.
106
- *
107
- * @param axisUp The unit vector of the z axis in the coordinate system. This parameter is an array of length 3, and the three values represent the front, right, and top coordinates in turn.
108
- *
109
- * @returns
110
- * 0: Success.< 0: Failure.
111
- */
112
- abstract updateSelfPosition(position: number[], axisForward: number[], axisRight: number[], axisUp: number[]): number;
113
- /**
114
- * @ignore
115
- */
116
- abstract updateSelfPositionEx(position: number[], axisForward: number[], axisRight: number[], axisUp: number[], connection: RtcConnection): number;
117
- /**
118
- * Updates the spatial position of the media player.
119
- * After a successful update, the local user can hear the change in the spatial position of the media player.
120
- *
121
- * @param playerId The ID of the media player.
122
- *
123
- * @param positionInfo The spatial position of the media player. See RemoteVoicePositionInfo .
124
- *
125
- * @returns
126
- * 0: Success.< 0: Failure.
127
- */
128
- abstract updatePlayerPositionInfo(playerId: number, positionInfo: RemoteVoicePositionInfo): number;
129
- /**
130
- * @ignore
131
- */
132
- abstract setParameters(params: string): number;
133
- /**
134
- * Stops or resumes publishing the local audio stream.
135
- * This method does not affect any ongoing audio recording, because it does not disable the audio capture device.Call this method after joinChannel [2/2] .When using the spatial audio effect, if you need to set whether to publish the local audio stream, Agora recommends calling this method instead of the muteLocalAudioStream method under IRtcEngine .
136
- *
137
- * @param mute Whether to stop publishing the local audio stream.true: Stop publishing the local audio stream.false: Publish the local audio stream.
138
- *
139
- * @returns
140
- * 0: Success.< 0: Failure.
141
- */
142
- abstract muteLocalAudioStream(mute: boolean): number;
143
- /**
144
- * Stops or resumes subscribing to the audio streams of all remote users.
145
- * After successfully calling this method, the local user stops or resumes subscribing to the audio streams of all remote users, including all subsequent users.Call this method after joinChannel [2/2] .When using the spatial audio effect, if you need to set whether to stop subscribing to the audio streams of all remote users, Agora recommends calling this method instead of the muteAllRemoteAudioStreams method in IRtcEngine .After calling this method, you need to call updateSelfPosition and updateRemotePosition to update the spatial location of the local user and the remote user; otherwise, the settings in this method do not take effect.
146
- *
147
- * @param mute Whether to stop subscribing to the audio streams of all remote users:true: Stops subscribing to the audio streams of all remote users.false: Subscribe to the audio streams of all remote users.
148
- *
149
- * @returns
150
- * 0: Success.< 0: Failure.
151
- */
152
- abstract muteAllRemoteAudioStreams(mute: boolean): number;
153
- /**
154
- * Sets the sound insulation area.
155
- * In virtual interactive scenarios, you can use this method to set the sound insulation area and sound attenuation coefficient. When the sound source (which can be the user or the media player) and the listener belong to the inside and outside of the sound insulation area, they can experience the attenuation effect of sound similar to the real environment when it encounters a building partition.When the sound source and the listener belong to the inside and outside of the sound insulation area, the sound attenuation effect is determined by the sound attenuation coefficient in SpatialAudioZone .If the user or media player is in the same sound insulation area, it is not affected by SpatialAudioZone, and the sound attenuation effect is determined by the attenuation parameter in setPlayerAttenuation or setRemoteAudioAttenuation. If you do not call setPlayerAttenuation or setRemoteAudioAttenuation, the default sound attenuation coefficient of the SDK is 0.5, which simulates the attenuation of the sound in the real environment.If the sound source and the receiver belong to two sound insulation areas, the receiver cannot hear the sound source.If this method is called multiple times, the last sound insulation area set takes effect.
156
- *
157
- * @param zones Sound insulation area settings. See SpatialAudioZone.
158
- *
159
- * @returns
160
- * 0: Success.< 0: Failure.
161
- */
162
- abstract setZones(zones: SpatialAudioZone[], zoneCount: number): number;
163
- /**
164
- * Sets the sound attenuation properties of the media player.
165
- *
166
- * @param playerId The ID of the media player.
167
- *
168
- * @param attenuation The sound attenuation coefficient of the remote user or media player. The value range is [0,1]. The values are as follows:0: Broadcast mode, where the volume and timbre are not attenuated with distance, and the volume and timbre heard by local users do not change regardless of distance.(0,0.5): Weak attenuation mode, that is, the volume and timbre are only weakly attenuated during the propagation process, and the sound can travel farther than the real environment.0.5: (Default) simulates the attenuation of the volume in the real environment; the effect is equivalent to not setting the speaker_attenuation parameter.(0.5,1]: Strong attenuation mode, that is, the volume and timbre attenuate rapidly during the propagation process.
169
- *
170
- * @param forceSet Whether to force the sound attenuation effect of the media player:true: Force attenuation to set the attenuation of the user. At this time, the attenuation coefficient of the sound insulation area set in the audioAttenuation in the SpatialAudioZone does not take effect for the user.false: Do not force attenuation e to set the user's sound attenuationffect, as shown in the following two cases.If the sound source and listener are inside and outside the sound isolation area, the sound attenuation effect is determined by the audioAttenuation in SpatialAudioZone.If the sound source and the listener are in the same sound insulation area or outside the same sound insulation area, the sound attenuation effect is determined by attenuation in this method.
171
- *
172
- * @returns
173
- * 0: Success.< 0: Failure.
174
- */
175
- abstract setPlayerAttenuation(playerId: number, attenuation: number, forceSet: boolean): number;
176
- /**
177
- * Stops or resumes subscribing to the audio stream of a specified user.
178
- * Call this method after joinChannel [2/2] .When using the spatial audio effect, if you need to set whether to stop subscribing to the audio stream of a specified user, Agora recommends calling this method instead of the muteRemoteAudioStream method in IRtcEngine .
179
- *
180
- * @param uid The user ID. This parameter must be the same as the user ID passed in when the user joined the channel.
181
- *
182
- * @param mute Whether to subscribe to the specified remote user's audio stream.true: Stop subscribing to the audio stream of the specified user.false: (Default) Subscribe to the audio stream of the specified user. The SDK decides whether to subscribe according to the distance between the local user and the remote user.
183
- *
184
- * @returns
185
- * 0: Success.< 0: Failure.
186
- */
187
- abstract muteRemoteAudioStream(uid: number, mute: boolean): number;
188
- }
189
- /**
190
- * This class calculates user positions through the SDK to implement the spatial audio effect.
191
- * This class inherits from IBaseSpatialAudioEngine . Before calling other APIs in this class, you need to call the initialize method to initialize this class.
192
- */
193
- export declare abstract class ILocalSpatialAudioEngine extends IBaseSpatialAudioEngine {
194
- /**
195
- * Initializes ILocalSpatialAudioEngine .
196
- * Before calling other methods of the ILocalSpatialAudioEngine class, you need to call this method to initialize ILocalSpatialAudioEngine.The SDK supports creating only one ILocalSpatialAudioEngine instance for an app.
197
- *
198
- * @returns
199
- * 0: Success.< 0: Failure.
200
- */
201
- abstract initialize(): number;
202
- /**
203
- * Updates the spatial position of the specified remote user.
204
- * After successfully calling this method, the SDK calculates the spatial audio parameters based on the relative position of the local and remote user.Call this method after joinChannel [2/2] .
205
- *
206
- * @param uid The user ID. This parameter must be the same as the user ID passed in when the user joined the channel.
207
- *
208
- * @param posInfo The spatial position of the remote user. See RemoteVoicePositionInfo .
209
- *
210
- * @returns
211
- * 0: Success.< 0: Failure.
212
- */
213
- abstract updateRemotePosition(uid: number, posInfo: RemoteVoicePositionInfo): number;
214
- /**
215
- * @ignore
216
- */
217
- abstract updateRemotePositionEx(uid: number, posInfo: RemoteVoicePositionInfo, connection: RtcConnection): number;
218
- /**
219
- * Removes the spatial position of the specified remote user.
220
- * After successfully calling this method, the local user no longer hears the specified remote user.After leaving the channel, to avoid wasting resources, you can also call this method to delete the spatial position of the specified remote user.
221
- *
222
- * @param uid The user ID. This parameter must be the same as the user ID passed in when the user joined the channel.
223
- *
224
- * @returns
225
- * 0: Success.< 0: Failure.
226
- */
227
- abstract removeRemotePosition(uid: number): number;
228
- /**
229
- * @ignore
230
- */
231
- abstract removeRemotePositionEx(uid: number, connection: RtcConnection): number;
232
- /**
233
- * Removes the spatial positions of all remote users.
234
- * After successfully calling this method, the local user no longer hears any remote users.After leaving the channel, to avoid wasting resources, you can also call this method to delete the spatial positions of all remote users.
235
- *
236
- * @returns
237
- * 0: Success.< 0: Failure.
238
- */
239
- abstract clearRemotePositions(): number;
240
- /**
241
- * @ignore
242
- */
243
- abstract clearRemotePositionsEx(connection: RtcConnection): number;
244
- /**
245
- * @ignore
246
- */
247
- abstract setRemoteAudioAttenuation(uid: number, attenuation: number, forceSet: boolean): number;
248
- }
1
+ import './extension/IAgoraSpatialAudioExtension';
2
+ import { RtcConnection } from './IAgoraRtcEngineEx';
3
+ /**
4
+ * The spatial position of the remote user or the media player.
5
+ */
6
+ export declare class RemoteVoicePositionInfo {
7
+ /**
8
+ * The coordinates in the world coordinate system. This parameter is an array of length 3, and the three values represent the front, right, and top coordinates in turn.
9
+ */
10
+ position?: number[];
11
+ /**
12
+ * The unit vector of the x axis in the coordinate system. This parameter is an array of length 3, and the three values represent the front, right, and top coordinates in turn.
13
+ */
14
+ forward?: number[];
15
+ }
16
+ /**
17
+ * Sound insulation area settings.
18
+ */
19
+ export declare class SpatialAudioZone {
20
+ /**
21
+ * The ID of the sound insulation area.
22
+ */
23
+ zoneSetId?: number;
24
+ /**
25
+ * The spatial center point of the sound insulation area. This parameter is an array of length 3, and the three values represent the front, right, and top coordinates in turn.
26
+ */
27
+ position?: number[];
28
+ /**
29
+ * Starting at position, the forward unit vector. This parameter is an array of length 3, and the three values represent the front, right, and top coordinates in turn.
30
+ */
31
+ forward?: number[];
32
+ /**
33
+ * Starting at position, the right unit vector. This parameter is an array of length 3, and the three values represent the front, right, and top coordinates in turn.
34
+ */
35
+ right?: number[];
36
+ /**
37
+ * Starting at position, the up unit vector. This parameter is an array of length 3, and the three values represent the front, right, and top coordinates in turn.
38
+ */
39
+ up?: number[];
40
+ /**
41
+ * The entire sound insulation area is regarded as a cube; this represents the length of the forward side in the unit length of the game engine.
42
+ */
43
+ forwardLength?: number;
44
+ /**
45
+ * The entire sound insulation area is regarded as a cube; this represents the length of the right side in the unit length of the game engine.
46
+ */
47
+ rightLength?: number;
48
+ /**
49
+ * The entire sound insulation area is regarded as a cube; this represents the length of the up side in the unit length of the game engine.
50
+ */
51
+ upLength?: number;
52
+ /**
53
+ * The sound attenuation coefficient when users within the sound insulation area communicate with external users. The value range is [0,1]. The values are as follows:0: Broadcast mode, where the volume and timbre are not attenuated with distance, and the volume and timbre heard by local users do not change regardless of distance.(0,0.5): Weak attenuation mode, that is, the volume and timbre are only weakly attenuated during the propagation process, and the sound can travel farther than the real environment.0.5: (Default) simulates the attenuation of the volume in the real environment; the effect is equivalent to not setting the audioAttenuation parameter.(0.5,1]: Strong attenuation mode (default value is 1), that is, the volume and timbre attenuate rapidly during propagation.
54
+ */
55
+ audioAttenuation?: number;
56
+ }
57
+ /**
58
+ * This class contains some of the APIs in the ILocalSpatialAudioEngine class.
59
+ * The ILocalSpatialAudioEngine class inherits from IBaseSpatialAudioEngine.
60
+ */
61
+ export declare abstract class IBaseSpatialAudioEngine {
62
+ /**
63
+ * Destroys IBaseSpatialAudioEngine .
64
+ * This method releases all resources under IBaseSpatialAudioEngine. When the user does not need to use the spatial audio effect, you can call this method to release resources for other operations.After calling this method, you can no longer use any of the APIs under IBaseSpatialAudioEngine.Call this method before the release method under IRtcEngine .
65
+ */
66
+ abstract release(): void;
67
+ /**
68
+ * Sets the maximum number of streams that a user can receive in a specified audio reception range.
69
+ * If the number of receivable streams exceeds the set value, the local user receives the maxCount streams that are closest to the local user.
70
+ *
71
+ * @param maxCount The maximum number of streams that a user can receive within a specified audio reception range. The value of this parameter should be ≤ 16, and the default value is 10.
72
+ *
73
+ * @returns
74
+ * 0: Success.< 0: Failure.
75
+ */
76
+ abstract setMaxAudioRecvCount(maxCount: number): number;
77
+ /**
78
+ * Sets the audio reception range of the local user.
79
+ * After the setting is successful, the local user can only hear the remote users within the setting range or belonging to the same team. You can call this method at any time to update the audio reception range.
80
+ *
81
+ * @param range The maximum audio reception range. The unit is meters. The value of this parameter must be greater than 0, and the default value is 20.
82
+ *
83
+ * @returns
84
+ * 0: Success.< 0: Failure.
85
+ */
86
+ abstract setAudioRecvRange(range: number): number;
87
+ /**
88
+ * Sets the length (in meters) of the game engine distance per unit.
89
+ * In a game engine, the unit of distance is customized, while in the Agora spatial audio algorithm, distance is measured in meters. By default, the SDK converts the game engine distance per unit to one meter. You can call this method to convert the game engine distance per unit to a specified number of meters.
90
+ *
91
+ * @param unit The number of meters that the game engine distance per unit is equal to. The value of this parameter must be greater than 0.00, and the default value is 1.00. For example, setting unit as 2.00 means the game engine distance per unit equals 2 meters.The larger the value is, the faster the sound heard by the local user attenuates when the remote user moves far away from the local user.
92
+ *
93
+ * @returns
94
+ * 0: Success.< 0: Failure.
95
+ */
96
+ abstract setDistanceUnit(unit: number): number;
97
+ /**
98
+ * Updates the spatial position of the local user.
99
+ * Under the ILocalSpatialAudioEngine class, this method needs to be used with updateRemotePosition . The SDK calculates the relative position between the local and remote users according to this method and the parameter settings in updateRemotePosition, and then calculates the user's spatial audio effect parameters.
100
+ *
101
+ * @param position The coordinates in the world coordinate system. This parameter is an array of length 3, and the three values represent the front, right, and top coordinates in turn.
102
+ * @param axisForward The unit vector of the x axis in the coordinate system. This parameter is an array of length 3, and the three values represent the front, right, and top coordinates in turn.
103
+ * @param axisRight The unit vector of the y axis in the coordinate system. This parameter is an array of length 3, and the three values represent the front, right, and top coordinates in turn.
104
+ * @param axisUp The unit vector of the z axis in the coordinate system. This parameter is an array of length 3, and the three values represent the front, right, and top coordinates in turn.
105
+ *
106
+ * @returns
107
+ * 0: Success.< 0: Failure.
108
+ */
109
+ abstract updateSelfPosition(position: number[], axisForward: number[], axisRight: number[], axisUp: number[]): number;
110
+ /**
111
+ * @ignore
112
+ */
113
+ abstract updateSelfPositionEx(position: number[], axisForward: number[], axisRight: number[], axisUp: number[], connection: RtcConnection): number;
114
+ /**
115
+ * Updates the spatial position of the media player.
116
+ * After a successful update, the local user can hear the change in the spatial position of the media player.
117
+ *
118
+ * @param playerId The ID of the media player.
119
+ * @param positionInfo The spatial position of the media player. See RemoteVoicePositionInfo .
120
+ *
121
+ * @returns
122
+ * 0: Success.< 0: Failure.
123
+ */
124
+ abstract updatePlayerPositionInfo(playerId: number, positionInfo: RemoteVoicePositionInfo): number;
125
+ /**
126
+ * @ignore
127
+ */
128
+ abstract setParameters(params: string): number;
129
+ /**
130
+ * Stops or resumes publishing the local audio stream.
131
+ * This method does not affect any ongoing audio recording, because it does not disable the audio capture device.Call this method after joinChannel .When using the spatial audio effect, if you need to set whether to stop subscribing to the audio stream of a specified user, Agora recommends calling this method instead of the muteLocalAudioStream method in IRtcEngine .
132
+ *
133
+ * @param mute Whether to stop publishing the local audio stream:: Stop publishing the local audio stream.true: Publish the local audio stream.false
134
+ *
135
+ * @returns
136
+ * 0: Success.< 0: Failure.
137
+ */
138
+ abstract muteLocalAudioStream(mute: boolean): number;
139
+ /**
140
+ * Stops or resumes subscribing to the audio streams of all remote users.
141
+ * After successfully calling this method, the local user stops or resumes subscribing to the audio streams of all remote users, including all subsequent users.Call this method after joinChannel .When using the spatial audio effect, if you need to set whether to stop subscribing to the audio streams of all remote users, Agora recommends calling this method instead of the muteAllRemoteAudioStreams method in IRtcEngine .After calling this method, you need to call updateSelfPosition and updateRemotePosition to update the spatial location of the local user and the remote user; otherwise, the settings in this method do not take effect.
142
+ *
143
+ * @param mute Whether to stop subscribing to the audio streams of all remote users:true: Stop subscribing to the audio streams of all remote users.false: Subscribe to the audio streams of all remote users.
144
+ *
145
+ * @returns
146
+ * 0: Success.< 0: Failure.
147
+ */
148
+ abstract muteAllRemoteAudioStreams(mute: boolean): number;
149
+ /**
150
+ * Sets the sound insulation area.
151
+ * In virtual interactive scenarios, you can use this method to set the sound insulation area and sound attenuation coefficient. When the sound source (which can be the user or the media player) and the listener belong to the inside and outside of the sound insulation area, they can experience the attenuation effect of sound similar to the real environment when it encounters a building partition.When the sound source and the listener belong to the inside and outside of the sound insulation area, the sound attenuation effect is determined by the sound attenuation coefficient in SpatialAudioZone .If the user or media player is in the same sound insulation area, it is not affected by SpatialAudioZone, and the sound attenuation effect is determined by the attenuation parameter in setPlayerAttenuation or setRemoteAudioAttenuation. If you do not call setPlayerAttenuation or setRemoteAudioAttenuation, the default sound attenuation coefficient of the SDK is 0.5, which simulates the attenuation of the sound in the real environment.If the sound source and the receiver belong to two sound insulation areas, the receiver cannot hear the sound source.If this method is called multiple times, the last sound insulation area set takes effect.
152
+ *
153
+ * @param zones Sound insulation area settings. See SpatialAudioZone.
154
+ *
155
+ * @returns
156
+ * 0: Success.< 0: Failure.
157
+ */
158
+ abstract setZones(zones: SpatialAudioZone[], zoneCount: number): number;
159
+ /**
160
+ * Sets the sound attenuation properties of the media player.
161
+ *
162
+ * @param playerId The ID of the media player.
163
+ * @param attenuation The sound attenuation coefficient of the remote user or media player. The value range is [0,1]. The values are as follows:0: Broadcast mode, where the volume and timbre are not attenuated with distance, and the volume and timbre heard by local users do not change regardless of distance.(0,0.5): Weak attenuation mode, that is, the volume and timbre are only weakly attenuated during the propagation process, and the sound can travel farther than the real environment.0.5: (Default) simulates the attenuation of the volume in the real environment; the effect is equivalent to not setting the speaker_attenuation parameter.(0.5,1]: Strong attenuation mode, that is, the volume and timbre attenuate rapidly during the propagation process.
164
+ * @param forceSet Whether to force the sound attenuation effect of the media player:true: Force attenuation to set the attenuation of the media player. At this time, the attenuation coefficient of the sound insulation are set in the audioAttenuation in the SpatialAudioZone does not take effect for the media player.false: Do not force attenuation to set the sound attenuation effect of the media player, as shown in the following two cases.If the sound source and listener are inside and outside the sound isolation area, the sound attenuation effect is determined by the audioAttenuation in SpatialAudioZone.If the sound source and the listener are in the same sound insulation area or outside the same sound insulation area, the sound attenuation effect is determined by attenuation in this method.
165
+ *
166
+ * @returns
167
+ * 0: Success.< 0: Failure.
168
+ */
169
+ abstract setPlayerAttenuation(playerId: number, attenuation: number, forceSet: boolean): number;
170
+ /**
171
+ * Stops or resumes subscribing to the audio stream of a specified user.
172
+ * Call this method after joinChannel .When using the spatial audio effect, if you need to set whether to stop subscribing to the audio stream of a specified user, Agora recommends calling this method instead of the muteRemoteAudioStream method in IRtcEngine .
173
+ *
174
+ * @param uid The user ID. This parameter must be the same as the user ID passed in when the user joined the channel.
175
+ * @param mute Whether to subscribe to the specified remote user's audio stream.true: Stop subscribing to the audio stream of the specified user.false: (Default) Subscribe to the audio stream of the specified user. The SDK decides whether to subscribe according to the distance between the local user and the remote user.
176
+ *
177
+ * @returns
178
+ * 0: Success.< 0: Failure.
179
+ */
180
+ abstract muteRemoteAudioStream(uid: number, mute: boolean): number;
181
+ }
182
+ /**
183
+ * This class calculates user positions through the SDK to implement the spatial audio effect.
184
+ * This class inherits from IBaseSpatialAudioEngine . Before calling other APIs in this class, you need to call the initialize method to initialize this class.
185
+ */
186
+ export declare abstract class ILocalSpatialAudioEngine extends IBaseSpatialAudioEngine {
187
+ /**
188
+ * Initializes ILocalSpatialAudioEngine .
189
+ * Before calling other methods of the ILocalSpatialAudioEngine class, you need to call this method to initialize ILocalSpatialAudioEngine.The SDK supports creating only one ILocalSpatialAudioEngine instance for an app.
190
+ *
191
+ * @returns
192
+ * 0: Success.< 0: Failure.
193
+ */
194
+ abstract initialize(): number;
195
+ /**
196
+ * Updates the spatial position of the specified remote user.
197
+ * After successfully calling this method, the SDK calculates the spatial audio parameters based on the relative position of the local and remote user.Call this method after joinChannel .
198
+ *
199
+ * @param uid The user ID. This parameter must be the same as the user ID passed in when the user joined the channel.
200
+ * @param posInfo The spatial position of the remote user. See RemoteVoicePositionInfo .
201
+ *
202
+ * @returns
203
+ * 0: Success.< 0: Failure.
204
+ */
205
+ abstract updateRemotePosition(uid: number, posInfo: RemoteVoicePositionInfo): number;
206
+ /**
207
+ * @ignore
208
+ */
209
+ abstract updateRemotePositionEx(uid: number, posInfo: RemoteVoicePositionInfo, connection: RtcConnection): number;
210
+ /**
211
+ * Removes the spatial position of the specified remote user.
212
+ * After successfully calling this method, the local user no longer hears the specified remote user.After leaving the channel, to avoid wasting resources, you can also call this method to delete the spatial position of the specified remote user.
213
+ *
214
+ * @param uid The user ID. This parameter must be the same as the user ID passed in when the user joined the channel.
215
+ *
216
+ * @returns
217
+ * 0: Success.< 0: Failure.
218
+ */
219
+ abstract removeRemotePosition(uid: number): number;
220
+ /**
221
+ * Occurs when the most active remote speaker is detected.
222
+ * After a successful call of enableAudioVolumeIndication , the SDK continuously detects which remote user has the loudest volume. During the current period, the remote user, who is detected as the loudest for the most times, is the most active user.When the number of users is no less than two and an active remote speaker exists, the SDK triggers this callback and reports the uid of the most active remote speaker.If the most active remote speaker is always the same user, the SDK triggers the onActiveSpeaker callback only once.If the most active remote speaker changes to another user, the SDK triggers this callback again and reports the uid of the new active remote speaker.
223
+ *
224
+ * @param uid The user ID of the most active remote speaker.
225
+ * @param connection The connection information. See RtcConnection .
226
+ */
227
+ abstract removeRemotePositionEx(uid: number, connection: RtcConnection): number;
228
+ /**
229
+ * Removes the spatial positions of all remote users.
230
+ * After successfully calling this method, the local user no longer hears any remote users.After leaving the channel, to avoid wasting resources, you can also call this method to delete the spatial positions of all remote users.
231
+ *
232
+ * @returns
233
+ * 0: Success.< 0: Failure.
234
+ */
235
+ abstract clearRemotePositions(): number;
236
+ /**
237
+ * Stops recording the local audio and video.
238
+ * After calling startRecording , if you want to stop the recording, you must call this method; otherwise, the generated recording files may not be playable.
239
+ *
240
+ * @param connection The connection information. See RtcConnection .
241
+ *
242
+ * @returns
243
+ * 0: Success.< 0: Failure.-7: The method is called before IRtcEngine is initialized.
244
+ */
245
+ abstract clearRemotePositionsEx(connection: RtcConnection): number;
246
+ /**
247
+ * Sets the sound attenuation effect for the specified user.
248
+ *
249
+ * @param uid The user ID. This parameter must be the same as the user ID passed in when the user joined the channel.
250
+ * @param attenuation For the user's sound attenuation coefficient, the value range is [0,1]. The values are as follows:
251
+ * 0: Broadcast mode, where the volume and timbre are not attenuated with distance, and the volume and timbre heard by local users do not change regardless of distance.
252
+ * (0,0.5): Weak attenuation mode, that is, the volume and timbre are only weakly attenuated during the propagation process, and the sound can travel farther than the real environment.
253
+ * 0.5: (Default) simulates the attenuation of the volume in the real environment; the effect is equivalent to not setting the speaker_attenuation parameter.
254
+ * (0.5,1]: Strong attenuation mode, that is, the volume and timbre attenuate rapidly during the propagation process.
255
+ *
256
+ * @param forceSet Whether to force the user's sound attenuation effect:true: Force attenuation to set the sound attenuation of the user. At this time, the attenuation coefficient of the sound insulation area set in the audioAttenuation of the SpatialAudioZone does not take effect for the user.
257
+ * If the sound source and listener are inside and outside the sound isolation area, the sound attenuation effect is determined by the audioAttenuation in SpatialAudioZone.
258
+ * If the sound source and the listener are in the same sound insulation area or outside the same sound insulation area, the sound attenuation effect is determined by attenuation in this method.
259
+ * false: Do not force attenuation to set the user's sound attenuation effect, as shown in the following two cases.
260
+ *
261
+ * @returns
262
+ * 0: Success.< 0: Failure.
263
+ */
264
+ abstract setRemoteAudioAttenuation(uid: number, attenuation: number, forceSet: boolean): number;
265
+ }
266
+ //# sourceMappingURL=IAgoraSpatialAudio.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"IAgoraSpatialAudio.d.ts","sourceRoot":"","sources":["../../ts/Private/IAgoraSpatialAudio.ts"],"names":[],"mappings":"AAAA,OAAO,yCAAyC,CAAC;AACjD,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEpD;;GAEG;AACH,qBAAa,uBAAuB;IAClC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;CACpB;AAED;;GAEG;AACH,qBAAa,gBAAgB;IAC3B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC;IACd;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;;GAGG;AACH,8BAAsB,uBAAuB;IAC3C;;;OAGG;IACH,QAAQ,CAAC,OAAO,IAAI,IAAI;IAExB;;;;;;;;OAQG;IACH,QAAQ,CAAC,oBAAoB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IAEvD;;;;;;;;OAQG;IACH,QAAQ,CAAC,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IAEjD;;;;;;;;OAQG;IACH,QAAQ,CAAC,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAE9C;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,kBAAkB,CACzB,QAAQ,EAAE,MAAM,EAAE,EAClB,WAAW,EAAE,MAAM,EAAE,EACrB,SAAS,EAAE,MAAM,EAAE,EACnB,MAAM,EAAE,MAAM,EAAE,GACf,MAAM;IAET;;OAEG;IACH,QAAQ,CAAC,oBAAoB,CAC3B,QAAQ,EAAE,MAAM,EAAE,EAClB,WAAW,EAAE,MAAM,EAAE,EACrB,SAAS,EAAE,MAAM,EAAE,EACnB,MAAM,EAAE,MAAM,EAAE,EAChB,UAAU,EAAE,aAAa,GACxB,MAAM;IAET;;;;;;;;;OASG;IACH,QAAQ,CAAC,wBAAwB,CAC/B,QAAQ,EAAE,MAAM,EAChB,YAAY,EAAE,uBAAuB,GACpC,MAAM;IAET;;OAEG;IACH,QAAQ,CAAC,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM;IAE9C;;;;;;;;OAQG;IACH,QAAQ,CAAC,oBAAoB,CAAC,IAAI,EAAE,OAAO,GAAG,MAAM;IAEpD;;;;;;;;OAQG;IACH,QAAQ,CAAC,yBAAyB,CAAC,IAAI,EAAE,OAAO,GAAG,MAAM;IAEzD;;;;;;;;OAQG;IACH,QAAQ,CAAC,QAAQ,CAAC,KAAK,EAAE,gBAAgB,EAAE,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM;IAEvE;;;;;;;;;OASG;IACH,QAAQ,CAAC,oBAAoB,CAC3B,QAAQ,EAAE,MAAM,EAChB,WAAW,EAAE,MAAM,EACnB,QAAQ,EAAE,OAAO,GAChB,MAAM;IAET;;;;;;;;;OASG;IACH,QAAQ,CAAC,qBAAqB,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,GAAG,MAAM;CACnE;AAED;;;GAGG;AACH,8BAAsB,wBAAyB,SAAQ,uBAAuB;IAC5E;;;;;;OAMG;IACH,QAAQ,CAAC,UAAU,IAAI,MAAM;IAE7B;;;;;;;;;OASG;IACH,QAAQ,CAAC,oBAAoB,CAC3B,GAAG,EAAE,MAAM,EACX,OAAO,EAAE,uBAAuB,GAC/B,MAAM;IAET;;OAEG;IACH,QAAQ,CAAC,sBAAsB,CAC7B,GAAG,EAAE,MAAM,EACX,OAAO,EAAE,uBAAuB,EAChC,UAAU,EAAE,aAAa,GACxB,MAAM;IAET;;;;;;;;OAQG;IACH,QAAQ,CAAC,oBAAoB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM;IAElD;;;;;;OAMG;IACH,QAAQ,CAAC,sBAAsB,CAC7B,GAAG,EAAE,MAAM,EACX,UAAU,EAAE,aAAa,GACxB,MAAM;IAET;;;;;;OAMG;IACH,QAAQ,CAAC,oBAAoB,IAAI,MAAM;IAEvC;;;;;;;;OAQG;IACH,QAAQ,CAAC,sBAAsB,CAAC,UAAU,EAAE,aAAa,GAAG,MAAM;IAElE;;;;;;;;;;;;;;;;;OAiBG;IACH,QAAQ,CAAC,yBAAyB,CAChC,GAAG,EAAE,MAAM,EACX,WAAW,EAAE,MAAM,EACnB,QAAQ,EAAE,OAAO,GAChB,MAAM;CACV"}