sfml.js 1.0.0-rc.1 → 1.0.0

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 (334) hide show
  1. package/README.ja.md +177 -0
  2. package/README.ko.md +177 -0
  3. package/README.md +119 -14
  4. package/README.zh-CN.md +177 -0
  5. package/assets/branding/sfml-js-symbol-pentagon.svg +24 -0
  6. package/assets/branding/sfml-js-wordmark-dark.svg +20 -0
  7. package/assets/branding/sfml-js-wordmark.svg +19 -0
  8. package/assets/breakout.png +0 -0
  9. package/dist/audio/effect-processor.d.ts +53 -8
  10. package/dist/audio/effect-processor.js +35 -5
  11. package/dist/audio/input-sound-file.d.ts +101 -15
  12. package/dist/audio/input-sound-file.js +101 -15
  13. package/dist/audio/listener.d.ts +74 -12
  14. package/dist/audio/listener.js +74 -12
  15. package/dist/audio/music.d.ts +172 -22
  16. package/dist/audio/music.js +185 -24
  17. package/dist/audio/output-sound-file.d.ts +36 -4
  18. package/dist/audio/output-sound-file.js +36 -4
  19. package/dist/audio/playback-device.d.ts +103 -17
  20. package/dist/audio/playback-device.js +97 -16
  21. package/dist/audio/sound-buffer-recorder.d.ts +89 -9
  22. package/dist/audio/sound-buffer-recorder.js +89 -9
  23. package/dist/audio/sound-buffer.d.ts +121 -16
  24. package/dist/audio/sound-buffer.js +98 -13
  25. package/dist/audio/sound-file-factory.d.ts +84 -11
  26. package/dist/audio/sound-file-factory.js +84 -11
  27. package/dist/audio/sound-file-reader.d.ts +155 -24
  28. package/dist/audio/sound-file-reader.js +84 -13
  29. package/dist/audio/sound-file-writer.d.ts +49 -7
  30. package/dist/audio/sound-file-writer.js +13 -2
  31. package/dist/audio/sound-recorder.d.ts +143 -19
  32. package/dist/audio/sound-recorder.js +142 -18
  33. package/dist/audio/sound-source.d.ts +273 -45
  34. package/dist/audio/sound-source.js +273 -45
  35. package/dist/audio/sound-stream.d.ts +57 -9
  36. package/dist/audio/sound-stream.js +43 -7
  37. package/dist/audio/sound.d.ts +32 -5
  38. package/dist/audio/sound.js +32 -5
  39. package/dist/audio/value.d.ts +291 -48
  40. package/dist/audio/value.js +235 -39
  41. package/dist/audio/worker.d.ts +256 -38
  42. package/dist/graphics/blend-mode.d.ts +199 -33
  43. package/dist/graphics/blend-mode.js +163 -27
  44. package/dist/graphics/boolean-vector.d.ts +102 -16
  45. package/dist/graphics/boolean-vector.js +102 -16
  46. package/dist/graphics/circle-shape.d.ts +68 -11
  47. package/dist/graphics/circle-shape.js +37 -6
  48. package/dist/graphics/color.d.ts +227 -42
  49. package/dist/graphics/color.js +177 -32
  50. package/dist/graphics/convex-shape.d.ts +45 -7
  51. package/dist/graphics/convex-shape.js +31 -5
  52. package/dist/graphics/drawable.d.ts +15 -2
  53. package/dist/graphics/drawable.js +6 -1
  54. package/dist/graphics/font.d.ts +153 -24
  55. package/dist/graphics/font.js +116 -18
  56. package/dist/graphics/glsl-matrix.d.ts +44 -7
  57. package/dist/graphics/glsl-matrix.js +44 -7
  58. package/dist/graphics/glsl.d.ts +129 -21
  59. package/dist/graphics/glsl.js +123 -20
  60. package/dist/graphics/glyph.d.ts +106 -17
  61. package/dist/graphics/glyph.js +76 -12
  62. package/dist/graphics/image.d.ts +159 -24
  63. package/dist/graphics/image.js +122 -18
  64. package/dist/graphics/primitive-type.d.ts +42 -7
  65. package/dist/graphics/primitive-type.js +42 -7
  66. package/dist/graphics/rect.d.ts +162 -26
  67. package/dist/graphics/rect.js +101 -16
  68. package/dist/graphics/rectangle-shape.d.ts +44 -7
  69. package/dist/graphics/rectangle-shape.js +31 -5
  70. package/dist/graphics/render-states.d.ts +153 -25
  71. package/dist/graphics/render-states.js +49 -8
  72. package/dist/graphics/render-target.d.ts +145 -22
  73. package/dist/graphics/render-target.js +110 -17
  74. package/dist/graphics/render-texture.d.ts +100 -16
  75. package/dist/graphics/render-texture.js +80 -13
  76. package/dist/graphics/render-window.d.ts +106 -17
  77. package/dist/graphics/render-window.js +57 -9
  78. package/dist/graphics/shader.d.ts +153 -24
  79. package/dist/graphics/shader.js +126 -20
  80. package/dist/graphics/shape.d.ts +133 -21
  81. package/dist/graphics/shape.js +115 -18
  82. package/dist/graphics/sprite.d.ts +71 -11
  83. package/dist/graphics/sprite.js +57 -9
  84. package/dist/graphics/stencil-mode.d.ts +193 -32
  85. package/dist/graphics/stencil-mode.js +121 -20
  86. package/dist/graphics/swap.d.ts +13 -2
  87. package/dist/graphics/text.d.ts +624 -103
  88. package/dist/graphics/text.js +443 -73
  89. package/dist/graphics/texture.d.ts +209 -32
  90. package/dist/graphics/texture.js +137 -21
  91. package/dist/graphics/transform.d.ts +93 -14
  92. package/dist/graphics/transform.js +93 -14
  93. package/dist/graphics/transformable.d.ts +13 -2
  94. package/dist/graphics/transformable.js +13 -2
  95. package/dist/graphics/vertex-array.d.ts +83 -14
  96. package/dist/graphics/vertex-array.js +70 -12
  97. package/dist/graphics/vertex-buffer.d.ts +162 -26
  98. package/dist/graphics/vertex-buffer.js +106 -17
  99. package/dist/graphics/vertex.d.ts +83 -14
  100. package/dist/graphics/vertex.js +43 -7
  101. package/dist/graphics/view.d.ts +140 -22
  102. package/dist/graphics/view.js +103 -16
  103. package/dist/internal/glsl-value.d.ts +30 -5
  104. package/dist/internal/glsl-value.js +30 -5
  105. package/dist/internal/scalar.d.ts +9 -1
  106. package/dist/internal/transformable.d.ts +84 -13
  107. package/dist/internal/value-storage.d.ts +8 -1
  108. package/dist/network/common.d.ts +6 -1
  109. package/dist/network/common.js +6 -1
  110. package/dist/network/dns.d.ts +103 -14
  111. package/dist/network/dns.js +55 -6
  112. package/dist/network/ftp.d.ts +217 -33
  113. package/dist/network/ftp.js +217 -33
  114. package/dist/network/gen/constants.d.ts +750 -124
  115. package/dist/network/gen/constants.js +750 -124
  116. package/dist/network/http.d.ts +365 -57
  117. package/dist/network/http.js +365 -57
  118. package/dist/network/ip-address.d.ts +179 -26
  119. package/dist/network/ip-address.js +164 -24
  120. package/dist/network/packet.d.ts +200 -29
  121. package/dist/network/packet.js +101 -13
  122. package/dist/network/sftp.d.ts +525 -84
  123. package/dist/network/sftp.js +322 -53
  124. package/dist/network/socket-selector.d.ts +109 -15
  125. package/dist/network/socket-selector.js +103 -14
  126. package/dist/network/socket.d.ts +245 -33
  127. package/dist/network/socket.js +205 -28
  128. package/dist/network/tcp-listener.d.ts +91 -13
  129. package/dist/network/tcp-listener.js +85 -12
  130. package/dist/network/tcp-socket.d.ts +232 -33
  131. package/dist/network/tcp-socket.js +153 -22
  132. package/dist/network/tls-material.d.ts +18 -2
  133. package/dist/network/tls-material.js +18 -2
  134. package/dist/network/udp-socket.d.ts +137 -19
  135. package/dist/network/udp-socket.js +101 -13
  136. package/dist/system/angle.d.ts +60 -10
  137. package/dist/system/angle.js +60 -10
  138. package/dist/system/clock.d.ts +51 -8
  139. package/dist/system/clock.js +51 -8
  140. package/dist/system/err.d.ts +14 -2
  141. package/dist/system/err.js +14 -2
  142. package/dist/system/error.d.ts +12 -2
  143. package/dist/system/error.js +12 -2
  144. package/dist/system/file-input-stream.d.ts +54 -7
  145. package/dist/system/file-input-stream.js +54 -7
  146. package/dist/system/input-stream.d.ts +97 -13
  147. package/dist/system/input-stream.js +60 -8
  148. package/dist/system/operators.d.ts +146 -19
  149. package/dist/system/operators.js +118 -15
  150. package/dist/system/sleep.d.ts +6 -1
  151. package/dist/system/sleep.js +6 -1
  152. package/dist/system/suspend-aware-clock.d.ts +18 -3
  153. package/dist/system/suspend-aware-clock.js +18 -3
  154. package/dist/system/time.d.ts +81 -12
  155. package/dist/system/time.js +63 -9
  156. package/dist/system/timeout-with-predicate.d.ts +48 -7
  157. package/dist/system/timeout-with-predicate.js +20 -3
  158. package/dist/system/unicode.d.ts +42 -6
  159. package/dist/system/unicode.js +42 -6
  160. package/dist/system/vector2.d.ts +240 -36
  161. package/dist/system/vector2.js +105 -16
  162. package/dist/system/vector3.d.ts +197 -31
  163. package/dist/system/vector3.js +104 -16
  164. package/dist/system/version.d.ts +43 -7
  165. package/dist/system/version.js +7 -1
  166. package/dist/window/clipboard.d.ts +12 -2
  167. package/dist/window/clipboard.js +12 -2
  168. package/dist/window/context-settings.d.ts +78 -13
  169. package/dist/window/context-settings.js +30 -5
  170. package/dist/window/context.d.ts +70 -10
  171. package/dist/window/context.js +52 -7
  172. package/dist/window/cursor.d.ts +44 -6
  173. package/dist/window/cursor.js +28 -4
  174. package/dist/window/event.d.ts +423 -70
  175. package/dist/window/event.js +36 -6
  176. package/dist/window/gen/constants.d.ts +1890 -314
  177. package/dist/window/gen/constants.js +1890 -314
  178. package/dist/window/joystick.d.ts +67 -11
  179. package/dist/window/joystick.js +43 -7
  180. package/dist/window/keyboard.d.ts +42 -6
  181. package/dist/window/keyboard.js +26 -4
  182. package/dist/window/mouse.d.ts +24 -3
  183. package/dist/window/mouse.js +24 -3
  184. package/dist/window/sensor.d.ts +20 -3
  185. package/dist/window/sensor.js +20 -3
  186. package/dist/window/touch.d.ts +19 -4
  187. package/dist/window/touch.js +19 -4
  188. package/dist/window/video-mode.d.ts +61 -10
  189. package/dist/window/video-mode.js +36 -6
  190. package/dist/window/vulkan.d.ts +26 -3
  191. package/dist/window/vulkan.js +26 -3
  192. package/dist/window/window.d.ts +296 -44
  193. package/dist/window/window.js +241 -34
  194. package/docs/README.ja.md +30 -0
  195. package/docs/README.ko.md +30 -0
  196. package/docs/README.md +30 -0
  197. package/docs/README.zh-CN.md +30 -0
  198. package/docs/api.ja.md +84 -0
  199. package/docs/api.ko.md +84 -0
  200. package/docs/api.md +48 -1080
  201. package/docs/api.zh-CN.md +81 -0
  202. package/docs/audio.ja.md +249 -0
  203. package/docs/audio.ko.md +251 -0
  204. package/docs/audio.md +132 -92
  205. package/docs/audio.zh-CN.md +252 -0
  206. package/docs/concepts.ja.md +130 -0
  207. package/docs/concepts.ko.md +130 -0
  208. package/docs/concepts.md +131 -0
  209. package/docs/concepts.zh-CN.md +131 -0
  210. package/docs/development.ja.md +144 -0
  211. package/docs/development.ko.md +144 -0
  212. package/docs/development.md +112 -43
  213. package/docs/development.zh-CN.md +146 -0
  214. package/docs/getting-started.ja.md +154 -0
  215. package/docs/getting-started.ko.md +154 -0
  216. package/docs/getting-started.md +156 -0
  217. package/docs/getting-started.zh-CN.md +156 -0
  218. package/docs/graphics.ja.md +256 -0
  219. package/docs/graphics.ko.md +254 -0
  220. package/docs/graphics.md +255 -0
  221. package/docs/graphics.zh-CN.md +257 -0
  222. package/docs/network.ja.md +214 -0
  223. package/docs/network.ko.md +216 -0
  224. package/docs/network.md +133 -84
  225. package/docs/network.zh-CN.md +218 -0
  226. package/docs/system.ja.md +169 -0
  227. package/docs/system.ko.md +171 -0
  228. package/docs/system.md +173 -0
  229. package/docs/system.zh-CN.md +173 -0
  230. package/docs/window.ja.md +138 -0
  231. package/docs/window.ko.md +140 -0
  232. package/docs/window.md +141 -0
  233. package/docs/window.zh-CN.md +141 -0
  234. package/native/shared-handle.h +41 -3
  235. package/package.json +17 -6
  236. package/src/audio/effect-processor.ts +53 -8
  237. package/src/audio/input-sound-file.ts +101 -15
  238. package/src/audio/listener.ts +74 -12
  239. package/src/audio/music.ts +191 -25
  240. package/src/audio/output-sound-file.ts +36 -4
  241. package/src/audio/playback-device.ts +103 -17
  242. package/src/audio/sound-buffer-recorder.ts +89 -9
  243. package/src/audio/sound-buffer.ts +121 -16
  244. package/src/audio/sound-file-factory.ts +84 -11
  245. package/src/audio/sound-file-reader.ts +155 -24
  246. package/src/audio/sound-file-writer.ts +49 -7
  247. package/src/audio/sound-recorder.ts +155 -20
  248. package/src/audio/sound-source.ts +273 -45
  249. package/src/audio/sound-stream.ts +57 -9
  250. package/src/audio/sound.ts +32 -5
  251. package/src/audio/value.ts +291 -48
  252. package/src/audio/worker.ts +256 -38
  253. package/src/graphics/blend-mode.ts +199 -33
  254. package/src/graphics/boolean-vector.ts +102 -16
  255. package/src/graphics/circle-shape.ts +68 -11
  256. package/src/graphics/color.ts +227 -42
  257. package/src/graphics/convex-shape.ts +45 -7
  258. package/src/graphics/drawable.ts +15 -2
  259. package/src/graphics/font.ts +153 -24
  260. package/src/graphics/glsl-matrix.ts +44 -7
  261. package/src/graphics/glsl.ts +129 -21
  262. package/src/graphics/glyph.ts +106 -17
  263. package/src/graphics/image.ts +159 -24
  264. package/src/graphics/primitive-type.ts +42 -7
  265. package/src/graphics/rect.ts +162 -26
  266. package/src/graphics/rectangle-shape.ts +44 -7
  267. package/src/graphics/render-states.ts +153 -25
  268. package/src/graphics/render-target.ts +145 -22
  269. package/src/graphics/render-texture.ts +100 -16
  270. package/src/graphics/render-window.ts +113 -18
  271. package/src/graphics/shader.ts +153 -24
  272. package/src/graphics/shape.ts +133 -21
  273. package/src/graphics/sprite.ts +71 -11
  274. package/src/graphics/stencil-mode.ts +193 -32
  275. package/src/graphics/swap.ts +13 -2
  276. package/src/graphics/text.ts +624 -103
  277. package/src/graphics/texture.ts +209 -32
  278. package/src/graphics/transform.ts +93 -14
  279. package/src/graphics/transformable.ts +13 -2
  280. package/src/graphics/vertex-array.ts +83 -14
  281. package/src/graphics/vertex-buffer.ts +162 -26
  282. package/src/graphics/vertex.ts +83 -14
  283. package/src/graphics/view.ts +140 -22
  284. package/src/internal/glsl-value.ts +30 -5
  285. package/src/internal/scalar.ts +9 -1
  286. package/src/internal/transformable.ts +84 -13
  287. package/src/internal/value-storage.ts +8 -1
  288. package/src/network/common.ts +6 -1
  289. package/src/network/dns.ts +103 -14
  290. package/src/network/ftp.ts +217 -33
  291. package/src/network/gen/constants.ts +750 -124
  292. package/src/network/http.ts +365 -57
  293. package/src/network/ip-address.ts +179 -26
  294. package/src/network/packet.ts +200 -29
  295. package/src/network/sftp.ts +525 -84
  296. package/src/network/socket-selector.ts +109 -15
  297. package/src/network/socket.ts +245 -33
  298. package/src/network/tcp-listener.ts +91 -13
  299. package/src/network/tcp-socket.ts +232 -33
  300. package/src/network/tls-material.ts +18 -2
  301. package/src/network/udp-socket.ts +137 -19
  302. package/src/system/angle.ts +60 -10
  303. package/src/system/clock.ts +51 -8
  304. package/src/system/err.ts +14 -2
  305. package/src/system/error.ts +12 -2
  306. package/src/system/file-input-stream.ts +54 -7
  307. package/src/system/input-stream.ts +97 -13
  308. package/src/system/operators.ts +146 -19
  309. package/src/system/sleep.ts +6 -1
  310. package/src/system/suspend-aware-clock.ts +18 -3
  311. package/src/system/time.ts +81 -12
  312. package/src/system/timeout-with-predicate.ts +48 -7
  313. package/src/system/unicode.ts +42 -6
  314. package/src/system/vector2.ts +240 -36
  315. package/src/system/vector3.ts +197 -31
  316. package/src/system/version.ts +43 -7
  317. package/src/window/clipboard.ts +12 -2
  318. package/src/window/context-settings.ts +78 -13
  319. package/src/window/context.ts +70 -10
  320. package/src/window/cursor.ts +44 -6
  321. package/src/window/event.ts +423 -70
  322. package/src/window/gen/constants.ts +1890 -314
  323. package/src/window/joystick.ts +67 -11
  324. package/src/window/keyboard.ts +42 -6
  325. package/src/window/mouse.ts +24 -3
  326. package/src/window/sensor.ts +20 -3
  327. package/src/window/touch.ts +19 -4
  328. package/src/window/video-mode.ts +61 -10
  329. package/src/window/vulkan.ts +26 -3
  330. package/src/window/window.ts +314 -46
  331. package/tools/constant-docs.cjs +109 -0
  332. package/tools/constant-docs.json +1318 -0
  333. package/tools/generate-network-constants.cjs +21 -9
  334. package/tools/generate-window-constants.cjs +26 -12
