agora-electron-sdk 4.5.2 → 4.5.3-dev.2

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 (411) hide show
  1. package/CHANGELOG.md +39 -0
  2. package/README.md +6 -3
  3. package/js/example/src/renderer/examples/advanced/VideoEffect/videoEffectHelpers.js +395 -0
  4. package/js/{AgoraSdk.js → ts/AgoraSdk.js} +2 -12
  5. package/js/{Decoder → ts/Decoder}/index.js +1 -1
  6. package/js/{Private → ts/Private}/AgoraBase.js +829 -674
  7. package/js/{Private → ts/Private}/AgoraMediaBase.js +154 -151
  8. package/js/{Private → ts/Private}/AgoraMediaPlayerTypes.js +58 -54
  9. package/js/{Private → ts/Private}/IAgoraLog.js +13 -13
  10. package/js/{Private → ts/Private}/IAgoraMediaEngine.js +4 -4
  11. package/js/{Private → ts/Private}/IAgoraMediaPlayer.js +2 -2
  12. package/js/{Private → ts/Private}/IAgoraMusicContentCenter.js +1 -1
  13. package/js/{Private → ts/Private}/IAgoraRhythmPlayer.js +13 -13
  14. package/js/{Private → ts/Private}/IAgoraRtcEngine.js +150 -94
  15. package/js/{Private → ts/Private}/IAgoraRtcEngineEx.js +3 -3
  16. package/js/{Private → ts/Private}/IAgoraSpatialAudio.js +4 -4
  17. package/js/{Private → ts/Private}/IAudioDeviceManager.js +2 -2
  18. package/js/{Private → ts/Private}/impl/IAgoraMediaPlayerImpl.js +10 -0
  19. package/js/{Private → ts/Private}/impl/IAgoraRtcEngineExImpl.js +74 -0
  20. package/js/{Private → ts/Private}/impl/IAgoraRtcEngineImpl.js +233 -1
  21. package/js/{Private → ts/Private}/internal/IrisApiEngine.js +45 -0
  22. package/js/{Private → ts/Private}/internal/RtcEngineExInternal.js +74 -4
  23. package/js/ts/Private/internal/VideoEffectObjectInternal.js +14 -0
  24. package/js/{Private → ts/Private}/ti/IAgoraRtcEngine-ti.js +2 -0
  25. package/js/{Renderer → ts/Renderer}/AgoraView.js +19 -2
  26. package/js/{Renderer → ts/Renderer}/IRenderer.js +7 -4
  27. package/js/{Renderer → ts/Renderer}/IRendererCache.js +17 -1
  28. package/js/ts/Renderer/RendererCache.js +252 -0
  29. package/js/{Renderer → ts/Renderer}/RendererManager.js +13 -64
  30. package/js/{Renderer → ts/Renderer}/WebCodecsRenderer/index.js +5 -5
  31. package/js/{Renderer → ts/Renderer}/WebCodecsRendererCache.js +13 -1
  32. package/js/{Renderer → ts/Renderer}/WebGLRenderer/index.js +179 -26
  33. package/js/{Renderer → ts/Renderer}/YUVCanvasRenderer/index.js +12 -5
  34. package/js/{Utils.js → ts/Utils.js} +7 -7
  35. package/package.json +25 -12
  36. package/scripts/checkElectron.js +4 -2
  37. package/scripts/download.js +102 -0
  38. package/scripts/downloadPrebuild.js +2 -1
  39. package/scripts/synclib.js +2 -2
  40. package/ts/AgoraSdk.ts +2 -12
  41. package/ts/Decoder/index.ts +5 -1
  42. package/ts/Private/AgoraBase.ts +1259 -1060
  43. package/ts/Private/AgoraMediaBase.ts +351 -324
  44. package/ts/Private/AgoraMediaPlayerTypes.ts +94 -91
  45. package/ts/Private/IAgoraLog.ts +20 -18
  46. package/ts/Private/IAgoraMediaEngine.ts +86 -81
  47. package/ts/Private/IAgoraMediaPlayer.ts +196 -181
  48. package/ts/Private/IAgoraMediaPlayerSource.ts +40 -40
  49. package/ts/Private/IAgoraMusicContentCenter.ts +3 -3
  50. package/ts/Private/IAgoraRhythmPlayer.ts +15 -15
  51. package/ts/Private/IAgoraRtcEngine.ts +2492 -2047
  52. package/ts/Private/IAgoraRtcEngineEx.ts +434 -335
  53. package/ts/Private/IAgoraSpatialAudio.ts +43 -45
  54. package/ts/Private/IAudioDeviceManager.ts +106 -97
  55. package/ts/Private/impl/IAgoraMediaPlayerImpl.ts +12 -0
  56. package/ts/Private/impl/IAgoraRtcEngineExImpl.ts +138 -0
  57. package/ts/Private/impl/IAgoraRtcEngineImpl.ts +331 -0
  58. package/ts/Private/internal/IrisApiEngine.ts +47 -0
  59. package/ts/Private/internal/RtcEngineExInternal.ts +106 -9
  60. package/ts/Private/internal/VideoEffectObjectInternal.ts +14 -0
  61. package/ts/Private/ti/IAgoraRtcEngine-ti.ts +2 -0
  62. package/ts/Renderer/AgoraView.ts +32 -3
  63. package/ts/Renderer/IRenderer.ts +8 -3
  64. package/ts/Renderer/IRendererCache.ts +33 -0
  65. package/ts/Renderer/RendererCache.ts +211 -12
  66. package/ts/Renderer/RendererManager.ts +21 -99
  67. package/ts/Renderer/WebCodecsRenderer/index.ts +9 -6
  68. package/ts/Renderer/WebCodecsRendererCache.ts +17 -1
  69. package/ts/Renderer/WebGLRenderer/index.ts +246 -40
  70. package/ts/Renderer/YUVCanvasRenderer/index.ts +29 -16
  71. package/ts/Types.ts +14 -9
  72. package/ts/Utils.ts +8 -7
  73. package/types/example/src/renderer/examples/advanced/VideoEffect/videoEffectHelpers.d.ts +168 -0
  74. package/types/example/src/renderer/examples/advanced/VideoEffect/videoEffectHelpers.d.ts.map +1 -0
  75. package/types/{AgoraSdk.d.ts → ts/AgoraSdk.d.ts} +2 -12
  76. package/types/ts/AgoraSdk.d.ts.map +1 -0
  77. package/types/ts/Decoder/gpu-utils.d.ts.map +1 -0
  78. package/types/ts/Decoder/index.d.ts.map +1 -0
  79. package/types/ts/Private/AgoraBase.d.ts +5504 -0
  80. package/types/ts/Private/AgoraBase.d.ts.map +1 -0
  81. package/types/ts/Private/AgoraMediaBase.d.ts +1695 -0
  82. package/types/ts/Private/AgoraMediaBase.d.ts.map +1 -0
  83. package/types/ts/Private/AgoraMediaPlayerTypes.d.ts +456 -0
  84. package/types/ts/Private/AgoraMediaPlayerTypes.d.ts.map +1 -0
  85. package/types/ts/Private/IAgoraH265Transcoder.d.ts.map +1 -0
  86. package/types/ts/Private/IAgoraLog.d.ts +91 -0
  87. package/types/ts/Private/IAgoraLog.d.ts.map +1 -0
  88. package/types/ts/Private/IAgoraMediaEngine.d.ts +255 -0
  89. package/types/ts/Private/IAgoraMediaEngine.d.ts.map +1 -0
  90. package/types/ts/Private/IAgoraMediaPlayer.d.ts +662 -0
  91. package/types/ts/Private/IAgoraMediaPlayer.d.ts.map +1 -0
  92. package/types/ts/Private/IAgoraMediaPlayerSource.d.ts +109 -0
  93. package/types/ts/Private/IAgoraMediaPlayerSource.d.ts.map +1 -0
  94. package/types/ts/Private/IAgoraMediaRecorder.d.ts.map +1 -0
  95. package/types/ts/Private/IAgoraMediaStreamingSource.d.ts.map +1 -0
  96. package/types/{Private → ts/Private}/IAgoraMusicContentCenter.d.ts +3 -3
  97. package/types/ts/Private/IAgoraMusicContentCenter.d.ts.map +1 -0
  98. package/types/ts/Private/IAgoraRhythmPlayer.d.ts +65 -0
  99. package/types/ts/Private/IAgoraRhythmPlayer.d.ts.map +1 -0
  100. package/types/ts/Private/IAgoraRtcEngine.d.ts +6504 -0
  101. package/types/ts/Private/IAgoraRtcEngine.d.ts.map +1 -0
  102. package/types/ts/Private/IAgoraRtcEngineEx.d.ts +817 -0
  103. package/types/ts/Private/IAgoraRtcEngineEx.d.ts.map +1 -0
  104. package/types/ts/Private/IAgoraSpatialAudio.d.ts +194 -0
  105. package/types/ts/Private/IAgoraSpatialAudio.d.ts.map +1 -0
  106. package/types/ts/Private/IAudioDeviceManager.d.ts +321 -0
  107. package/types/ts/Private/IAudioDeviceManager.d.ts.map +1 -0
  108. package/types/ts/Private/extension/AgoraBaseExtension.d.ts.map +1 -0
  109. package/types/ts/Private/extension/AgoraMediaBaseExtension.d.ts.map +1 -0
  110. package/types/ts/Private/extension/AgoraMediaPlayerTypesExtension.d.ts.map +1 -0
  111. package/types/ts/Private/extension/IAgoraH265TranscoderExtension.d.ts.map +1 -0
  112. package/types/ts/Private/extension/IAgoraLogExtension.d.ts.map +1 -0
  113. package/types/ts/Private/extension/IAgoraMediaEngineExtension.d.ts.map +1 -0
  114. package/types/ts/Private/extension/IAgoraMediaPlayerExtension.d.ts.map +1 -0
  115. package/types/ts/Private/extension/IAgoraMediaPlayerSourceExtension.d.ts.map +1 -0
  116. package/types/ts/Private/extension/IAgoraMediaRecorderExtension.d.ts.map +1 -0
  117. package/types/ts/Private/extension/IAgoraMusicContentCenterExtension.d.ts.map +1 -0
  118. package/types/ts/Private/extension/IAgoraRhythmPlayerExtension.d.ts.map +1 -0
  119. package/types/ts/Private/extension/IAgoraRtcEngineExExtension.d.ts.map +1 -0
  120. package/types/ts/Private/extension/IAgoraRtcEngineExtension.d.ts.map +1 -0
  121. package/types/ts/Private/extension/IAgoraSpatialAudioExtension.d.ts.map +1 -0
  122. package/types/ts/Private/extension/IAudioDeviceManagerExtension.d.ts.map +1 -0
  123. package/types/ts/Private/impl/AgoraBaseImpl.d.ts.map +1 -0
  124. package/types/ts/Private/impl/AgoraMediaBaseImpl.d.ts.map +1 -0
  125. package/types/ts/Private/impl/IAgoraH265TranscoderImpl.d.ts.map +1 -0
  126. package/types/ts/Private/impl/IAgoraMediaEngineImpl.d.ts.map +1 -0
  127. package/types/{Private → ts/Private}/impl/IAgoraMediaPlayerImpl.d.ts +2 -0
  128. package/types/ts/Private/impl/IAgoraMediaPlayerImpl.d.ts.map +1 -0
  129. package/types/ts/Private/impl/IAgoraMediaPlayerSourceImpl.d.ts.map +1 -0
  130. package/types/ts/Private/impl/IAgoraMediaRecorderImpl.d.ts.map +1 -0
  131. package/types/ts/Private/impl/IAgoraMusicContentCenterImpl.d.ts.map +1 -0
  132. package/types/{Private → ts/Private}/impl/IAgoraRtcEngineExImpl.d.ts +7 -1
  133. package/types/ts/Private/impl/IAgoraRtcEngineExImpl.d.ts.map +1 -0
  134. package/types/{Private → ts/Private}/impl/IAgoraRtcEngineImpl.d.ts +27 -1
  135. package/types/ts/Private/impl/IAgoraRtcEngineImpl.d.ts.map +1 -0
  136. package/types/ts/Private/impl/IAgoraSpatialAudioImpl.d.ts.map +1 -0
  137. package/types/ts/Private/impl/IAudioDeviceManagerImpl.d.ts.map +1 -0
  138. package/types/ts/Private/internal/AgoraH265TranscoderInternal.d.ts.map +1 -0
  139. package/types/ts/Private/internal/AgoraMediaBaseInternal.d.ts.map +1 -0
  140. package/types/ts/Private/internal/AudioDeviceManagerInternal.d.ts.map +1 -0
  141. package/types/ts/Private/internal/IrisApiEngine.d.ts.map +1 -0
  142. package/types/ts/Private/internal/LocalSpatialAudioEngineInternal.d.ts.map +1 -0
  143. package/types/ts/Private/internal/MediaEngineInternal.d.ts.map +1 -0
  144. package/types/ts/Private/internal/MediaPlayerInternal.d.ts.map +1 -0
  145. package/types/ts/Private/internal/MediaRecorderInternal.d.ts.map +1 -0
  146. package/types/ts/Private/internal/MusicContentCenterInternal.d.ts.map +1 -0
  147. package/types/{Private → ts/Private}/internal/RtcEngineExInternal.d.ts +10 -4
  148. package/types/ts/Private/internal/RtcEngineExInternal.d.ts.map +1 -0
  149. package/types/ts/Private/internal/VideoEffectObjectInternal.d.ts +7 -0
  150. package/types/ts/Private/internal/VideoEffectObjectInternal.d.ts.map +1 -0
  151. package/types/{Private → ts/Private}/ipc/main.d.ts.map +1 -1
  152. package/types/ts/Private/ipc/renderer.d.ts.map +1 -0
  153. package/types/ts/Private/ti/AgoraBase-ti.d.ts.map +1 -0
  154. package/types/ts/Private/ti/AgoraMediaBase-ti.d.ts.map +1 -0
  155. package/types/ts/Private/ti/AgoraMediaPlayerTypes-ti.d.ts.map +1 -0
  156. package/types/ts/Private/ti/IAgoraH265Transcoder-ti.d.ts.map +1 -0
  157. package/types/ts/Private/ti/IAgoraLog-ti.d.ts.map +1 -0
  158. package/types/ts/Private/ti/IAgoraMediaEngine-ti.d.ts.map +1 -0
  159. package/types/ts/Private/ti/IAgoraMediaPlayer-ti.d.ts.map +1 -0
  160. package/types/ts/Private/ti/IAgoraMediaPlayerSource-ti.d.ts.map +1 -0
  161. package/types/ts/Private/ti/IAgoraMediaRecorder-ti.d.ts.map +1 -0
  162. package/types/ts/Private/ti/IAgoraMediaStreamingSource-ti.d.ts.map +1 -0
  163. package/types/ts/Private/ti/IAgoraMusicContentCenter-ti.d.ts.map +1 -0
  164. package/types/ts/Private/ti/IAgoraRhythmPlayer-ti.d.ts.map +1 -0
  165. package/types/ts/Private/ti/IAgoraRtcEngine-ti.d.ts.map +1 -0
  166. package/types/ts/Private/ti/IAgoraRtcEngineEx-ti.d.ts.map +1 -0
  167. package/types/ts/Private/ti/IAgoraSpatialAudio-ti.d.ts.map +1 -0
  168. package/types/ts/Private/ti/IAudioDeviceManager-ti.d.ts.map +1 -0
  169. package/types/{Renderer → ts/Renderer}/AgoraView.d.ts +6 -0
  170. package/types/ts/Renderer/AgoraView.d.ts.map +1 -0
  171. package/types/ts/Renderer/CapabilityManager.d.ts.map +1 -0
  172. package/types/{Renderer → ts/Renderer}/IRenderer.d.ts +2 -2
  173. package/types/ts/Renderer/IRenderer.d.ts.map +1 -0
  174. package/types/{Renderer → ts/Renderer}/IRendererCache.d.ts +21 -1
  175. package/types/ts/Renderer/IRendererCache.d.ts.map +1 -0
  176. package/types/{Renderer → ts/Renderer}/RendererCache.d.ts +27 -0
  177. package/types/ts/Renderer/RendererCache.d.ts.map +1 -0
  178. package/types/{Renderer → ts/Renderer}/RendererManager.d.ts +4 -17
  179. package/types/ts/Renderer/RendererManager.d.ts.map +1 -0
  180. package/types/{Renderer → ts/Renderer}/WebCodecsRenderer/index.d.ts +3 -3
  181. package/types/ts/Renderer/WebCodecsRenderer/index.d.ts.map +1 -0
  182. package/types/{Renderer → ts/Renderer}/WebCodecsRendererCache.d.ts +7 -0
  183. package/types/ts/Renderer/WebCodecsRendererCache.d.ts.map +1 -0
  184. package/types/{Renderer → ts/Renderer}/WebGLRenderer/index.d.ts +12 -2
  185. package/types/ts/Renderer/WebGLRenderer/index.d.ts.map +1 -0
  186. package/types/ts/Renderer/WebGLRenderer/webgl-utils.d.ts.map +1 -0
  187. package/types/ts/Renderer/YUVCanvasRenderer/index.d.ts +10 -0
  188. package/types/ts/Renderer/YUVCanvasRenderer/index.d.ts.map +1 -0
  189. package/types/ts/Renderer/index.d.ts.map +1 -0
  190. package/types/{Types.d.ts → ts/Types.d.ts} +11 -6
  191. package/types/ts/Types.d.ts.map +1 -0
  192. package/types/{Utils.d.ts → ts/Utils.d.ts} +1 -1
  193. package/types/ts/Utils.d.ts.map +1 -0
  194. package/js/Renderer/RendererCache.js +0 -100
  195. package/types/AgoraSdk.d.ts.map +0 -1
  196. package/types/Decoder/gpu-utils.d.ts.map +0 -1
  197. package/types/Decoder/index.d.ts.map +0 -1
  198. package/types/Private/AgoraBase.d.ts +0 -5310
  199. package/types/Private/AgoraBase.d.ts.map +0 -1
  200. package/types/Private/AgoraMediaBase.d.ts +0 -1668
  201. package/types/Private/AgoraMediaBase.d.ts.map +0 -1
  202. package/types/Private/AgoraMediaPlayerTypes.d.ts +0 -453
  203. package/types/Private/AgoraMediaPlayerTypes.d.ts.map +0 -1
  204. package/types/Private/IAgoraH265Transcoder.d.ts.map +0 -1
  205. package/types/Private/IAgoraLog.d.ts +0 -89
  206. package/types/Private/IAgoraLog.d.ts.map +0 -1
  207. package/types/Private/IAgoraMediaEngine.d.ts +0 -250
  208. package/types/Private/IAgoraMediaEngine.d.ts.map +0 -1
  209. package/types/Private/IAgoraMediaPlayer.d.ts +0 -648
  210. package/types/Private/IAgoraMediaPlayer.d.ts.map +0 -1
  211. package/types/Private/IAgoraMediaPlayerSource.d.ts +0 -109
  212. package/types/Private/IAgoraMediaPlayerSource.d.ts.map +0 -1
  213. package/types/Private/IAgoraMediaRecorder.d.ts.map +0 -1
  214. package/types/Private/IAgoraMediaStreamingSource.d.ts.map +0 -1
  215. package/types/Private/IAgoraMusicContentCenter.d.ts.map +0 -1
  216. package/types/Private/IAgoraRhythmPlayer.d.ts +0 -65
  217. package/types/Private/IAgoraRhythmPlayer.d.ts.map +0 -1
  218. package/types/Private/IAgoraRtcEngine.d.ts +0 -6103
  219. package/types/Private/IAgoraRtcEngine.d.ts.map +0 -1
  220. package/types/Private/IAgoraRtcEngineEx.d.ts +0 -741
  221. package/types/Private/IAgoraRtcEngineEx.d.ts.map +0 -1
  222. package/types/Private/IAgoraSpatialAudio.d.ts +0 -196
  223. package/types/Private/IAgoraSpatialAudio.d.ts.map +0 -1
  224. package/types/Private/IAudioDeviceManager.d.ts +0 -312
  225. package/types/Private/IAudioDeviceManager.d.ts.map +0 -1
  226. package/types/Private/extension/AgoraBaseExtension.d.ts.map +0 -1
  227. package/types/Private/extension/AgoraMediaBaseExtension.d.ts.map +0 -1
  228. package/types/Private/extension/AgoraMediaPlayerTypesExtension.d.ts.map +0 -1
  229. package/types/Private/extension/IAgoraH265TranscoderExtension.d.ts.map +0 -1
  230. package/types/Private/extension/IAgoraLogExtension.d.ts.map +0 -1
  231. package/types/Private/extension/IAgoraMediaEngineExtension.d.ts.map +0 -1
  232. package/types/Private/extension/IAgoraMediaPlayerExtension.d.ts.map +0 -1
  233. package/types/Private/extension/IAgoraMediaPlayerSourceExtension.d.ts.map +0 -1
  234. package/types/Private/extension/IAgoraMediaRecorderExtension.d.ts.map +0 -1
  235. package/types/Private/extension/IAgoraMusicContentCenterExtension.d.ts.map +0 -1
  236. package/types/Private/extension/IAgoraRhythmPlayerExtension.d.ts.map +0 -1
  237. package/types/Private/extension/IAgoraRtcEngineExExtension.d.ts.map +0 -1
  238. package/types/Private/extension/IAgoraRtcEngineExtension.d.ts.map +0 -1
  239. package/types/Private/extension/IAgoraSpatialAudioExtension.d.ts.map +0 -1
  240. package/types/Private/extension/IAudioDeviceManagerExtension.d.ts.map +0 -1
  241. package/types/Private/impl/AgoraBaseImpl.d.ts.map +0 -1
  242. package/types/Private/impl/AgoraMediaBaseImpl.d.ts.map +0 -1
  243. package/types/Private/impl/IAgoraH265TranscoderImpl.d.ts.map +0 -1
  244. package/types/Private/impl/IAgoraMediaEngineImpl.d.ts.map +0 -1
  245. package/types/Private/impl/IAgoraMediaPlayerImpl.d.ts.map +0 -1
  246. package/types/Private/impl/IAgoraMediaPlayerSourceImpl.d.ts.map +0 -1
  247. package/types/Private/impl/IAgoraMediaRecorderImpl.d.ts.map +0 -1
  248. package/types/Private/impl/IAgoraMusicContentCenterImpl.d.ts.map +0 -1
  249. package/types/Private/impl/IAgoraRtcEngineExImpl.d.ts.map +0 -1
  250. package/types/Private/impl/IAgoraRtcEngineImpl.d.ts.map +0 -1
  251. package/types/Private/impl/IAgoraSpatialAudioImpl.d.ts.map +0 -1
  252. package/types/Private/impl/IAudioDeviceManagerImpl.d.ts.map +0 -1
  253. package/types/Private/internal/AgoraH265TranscoderInternal.d.ts.map +0 -1
  254. package/types/Private/internal/AgoraMediaBaseInternal.d.ts.map +0 -1
  255. package/types/Private/internal/AudioDeviceManagerInternal.d.ts.map +0 -1
  256. package/types/Private/internal/IrisApiEngine.d.ts.map +0 -1
  257. package/types/Private/internal/LocalSpatialAudioEngineInternal.d.ts.map +0 -1
  258. package/types/Private/internal/MediaEngineInternal.d.ts.map +0 -1
  259. package/types/Private/internal/MediaPlayerInternal.d.ts.map +0 -1
  260. package/types/Private/internal/MediaRecorderInternal.d.ts.map +0 -1
  261. package/types/Private/internal/MusicContentCenterInternal.d.ts.map +0 -1
  262. package/types/Private/internal/RtcEngineExInternal.d.ts.map +0 -1
  263. package/types/Private/ipc/renderer.d.ts.map +0 -1
  264. package/types/Private/ti/AgoraBase-ti.d.ts.map +0 -1
  265. package/types/Private/ti/AgoraMediaBase-ti.d.ts.map +0 -1
  266. package/types/Private/ti/AgoraMediaPlayerTypes-ti.d.ts.map +0 -1
  267. package/types/Private/ti/IAgoraH265Transcoder-ti.d.ts.map +0 -1
  268. package/types/Private/ti/IAgoraLog-ti.d.ts.map +0 -1
  269. package/types/Private/ti/IAgoraMediaEngine-ti.d.ts.map +0 -1
  270. package/types/Private/ti/IAgoraMediaPlayer-ti.d.ts.map +0 -1
  271. package/types/Private/ti/IAgoraMediaPlayerSource-ti.d.ts.map +0 -1
  272. package/types/Private/ti/IAgoraMediaRecorder-ti.d.ts.map +0 -1
  273. package/types/Private/ti/IAgoraMediaStreamingSource-ti.d.ts.map +0 -1
  274. package/types/Private/ti/IAgoraMusicContentCenter-ti.d.ts.map +0 -1
  275. package/types/Private/ti/IAgoraRhythmPlayer-ti.d.ts.map +0 -1
  276. package/types/Private/ti/IAgoraRtcEngine-ti.d.ts.map +0 -1
  277. package/types/Private/ti/IAgoraRtcEngineEx-ti.d.ts.map +0 -1
  278. package/types/Private/ti/IAgoraSpatialAudio-ti.d.ts.map +0 -1
  279. package/types/Private/ti/IAudioDeviceManager-ti.d.ts.map +0 -1
  280. package/types/Renderer/AgoraView.d.ts.map +0 -1
  281. package/types/Renderer/CapabilityManager.d.ts.map +0 -1
  282. package/types/Renderer/IRenderer.d.ts.map +0 -1
  283. package/types/Renderer/IRendererCache.d.ts.map +0 -1
  284. package/types/Renderer/RendererCache.d.ts.map +0 -1
  285. package/types/Renderer/RendererManager.d.ts.map +0 -1
  286. package/types/Renderer/WebCodecsRenderer/index.d.ts.map +0 -1
  287. package/types/Renderer/WebCodecsRendererCache.d.ts.map +0 -1
  288. package/types/Renderer/WebGLRenderer/index.d.ts.map +0 -1
  289. package/types/Renderer/WebGLRenderer/webgl-utils.d.ts.map +0 -1
  290. package/types/Renderer/YUVCanvasRenderer/index.d.ts +0 -9
  291. package/types/Renderer/YUVCanvasRenderer/index.d.ts.map +0 -1
  292. package/types/Renderer/index.d.ts.map +0 -1
  293. package/types/Types.d.ts.map +0 -1
  294. package/types/Utils.d.ts.map +0 -1
  295. /package/js/{Decoder → ts/Decoder}/gpu-utils.js +0 -0
  296. /package/js/{Private → ts/Private}/IAgoraH265Transcoder.js +0 -0
  297. /package/js/{Private → ts/Private}/IAgoraMediaPlayerSource.js +0 -0
  298. /package/js/{Private → ts/Private}/IAgoraMediaRecorder.js +0 -0
  299. /package/js/{Private → ts/Private}/IAgoraMediaStreamingSource.js +0 -0
  300. /package/js/{Private → ts/Private}/extension/AgoraBaseExtension.js +0 -0
  301. /package/js/{Private → ts/Private}/extension/AgoraMediaBaseExtension.js +0 -0
  302. /package/js/{Private → ts/Private}/extension/AgoraMediaPlayerTypesExtension.js +0 -0
  303. /package/js/{Private → ts/Private}/extension/IAgoraH265TranscoderExtension.js +0 -0
  304. /package/js/{Private → ts/Private}/extension/IAgoraLogExtension.js +0 -0
  305. /package/js/{Private → ts/Private}/extension/IAgoraMediaEngineExtension.js +0 -0
  306. /package/js/{Private → ts/Private}/extension/IAgoraMediaPlayerExtension.js +0 -0
  307. /package/js/{Private → ts/Private}/extension/IAgoraMediaPlayerSourceExtension.js +0 -0
  308. /package/js/{Private → ts/Private}/extension/IAgoraMediaRecorderExtension.js +0 -0
  309. /package/js/{Private → ts/Private}/extension/IAgoraMusicContentCenterExtension.js +0 -0
  310. /package/js/{Private → ts/Private}/extension/IAgoraRhythmPlayerExtension.js +0 -0
  311. /package/js/{Private → ts/Private}/extension/IAgoraRtcEngineExExtension.js +0 -0
  312. /package/js/{Private → ts/Private}/extension/IAgoraRtcEngineExtension.js +0 -0
  313. /package/js/{Private → ts/Private}/extension/IAgoraSpatialAudioExtension.js +0 -0
  314. /package/js/{Private → ts/Private}/extension/IAudioDeviceManagerExtension.js +0 -0
  315. /package/js/{Private → ts/Private}/impl/AgoraBaseImpl.js +0 -0
  316. /package/js/{Private → ts/Private}/impl/AgoraMediaBaseImpl.js +0 -0
  317. /package/js/{Private → ts/Private}/impl/IAgoraH265TranscoderImpl.js +0 -0
  318. /package/js/{Private → ts/Private}/impl/IAgoraMediaEngineImpl.js +0 -0
  319. /package/js/{Private → ts/Private}/impl/IAgoraMediaPlayerSourceImpl.js +0 -0
  320. /package/js/{Private → ts/Private}/impl/IAgoraMediaRecorderImpl.js +0 -0
  321. /package/js/{Private → ts/Private}/impl/IAgoraMusicContentCenterImpl.js +0 -0
  322. /package/js/{Private → ts/Private}/impl/IAgoraSpatialAudioImpl.js +0 -0
  323. /package/js/{Private → ts/Private}/impl/IAudioDeviceManagerImpl.js +0 -0
  324. /package/js/{Private → ts/Private}/internal/AgoraH265TranscoderInternal.js +0 -0
  325. /package/js/{Private → ts/Private}/internal/AgoraMediaBaseInternal.js +0 -0
  326. /package/js/{Private → ts/Private}/internal/AudioDeviceManagerInternal.js +0 -0
  327. /package/js/{Private → ts/Private}/internal/LocalSpatialAudioEngineInternal.js +0 -0
  328. /package/js/{Private → ts/Private}/internal/MediaEngineInternal.js +0 -0
  329. /package/js/{Private → ts/Private}/internal/MediaPlayerInternal.js +0 -0
  330. /package/js/{Private → ts/Private}/internal/MediaRecorderInternal.js +0 -0
  331. /package/js/{Private → ts/Private}/internal/MusicContentCenterInternal.js +0 -0
  332. /package/js/{Private → ts/Private}/ipc/main.js +0 -0
  333. /package/js/{Private → ts/Private}/ipc/renderer.js +0 -0
  334. /package/js/{Private → ts/Private}/ti/AgoraBase-ti.js +0 -0
  335. /package/js/{Private → ts/Private}/ti/AgoraMediaBase-ti.js +0 -0
  336. /package/js/{Private → ts/Private}/ti/AgoraMediaPlayerTypes-ti.js +0 -0
  337. /package/js/{Private → ts/Private}/ti/IAgoraH265Transcoder-ti.js +0 -0
  338. /package/js/{Private → ts/Private}/ti/IAgoraLog-ti.js +0 -0
  339. /package/js/{Private → ts/Private}/ti/IAgoraMediaEngine-ti.js +0 -0
  340. /package/js/{Private → ts/Private}/ti/IAgoraMediaPlayer-ti.js +0 -0
  341. /package/js/{Private → ts/Private}/ti/IAgoraMediaPlayerSource-ti.js +0 -0
  342. /package/js/{Private → ts/Private}/ti/IAgoraMediaRecorder-ti.js +0 -0
  343. /package/js/{Private → ts/Private}/ti/IAgoraMediaStreamingSource-ti.js +0 -0
  344. /package/js/{Private → ts/Private}/ti/IAgoraMusicContentCenter-ti.js +0 -0
  345. /package/js/{Private → ts/Private}/ti/IAgoraRhythmPlayer-ti.js +0 -0
  346. /package/js/{Private → ts/Private}/ti/IAgoraRtcEngineEx-ti.js +0 -0
  347. /package/js/{Private → ts/Private}/ti/IAgoraSpatialAudio-ti.js +0 -0
  348. /package/js/{Private → ts/Private}/ti/IAudioDeviceManager-ti.js +0 -0
  349. /package/js/{Renderer → ts/Renderer}/CapabilityManager.js +0 -0
  350. /package/js/{Renderer → ts/Renderer}/WebGLRenderer/webgl-utils.js +0 -0
  351. /package/js/{Renderer → ts/Renderer}/index.js +0 -0
  352. /package/js/{Types.js → ts/Types.js} +0 -0
  353. /package/types/{Decoder → ts/Decoder}/gpu-utils.d.ts +0 -0
  354. /package/types/{Decoder → ts/Decoder}/index.d.ts +0 -0
  355. /package/types/{Private → ts/Private}/IAgoraH265Transcoder.d.ts +0 -0
  356. /package/types/{Private → ts/Private}/IAgoraMediaRecorder.d.ts +0 -0
  357. /package/types/{Private → ts/Private}/IAgoraMediaStreamingSource.d.ts +0 -0
  358. /package/types/{Private → ts/Private}/extension/AgoraBaseExtension.d.ts +0 -0
  359. /package/types/{Private → ts/Private}/extension/AgoraMediaBaseExtension.d.ts +0 -0
  360. /package/types/{Private → ts/Private}/extension/AgoraMediaPlayerTypesExtension.d.ts +0 -0
  361. /package/types/{Private → ts/Private}/extension/IAgoraH265TranscoderExtension.d.ts +0 -0
  362. /package/types/{Private → ts/Private}/extension/IAgoraLogExtension.d.ts +0 -0
  363. /package/types/{Private → ts/Private}/extension/IAgoraMediaEngineExtension.d.ts +0 -0
  364. /package/types/{Private → ts/Private}/extension/IAgoraMediaPlayerExtension.d.ts +0 -0
  365. /package/types/{Private → ts/Private}/extension/IAgoraMediaPlayerSourceExtension.d.ts +0 -0
  366. /package/types/{Private → ts/Private}/extension/IAgoraMediaRecorderExtension.d.ts +0 -0
  367. /package/types/{Private → ts/Private}/extension/IAgoraMusicContentCenterExtension.d.ts +0 -0
  368. /package/types/{Private → ts/Private}/extension/IAgoraRhythmPlayerExtension.d.ts +0 -0
  369. /package/types/{Private → ts/Private}/extension/IAgoraRtcEngineExExtension.d.ts +0 -0
  370. /package/types/{Private → ts/Private}/extension/IAgoraRtcEngineExtension.d.ts +0 -0
  371. /package/types/{Private → ts/Private}/extension/IAgoraSpatialAudioExtension.d.ts +0 -0
  372. /package/types/{Private → ts/Private}/extension/IAudioDeviceManagerExtension.d.ts +0 -0
  373. /package/types/{Private → ts/Private}/impl/AgoraBaseImpl.d.ts +0 -0
  374. /package/types/{Private → ts/Private}/impl/AgoraMediaBaseImpl.d.ts +0 -0
  375. /package/types/{Private → ts/Private}/impl/IAgoraH265TranscoderImpl.d.ts +0 -0
  376. /package/types/{Private → ts/Private}/impl/IAgoraMediaEngineImpl.d.ts +0 -0
  377. /package/types/{Private → ts/Private}/impl/IAgoraMediaPlayerSourceImpl.d.ts +0 -0
  378. /package/types/{Private → ts/Private}/impl/IAgoraMediaRecorderImpl.d.ts +0 -0
  379. /package/types/{Private → ts/Private}/impl/IAgoraMusicContentCenterImpl.d.ts +0 -0
  380. /package/types/{Private → ts/Private}/impl/IAgoraSpatialAudioImpl.d.ts +0 -0
  381. /package/types/{Private → ts/Private}/impl/IAudioDeviceManagerImpl.d.ts +0 -0
  382. /package/types/{Private → ts/Private}/internal/AgoraH265TranscoderInternal.d.ts +0 -0
  383. /package/types/{Private → ts/Private}/internal/AgoraMediaBaseInternal.d.ts +0 -0
  384. /package/types/{Private → ts/Private}/internal/AudioDeviceManagerInternal.d.ts +0 -0
  385. /package/types/{Private → ts/Private}/internal/IrisApiEngine.d.ts +0 -0
  386. /package/types/{Private → ts/Private}/internal/LocalSpatialAudioEngineInternal.d.ts +0 -0
  387. /package/types/{Private → ts/Private}/internal/MediaEngineInternal.d.ts +0 -0
  388. /package/types/{Private → ts/Private}/internal/MediaPlayerInternal.d.ts +0 -0
  389. /package/types/{Private → ts/Private}/internal/MediaRecorderInternal.d.ts +0 -0
  390. /package/types/{Private → ts/Private}/internal/MusicContentCenterInternal.d.ts +0 -0
  391. /package/types/{Private → ts/Private}/ipc/main.d.ts +0 -0
  392. /package/types/{Private → ts/Private}/ipc/renderer.d.ts +0 -0
  393. /package/types/{Private → ts/Private}/ti/AgoraBase-ti.d.ts +0 -0
  394. /package/types/{Private → ts/Private}/ti/AgoraMediaBase-ti.d.ts +0 -0
  395. /package/types/{Private → ts/Private}/ti/AgoraMediaPlayerTypes-ti.d.ts +0 -0
  396. /package/types/{Private → ts/Private}/ti/IAgoraH265Transcoder-ti.d.ts +0 -0
  397. /package/types/{Private → ts/Private}/ti/IAgoraLog-ti.d.ts +0 -0
  398. /package/types/{Private → ts/Private}/ti/IAgoraMediaEngine-ti.d.ts +0 -0
  399. /package/types/{Private → ts/Private}/ti/IAgoraMediaPlayer-ti.d.ts +0 -0
  400. /package/types/{Private → ts/Private}/ti/IAgoraMediaPlayerSource-ti.d.ts +0 -0
  401. /package/types/{Private → ts/Private}/ti/IAgoraMediaRecorder-ti.d.ts +0 -0
  402. /package/types/{Private → ts/Private}/ti/IAgoraMediaStreamingSource-ti.d.ts +0 -0
  403. /package/types/{Private → ts/Private}/ti/IAgoraMusicContentCenter-ti.d.ts +0 -0
  404. /package/types/{Private → ts/Private}/ti/IAgoraRhythmPlayer-ti.d.ts +0 -0
  405. /package/types/{Private → ts/Private}/ti/IAgoraRtcEngine-ti.d.ts +0 -0
  406. /package/types/{Private → ts/Private}/ti/IAgoraRtcEngineEx-ti.d.ts +0 -0
  407. /package/types/{Private → ts/Private}/ti/IAgoraSpatialAudio-ti.d.ts +0 -0
  408. /package/types/{Private → ts/Private}/ti/IAudioDeviceManager-ti.d.ts +0 -0
  409. /package/types/{Renderer → ts/Renderer}/CapabilityManager.d.ts +0 -0
  410. /package/types/{Renderer → ts/Renderer}/WebGLRenderer/webgl-utils.d.ts +0 -0
  411. /package/types/{Renderer → ts/Renderer}/index.d.ts +0 -0
