Skip to content

Commit 04a3c79

Browse files
committed
resolved minor typos and text capitalization
Signed-off-by: Abhijay Jain <[email protected]>
1 parent 246fd15 commit 04a3c79

File tree

1 file changed

+7
-20
lines changed

1 file changed

+7
-20
lines changed

src/audioin.js

Lines changed: 7 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -51,59 +51,46 @@ p5sound.inputSources = [];
5151
class AudioIn {
5252
constructor(errorCallback) {
5353
/**
54-
* set up audio input
55-
*
54+
* Set up audio input
5655
* @property {GainNode} input
5756
*/
5857
this.input = p5sound.audiocontext.createGain();
59-
6058
/**
61-
* send audio as an output, i.e. your computer's speaker.
62-
*
59+
* Send audio as an output, i.e. your computer's speaker.
6360
* @property {GainNode} output
6461
*/
6562
this.output = p5sound.audiocontext.createGain();
66-
6763
/**
68-
* used to store the MediaStream object that is returned from the getUserMedia() API,
64+
* Used to store the MediaStream object that is returned from the getUserMedia() API,
6965
* which allows access to the user's microphone. The stream is used to create a MediaStreamAudioSourceNode,
7066
* which is used as the audio source for the input and output gain nodes.
7167
* The stream is also used to check if the browser supports the MediaStreamTrack and mediaDevices API,
7268
* and if not, an errorCallback function is called or an alert is displayed.
73-
*
7469
* @property {MediaStream|null} stream
7570
*/
7671
this.stream = null;
77-
7872
/**
79-
* used to access the "audio input" from the user's microphone.
73+
* Used to access the "audio input" from the user's microphone.
8074
* It creates a MediaStream object that can be used to start and stop the mic and measure its volume using the getLevel() method or by connecting it to an FFT object.
8175
* MediaStream object can also be use to check if the browser supports MediaStreamTrack and mediaDevices and to add the AudioIn object to the soundArray for disposal on close.
82-
*
8376
* @property {MediaStreamAudioSourceNode|null} mediaStream
8477
*/
8578
this.mediaStream = null;
86-
8779
/**
88-
* use to store the "current source of audio input", such as the user's microphone.
89-
* initially set to "null" and can be updated as the user selects different audio sources.
90-
* also used in conjunction with the "input" and "mediaStream" properties to control audio input.
91-
*
80+
* Used to store the "current source of audio input", such as the user's microphone.
81+
* Initially set to "null" and can be updated as the user selects different audio sources.
82+
* Also used in conjunction with the "input" and "mediaStream" properties to control audio input.
9283
* @property {Number|null} currentSource
9384
*/
9485
this.currentSource = null;
95-
9686
/**
9787
* Client must allow browser to access their microphone / audioin source.
9888
* Default: false. Will become true when the client enables access.
99-
*
10089
* @property {Boolean} enabled
10190
*/
10291
this.enabled = false;
103-
10492
/**
10593
* Input amplitude, connect to it by default but not to master out
106-
*
10794
* @property {p5.Amplitude} amplitude
10895
*/
10996
this.amplitude = new Amplitude();

0 commit comments

Comments
 (0)