-
Notifications
You must be signed in to change notification settings - Fork 23.1k
docs(Fx138): Add port pages for AudioWorklet and AudioWorkletGlobalScope
#39264
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| --- | ||
| title: "AudioWorklet: port" | ||
| short-title: port | ||
| slug: Web/API/AudioWorklet/port | ||
| page-type: web-api-instance-property | ||
| browser-compat: api.AudioWorklet.port | ||
| --- | ||
|
|
||
| {{APIRef("Web Audio API")}} | ||
|
|
||
| The **`port`** read-only property of the {{domxref("AudioWorklet")}} interface returns a {{domxref("MessagePort")}} object that can be used to send and receive messages between the main thread and the associated {{domxref("AudioWorkletGlobalScope")}}. | ||
|
|
||
| This allows for custom, asynchronous communication between code in the main thread and the global scope of an audio worklet, such as receiving control data or global settings. | ||
|
|
||
| ## Value | ||
|
|
||
| The {{domxref("MessagePort")}} object connecting the `AudioWorklet` and its associated `AudioWorkletGlobalScope`. | ||
|
|
||
| ## Examples | ||
|
|
||
| See [`AudioWorkletNode.port`](/en-US/docs/Web/API/AudioWorkletNode/port#examples) for more examples. | ||
|
|
||
| ### Using a port for global messages | ||
|
|
||
| In the following example, we can use `port.onmessage` to receive data and `port.postMessage` to send data: | ||
|
|
||
| ```js | ||
| const context = new AudioContext(); | ||
| // Load the module that contains worklet code | ||
| await context.audioWorklet.addModule("processor.js"); | ||
|
|
||
| // Listener for messages from AudioWorkletGlobalScope | ||
| context.audioWorklet.port.onmessage = (event) => { | ||
| console.log("Message from global worklet:", event.data); | ||
| }; | ||
|
|
||
| // Set a global config, for example: | ||
| context.audioWorklet.port.postMessage({ | ||
| volume: 0.8, | ||
| }); | ||
| ``` | ||
|
|
||
| ## Specifications | ||
|
|
||
| {{Specifications}} | ||
|
|
||
| ## Browser compatibility | ||
|
|
||
| {{Compat}} | ||
|
|
||
| ## See also | ||
|
|
||
| - {{domxref("AudioWorkletGlobalScope")}} — the global execution context of an `AudioWorklet` | ||
| - [Web Audio API](/en-US/docs/Web/API/Web_Audio_API) | ||
| - [Using the Web Audio API](/en-US/docs/Web/API/Web_Audio_API/Using_Web_Audio_API) | ||
| - [Using AudioWorklet](/en-US/docs/Web/API/Web_Audio_API/Using_AudioWorklet) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| --- | ||
| title: "AudioWorkletGlobalScope: port" | ||
| short-title: port | ||
| slug: Web/API/AudioWorkletGlobalScope/port | ||
| page-type: web-api-instance-property | ||
| spec-urls: https://webaudio.github.io/web-audio-api/#AudioWorkletGlobalScope | ||
| --- | ||
|
|
||
| {{APIRef("Web Audio API")}} | ||
|
|
||
| The **`port`** read-only property of the {{domxref("AudioWorkletGlobalScope")}} interface returns a {{domxref("MessagePort")}} object that can be used to send and receive messages between the main thread and the associated {{domxref("AudioWorklet")}}. | ||
|
|
||
| This allows for custom, asynchronous communication between code in the main thread and the global scope of an audio worklet, such as sending control data or global settings. | ||
|
|
||
| ## Value | ||
|
|
||
| The {{domxref("MessagePort")}} object that is connecting the `AudioWorklet` and its associated `AudioWorkletGlobalScope`. | ||
|
|
||
| ## Examples | ||
|
|
||
| See [`AudioWorkletNode.port`](/en-US/docs/Web/API/AudioWorkletNode/port#examples) for examples. | ||
|
|
||
| ## Specifications | ||
|
|
||
| {{Specifications}} | ||
|
|
||
| ## Browser compatibility | ||
|
|
||
| {{Compat}} | ||
|
|
||
| ## See also | ||
|
|
||
| - [Web Audio API](/en-US/docs/Web/API/Web_Audio_API) | ||
| - [Using the Web Audio API](/en-US/docs/Web/API/Web_Audio_API/Using_Web_Audio_API) | ||
| - [Using AudioWorklet](/en-US/docs/Web/API/Web_Audio_API/Using_AudioWorklet) |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.