@@ -1,97 +1,97 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.RecorderInfo = exports.MediaRecorderConfiguration = exports.RecorderReasonCode = exports.RecorderState = exports.MediaRecorderStreamType = exports.MediaRecorderContainerFormat = exports.ExternalVideoSourceType = exports.VideoFrameProcessMode = exports.UserAudioSpectrumInfo = exports.AudioSpectrumData = exports.AudioParams = exports.AudioFramePosition = exports.AudioFrame = exports.AudioFrameType = exports.SnapshotConfig = exports.VideoModulePosition = exports.MediaPlayerSourceType = exports.VideoFrame = exports.ExternalVideoFrame = exports.VideoBufferType = exports.EglContextType = exports.AlphaStitchMode = exports.Hdr10MetadataInfo = exports.ColorSpace = exports.TransferID = exports.MatrixID = exports.RangeID = exports.PrimaryID = exports.IVideoFrameMetaInfo = exports.MetaInfoKey = exports.CameraVideoSourceType = exports.RenderModeType = exports.VideoPixelFormat = exports.AudioDualMonoMode = exports.AudioPcmFrame = exports.AudioEncodedFrameInfo = exports.PacketOptions = exports.ContentInspectConfig = exports.ContentInspectModule = exports.ContentInspectType = exports.ContentInspectResult = exports.MediaSourceType = exports.RawAudioFrameOpModeType = exports.AudioParameters = exports.BytesPerSample = exports.AudioRoute = exports.AudioSourceType = exports.VideoSourceType = exports.ExtensionContext = void 0;
3
+ exports.RecorderInfo = exports.MediaRecorderConfiguration = exports.RecorderReasonCode = exports.RecorderState = exports.MediaRecorderStreamType = exports.MediaRecorderContainerFormat = exports.ExternalVideoSourceType = exports.VideoFrameProcessMode = exports.UserAudioSpectrumInfo = exports.AudioSpectrumData = exports.AudioParams = exports.AudioFramePosition = exports.AudioFrame = exports.AudioFrameType = exports.SnapshotConfig = exports.ContentInspectConfig = exports.ContentInspectModule = exports.ContentInspectType = exports.ContentInspectResult = exports.VideoModulePosition = exports.MediaPlayerSourceType = exports.VideoFrame = exports.ExternalVideoFrame = exports.VideoBufferType = exports.EglContextType = exports.AlphaStitchMode = exports.Hdr10MetadataInfo = exports.ColorSpace = exports.TransferID = exports.MatrixID = exports.RangeID = exports.PrimaryID = exports.IVideoFrameMetaInfo = exports.MetaInfoKey = exports.CameraVideoSourceType = exports.RenderModeType = exports.VideoPixelFormat = exports.AudioDualMonoMode = exports.AudioPcmFrame = exports.AudioEncodedFrameInfo = exports.PacketOptions = exports.MediaSourceType = exports.RawAudioFrameOpModeType = exports.AudioParameters = exports.BytesPerSample = exports.AudioRoute = exports.AudioSourceType = exports.VideoSourceType = exports.ExtensionContext = void 0;
4
4
  require("./extension/AgoraMediaBaseExtension");
