Skip to content

rename masterVolume to outputVolume#610

Merged
therewasaguy merged 3 commits intomainfrom
therewasaguy/output-volume
May 26, 2021
Merged

rename masterVolume to outputVolume#610
therewasaguy merged 3 commits intomainfrom
therewasaguy/output-volume

Conversation

@therewasaguy
Copy link
Copy Markdown
Member

  • rename masterVolume to outputVolume
  • rename Master class to Main
  • update a bunch of examples, tests and comments to match

and rename Master to Main
Comment thread src/main.js Outdated
* in this sketch.
*
* @method getMasterVolume
* @method outputVolume
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should not it be getOutputVolume

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, thank you @endurance21 ! Just updated

Comment thread src/main.js Outdated
*
* @method getMasterVolume
* @method outputVolume
* @return {Number} Master amplitude (volume) for sound in this sketch.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Master amplitude (volume) should be replaced with
*Main amplitude ( volume) *

Comment thread src/main.js
*
* @method masterVolume
* @method outputVolume
* @param {Number|Object} volume Volume (amplitude) between 0.0
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

volume is repeated 2 times

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yep, this is intentional because the first one gets parsed as the name, the second as part of the description by jsdoc
jsdoc name and description

@endurance21 endurance21 self-requested a review April 26, 2021 13:04
@therewasaguy therewasaguy merged commit 17987e7 into main May 26, 2021
@therewasaguy therewasaguy deleted the therewasaguy/output-volume branch May 26, 2021 02:54
therewasaguy added a commit to processing/p5.js that referenced this pull request May 26, 2021
* Fix drywet function bug https://github.com/processing/p5.js-sound/pulls/606
* Fix function name in documentation processing/p5.js-sound#603
* Fix repeat initialization of audioWorklet processing/p5.js-sound#593
* Fix issue with p5.Score that prevented parts from being passed as argument processing/p5.js-sound#543
* Fallback when AudioWorklet buffer array length is zero
 processing/p5.js-sound#542
* Remove extra callbacks for SoundFile cue
 processing/p5.js-sound#449
* Fix abnormal behaviour of audio output in p5.signal example section
  processing/p5.js-sound#476
* Fix error while playing sound through `p5.soundFile.play()` method
 processing/p5.js-sound#542