@@ -8,9 +8,21 @@ const audio_codec_registry_1 = require("../internal/audio-codec-registry");
8
8
  const sound_file_reader_1 = require("./sound-file-reader");
9
9
  const value_1 = require("./value");
10
10
  exports.cancelAudioInput = Symbol('Audio.cancelInput');
11
- /** 可寻址音频解码器,按调用顺序异步读取交错 16 位 PCM。 */
11
+ /**
12
+ * Seekable audio decoder reading interleaved 16-bit PCM asynchronously in
13
+ * invocation order.
14
+ * @zh 可寻址音频解码器,按调用顺序异步读取交错 16 位 PCM。
15
+ * @ja 呼び出し順に非同期で 16 ビットインターリーブ PCM を読み取る、
16
+ * シーク可能な音声デコーダー。
17
+ * @ko 호출 순서대로 16비트 인터리브 PCM을 비동기로 읽는 탐색 가능한 오디오 디코더입니다.
18
+ */
12
19
  class InputSoundFile {
13
- /** 创建未打开数据源的解码器。 */
20
+ /**
21
+ * Create a decoder with no open data source.
22
+ * @zh 创建未打开数据源的解码器。
23
+ * @ja データソースを開いていないデコーダーを作成します。
24
+ * @ko 데이터 소스가 열리지 않은 디코더를 생성합니다.
25
+ */
14
26
  constructor() {
15
27
  this.queue = new audio_native_1.AudioQueue();
16
28
  const mapping = audio_native_1.audioNative.createAudioInput();
@@ -20,31 +32,91 @@ class InputSoundFile {
20
32
  this.u32 = new Uint32Array(mapping.buffer);
21
33
  this.channelMap = new Int32Array(mapping.channelMap);
22
34
  }
23
- /** 异步打开音频文件并读取格式信息,返回是否成功。 */
35
+ /**
36
+ * Asynchronously open an audio file and read its format information,
37
+ * returning whether it succeeded.
38
+ * @zh 异步打开音频文件并读取格式信息,返回是否成功。
39
+ * @ja 音声ファイルを非同期で開いて形式情報を読み取り、成功したかどうかを返します。
40
+ * @ko 오디오 파일을 비동기로 열고 형식 정보를 읽어 성공 여부를 반환합니다.
41
+ */
24
42
  openFromFile(filename) { return this.open(filename); }
25
- /** 异步打开编码音频字节,返回是否成功。 */
43
+ /**
44
+ * Asynchronously open encoded audio bytes, returning whether it succeeded.
45
+ * @zh 异步打开编码音频字节,返回是否成功。
46
+ * @ja エンコード済み音声バイトを非同期で開き、成功したかどうかを返します。
47
+ * @ko 인코딩된 오디오 바이트를 비동기로 열고 성공 여부를 반환합니다.
48
+ */
26
49
  openFromMemory(data) { return this.open(data); }
27
- /** 异步打开可寻址流,读取期间保留数据源引用。 */
50
+ /**
51
+ * Asynchronously open a seekable stream, retaining the data source reference
52
+ * during reading.
53
+ * @zh 异步打开可寻址流,读取期间保留数据源引用。
54
+ * @ja シーク可能なストリームを非同期で開き、読み取り中はデータソース参照を保持します。
55
+ * @ko 탐색 가능한 스트림을 비동기로 열고 읽는 동안 데이터 소스 참조를 유지합니다.
56
+ */
28
57
  openFromStream(stream) {
29
58
  return this.open(stream);
30
59
  }
31
- /** 返回所有声道合计的样本总数。 */
60
+ /**
61
+ * Return the total sample count across all channels.
62
+ * @zh 返回所有声道合计的样本总数。
63
+ * @ja 全チャンネルのサンプル総数を返します。
64
+ * @ko 모든 채널의 샘플 총수를 반환합니다.
65
+ */
32
66
  getSampleCount() { return this.u64[0]; }
33
- /** 返回当前样本偏移,包含所有交错声道。 */
67
+ /**
68
+ * Return the current sample offset, including all interleaved channels.
69
+ * @zh 返回当前样本偏移,包含所有交错声道。
70
+ * @ja 全インターリーブチャンネルを含む現在のサンプルオフセットを返します。
71
+ * @ko 모든 인터리브 채널을 포함하는 현재 샘플 오프셋을 반환합니다.
72
+ */
34
73
  getSampleOffset() { return this.u64[1]; }
35
- /** 返回音频总时长。 */
74
+ /**
75
+ * Return the total audio duration.
76
+ * @zh 返回音频总时长。
77
+ * @ja 音声全体の長さを返します。
78
+ * @ko 오디오의 전체 길이를 반환합니다.
79
+ */
36
80
  getDuration() { return new time_1.Time(this.i64[2]); }
37
- /** 返回当前解码位置对应的时间。 */
81
+ /**
82
+ * Return the time corresponding to the current decoding position.
83
+ * @zh 返回当前解码位置对应的时间。
84
+ * @ja 現在のデコード位置に対応する時刻を返します。
85
+ * @ko 현재 디코딩 위치에 해당하는 시간을 반환합니다.
86
+ */
38
87
  getTimeOffset() { return new time_1.Time(this.i64[3]); }
39
- /** 返回每声道采样率,单位为 Hz。 */
88
+ /**
89
+ * Return the sample rate per channel, in Hz.
90
+ * @zh 返回每声道采样率,单位为 Hz。
91
+ * @ja チャンネルごとのサンプルレートを Hz で返します。
92
+ * @ko 채널별 샘플 레이트를 Hz 단위로 반환합니다.
93
+ */
40
94
  getSampleRate() { return this.u32[10]; }
41
- /** 返回声道数。 */
95
+ /**
96
+ * Return the number of channels.
97
+ * @zh 返回声道数。
98
+ * @ja チャンネル数を返します。
99
+ * @ko 채널 수를 반환합니다.
100
+ */
42
101
  getChannelCount() { return this.u32[11]; }
43
- /** 返回交错声道的位置映射。 */
102
+ /**
103
+ * Return the position mapping of interleaved channels.
104
+ * @zh 返回交错声道的位置映射。
105
+ * @ja インターリーブチャンネルの位置マッピングを返します。
106
+ * @ko 인터리브 채널의 위치 매핑을 반환합니다.
107
+ */
44
108
  getChannelMap() { return this.channelMap; }
45
109
  /** @internal */
46
110
  [exports.cancelAudioInput]() { this.stream?.close(); }
47
- /** 异步解码到 data,返回实际写入的样本数;末尾返回 0n,完成前勿修改缓冲区。 */
111
+ /**
112
+ * Asynchronously decode into data, returning the actual number of samples
113
+ * written; return 0n at the end. Do not modify the buffer before completion.
114
+ * @zh 异步解码到 data,返回实际写入的样本数;末尾返回 0n,完成前勿修改缓冲区。
115
+ * @ja data に非同期でデコードし、実際に書き込んだサンプル数を返します。
116
+ * 末尾では 0n を返します。完了前にバッファーを変更しないでください。
117
+ * @ko data에 비동기로 디코딩하여 실제 기록한 샘플 수를 반환합니다.
118
+ * 끝에서는 0n을 반환하며, 완료 전에 버퍼를 수정하면 안 됩니다.
119
+ */
48
120
  read(data) {
49
121
  (0, value_1.samples)(data);
50
122
  return this.queue.run(async () => {
@@ -61,7 +133,15 @@ class InputSoundFile {
61
133
  return this.u64[4];
62
134
  });
63
135
  }
64
- /** 异步跳转到样本偏移(bigint,包含所有声道)或时间偏移(Time)。 */
136
+ /**
137
+ * Asynchronously seek to a sample offset (bigint, including all channels)
138
+ * or a time offset (Time).
139
+ * @zh 异步跳转到样本偏移(bigint,包含所有声道)或时间偏移(Time)。
140
+ * @ja サンプルオフセット(bigint、全チャンネルを含む)または
141
+ * 時間オフセット(Time)に非同期でシークします。
142
+ * @ko 샘플 오프셋(bigint, 모든 채널 포함) 또는 시간 오프셋(Time)으로
143
+ * 비동기 이동합니다.
144
+ */
65
145
  seek(offset) {
66
146
  const time = offset instanceof time_1.Time;
67
147
  const value = time ? (0, value_1.duration)(offset) : offset;
@@ -79,7 +159,13 @@ class InputSoundFile {
79
159
  }
80
160
  });
81
161
  }
82
- /** 等待此前操作并异步关闭解码器、释放其持有的数据源。 */
162
+ /**
163
+ * Wait for prior operations, then asynchronously close the decoder and
164
+ * release its retained data source.
165
+ * @zh 等待此前操作并异步关闭解码器、释放其持有的数据源。
166
+ * @ja 先行する操作を待ち、非同期でデコーダーを閉じて保持するデータソースを解放します。
167
+ * @ko 이전 작업을 기다린 뒤 디코더를 비동기로 닫고 보유한 데이터 소스를 해제합니다.
168
+ */
83
169
  close() {
84
170
  return this.queue.run(async () => {
85
171
  this.map(await (0, audio_native_1.audioAsync)(callback => audio_native_1.audioNative.closeAudioInput(this[audio_native_1.audioHandle], callback)));
@@ -2,27 +2,89 @@ import { Vector3f } from '../system/vector3';
2
2
  import type { ReadonlyValue as R } from '../internal/value-storage';
3
3
  import { Cone, type ConeInput } from './value';
4
4
  export { Cone } from './value';
5
- /** 设置所有声源的总音量百分比,0 静音、100 为原始音量。 */
5
+ /**
6
+ * Set the global volume percentage for all sources;
7
+ * 0 is silent and 100 is the original volume.
8
+ * @zh 设置所有声源的总音量百分比,0 静音、100 为原始音量。
9
+ * @ja 全音源の全体音量を百分率で設定します。0 は無音、100 は元の音量です。
10
+ * @ko 모든 음원의 전체 볼륨을 백분율로 설정합니다. 0은 무음, 100은 원래 볼륨입니다.
11
+ */
6
12
  export declare function setGlobalVolume(value: number): void;
7
- /** 返回总音量百分比。 */
13
+ /**
14
+ * Return the global volume percentage.
15
+ * @zh 返回总音量百分比。
16
+ * @ja 全体音量の百分率を返します。
17
+ * @ko 전체 볼륨 백분율을 반환합니다.
18
+ */
8
19
  export declare function getGlobalVolume(): number;
9
- /** 返回监听者的三维位置副本。 */
20
+ /**
21
+ * Return a copy of the listener's 3D position.
22
+ * @zh 返回监听者的三维位置副本。
23
+ * @ja リスナーの 3D 位置のコピーを返します。
24
+ * @ko 리스너의 3차원 위치 복사본을 반환합니다.
25
+ */
10
26
  export declare function getPosition(): Vector3f;
11
- /** 设置监听者的世界坐标位置。 */
27
+ /**
28
+ * Set the listener's position in world coordinates.
29
+ * @zh 设置监听者的世界坐标位置。
30
+ * @ja リスナーのワールド座標での位置を設定します。
31
+ * @ko 리스너의 월드 좌표 위치를 설정합니다.
32
+ */
12
33
  export declare function setPosition(value: R<Vector3f>): void;
13
- /** 返回监听者的朝向副本。 */
34
+ /**
35
+ * Return a copy of the listener's facing direction.
36
+ * @zh 返回监听者的朝向副本。
37
+ * @ja リスナーの向きのコピーを返します。
38
+ * @ko 리스너가 향하는 방향의 복사본을 반환합니다.
39
+ */
14
40
  export declare function getDirection(): Vector3f;
15
- /** 设置监听者的正前方方向。 */
41
+ /**
42
+ * Set the listener's forward direction.
43
+ * @zh 设置监听者的正前方方向。
44
+ * @ja リスナーの前方方向を設定します。
45
+ * @ko 리스너의 정면 방향을 설정합니다.
46
+ */
16
47
  export declare function setDirection(value: R<Vector3f>): void;
17
- /** 返回监听者的速度副本。 */
48
+ /**
49
+ * Return a copy of the listener's velocity.
50
+ * @zh 返回监听者的速度副本。
51
+ * @ja リスナーの速度のコピーを返します。
52
+ * @ko 리스너 속도의 복사본을 반환합니다.
53
+ */
18
54
  export declare function getVelocity(): Vector3f;
19
- /** 设置监听者的速度,用于多普勒效应,单位为位置单位/秒。 */
55
+ /**
56
+ * Set the listener's velocity for the Doppler effect, in position units/second.
57
+ * @zh 设置监听者的速度,用于多普勒效应,单位为位置单位/秒。
58
+ * @ja ドップラー効果用のリスナー速度を設定します。単位は位置単位/秒です。
59
+ * @ko 도플러 효과에 사용할 리스너 속도를 설정합니다. 단위는 위치 단위/초입니다.
60
+ */
20
61
  export declare function setVelocity(value: R<Vector3f>): void;
21
- /** 返回监听者上方方向的副本。 */
62
+ /**
63
+ * Return a copy of the listener's up direction.
64
+ * @zh 返回监听者上方方向的副本。
65
+ * @ja リスナーの上方向のコピーを返します。
66
+ * @ko 리스너 위쪽 방향의 복사본을 반환합니다.
67
+ */
22
68
  export declare function getUpVector(): Vector3f;
23
- /** 设置监听者上方方向,与正前方方向共同决定空间朝向。 */
69
+ /**
70
+ * Set the listener's up direction, which defines orientation together with the
71
+ * forward direction.
72
+ * @zh 设置监听者上方方向,与正前方方向共同决定空间朝向。
73
+ * @ja リスナーの上方向を設定します。前方方向とともに空間内の向きを決めます。
74
+ * @ko 리스너의 위쪽 방향을 설정합니다. 정면 방향과 함께 공간상의 방향을 결정합니다.
75
+ */
24
76
  export declare function setUpVector(value: R<Vector3f>): void;
25
- /** 复制方向锥参数并更新原生监听者。 */
77
+ /**
78
+ * Copy directional cone parameters and update the native listener.
79
+ * @zh 复制方向锥参数并更新原生监听者。
80
+ * @ja 指向性コーンのパラメーターをコピーし、ネイティブリスナーを更新します。
81
+ * @ko 지향성 원뿔 매개변수를 복사하고 네이티브 리스너를 갱신합니다.
82
+ */
26
83
  export declare function setCone(value: Readonly<ConeInput>): void;
27
- /** 返回监听者方向锥参数副本。 */
84
+ /**
85
+ * Return a copy of the listener's directional cone parameters.
86
+ * @zh 返回监听者方向锥参数副本。
87
+ * @ja リスナーの指向性コーンのパラメーターのコピーを返します。
88
+ * @ko 리스너의 지향성 원뿔 매개변수 복사본을 반환합니다.
89
+ */
28
90
  export declare function getCone(): Cone;
@@ -28,45 +28,102 @@ function setVector(field, value) {
28
28
  values[field + 2] = value.z;
29
29
  audio_native_1.audioNative.audioListenerField(handle, field, true);
30
30
  }
31
- /** 设置所有声源的总音量百分比,0 静音、100 为原始音量。 */
31
+ /**
32
+ * Set the global volume percentage for all sources;
33
+ * 0 is silent and 100 is the original volume.
34
+ * @zh 设置所有声源的总音量百分比,0 静音、100 为原始音量。
35
+ * @ja 全音源の全体音量を百分率で設定します。0 は無音、100 は元の音量です。
36
+ * @ko 모든 음원의 전체 볼륨을 백분율로 설정합니다. 0은 무음, 100은 원래 볼륨입니다.
37
+ */
32
38
  function setGlobalVolume(value) {
33
39
  const { handle, values } = listener();
34
40
  values[0] = (0, value_1.float)(value);
35
41
  audio_native_1.audioNative.audioListenerField(handle, 0, true);
36
42
  }
37
43
  exports.setGlobalVolume = setGlobalVolume;
38
- /** 返回总音量百分比。 */
44
+ /**
45
+ * Return the global volume percentage.
46
+ * @zh 返回总音量百分比。
47
+ * @ja 全体音量の百分率を返します。
48
+ * @ko 전체 볼륨 백분율을 반환합니다.
49
+ */
39
50
  function getGlobalVolume() {
40
51
  const { handle, values } = listener();
41
52
  audio_native_1.audioNative.audioListenerField(handle, 0, false);
42
53
  return values[0];
43
54
  }
44
55
  exports.getGlobalVolume = getGlobalVolume;
45
- /** 返回监听者的三维位置副本。 */
56
+ /**
57
+ * Return a copy of the listener's 3D position.
58
+ * @zh 返回监听者的三维位置副本。
59
+ * @ja リスナーの 3D 位置のコピーを返します。
60
+ * @ko 리스너의 3차원 위치 복사본을 반환합니다.
61
+ */
46
62
  function getPosition() { return getVector(1); }
47
63
  exports.getPosition = getPosition;
48
- /** 设置监听者的世界坐标位置。 */
64
+ /**
65
+ * Set the listener's position in world coordinates.
66
+ * @zh 设置监听者的世界坐标位置。
67
+ * @ja リスナーのワールド座標での位置を設定します。
68
+ * @ko 리스너의 월드 좌표 위치를 설정합니다.
69
+ */
49
70
  function setPosition(value) { setVector(1, value); }
50
71
  exports.setPosition = setPosition;
51
- /** 返回监听者的朝向副本。 */
72
+ /**
73
+ * Return a copy of the listener's facing direction.
74
+ * @zh 返回监听者的朝向副本。
75
+ * @ja リスナーの向きのコピーを返します。
76
+ * @ko 리스너가 향하는 방향의 복사본을 반환합니다.
77
+ */
52
78
  function getDirection() { return getVector(4); }
53
79
  exports.getDirection = getDirection;
54
- /** 设置监听者的正前方方向。 */
80
+ /**
81
+ * Set the listener's forward direction.
82
+ * @zh 设置监听者的正前方方向。
83
+ * @ja リスナーの前方方向を設定します。
84
+ * @ko 리스너의 정면 방향을 설정합니다.
85
+ */
55
86
  function setDirection(value) { setVector(4, value); }
56
87
  exports.setDirection = setDirection;
57
- /** 返回监听者的速度副本。 */
88
+ /**
89
+ * Return a copy of the listener's velocity.
90
+ * @zh 返回监听者的速度副本。
91
+ * @ja リスナーの速度のコピーを返します。
92
+ * @ko 리스너 속도의 복사본을 반환합니다.
93
+ */
58
94
  function getVelocity() { return getVector(7); }
59
95
  exports.getVelocity = getVelocity;
60
- /** 设置监听者的速度,用于多普勒效应,单位为位置单位/秒。 */
96
+ /**
97
+ * Set the listener's velocity for the Doppler effect, in position units/second.
98
+ * @zh 设置监听者的速度,用于多普勒效应,单位为位置单位/秒。
99
+ * @ja ドップラー効果用のリスナー速度を設定します。単位は位置単位/秒です。
100
+ * @ko 도플러 효과에 사용할 리스너 속도를 설정합니다. 단위는 위치 단위/초입니다.
101
+ */
61
102
  function setVelocity(value) { setVector(7, value); }
62
103
  exports.setVelocity = setVelocity;
63
- /** 返回监听者上方方向的副本。 */
104
+ /**
105
+ * Return a copy of the listener's up direction.
106
+ * @zh 返回监听者上方方向的副本。
107
+ * @ja リスナーの上方向のコピーを返します。
108
+ * @ko 리스너 위쪽 방향의 복사본을 반환합니다.
109
+ */
64
110
  function getUpVector() { return getVector(10); }
65
111
  exports.getUpVector = getUpVector;
66
- /** 设置监听者上方方向,与正前方方向共同决定空间朝向。 */
112
+ /**
113
+ * Set the listener's up direction, which defines orientation together with the
114
+ * forward direction.
115
+ * @zh 设置监听者上方方向,与正前方方向共同决定空间朝向。
116
+ * @ja リスナーの上方向を設定します。前方方向とともに空間内の向きを決めます。
117
+ * @ko 리스너의 위쪽 방향을 설정합니다. 정면 방향과 함께 공간상의 방향을 결정합니다.
118
+ */
67
119
  function setUpVector(value) { setVector(10, value); }
68
120
  exports.setUpVector = setUpVector;
69
- /** 复制方向锥参数并更新原生监听者。 */
121
+ /**
122
+ * Copy directional cone parameters and update the native listener.
123
+ * @zh 复制方向锥参数并更新原生监听者。
124
+ * @ja 指向性コーンのパラメーターをコピーし、ネイティブリスナーを更新します。
125
+ * @ko 지향성 원뿔 매개변수를 복사하고 네이티브 리스너를 갱신합니다.
126
+ */
70
127
  function setCone(value) {
71
128
  const inner = (0, value_1.angle)(value.innerAngle);
72
129
  const outer = (0, value_1.angle)(value.outerAngle);
@@ -76,7 +133,12 @@ function setCone(value) {
76
133
  audio_native_1.audioNative.audioListenerField(handle, 13, true);
77
134
  }
78
135
  exports.setCone = setCone;
79
- /** 返回监听者方向锥参数副本。 */
136
+ /**
137
+ * Return a copy of the listener's directional cone parameters.
138
+ * @zh 返回监听者方向锥参数副本。
139
+ * @ja リスナーの指向性コーンのパラメーターのコピーを返します。
140
+ * @ko 리스너의 지향성 원뿔 매개변수 복사본을 반환합니다.
141
+ */
80
142
  function getCone() {
81
143
  const { handle, values } = listener();
82
144
  audio_native_1.audioNative.audioListenerField(handle, 13, false);
@@ -3,58 +3,208 @@ import { Time } from '../system/time';
3
3
  import { TimeSpan, type TimeSpanInput } from './value';
4
4
  import type { InputStream } from '../system/input-stream';
5
5
  import type { AudioWorkerStats, SoundStreamChunk } from './worker';
6
- /** 按块解码和播放长音频,无需一次将全部样本加载到内存。 */
6
+ /**
7
+ * Decode and play long audio in blocks without loading all samples into memory
8
+ * at once.
9
+ * @zh 按块解码和播放长音频,无需一次将全部样本加载到内存。
10
+ * @ja 全サンプルを一度にメモリへ読み込まず、長い音声をブロック単位でデコード・再生します。
11
+ * @ko 모든 샘플을 한 번에 메모리에 로드하지 않고 긴 오디오를 블록별로 디코딩하고 재생합니다.
12
+ */
7
13
  export declare class Music extends SoundStream {
8
- /** 循环区间的时间段类型。 */
14
+ /**
15
+ * Time span type for the loop region.
16
+ * @zh 循环区间的时间段类型。
17
+ * @ja ループ区間の時間範囲の型。
18
+ * @ko 반복 구간의 시간 범위 타입입니다.
19
+ */
9
20
  static readonly TimeSpan: typeof TimeSpan;
10
- /** 串行管理打开和关闭操作。 */
21
+ /**
22
+ * Serialize open and close operations.
23
+ * @zh 串行管理打开和关闭操作。
24
+ * @ja 開く操作と閉じる操作を直列に管理します。
25
+ * @ko 열기 및 닫기 작업을 직렬로 관리합니다.
26
+ */
11
27
  private readonly queue;
12
- /** 当前文件解码与可选子类回调会话。 */
28
+ /**
29
+ * Current file decoding session with optional subclass callbacks.
30
+ * @zh 当前文件解码与可选子类回调会话。
31
+ * @ja 現在のファイルのデコードと任意のサブクラスコールバックのセッション。
32
+ * @ko 현재 파일 디코딩 및 선택적 하위 클래스 콜백 세션입니다.
33
+ */
13
34
  private pump?;
14
- /** 关闭时递增,取消此前尚未安装的打开请求。 */
35
+ /**
36
+ * Increment on close to cancel earlier open requests not yet installed.
37
+ * @zh 关闭时递增,取消此前尚未安装的打开请求。
38
+ * @ja 閉じる際に増加し、まだ適用されていない以前のオープン要求を取り消します。
39
+ * @ko 닫을 때 증가하여 아직 적용되지 않은 이전 열기 요청을 취소합니다.
40
+ */
15
41
  private closeGeneration;
16
- /** 创建未打开内容的音乐播放源。 */
42
+ /**
43
+ * Create a music playback source with no open content.
44
+ * @zh 创建未打开内容的音乐播放源。
45
+ * @ja コンテンツを開いていない音楽再生音源を作成します。
46
+ * @ko 콘텐츠가 열리지 않은 음악 재생 음원을 생성합니다.
47
+ */
17
48
  constructor();
18
- /** 异步打开音频文件用于流式播放,返回是否成功;不会自动 play。 */
49
+ /**
50
+ * Asynchronously open an audio file for streaming and return whether it
51
+ * succeeded; does not call play automatically.
52
+ * @zh 异步打开音频文件用于流式播放,返回是否成功;不会自动 play。
53
+ * @ja ストリーミング再生用に音声ファイルを非同期で開き、成功したかどうかを返します。
54
+ * play は自動では呼びません。
55
+ * @ko 스트리밍 재생을 위해 오디오 파일을 비동기로 열고 성공 여부를 반환합니다.
56
+ * play를 자동으로 호출하지 않습니다.
57
+ */
19
58
  openFromFile(filename: string): Promise<boolean>;
20
- /** 异步打开编码音频字节用于流式播放,返回是否成功。 */
59
+ /**
60
+ * Asynchronously open encoded audio bytes for streaming, returning whether it
61
+ * succeeded.
62
+ * @zh 异步打开编码音频字节用于流式播放,返回是否成功。
63
+ * @ja ストリーミング用にエンコード済み音声バイトを非同期で開き、
64
+ * 成功したかどうかを返します。
65
+ * @ko 스트리밍 재생을 위해 인코딩된 오디오 바이트를 비동기로 열고 성공 여부를 반환합니다.
66
+ */
21
67
  openFromMemory(data: Uint8Array): Promise<boolean>;
22
- /** 异步打开可寻址流,保留解码所需的数据源直到 close。 */
68
+ /**
69
+ * Asynchronously open a seekable stream, retaining the data source needed for
70
+ * decoding until close.
71
+ * @zh 异步打开可寻址流,保留解码所需的数据源直到 close。
72
+ * @ja シーク可能なストリームを非同期で開き、
73
+ * デコードに必要なデータソースを close まで保持します。
74
+ * @ko 탐색 가능한 스트림을 비동기로 열고,
75
+ * 디코딩에 필요한 데이터 소스를 close까지 유지합니다.
76
+ */
23
77
  openFromStream(stream: InputStream): Promise<boolean>;
24
- /** 返回流式解码泵最近的错误;未使用解码泵或无错误时为 undefined。 */
78
+ /**
79
+ * Return the latest streaming decoder pump error, or undefined if no pump is
80
+ * used or no error exists.
81
+ * @zh 返回流式解码泵最近的错误;未使用解码泵或无错误时为 undefined。
82
+ * @ja ストリーミングデコードポンプの最新エラーを返します。
83
+ * ポンプを使っていないかエラーがなければ undefined。
84
+ * @ko 스트리밍 디코딩 펌프의 최근 오류를 반환합니다.
85
+ * 펌프를 사용하지 않거나 오류가 없으면 undefined입니다.
86
+ */
25
87
  getWorkerError(): Error | undefined;
26
- /** 返回流式解码队列统计;未使用解码泵时为 undefined。 */
88
+ /**
89
+ * Return streaming decoder queue statistics, or undefined if no pump is used.
90
+ * @zh 返回流式解码队列统计;未使用解码泵时为 undefined。
91
+ * @ja ストリーミングデコードキューの統計を返します。ポンプ未使用なら undefined。
92
+ * @ko 스트리밍 디코딩 큐 통계를 반환합니다. 디코딩 펌프를 사용하지 않으면 undefined입니다.
93
+ */
27
94
  getWorkerStats(): AudioWorkerStats | undefined;
28
95
  /**
29
- * 停止播放并异步关闭解码数据源。
96
+ * Stop playback and asynchronously close the decoding data source.
97
+ * Inside this object's own audio callback, only request closure; actual
98
+ * cleanup completes after that callback ends.
99
+ * @zh 停止播放并异步关闭解码数据源。
30
100
  * 在自身音频回调内调用时只请求关闭;实际清理于该回调结束后完成。
101
+ * @ja 再生を停止し、デコード用データソースを非同期で閉じます。
102
+ * 自身の音声コールバック内では終了を要求するだけで、
103
+ * 実際のクリーンアップはそのコールバック終了後に完了します。
104
+ * @ko 재생을 중지하고 디코딩 데이터 소스를 비동기로 닫습니다.
105
+ * 자신의 오디오 콜백 내에서는 닫기만 요청하며,
106
+ * 실제 정리는 해당 콜백이 끝난 후 완료됩니다.
31
107
  */
32
108
  close(): Promise<void>;
33
- /** 返回音乐总时长。 */
109
+ /**
110
+ * Return the total music duration.
111
+ * @zh 返回音乐总时长。
112
+ * @ja 音楽全体の長さを返します。
113
+ * @ko 음악의 전체 길이를 반환합니다.
114
+ */
34
115
  getDuration(): Time;
35
- /** 返回循环区间副本,包含起点偏移和长度。 */
116
+ /**
117
+ * Return a copy of the loop region, including its starting offset and length.
118
+ * @zh 返回循环区间副本,包含起点偏移和长度。
119
+ * @ja 開始オフセットと長さを含むループ区間のコピーを返します。
120
+ * @ko 시작 오프셋과 길이를 포함한 반복 구간 복사본을 반환합니다.
121
+ */
36
122
  getLoopPoints(): TimeSpan;
37
- /** 设置循环区间;启用循环需另行调用 setLooping(true)。 */
123
+ /**
124
+ * Set the loop region; call setLooping(true) separately to enable looping.
125
+ * @zh 设置循环区间;启用循环需另行调用 setLooping(true)。
126
+ * @ja ループ区間を設定します。有効にするには別途 setLooping(true) を呼びます。
127
+ * @ko 반복 구간을 설정합니다. 반복 활성화는 별도로 setLooping(true)를 호출해야 합니다.
128
+ */
38
129
  setLoopPoints(value: Readonly<TimeSpanInput>): void;
39
130
  /**
40
- * 在对象所属 JS 线程填充交错 16 位 PCM;await super 可读取当前文件。
131
+ * Fill interleaved 16-bit PCM on the object's owning JS thread; await super
132
+ * to read the current file. samples references a reusable native slot, valid
133
+ * only until the callback ends; false denotes the final block.
134
+ * @zh 在对象所属 JS 线程填充交错 16 位 PCM;await super 可读取当前文件。
41
135
  * samples 指向原生可复用槽,仅在回调结束前有效;false 表示末块。
136
+ * @ja オブジェクトの所属 JS スレッドで 16 ビットインターリーブ PCM を埋めます。
137
+ * await super で現在のファイルを読み取れます。samples は再利用可能な
138
+ * ネイティブスロットを参照し、コールバック終了までのみ有効です。
139
+ * false は最終ブロックを示します。
140
+ * @ko 객체가 속한 JS 스레드에서 16비트 인터리브 PCM을 채웁니다.
141
+ * await super로 현재 파일을 읽을 수 있습니다. samples는 재사용 가능한
142
+ * 네이티브 슬롯을 참조하며 콜백 종료 전까지만 유효합니다. false는 마지막 블록입니다.
42
143
  */
43
144
  protected onGetData(chunk: SoundStreamChunk): boolean | Promise<boolean>;
44
- /** 在对象所属 JS 线程定位;await super 执行当前文件的默认定位。 */
145
+ /**
146
+ * Seek on the object's owning JS thread; await super performs the current
147
+ * file's default seek.
148
+ * @zh 在对象所属 JS 线程定位;await super 执行当前文件的默认定位。
149
+ * @ja オブジェクトの所属 JS スレッドでシークします。
150
+ * await super で現在のファイルの既定のシークを実行します。
151
+ * @ko 객체가 속한 JS 스레드에서 탐색합니다.
152
+ * await super는 현재 파일의 기본 탐색을 수행합니다.
153
+ */
45
154
  protected onSeek(offset: Time): void | Promise<void>;
46
155
  /**
47
- * 在对象所属 JS 线程准备末块时调用,返回下一轮交错样本偏移。
156
+ * Called on the object's owning JS thread while preparing the final block;
157
+ * return the next loop's interleaved sample offset. super returns the file's
158
+ * loop region or EOF position; undefined means no loop. The audio consumer
159
+ * thread initiates the actual seek, then asynchronously delegates to onSeek.
160
+ * @zh 在对象所属 JS 线程准备末块时调用,返回下一轮交错样本偏移。
48
161
  * super 返回文件循环区间或 EOF 的位置;undefined 表示不循环。
49
162
  * 实际定位由音频消费线程发起,再异步交给 onSeek。
163
+ * @ja 最終ブロックの準備中にオブジェクトの所属 JS スレッドで呼ばれ、
164
+ * 次のループのインターリーブサンプルオフセットを返します。super は
165
+ * ファイルのループ区間または EOF の位置を返し、undefined はループなしを表します。
166
+ * 実際のシークは音声消費スレッドが開始し、非同期で onSeek に委譲します。
167
+ * @ko 마지막 블록 준비 중 객체가 속한 JS 스레드에서 호출되며
168
+ * 다음 반복의 인터리브 샘플 오프셋을 반환합니다. super는 파일의 반복 구간
169
+ * 또는 EOF 위치를 반환하며 undefined는 반복하지 않음을 뜻합니다.
170
+ * 실제 탐색은 오디오 소비 스레드가 시작한 후 비동기로 onSeek에 넘깁니다.
50
171
  */
51
172
  protected onLoop(): bigint | undefined | Promise<bigint | undefined>;
52
- /** 获取当前回调所属的会话,避免 await 后误写新打开的音乐。 */
173
+ /**
174
+ * Get the current callback's session to avoid writing to newly opened music
175
+ * after await.
176
+ * @zh 获取当前回调所属的会话,避免 await 后误写新打开的音乐。
177
+ * @ja 現在のコールバックのセッションを取得し、
178
+ * await 後に新しく開いた音楽へ誤って書き込むのを防ぎます。
179
+ * @ko 현재 콜백이 속한 세션을 가져와 await 후 새로 열린 음악에
180
+ * 잘못 기록하는 것을 방지합니다.
181
+ */
53
182
  private callbackPump;
54
- /** 仅在子类覆写回调时安装弱引用派发器,保留普通实例 Native 路径。 */
183
+ /**
184
+ * Install weak-reference dispatchers only for subclass callback overrides,
185
+ * preserving the native path for ordinary instances.
186
+ * @zh 仅在子类覆写回调时安装弱引用派发器,保留普通实例 Native 路径。
187
+ * @ja サブクラスがコールバックをオーバーライドした場合のみ弱参照の
188
+ * ディスパッチャーを設定し、通常のインスタンスの Native 経路を維持します。
189
+ * @ko 하위 클래스가 콜백을 재정의할 때만 약한 참조 디스패처를 설치하여
190
+ * 일반 인스턴스의 Native 경로를 유지합니다.
191
+ */
55
192
  private createCallbacks;
56
- /** 脱离当前会话并等待 Native 队列和文件清理。 */
193
+ /**
194
+ * Detach the current session and await native queue and file cleanup.
195
+ * @zh 脱离当前会话并等待 Native 队列和文件清理。
196
+ * @ja 現在のセッションを切り離し、Native キューとファイルの後処理を待ちます。
197
+ * @ko 현재 세션을 분리하고 Native 큐와 파일 정리를 기다립니다.
198
+ */
57
199
  private closePump;
58
- /** 打开新文件;会话回调中拒绝重开,避免等待其自身的准备阶段。 */
200
+ /**
201
+ * Open a new file; reject reopening inside session callbacks to avoid waiting
202
+ * for their own preparation phase.
203
+ * @zh 打开新文件;会话回调中拒绝重开,避免等待其自身的准备阶段。
204
+ * @ja 新しいファイルを開きます。自身の準備段階を待たないよう、
205
+ * セッションコールバック内での再オープンは拒否します。
206
+ * @ko 새 파일을 엽니다. 자신의 준비 단계를 기다리지 않도록
207
+ * 세션 콜백 내에서 다시 여는 요청은 거부합니다.
208
+ */
59
209
  private open;
60
210
  }