Docs/audiodocs cleanup#1156
Open
SomePersonFromMars wants to merge 18 commits into
Open
Conversation
…ger documentation
…gNotificationManager docs
…tion Managers and other cleanup
Affected AnalyserNode docs and CLAUDE instructions.
* AudioDestinationNode documentation is now more robust. * Add AudioNodeInheritedSection for shared AudioNode tables code, * also add new AudioNodeMethodsTable, * and update AudioNodePropsTable for more clarity.
…ocumentation * Introduced a new OscillatorWavesChart component to visualize oscillator waveforms. * Replaced static image in oscillator-type documentation with the new chart component for better interactivity and clarity. * Added CSS styles for the new chart component and defined color variables for different wave types in colors.css. * Removed the outdated oscillator-waves.png image.
mdydek
requested changes
Jul 9, 2026
|
|
||
| Audio graph rendering is done in blocks of sample-frames. The number of sample-frames in a block is called render quantum size, and the block itself is called a render quantum. | ||
| By default render quantum size value is 128 and it is constant. | ||
| By default render quantum size value is `128` and it is constant. |
Collaborator
There was a problem hiding this comment.
Suggested change
| By default render quantum size value is `128` and it is constant. | |
| By default render quantum size value is `128` and it is a constant. |
|
|
||
| Inherits all methods from [`AudioNode`](/docs/core/audio-node#methods). | ||
|
|
||
| <AudioNodeMethodsTable /> |
Collaborator
There was a problem hiding this comment.
if you have this component created, you can use it in all the places, you are mentioning that "node inherits all methods from audioNode"
Comment on lines
-56
to
-59
| :::info | ||
| For more details, go to [android developer page](https://developer.android.com/develop/ui/views/notifications#Templates). | ||
| Resource name is a path to resource plased in res/drawable folder. It has to be either .png file or .xml file, name is indicated without file extenstion. (photo.png -> photo). | ||
| ::: |
Collaborator
There was a problem hiding this comment.
I think info block can be left here
| ### `decodeAudioData` | ||
|
|
||
| Decodes audio data from either a file path or an ArrayBuffer. The optional `sampleRate` parameter lets you resample the decoded audio; | ||
| Decodes audio data from either a file path or an [`ArrayBuffer`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer). The optional `sampleRate` parameter lets you resample the decoded audio; |
Collaborator
There was a problem hiding this comment.
I get it that it was previously like that, but current implementation decodes also from app assets, so its worth mentioning it
mdydek
requested changes
Jul 9, 2026
Comment on lines
157
to
+162
| | Parameter | Type | Description | | ||
| |-----------|------|-------------| | ||
| | `base64String` | `string` | Base64-encoded PCM audio data. | | ||
| | `inputSampleRate` | `number` | Sample rate of the input PCM data. | | ||
| | `inputChannelCount` | `number` | Number of channels in the input PCM data. | | ||
| | `isInterleaved` <Optional />| `boolean` | Whether the PCM data is interleaved. Default is `true`. | | ||
| | `isInterleaved` <Optional />| `boolean` | Whether the PCM data is interleaved. Defaults to `true`. | |
Collaborator
There was a problem hiding this comment.
here it is rendered differently than upper tables, which makes default behavior different, one is centering text and the other not, unify it
Use AudioNodePropsTable and AudioNodeMethodsTable on all pages that extend AudioNode directly, fill gaps on IIRFilterNode and worklet nodes, and update audiodocs/CLAUDE.md and the flow skill template accordingly.
- Left-align description/value columns and center name/type columns in AudioNodePropsTable and AudioNodeMethodsTable - Wrap notification-manager resource note in an info admonition - Minor decoding.mdx table alignment and wording fixes - Rename AudioDecoder.resolveStringSource -> resolveToStringSource and tighten its return type
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Closes RNAA-483
Introduced changes
AudioNodeInheritedSection,AudioNodeMethodsTable, enhancedAudioNodePropsTable) to reduce duplication and keep node pages uniform.OscillatorWavesChartcomponent and refreshed related type documentation.Checklist