5
5
  /**
6
- * The context information of the extension.
6
+ * Plugin context information.
7
7
  */
8
8
  class ExtensionContext {
9
9
  }
10
10
  exports.ExtensionContext = ExtensionContext;
11
11
  /**
12
- * The type of the video source.
12
+ * Type of video source.
13
13
  */
14
14
  var VideoSourceType;
15
15
  (function (VideoSourceType) {
16
16
  /**
17
- * 0: (Default) The primary camera.
17
+ * 0: (Default) The video source is the first camera.
18
18
  */
19
19
  VideoSourceType[VideoSourceType["VideoSourceCameraPrimary"] = 0] = "VideoSourceCameraPrimary";
20
20
  /**
21
- * 0: (Default) The primary camera.
21
+ * 0: (Default) The video source is the first camera.
22
22
  */
23
23
  VideoSourceType[VideoSourceType["VideoSourceCamera"] = 0] = "VideoSourceCamera";
24
24
  /**
25
- * 1: The secondary camera.
25
+ * 1: The video source is the second camera.
26
26
  */
27
27
  VideoSourceType[VideoSourceType["VideoSourceCameraSecondary"] = 1] = "VideoSourceCameraSecondary";
28
28
  /**
29
- * 2: The primary screen.
29
+ * 2: The video source is the first screen.
30
30
  */
31
31
  VideoSourceType[VideoSourceType["VideoSourceScreenPrimary"] = 2] = "VideoSourceScreenPrimary";
32
32
  /**
33
- * 2: The primary screen.
33
+ * 2: The video source is the first screen.
34
34
  */
35
35
  VideoSourceType[VideoSourceType["VideoSourceScreen"] = 2] = "VideoSourceScreen";
36
36
  /**
37
- * 3: The secondary screen.
37
+ * 3: The video source is the second screen.
38
38
  */
39
39
  VideoSourceType[VideoSourceType["VideoSourceScreenSecondary"] = 3] = "VideoSourceScreenSecondary";
40
40
  /**
41
- * 4: A custom video source.
41
+ * 4: Custom video source.
42
42
  */
43
43
  VideoSourceType[VideoSourceType["VideoSourceCustom"] = 4] = "VideoSourceCustom";
44
44
  /**
45
- * 5: The media player.
45
+ * 5: The video source is a media player.
46
46
  */
47
47
  VideoSourceType[VideoSourceType["VideoSourceMediaPlayer"] = 5] = "VideoSourceMediaPlayer";
48
48
  /**
49
- * 6: One PNG image.
49
+ * 6: The video source is a PNG image.
50
50
  */
51
51
  VideoSourceType[VideoSourceType["VideoSourceRtcImagePng"] = 6] = "VideoSourceRtcImagePng";
52
52
  /**
53
- * 7: One JPEG image.
53
+ * 7: The video source is a JPEG image.
54
54
  */
55
55
  VideoSourceType[VideoSourceType["VideoSourceRtcImageJpeg"] = 7] = "VideoSourceRtcImageJpeg";
56
56
  /**
57
- * 8: One GIF image.
57
+ * 8: The video source is a GIF image.
58
58
  */
59
59
  VideoSourceType[VideoSourceType["VideoSourceRtcImageGif"] = 8] = "VideoSourceRtcImageGif";
60
60
  /**
61
- * 9: One remote video acquired by the network.
61
+ * 9: The video source is remote video obtained over the network.
62
62
  */
63
63
  VideoSourceType[VideoSourceType["VideoSourceRemote"] = 9] = "VideoSourceRemote";
64
64
  /**
65
- * 10: One transcoded video source.
65
+ * 10: Transcoded video source.
66
66
  */
67
67
  VideoSourceType[VideoSourceType["VideoSourceTranscoded"] = 10] = "VideoSourceTranscoded";
68
68
  /**
69
- * 11: The third camera.
69
+ * 11: The video source is the third camera.
70
70
  */
71
71
  VideoSourceType[VideoSourceType["VideoSourceCameraThird"] = 11] = "VideoSourceCameraThird";
72
72
  /**
73
- * 12: The fourth camera.
73
+ * 12: The video source is the fourth camera.
74
74
  */
75
75
  VideoSourceType[VideoSourceType["VideoSourceCameraFourth"] = 12] = "VideoSourceCameraFourth";
76
76
  /**
77
- * 13: The third screen.
77
+ * 13: The video source is the third screen.
78
78
  */
79
79
  VideoSourceType[VideoSourceType["VideoSourceScreenThird"] = 13] = "VideoSourceScreenThird";
80
80
  /**
81
- * 14: The fourth screen.
81
+ * 14: The video source is the fourth screen.
82
82
  */
83
83
  VideoSourceType[VideoSourceType["VideoSourceScreenFourth"] = 14] = "VideoSourceScreenFourth";
84
84
  /**
85
- * @ignore
85
+ * 15: The video source is video processed by a speech-driven plugin.
86
86
  */
87
87
  VideoSourceType[VideoSourceType["VideoSourceSpeechDriven"] = 15] = "VideoSourceSpeechDriven";
88
88
  /**
89
- * 100: An unknown video source.
89
+ * 100: Unknown video source.
90
90
  */
91
91
  VideoSourceType[VideoSourceType["VideoSourceUnknown"] = 100] = "VideoSourceUnknown";
92
92
  })(VideoSourceType = exports.VideoSourceType || (exports.VideoSourceType = {}));
