1311079 - AudioListener and PannerNode example section is out-of-date

Status: RESOLVED FIXED

(Developer Documentation Graveyard :: API: Web Audio, defect, P5)

Description

[Artem Lvov]

:: Developer Documentation Request

      Request Type: Correction
     Gecko Version: unspecified
 Technical Contact: ARRAY(0x7fc034a30090)

:: Details

The example section on https://developer.mozilla.org/en-US/docs/Web/API/AudioContext/createPanner page (which is also used on some other pages related to `AudioListener` and `PannerNode`) has a link to the Github repo with a demo (https://github.com/mdn/panner-node) that uses some deprecated methods and attributes including `setOrientation`, `setPosition`, `setVelocity`, `dopplerFactor ` and `speedOfSound` (there's a more detailed description here https://github.com/mdn/panner-node/issues/1). I guess they should be at least marked as deprecated (like some of them are already) or at most the newer api should be used.

Also as mentioned here https://bugzilla.mozilla.org/show_bug.cgi?id=1267598 the example code contains `orientationX`, `orientationY` and `orientationZ` attributes of the `listener` (lines 20-22), though it should be `forwardX`, `forwardY` and `forwardZ` to follow the latest version of the spec (https://webaudio.github.io/web-audio-api/#widl-AudioListener-forwardX).

Thanks.

Comment 1

[Eric Shepherd [:sheppy]]

:cmills - do you want to take this, or shall I? You wrote this stuff; I've done some updates recently but you're still probably more familiar with it than I am.

Comment 2

[Chris Mills [:cmills]]

I can do this, yes. Sorry for the delay in responding to it.

Comment 3

[Artem Lvov]

Thanks a lot! Is there any way I could possibly help?

Comment 4

[Chris Mills [:cmills]]

(In reply to art.s.lvov from comment #3)
> Thanks a lot! Is there any way I could possibly help?

It would be great if you could review my work after I've done it, to make sure I've got these changes correct.

I'm currently compiling a list of changes that our WAA docs need! ;-)

Comment 5

[Artem Lvov]

(In reply to Chris Mills (Mozilla, MDN editor) [:cmills] from comment #4)
> (In reply to art.s.lvov from comment #3)
> > Thanks a lot! Is there any way I could possibly help?
> 
> It would be great if you could review my work after I've done it, to make
> sure I've got these changes correct.
> 
> I'm currently compiling a list of changes that our WAA docs need! ;-)

Wow, that sounds huge. Ok, I'll try my best )

Comment 6

[Chris Mills [:cmills]]

(In reply to art.s.lvov from comment #5)
> (In reply to Chris Mills (Mozilla, MDN editor) [:cmills] from comment #4)
> > (In reply to art.s.lvov from comment #3)
> > > Thanks a lot! Is there any way I could possibly help?
> > 
> > It would be great if you could review my work after I've done it, to make
> > sure I've got these changes correct.
> > 
> > I'm currently compiling a list of changes that our WAA docs need! ;-)
> 
> Wow, that sounds huge. Ok, I'll try my best )

There's thankfully less than you might think. My awesome colleagues have already made some of the changes too, which helps a lot.

Comment 7

[Chris Mills [:cmills]]

OK, I've updated the docs. First of all, see

https://developer.mozilla.org/en-US/docs/Web/API/AudioContext/createPanner

for the example changes.

I've also filled pages for the new properties on

https://developer.mozilla.org/en-US/docs/Web/API/AudioListener

And added a constructor for AudioPanner:

https://developer.mozilla.org/en-US/docs/Web/API/PannerNode/PannerNode

Comment 8

[Artem Lvov]

:cmills thanks for the update!
I also noticed that the default values for forwardZ and upY were wrong here https://developer.mozilla.org/en-US/docs/Web/API/AudioListener, so I fixed them (from 0's to -1 and 1 relatively): https://developer.mozilla.org/en-US/docs/Web/API/AudioListener$compare?locale=en-US&to=1139409&from=1137163.
Please let me know if I've done that wrong :|

Comment 9

[Chris Mills [:cmills]]

(In reply to Artem Lvov from comment #8)
> :cmills thanks for the update!
> I also noticed that the default values for forwardZ and upY were wrong here
> https://developer.mozilla.org/en-US/docs/Web/API/AudioListener, so I fixed
> them (from 0's to -1 and 1 relatively):
> https://developer.mozilla.org/en-US/docs/Web/API/
> AudioListener$compare?locale=en-US&to=1139409&from=1137163.
> Please let me know if I've done that wrong :|

You've done this just fine; thanks for catching those!