1023455 - Documentation for Web Audio Editor

Status: RESOLVED FIXED

(Developer Documentation Graveyard :: Developer Tools, defect)

Description

[Jordan Santell [:jsantell] [@jsantell]]

Web Audio Editor needs documentation, preferably by June 17th, to coincide with the release hacks post.
https://developer.mozilla.org/en-US/docs/Tools

Comment 1

[Will Bamberg [:wbamberg]]

Jordan: https://developer.mozilla.org/en-US/docs/Tools/Web_Audio_Editor. Let me know if I'm missing anything important or have anything wrong. If you have a screencast I'd love to add it.

Comment 2

[Jordan Santell [:jsantell] [@jsantell]]

No screencast (yet), but these docs are looking great!

Comment 3

[Jordan Santell [:jsantell] [@jsantell]]

Added a note on the params that are displayed:

"Each node has zero or more AudioParam properties that configure its operation. For example, the GainNode has a single gain property, while the OscillatorNode has frequency and detune properties. Some non-AudioParam properties are sometimes displayed, like an OscillatorNode's type property, and can be configured in the node inspector panel."

Most properties that are displayed are AudioParam properties (which modifying, edits their `value` prop), but in some cases, non AudioParam's are displayed, like a BufferAudioSourceNode's `buffer` property or an OscillatorNode's `type` property, which are just primitives, not representations of an AudioParam. For better or worse, the editor normalizes these two different types of props.

Comment 4

[Will Bamberg [:wbamberg]]

Thanks for the clarification on that. I'm closing this bug, though I might update the page with anything from the blog post that looks tasty.