93
93
  /**
94
- * The audio source type.
94
+ * Audio source type.
95
95
  */
96
96
  var AudioSourceType;
97
97
  (function (AudioSourceType) {
@@ -100,7 +100,7 @@ var AudioSourceType;
100
100
  */
101
101
  AudioSourceType[AudioSourceType["AudioSourceMicrophone"] = 0] = "AudioSourceMicrophone";
102
102
  /**
103
- * 1: Custom audio stream.
103
+ * 1: Custom captured audio stream.
104
104
  */
105
105
  AudioSourceType[AudioSourceType["AudioSourceCustom"] = 1] = "AudioSourceCustom";
106
106
  /**
@@ -116,69 +116,69 @@ var AudioSourceType;
116
116
  */
117
117
  AudioSourceType[AudioSourceType["AudioSourceMixedStream"] = 4] = "AudioSourceMixedStream";
118
118
  /**
119
- * 5: Audio stream from a specified remote user.
119
+ * 5: Audio stream of a specified remote user.
120
120
  */
121
121
  AudioSourceType[AudioSourceType["AudioSourceRemoteUser"] = 5] = "AudioSourceRemoteUser";
122
122
  /**
123
- * 6: Mixed audio streams from all users in the current channel.
123
+ * 6: Mixed stream of all audio streams in the current channel.
124
124
  */
125
125
  AudioSourceType[AudioSourceType["AudioSourceRemoteChannel"] = 6] = "AudioSourceRemoteChannel";
126
126
  /**
127
- * 100: An unknown audio source.
127
+ * 100: Unknown audio source.
128
128
  */
129
129
  AudioSourceType[AudioSourceType["AudioSourceUnknown"] = 100] = "AudioSourceUnknown";
130
130
  })(AudioSourceType = exports.AudioSourceType || (exports.AudioSourceType = {}));