* Library is re-written in ESM ( ECMASCRIPT MODULES).
* Audio Nodes are written as `Class` style rather than being  written as `function` style.
* Library using features of es6 like `let` , `const` keywords and many other es6+ features.
* Testing architecture has been made more clean and robust.
* All above listed improvements are part of [Divyanshu's](https://github.com/endurance21) GSOC-20 Project , more details can be found in his [wrap-up-post](https://github.com/endurance21/GSOC-20-WrapUp).
* Improvements in pre-commit-hook action  processing/p5.js-sound#574

* Fixed broken anchor tags in p5.Audioln
 processing/p5.js-sound#450
* Fixed typo  in p5.fft documentation
  processing/p5.js-sound#433
* Added documentations for P5.oscillator APIs
 processing/p5.js-sound#420
* Improved documentation of p5.soundloop
  processing/p5.js-sound#437
* Fixed broken links in p5.panner3D documentations
 processing/p5.js-sound#465
* Typo improvements in p5.soundloop reference
 processing/p5.js-sound#557

* renames: outputVolume method and Main class processing/p5.js-sound#610

We have deprecated functionality in an effort to focus the API
* p5.Signal
* p5.SoundFile.processPeaks
therewasaguy added a commit to processing/p5.js that referenced this pull request May 26, 2021
Bug Fixes
* Fix drywet function bug https://github.com/processing/p5.js-sound/pulls/606
* Fix function name in documentation processing/p5.js-sound#603
* Fix repeat initialization of audioWorklet processing/p5.js-sound#593
* Fix issue with p5.Score that prevented parts from being passed as argument processing/p5.js-sound#543
* Fallback when AudioWorklet buffer array length is zero
 processing/p5.js-sound#542
* Remove extra callbacks for SoundFile cue
 processing/p5.js-sound#449
* Fix abnormal behaviour of audio output in p5.signal example section
  processing/p5.js-sound#476
* Fix error while playing sound through `p5.soundFile.play()` method
 processing/p5.js-sound#542

Intrastructure Improvements
* Library is re-written in ESM ( ECMASCRIPT MODULES).
* Audio Nodes are written as `Class` style rather than being  written as `function` style.
* Library using features of es6 like `let` , `const` keywords and many other es6+ features.
* Testing architecture has been made more clean and robust.
* All above listed improvements are part of [Divyanshu's](https://github.com/endurance21) GSOC-20 Project , more details can be found in his [wrap-up-post](https://github.com/endurance21/GSOC-20-WrapUp).
* Improvements in pre-commit-hook action  processing/p5.js-sound#574

Documentation Fixes
* Fixed broken anchor tags in p5.Audioln
 processing/p5.js-sound#450
* Fixed typo  in p5.fft documentation
  processing/p5.js-sound#433
* Added documentations for P5.oscillator APIs
 processing/p5.js-sound#420
* Improved documentation of p5.soundloop
  processing/p5.js-sound#437
* Fixed broken links in p5.panner3D documentations
 processing/p5.js-sound#465
* Typo improvements in p5.soundloop reference
 processing/p5.js-sound#557

Deprecations and Renames
* renames: outputVolume method and Main class processing/p5.js-sound#610
* We have deprecated functionality in an effort to focus the API
  * p5.Signal
  * p5.SoundFile.processPeaks
@therewasaguy therewasaguy mentioned this pull request May 26, 2021
3 tasks
therewasaguy added a commit to processing/p5.js that referenced this pull request May 26, 2021
Bug Fixes
* Fix drywet function bug https://github.com/processing/p5.js-sound/pulls/606
* Fix function name in documentation processing/p5.js-sound#603
* Fix repeat initialization of audioWorklet processing/p5.js-sound#593
* Fix issue with p5.Score that prevented parts from being passed as argument processing/p5.js-sound#543
* Fallback when AudioWorklet buffer array length is zero
 processing/p5.js-sound#542
* Remove extra callbacks for SoundFile cue
 processing/p5.js-sound#449
* Fix abnormal behaviour of audio output in p5.signal example section
  processing/p5.js-sound#476
* Fix error while playing sound through `p5.soundFile.play()` method
 processing/p5.js-sound#542
* Bring back p5.PeakDetect which was missing in 1.0.0

Intrastructure Improvements
* Library is re-written in ESM ( ECMASCRIPT MODULES).
* Audio Nodes are written as `Class` style rather than being  written as `function` style.
* Library using features of es6 like `let` , `const` keywords and many other es6+ features.
* Testing architecture has been made more clean and robust.
* All above listed improvements are part of [Divyanshu's](https://github.com/endurance21) GSOC-20 Project , more details can be found in his [wrap-up-post](https://github.com/endurance21/GSOC-20-WrapUp).
* Improvements in pre-commit-hook action  processing/p5.js-sound#574

Documentation Fixes
* Fixed broken anchor tags in p5.Audioln
 processing/p5.js-sound#450
* Fixed typo  in p5.fft documentation
  processing/p5.js-sound#433
* Added documentations for P5.oscillator APIs
 processing/p5.js-sound#420
* Improved documentation of p5.soundloop
  processing/p5.js-sound#437
* Fixed broken links in p5.panner3D documentations
 processing/p5.js-sound#465
* Typo improvements in p5.soundloop reference
 processing/p5.js-sound#557

Deprecations and Renames
* renames: outputVolume method and Main class processing/p5.js-sound#610
* We have deprecated functionality in an effort to focus the API
  * p5.Signal
  * p5.SoundFile.processPeaks
therewasaguy added a commit to processing/p5.js that referenced this pull request May 30, 2021
Bug Fixes
* Fix drywet function bug https://github.com/processing/p5.js-sound/pulls/606
* Fix function name in documentation processing/p5.js-sound#603
* Fix repeat initialization of audioWorklet processing/p5.js-sound#593
* Fix issue with p5.Score that prevented parts from being passed as argument processing/p5.js-sound#543
* Fallback when AudioWorklet buffer array length is zero
 processing/p5.js-sound#542
* Remove extra callbacks for SoundFile cue
 processing/p5.js-sound#449
* Fix abnormal behaviour of audio output in p5.signal example section
  processing/p5.js-sound#476
* Fix error while playing sound through `p5.soundFile.play()` method
 processing/p5.js-sound#542
* Bring back p5.PeakDetect which was missing in 1.0.0

Intrastructure Improvements
* Library is re-written in ESM ( ECMASCRIPT MODULES).
* Audio Nodes are written as `Class` style rather than being  written as `function` style.
* Library using features of es6 like `let` , `const` keywords and many other es6+ features.
* Testing architecture has been made more clean and robust.
* All above listed improvements are part of [Divyanshu's](https://github.com/endurance21) GSOC-20 Project , more details can be found in his [wrap-up-post](https://github.com/endurance21/GSOC-20-WrapUp).
* Improvements in pre-commit-hook action  processing/p5.js-sound#574

Documentation Fixes
* Fixed broken anchor tags in p5.Audioln
 processing/p5.js-sound#450
* Fixed typo  in p5.fft documentation
  processing/p5.js-sound#433
* Added documentations for P5.oscillator APIs
 processing/p5.js-sound#420
* Improved documentation of p5.soundloop
  processing/p5.js-sound#437
* Fixed broken links in p5.panner3D documentations
 processing/p5.js-sound#465
* Typo improvements in p5.soundloop reference
 processing/p5.js-sound#557

Deprecations and Renames
* renames: outputVolume method and Main class processing/p5.js-sound#610
* We have deprecated functionality in an effort to focus the API
  * p5.Signal
  * p5.SoundFile.processPeaks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants