Action item 87 Review Web Docs and suggest updates

Hi All,

I have an action (http://www.w3.org/2011/audio/track/actions/87) to review our documentation here http://docs.webplatform.org/wiki/apis/webaudio.

Having made a start with the intention of sharing the findings with the group, I realise that it would be much more productive to actually make the changes and keep a record which can then be reviewed.

If people are happy for me to go ahead (we can discuss on the call tomorrow) then Iíll get it done asap.

In general I am proposing the following:

  *   Each API item has a corresponding reference example.
  *   Add default input/output/channels information for each item as per the spec.
  *   Change href to old spec on each page replace with webaudio.github.io/web-audio-api/

Top level listing
Remove (or mark as deprecated)
WaveTable, ScriptProcessorNode, AudioProcessingEvent
Add
PeriodicWave, AudioWorker, AudioProcessEvent, MediaElementAudioSourceNode, MediaStreamAudioSourceNode, MediaStreamAudioDestinationNode

Per API item

AnalyserNode
Add
getFloatTimeDomainData

AudioBuffer
Add
copyFromChannel, copyToChannel

AudioBufferSourceNode
Add
onEnded
Remove
playbackState

Etc
Etc
Etc

Iíll aim to get to a point were the docs directly reflect the current spec asap.

Let me know if you have any comments.

Best

Matt

--
Matthew Paradis
Senior Software Engineer (Audio),
BBC Research & Development
030304 09889 | matthew.paradis@bbc.co.uk | www.bbc.co.uk/rd/sound

Received on Wednesday, 1 October 2014 16:09:32 UTC