131
131
  /**
132
- * The type of the audio route.
132
+ * Types of audio routing.
133
133
  */
134
134
  var AudioRoute;
135
135
  (function (AudioRoute) {
136
136
  /**
137
- * -1: The default audio route.
137
+ * -1: Use the default audio route.
138
138
  */
139
139
  AudioRoute[AudioRoute["RouteDefault"] = -1] = "RouteDefault";
140
140
  /**
141
- * 0: Audio output routing is a headset with microphone.
141
+ * 0: Audio routed to headset with microphone.
142
142
  */
143
143
  AudioRoute[AudioRoute["RouteHeadset"] = 0] = "RouteHeadset";
144
144
  /**
145
- * 1: The audio route is an earpiece.
145
+ * 1: Audio routed to earpiece.
146
146
  */
147
147
  AudioRoute[AudioRoute["RouteEarpiece"] = 1] = "RouteEarpiece";
148
148
  /**
149
- * 2: The audio route is a headset without a microphone.
149
+ * 2: Audio routed to headset without microphone.
150
150
  */
151
151
  AudioRoute[AudioRoute["RouteHeadsetnomic"] = 2] = "RouteHeadsetnomic";
152
152
  /**
153
- * 3: The audio route is the speaker that comes with the device.
153
+ * 3: Audio routed to built-in speaker.
154
154
  */
155
155
  AudioRoute[AudioRoute["RouteSpeakerphone"] = 3] = "RouteSpeakerphone";
156
156
  /**
157
- * 4: The audio route is an external speaker. (macOS only)
157
+ * 4: Audio routed to external speaker. (macOS only)
158
158
  */
159
159
  AudioRoute[AudioRoute["RouteLoudspeaker"] = 4] = "RouteLoudspeaker";
160
160
  /**
161
- * 5: The audio route is a Bluetooth device using the HFP protocol.
161
+ * 5: Audio routed to Bluetooth device using HFP protocol.
162
162
  */
163
163
  AudioRoute[AudioRoute["RouteBluetoothDeviceHfp"] = 5] = "RouteBluetoothDeviceHfp";
164
164
  /**
165
- * 6: The audio route is a USB peripheral device. (For macOS only)
165
+ * 6: Audio routed to USB peripheral device. (macOS only)
166
166
  */
167
167
  AudioRoute[AudioRoute["RouteUsb"] = 6] = "RouteUsb";
168
168
  /**
169
- * 7: The audio route is an HDMI peripheral device. (For macOS only)
169
+ * 7: Audio routed to HDMI peripheral device. (macOS only)
170
170
  */
171
171
  AudioRoute[AudioRoute["RouteHdmi"] = 7] = "RouteHdmi";
172
172
  /**
173
- * 8: The audio route is a DisplayPort peripheral device. (For macOS only)
173
+ * 8: Audio routed to DisplayPort peripheral device. (macOS only)
174
174
  */
175
175
  AudioRoute[AudioRoute["RouteDisplayport"] = 8] = "RouteDisplayport";
176
176
  /**
177
- * 9: The audio route is Apple AirPlay. (For macOS only)
177
+ * 9: Audio routed to Apple AirPlay. (macOS only)
178
178
  */
179
179
  AudioRoute[AudioRoute["RouteAirplay"] = 9] = "RouteAirplay";
180
180
  /**
181
- * 10: The audio route is a Bluetooth device using the A2DP protocol.
181
+ * 10: Audio routed to Bluetooth device using A2DP protocol.
182
182
  */
183
183
  AudioRoute[AudioRoute["RouteBluetoothDeviceA2dp"] = 10] = "RouteBluetoothDeviceA2dp";
184
184
  })(AudioRoute = exports.AudioRoute || (exports.AudioRoute = {}));
