node-web-audio-api 1.0.0 → 1.0.1

package/CHANGELOG.md

@@ -1,8 +1,12 @@
 # CHANGELOG
 
-## v1.0.0 (11/01/2024)
+## v1.0.1 (17/01/2025)
 
-- Align version with upsteam crate
+- Update upstream crate to [v1.2.0](https://github.com/orottier/web-audio-api-rs/blob/main/CHANGELOG.md#version-120-2025-01-16)
+
+## v1.0.0 (11/01/2025)
+
+- Align version with upstream crate
 - Refactor CI
 
 ## v0.21.5 (23/12/2024)
@@ -62,7 +66,7 @@
 
 - Update upstream create to [v0.42.0](https://github.com/orottier/web-audio-api-rs/blob/main/CHANGELOG.md#version-0420-2024-02-05)
 - Improve Error handling
-- Add channelCounnt to media constraints
+- Add channelCount to media constraints
 
 ## v0.15.0 (16/01/2024)
 
@@ -102,7 +106,7 @@
 
 ## v0.8.0 (19/05/2023)
 
-- Implement MediaDevices enumerateDeviaces and getUserMedia
+- Implement MediaDevices enumerateDevices and getUserMedia
 - Use jack as default output if exists on linux
 
 ## v0.7.0 (23/02/2023)

package/README.md

@@ -60,24 +60,36 @@ npm run build
 
 3. Run the examples from the project's root directory
 ```sh
-node examples/granular-scrub.mjs
+node examples/granular-scrub.js
 ```
 
 ## Caveats
 
+- `AudioBuffer#getChannelData` is implemented but not reliable in some situations. Your should prefer `AudioBuffer#copyToChannel` and `AudioBuffer#copyFromChannel` when you want to access or manipulate the underlying samples in a safe way.
 - `Streams`: only a minimal audio input stream and the `MediaStreamSourceNode` are provided. All other `MediaStream` features are left on the side for now as they principally concern a different API specification, which is not a trivial problem.
 
-## Supported Platforms
+## Supported Platforms - Prebuilt Binaries
+
+We provide prebuilt binaries for the following platforms:
+
+|                                                     | binaries |
+|-----------------------------------------------------|:--------:|
+| Windows x64                                         | ✓        |
+| Windows arm64                                       | ✓        |
+| macOS x64                                           | ✓        |
+| macOS aarch64                                       | ✓        |
+| Linux x64 gnu (jack / pipewire-jack)                | ✓        |
+| Linux arm gnueabihf (jack / pipewire-jack)          | ✓        |
+| Linux arm64 gnu     (jack / pipewire-jack)          | ✓        |
+
+
+
+### Important notes
+
+- If you need support for another platform, please fill an [issue](https://github.com/ircam-ismm/node-web-audio-api/issues) and we will see what we can do.
+
+- All provided Linux binaries are built with the `jack` flag, which should work either with properly configured [Jack](https://jackaudio.org/) or [pipewire-jack](https://pipewire.org/) backends. If this is a limitation for you, please fill an [issue](https://github.com/ircam-ismm/node-web-audio-api/issues) and we will see what we can do.
 
-|                              | binaries | tested |
-| ---------------------------  | ------   | ------ |
-| Windows x64                  | ✓        |        |
-| Windows arm64                | ✓        |        |
-| macOS x64                    | ✓        | ✓      |
-| macOS aarch64                | ✓        | ✓      |
-| Linux x64 gnu                | ✓        |        |
-| Linux arm gnueabihf (RPi)    | ✓        | ✓      |
-| Linux arm64 gnu (RPi)        | ✓        | ✓      |
 
 ## Manual Build
 
@@ -161,7 +173,7 @@ Then run:
 npm run wpt                      # build in debug mode and run all wpt test
 npm run wpt:only                 # run all wpt test without build
 npm run wpt -- --list            # list all wpt test files
-npm run wpt -- --filter <string> # apply <string> filter on executed/listed wpt tests 
+npm run wpt -- --filter <string> # apply <string> filter on executed/listed wpt tests
 ```
 
 ## License

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-web-audio-api",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "author": "Benjamin Matuszewski",
   "description": "Web Audio API implementation for Node.js",
   "exports": {