17344 2012-06-05 11:36:45 +0000 (NoteOnOffNaming): noteOn, noteGrainOn and noteOff naming 2012-10-12 07:55:44 +0000 1 1 1 Unclassified AudioWG Web Audio API unspecified PC All CLOSED FIXED P2 normal TBD 1 philipj crogers cwilso joe olivier.thereaux public-audio dave.null oldest_to_newest 68655 0 philipj 2012-06-05 11:36:45 +0000 Audio-ISSUE-52 (NoteOnOffNaming): noteOn, noteGrainOn and noteOff naming [Web Audio API] http://www.w3.org/2011/audio/track/issues/52 Raised by: Philip Jägenstedt On product: Web Audio API The naming convention is unfortunate as the connection to a note is not clear. For a game sound effects or UI sound effects, this terminology is fairly obscure. The noteGrainOn grainDuration parameter does not seem to serve any purpose given that noteOff also exists. Suggested simplification: void play(optional double when, optional double offset, optional double duration); void stop(optional double when); Note that the special meaning of 0 in note* is not needed if the arguments are optional. 68840 1 olivier.thereaux 2012-06-07 16:01:26 +0000 Comment from Chris Rogers, 18 May 2012: Agreed that the names are unfortunate, also because "note-on" and "note-off" have specific connotations in MIDI which are not the same as in this spec. So it will be a good idea to change the names. We have already discussed in the tele-conferences (and in much earlier discussions in the mailing list) that start() and stop() would be good names. I still believe the "duration" is useful, but we can discuss further. I'm OK with making special meaning of 0 go away --- it used to be this way, but for some reason somebody changed it in WebKit 71706 2 joe 2012-07-31 10:46:28 +0000 *** Bug 18442 has been marked as a duplicate of this bug. *** 72533 3 olivier.thereaux 2012-08-22 15:21:23 +0000 (In reply to comment #1) > Comment from Chris Rogers, 18 May 2012: > We have already discussed in the tele-conferences (and in much earlier > discussions in the mailing list) that start() and stop() would be good names. Teleconference discussion minuted here: http://www.w3.org/2012/05/02-audio-minutes.html#item02 72597 4 olivier.thereaux 2012-08-23 09:42:55 +0000 We reached a proposed resolution on this during the teleconference on 22nd August 2012: http://www.w3.org/2012/08/22-audio-minutes#item02 * noteOn/noteOff will be renamed to start/stop * The old name will be mentioned in an informational section in the web audio spec * The Webkit implementation is likely to keep supporting the old names * Other upcoming implementations are not encouraged to support the old names I am switching the issue as ASSIGNED (to the editor), will close once changes have been made in the spec. 72622 5 cwilso 2012-08-23 17:36:26 +0000 I didn't notice any comment in the notes or this bug about renaming noteGrainOn as well. I presume this should be renamed to startGrain()? 73537 6 olivier.thereaux 2012-09-10 10:32:12 +0000 (In reply to comment #5) > I didn't notice any comment in the notes or this bug about renaming noteGrainOn > as well. I presume this should be renamed to startGrain()? Don't recall us talking about noteGrainOn indeed, but startGrain() does sound consistent with the other changes. I might set aside a couple of minutes during our call this week to get a quick show of hands about it, then we can wrap up this re-naming issue. 73752 7 olivier.thereaux 2012-09-13 09:35:00 +0000 (In reply to comment #5) > I didn't notice any comment in the notes or this bug about renaming noteGrainOn > as well. I presume this should be renamed to startGrain()? As discussed on the 12th September teleconference, the suggestion is to not have a separate method for this, but instead to overload the start() method with extra parameters. 74765 8 olivier.thereaux 2012-09-28 09:35:15 +0000 Resolved per http://dvcs.w3.org/hg/audio/rev/aea45daa1200 Note that the old names have been added to an informational section. 76067 9 olivier.thereaux 2012-10-12 07:55:44 +0000 No objection after close to 2 weeks. Closing.