@@ -199,21 +199,21 @@ class AudioParameters {
199
199
  }
200
200
  exports.AudioParameters = AudioParameters;
201
201
  /**
202
- * The use mode of the audio data.
202
+ * Usage mode of audio data.
203
203
  */
204
204
  var RawAudioFrameOpModeType;
205
205
  (function (RawAudioFrameOpModeType) {
206
206
  /**
207
- * 0: Read-only mode, Users only read the data returned by the SDK without modifying anything. For example, when users acquire the data with the Agora SDK, then start the media push.
207
+ * 0: (Default) Read-only mode. You only retrieve the raw data returned by the SDK without making any modifications. For example, if you collect data via the SDK and perform your own CDN streaming, you can use this mode.
208
208
  */
209
209
  RawAudioFrameOpModeType[RawAudioFrameOpModeType["RawAudioFrameOpModeReadOnly"] = 0] = "RawAudioFrameOpModeReadOnly";
210
210
  /**
211
- * 2: Read and write mode, Users read the data returned by the SDK, modify it, and then play it. For example, when users have their own audio-effect processing module and perform some voice preprocessing, such as a voice change.
211
+ * 2: Read-write mode. You modify the raw audio returned by the SDK and send it back to the SDK for encoding and transmission. For example, if you have your own audio effects module and want to pre-process the data (e.g., voice changing), you can use this mode.
212
212
  */
213
213
  RawAudioFrameOpModeType[RawAudioFrameOpModeType["RawAudioFrameOpModeReadWrite"] = 2] = "RawAudioFrameOpModeReadWrite";
214
214
  })(RawAudioFrameOpModeType = exports.RawAudioFrameOpModeType || (exports.RawAudioFrameOpModeType = {}));
215
215
  /**
216
- * Media source type.
216
+ * Media source types.
217
217
  */
218
218
  var MediaSourceType;
219
219
  (function (MediaSourceType) {
@@ -222,15 +222,15 @@ var MediaSourceType;
222
222
  */
223
223
  MediaSourceType[MediaSourceType["AudioPlayoutSource"] = 0] = "AudioPlayoutSource";
224
224
  /**
225
- * 1: Audio capturing device.
225
+ * 1: Audio recording device.
226
226
  */
227
227
  MediaSourceType[MediaSourceType["AudioRecordingSource"] = 1] = "AudioRecordingSource";
228
228
  /**
229
- * 2: The primary camera.
229
+ * 2: Primary camera.
230
230
  */
231
231
  MediaSourceType[MediaSourceType["PrimaryCameraSource"] = 2] = "PrimaryCameraSource";
232
232
  /**
233
- * 3: A secondary camera.
233
+ * 3: Secondary camera.
234
234
  */
235
235
  MediaSourceType[MediaSourceType["SecondaryCameraSource"] = 3] = "SecondaryCameraSource";
236
236
  /**
@@ -270,7 +270,7 @@ var MediaSourceType;
270
270
  */
271
271
  MediaSourceType[MediaSourceType["TranscodedVideoSource"] = 12] = "TranscodedVideoSource";
272
272
  /**
273
- * @ignore
273
+ * 13: Video source processed by speech-driven plugin.
274
274
  */
275
275
  MediaSourceType[MediaSourceType["SpeechDrivenVideoSource"] = 13] = "SpeechDrivenVideoSource";
276
276
  /**
@@ -278,58 +278,6 @@ var MediaSourceType;
278
278
  */
279
279
  MediaSourceType[MediaSourceType["UnknownMediaSource"] = 100] = "UnknownMediaSource";
280
280
  })(MediaSourceType = exports.MediaSourceType || (exports.MediaSourceType = {}));
281
- /**
282
- * @ignore
283
- */
284
- var ContentInspectResult;
285
- (function (ContentInspectResult) {
286
- /**
287
- * @ignore
288
- */
289
- ContentInspectResult[ContentInspectResult["ContentInspectNeutral"] = 1] = "ContentInspectNeutral";
290
- /**
291
- * @ignore
292
- */
293
- ContentInspectResult[ContentInspectResult["ContentInspectSexy"] = 2] = "ContentInspectSexy";
294
- /**
295
- * @ignore
296
- */
297
- ContentInspectResult[ContentInspectResult["ContentInspectPorn"] = 3] = "ContentInspectPorn";
298
- })(ContentInspectResult = exports.ContentInspectResult || (exports.ContentInspectResult = {}));
299
- /**
300
- * The type of video content moderation module.
301
- */
302
- var ContentInspectType;
303
- (function (ContentInspectType) {
304
- /**
305
- * 0: (Default) This module has no actual function. Do not set type to this value.
306
- */
307
- ContentInspectType[ContentInspectType["ContentInspectInvalid"] = 0] = "ContentInspectInvalid";
308
- /**
309
- * @ignore
310
- */
311
- ContentInspectType[ContentInspectType["ContentInspectModeration"] = 1] = "ContentInspectModeration";
312
- /**
313
- * 2: Video screenshot and upload via Agora self-developed extension. SDK takes screenshots of the video stream in the channel and uploads them.
314
- */
315
- ContentInspectType[ContentInspectType["ContentInspectSupervision"] = 2] = "ContentInspectSupervision";
316
- /**
317
- * 3: Video screenshot and upload via extensions from Agora Extensions Marketplace. SDK uses video moderation extensions from Agora Extensions Marketplace to take screenshots of the video stream in the channel and uploads them.
318
- */
319
- ContentInspectType[ContentInspectType["ContentInspectImageModeration"] = 3] = "ContentInspectImageModeration";
320
- })(ContentInspectType = exports.ContentInspectType || (exports.ContentInspectType = {}));
321
- /**
322
- * ContentInspectModule A structure used to configure the frequency of video screenshot and upload.
323
- */
324
- class ContentInspectModule {
325
- }
326
- exports.ContentInspectModule = ContentInspectModule;
327
- /**
328
- * Screenshot and upload configuration.
329
- */
330
- class ContentInspectConfig {
331
- }
332
- exports.ContentInspectConfig = ContentInspectConfig;
333
281
  /**
334
282
  * @ignore
335
283
  */
@@ -343,13 +291,13 @@ class AudioEncodedFrameInfo {
343
291
  }
344
292
  exports.AudioEncodedFrameInfo = AudioEncodedFrameInfo;
345
293
  /**
346
- * The parameters of the audio frame in PCM format.
294
+ * Information of external PCM format audio frame.
347
295
  */
348
296
  class AudioPcmFrame {
349
297
  }
350
298
  exports.AudioPcmFrame = AudioPcmFrame;
