p5.sound.js icon indicating copy to clipboard operation
p5.sound.js copied to clipboard

Add example sketches for all p5.AudioIn methods in p5.Sound reference

Open perminder-17 opened this issue 6 months ago • 3 comments

Increasing Access

The p5.Sound reference pages currently lack live examples. This issue is specifically for the p5.AudioIn class. Without examples, it’s hard for users to see how each method behaves in a sketch.

Add one or more simple example sketches demonstrating each of the following p5.AudioIn methods:

  • [ ] amp()
  • [ ] amplitude
  • [ ] connect()
  • [ ] currentSource
  • [ ] disconnect
  • [ ] enabled
  • [ ] getSources()
  • [ ] input()
  • [ ] mediaStream
  • [ ] output
  • [ ] setSource()
  • [ ] start()
  • [ ] stop()
  • [ ] stream

Feel free to add one example or multiple examples for any of these methods and submit a PR.

Most appropriate sub-area of p5.js?

Reference

Feature request details

A pull request that updates the p5.sound reference documentation with at least one working code example per method, so that users can immediately copy, paste, and run each sketch to learn how p5.AudioIn works.

perminder-17 avatar Jul 14 '25 00:07 perminder-17

Hi @davepagurek, @perminder-17 I’d like to work on this issue — could you please assign it to me?

Nitin2332 avatar Sep 24 '25 16:09 Nitin2332

yes, feel free to work on this. Go ahead!

perminder-17 avatar Sep 24 '25 17:09 perminder-17

Most of the methods unique to AudioIn() are documented in the main example found here: https://beta.p5js.org/reference/p5.sound/p5.audioin/

Some of the methods listed in the above list are only found in the original library

ogbabydiesal avatar Oct 26 '25 18:10 ogbabydiesal

I don't think there's any update from Nitin, I am starting to work on it, and I will raise a PR at the earliest.

kunstewi avatar Dec 14 '25 10:12 kunstewi