351
299
  /**
352
- * The channel mode.
300
+ * Channel mode.
353
301
  */
354
302
  var AudioDualMonoMode;
355
303
  (function (AudioDualMonoMode) {
@@ -358,29 +306,29 @@ var AudioDualMonoMode;
358
306
  */
359
307
  AudioDualMonoMode[AudioDualMonoMode["AudioDualMonoStereo"] = 0] = "AudioDualMonoStereo";
360
308
  /**
361
- * 1: Left channel mode. This mode replaces the audio of the right channel with the audio of the left channel, which means the user can only hear the audio of the left channel.
309
+ * 1: Left channel mode. Replaces the right channel audio with the left channel audio, so users only hear the left channel.
362
310
  */
363
311
  AudioDualMonoMode[AudioDualMonoMode["AudioDualMonoL"] = 1] = "AudioDualMonoL";
364
312
  /**
365
- * 2: Right channel mode. This mode replaces the audio of the left channel with the audio of the right channel, which means the user can only hear the audio of the right channel.
313
+ * 2: Right channel mode. Replaces the left channel audio with the right channel audio, so users only hear the right channel.
366
314
  */
367
315
  AudioDualMonoMode[AudioDualMonoMode["AudioDualMonoR"] = 2] = "AudioDualMonoR";
368
316
  /**
369
- * 3: Mixed channel mode. This mode mixes the audio of the left channel and the right channel, which means the user can hear the audio of the left channel and the right channel at the same time.
317
+ * 3: Mixed mode. Combines left and right channel audio so users hear both channels simultaneously.
370
318
  */
371
319
  AudioDualMonoMode[AudioDualMonoMode["AudioDualMonoMix"] = 3] = "AudioDualMonoMix";
372
320
  })(AudioDualMonoMode = exports.AudioDualMonoMode || (exports.AudioDualMonoMode = {}));
373
321
  /**
374
- * The video pixel format.
322
+ * Video pixel format.
375
323
  */
376
324
  var VideoPixelFormat;
377
325
  (function (VideoPixelFormat) {
378
326
  /**
379
- * 0: Raw video pixel format.
327
+ * 0: Original video pixel format.
380
328
  */
381
329
  VideoPixelFormat[VideoPixelFormat["VideoPixelDefault"] = 0] = "VideoPixelDefault";
382
330
  /**
383
- * 1: The format is I420.
331
+ * 1: I420 format.
384
332
  */
385
333
  VideoPixelFormat[VideoPixelFormat["VideoPixelI420"] = 1] = "VideoPixelI420";
386
334
  /**
@@ -392,7 +340,7 @@ var VideoPixelFormat;
392
340
  */
393
341
  VideoPixelFormat[VideoPixelFormat["VideoPixelNv21"] = 3] = "VideoPixelNv21";
394
342
  /**
395
- * 4: The format is RGBA.
343
+ * 4: RGBA format.
396
344
  */
397
345
  VideoPixelFormat[VideoPixelFormat["VideoPixelRgba"] = 4] = "VideoPixelRgba";
398
346
  /**
@@ -424,7 +372,7 @@ var VideoPixelFormat;
424
372
  */
425
373
  VideoPixelFormat[VideoPixelFormat["VideoCvpixelP010"] = 15] = "VideoCvpixelP010";
426
374
  /**
427
- * 16: The format is I422.
375
+ * 16: I422 format.
428
376
  */
429
377
  VideoPixelFormat[VideoPixelFormat["VideoPixelI422"] = 16] = "VideoPixelI422";
430
378
  /**
@@ -437,16 +385,16 @@ var VideoPixelFormat;
437
385
  VideoPixelFormat[VideoPixelFormat["VideoPixelI010"] = 18] = "VideoPixelI010";
438
386
  })(VideoPixelFormat = exports.VideoPixelFormat || (exports.VideoPixelFormat = {}));
439
387
  /**
440
- * Video display modes.
388
+ * Video display mode.
441
389
  */
442
390
  var RenderModeType;
443
391
  (function (RenderModeType) {
444
392
  /**
445
- * 1: Hidden mode. The priority is to fill the window. Any excess video that does not match the window size will be cropped.
393
+ * 1: The video is scaled proportionally. Priority is given to filling the view. Excess video beyond the view due to size mismatch is cropped.
446
394
  */
447
395
  RenderModeType[RenderModeType["RenderModeHidden"] = 1] = "RenderModeHidden";
448
396
  /**
449
- * 2: Fit mode. The priority is to ensure that all video content is displayed. Any areas of the window that are not filled due to the mismatch between video size and window size will be filled with black.
397
+ * 2: The video is scaled proportionally. Priority is given to displaying the entire video content. Black bars are added to fill the view if the video size does not match the view size.
450
398
  */
451
399
  RenderModeType[RenderModeType["RenderModeFit"] = 2] = "RenderModeFit";
452
400
  /**
@@ -713,12 +661,12 @@ class Hdr10MetadataInfo {
713
661
  }
714
662
  exports.Hdr10MetadataInfo = Hdr10MetadataInfo;
715
663
  /**
716
- * The relative position of alphaBuffer and video frames.
664
+ * The relative position of alphaBuffer and the video frame.
717
665
  */
718
666
  var AlphaStitchMode;
719
667
  (function (AlphaStitchMode) {
720
668
  /**
721
- * 0: (Default) Only video frame, that is, alphaBuffer is not stitched with the video frame.
669
+ * 0: (Default) Only the video frame is used, i.e., alphaBuffer is not stitched with the video frame.
722
670
  */
723
671
  AlphaStitchMode[AlphaStitchMode["NoAlphaStitch"] = 0] = "NoAlphaStitch";
724
672
  /**
@@ -753,33 +701,33 @@ var EglContextType;
753
701
  EglContextType[EglContextType["EglContext14"] = 1] = "EglContext14";
754
702
  })(EglContextType = exports.EglContextType || (exports.EglContextType = {}));
755
703
  /**
756
- * The video buffer type.
704
+ * Video buffer type.
757
705
  */
758
706
  var VideoBufferType;
759
707
  (function (VideoBufferType) {
760
708
  /**
761
- * 1: The video buffer in the format of raw data.
709
+ * 1: Type is raw data.
762
710
  */
763
711
  VideoBufferType[VideoBufferType["VideoBufferRawData"] = 1] = "VideoBufferRawData";
764
712
  /**
765
- * 2: The video buffer in the format of raw data.
713
+ * 2: Type is raw data.
766
714
  */
767
715
  VideoBufferType[VideoBufferType["VideoBufferArray"] = 2] = "VideoBufferArray";
768
716
  /**
769
- * 3: The video buffer in the format of Texture.
717
+ * 3: Type is Texture.
770
718
  */
771
719
  VideoBufferType[VideoBufferType["VideoBufferTexture"] = 3] = "VideoBufferTexture";
772
720
  })(VideoBufferType = exports.VideoBufferType || (exports.VideoBufferType = {}));
773
721
  /**
774
- * The external video frame.
722
+ * External video frame.
775
723
  */
776
724
  class ExternalVideoFrame {
777
725
  }
778
726
  exports.ExternalVideoFrame = ExternalVideoFrame;
779
727
  /**
780
- * Configurations of the video frame.
728
+ * Video frame property settings.
781
729
  *
782
- * Note that the buffer provides a pointer to a pointer. This interface cannot modify the pointer of the buffer, but it can modify the content of the buffer.
730
+ * The buffer is provided as a pointer to a pointer. This interface cannot modify the buffer pointer, only the buffer content.
783
731
  */
784
732
  class VideoFrame {
785
733
  }
@@ -803,31 +751,83 @@ var MediaPlayerSourceType;
803
751
  MediaPlayerSourceType[MediaPlayerSourceType["MediaPlayerSourceSimple"] = 2] = "MediaPlayerSourceSimple";
804
752
  })(MediaPlayerSourceType = exports.MediaPlayerSourceType || (exports.MediaPlayerSourceType = {}));
805
753
  /**
806
- * The frame position of the video observer.
754
+ * Video observation position.
807
755
  */
808
756
  var VideoModulePosition;
809
757
  (function (VideoModulePosition) {
810
758
  /**
811
- * 1: The location of the locally collected video data after preprocessing corresponds to the onCaptureVideoFrame callback. The observed video here has the effect of video pre-processing, which can be verified by enabling image enhancement, virtual background, or watermark.
759
+ * 1: Position after local video capture and preprocessing, corresponding to the onCaptureVideoFrame callback. The video observed here includes video preprocessing effects, which can be verified by enabling beauty effects, virtual background, or watermark.
812
760
  */
813
761
  VideoModulePosition[VideoModulePosition["PositionPostCapturer"] = 1] = "PositionPostCapturer";
814
762
  /**
815
- * 2: The pre-renderer position, which corresponds to the video data in the onRenderVideoFrame callback.
763
+ * 2: Position before rendering of received remote video, corresponding to the onRenderVideoFrame callback.
816
764
  */
817
765
  VideoModulePosition[VideoModulePosition["PositionPreRenderer"] = 2] = "PositionPreRenderer";
818
766
  /**
819
- * 4: The pre-encoder position, which corresponds to the video data in the onPreEncodeVideoFrame callback. The observed video here has the effects of video pre-processing and encoding pre-processing.
820
- * To verify the pre-processing effects of the video, you can enable image enhancement, virtual background, or watermark.
821
- * To verify the pre-encoding processing effect, you can set a lower frame rate (for example, 5 fps).
767
+ * 4: Position before local video encoding, corresponding to the onPreEncodeVideoFrame callback. The video observed here includes preprocessing and pre-encoding effects:
768
+ * For preprocessing effects, you can verify by enabling beauty effects, virtual background, or watermark.
769
+ * For pre-encoding effects, you can verify by setting a low frame rate (e.g., 5 fps).
822
770
  */
823
771
  VideoModulePosition[VideoModulePosition["PositionPreEncoder"] = 4] = "PositionPreEncoder";
824
772
  /**
825
- * 8: The position after local video capture and before pre-processing. The observed video here does not have pre-processing effects, which can be verified by enabling image enhancement, virtual background, or watermarks.
773
+ * 8: Position after local video capture and before preprocessing. The video observed here does not include preprocessing effects, which can be verified by enabling beauty effects, virtual background, or watermark.
826
774
  */
827
775
  VideoModulePosition[VideoModulePosition["PositionPostCapturerOrigin"] = 8] = "PositionPostCapturerOrigin";
828
776
  })(VideoModulePosition = exports.VideoModulePosition || (exports.VideoModulePosition = {}));
829
777
  /**
830
- * The snapshot configuration.
778
+ * @ignore
779
+ */
780
+ var ContentInspectResult;
781
+ (function (ContentInspectResult) {
782
+ /**
783
+ * @ignore
784
+ */
785
+ ContentInspectResult[ContentInspectResult["ContentInspectNeutral"] = 1] = "ContentInspectNeutral";
786
+ /**
787
+ * @ignore
788
+ */
789
+ ContentInspectResult[ContentInspectResult["ContentInspectSexy"] = 2] = "ContentInspectSexy";
790
+ /**
791
+ * @ignore
792
+ */
793
+ ContentInspectResult[ContentInspectResult["ContentInspectPorn"] = 3] = "ContentInspectPorn";
794
+ })(ContentInspectResult = exports.ContentInspectResult || (exports.ContentInspectResult = {}));
795
+ /**
796
+ * The type of video content moderation module.
797
+ */
798
+ var ContentInspectType;
799
+ (function (ContentInspectType) {
800
+ /**
801
+ * 0: (Default) This module has no actual function. Do not set type to this value.
802
+ */
803
+ ContentInspectType[ContentInspectType["ContentInspectInvalid"] = 0] = "ContentInspectInvalid";
804
+ /**
805
+ * @ignore
806
+ */
807
+ ContentInspectType[ContentInspectType["ContentInspectModeration"] = 1] = "ContentInspectModeration";
808
+ /**
809
+ * 2: Uses Agora's self-developed plugin to capture and upload screenshots. The SDK captures and uploads screenshots of the video stream.
810
+ */
811
+ ContentInspectType[ContentInspectType["ContentInspectSupervision"] = 2] = "ContentInspectSupervision";
812
+ /**
813
+ * 3: Uses a Marketplace plugin to capture and upload screenshots. The SDK uses a Marketplace video moderation plugin to capture and upload screenshots of the video stream.
814
+ */
815
+ ContentInspectType[ContentInspectType["ContentInspectImageModeration"] = 3] = "ContentInspectImageModeration";
816
+ })(ContentInspectType = exports.ContentInspectType || (exports.ContentInspectType = {}));
817
+ /**
818
+ * ContentInspectModule structure used to configure the frequency of local screenshot uploads.
819
+ */
820
+ class ContentInspectModule {
821
+ }
822
+ exports.ContentInspectModule = ContentInspectModule;
823
+ /**
824
+ * Local screenshot upload configuration.
825
+ */
826
+ class ContentInspectConfig {
827
+ }
828
+ exports.ContentInspectConfig = ContentInspectConfig;
829
+ /**
830
+ * Video snapshot settings.
831
831
  */
832
832
  class SnapshotConfig {
833
833
  }
@@ -881,50 +881,53 @@ var AudioFramePosition;
881
881
  /**
882
882
  * Audio data format.
883
883
  *
884
- * The SDK sets the audio data format in the following callbacks according to AudioParams. onRecordAudioFrame onPlaybackAudioFrame onMixedAudioFrame
885
- * The SDK calculates the sampling interval through the samplesPerCall, sampleRate, and channel parameters in AudioParams, and triggers the onRecordAudioFrame, onPlaybackAudioFrame, onMixedAudioFrame, and onEarMonitoringAudioFrame callbacks according to the sampling interval. Sample interval (sec) = samplePerCall /(sampleRate × channel).
886
- * Ensure that the sample interval 0.01 (s).
884
+ * The SDK sets the audio data format in the following callbacks based on AudioParams : onRecordAudioFrame onPlaybackAudioFrame onMixedAudioFrame
885
+ * The SDK calculates the sampling interval using the samplesPerCall, sampleRate, and channel parameters in AudioParams, and triggers the onRecordAudioFrame, onPlaybackAudioFrame, onMixedAudioFrame, and onEarMonitoringAudioFrame callbacks based on that interval.
886
+ * Sampling interval = samplesPerCall / (sampleRate × channel).
887
+ * Ensure the sampling interval is not less than 0.01 (s).
887
888
  */
888
889
  class AudioParams {
889
890
  }
890
891
  exports.AudioParams = AudioParams;
891
892
  /**
892
- * The audio spectrum data.
893
+ * Audio spectrum data.
893
894
  */
894
895
  class AudioSpectrumData {
895
896
  }
896
897
  exports.AudioSpectrumData = AudioSpectrumData;
897
898
  /**
898
- * Audio spectrum information of the remote user.
899
+ * Audio spectrum information of a remote user.
899
900
  */
900
901
  class UserAudioSpectrumInfo {
901
902
  }
902
903
  exports.UserAudioSpectrumInfo = UserAudioSpectrumInfo;
903
904
  /**
904
- * The process mode of the video frame:
905
+ * Video frame processing mode.
905
906
  */
906
907
  var VideoFrameProcessMode;
907
908
  (function (VideoFrameProcessMode) {
908
909
  /**
909
- * Read-only mode. In this mode, you do not modify the video frame. The video frame observer is a renderer.
910
+ * Read-only mode.
911
+ * In read-only mode, you do not modify the video frame. The video observer acts as a renderer.
910
912
  */
911
913
  VideoFrameProcessMode[VideoFrameProcessMode["ProcessModeReadOnly"] = 0] = "ProcessModeReadOnly";
912
914
  /**
913
- * Read and write mode. In this mode, you modify the video frame. The video frame observer is a video filter.
915
+ * Read-write mode.
916
+ * In read-write mode, you modify the video frame. The video observer acts as a video filter.
914
917
  */
915
918
  VideoFrameProcessMode[VideoFrameProcessMode["ProcessModeReadWrite"] = 1] = "ProcessModeReadWrite";
916
919
  })(VideoFrameProcessMode = exports.VideoFrameProcessMode || (exports.VideoFrameProcessMode = {}));
917
920
  /**
918
- * The external video frame encoding type.
921
+ * Encoding type of external video frames.
919
922
  */
920
923
  var ExternalVideoSourceType;
921
924
  (function (ExternalVideoSourceType) {
922
925
  /**
923
- * 0: The video frame is not encoded.
926
+ * 0: Unencoded video frame.
924
927
  */
925
928
  ExternalVideoSourceType[ExternalVideoSourceType["VideoFrame"] = 0] = "VideoFrame";
926
929
  /**
927
- * 1: The video frame is encoded.
930
+ * 1: Encoded video frame.
928
931
  */
929
932
  ExternalVideoSourceType[ExternalVideoSourceType["EncodedVideoFrame"] = 1] = "EncodedVideoFrame";
930
933
  })(ExternalVideoSourceType = exports.ExternalVideoSourceType || (exports.ExternalVideoSourceType = {}));
@@ -939,48 +942,48 @@ var MediaRecorderContainerFormat;
939
942
  MediaRecorderContainerFormat[MediaRecorderContainerFormat["FormatMp4"] = 1] = "FormatMp4";
940
943
  })(MediaRecorderContainerFormat = exports.MediaRecorderContainerFormat || (exports.MediaRecorderContainerFormat = {}));
941
944
  /**
942
- * The recording content.
945
+ * @ignore
943
946
  */
944
947
  var MediaRecorderStreamType;
945
948
  (function (MediaRecorderStreamType) {
946
949
  /**
947
- * Only audio.
950
+ * @ignore
948
951
  */
949
952
  MediaRecorderStreamType[MediaRecorderStreamType["StreamTypeAudio"] = 1] = "StreamTypeAudio";
950
953
  /**
951
- * Only video.
954
+ * @ignore
952
955
  */
953
956
  MediaRecorderStreamType[MediaRecorderStreamType["StreamTypeVideo"] = 2] = "StreamTypeVideo";
954
957
  /**
955
- * (Default) Audio and video.
958
+ * @ignore
956
959
  */
957
960
  MediaRecorderStreamType[MediaRecorderStreamType["StreamTypeBoth"] = 3] = "StreamTypeBoth";
958
961
  })(MediaRecorderStreamType = exports.MediaRecorderStreamType || (exports.MediaRecorderStreamType = {}));
959
962
  /**
960
- * The current recording state.
963
+ * Current recording state.
961
964
  */
962
965
  var RecorderState;
963
966
  (function (RecorderState) {
964
967
  /**
965
- * -1: An error occurs during the recording. See RecorderReasonCode for the reason.
968
+ * -1: Audio/video stream recording error. See RecorderReasonCode for details.
966
969
  */
967
970
  RecorderState[RecorderState["RecorderStateError"] = -1] = "RecorderStateError";
968
971
  /**
969
- * 2: The audio and video recording starts.
972
+ * 2: Audio/video stream recording started.
970
973
  */
971
974
  RecorderState[RecorderState["RecorderStateStart"] = 2] = "RecorderStateStart";
972
975
  /**
973
- * 3: The audio and video recording stops.
976
+ * 3: Audio/video stream recording stopped.
974
977
  */
975
978
  RecorderState[RecorderState["RecorderStateStop"] = 3] = "RecorderStateStop";
976
979
  })(RecorderState = exports.RecorderState || (exports.RecorderState = {}));
977
980
  /**
978
- * The reason for the state change.
981
+ * Reason for recording state error.
979
982
  */
980
983
  var RecorderReasonCode;
981
984
  (function (RecorderReasonCode) {
982
985
  /**
983
- * 0: No error.
986
+ * 0: Everything is normal.
984
987
  */
985
988
  RecorderReasonCode[RecorderReasonCode["RecorderReasonNone"] = 0] = "RecorderReasonNone";
986
989
  /**