renaming analyze to scope and documenting
This commit is contained in:
@ -110,7 +110,7 @@ export class SoundEvent extends AudibleEvent {
|
||||
self.updateValue("release", 0.0);
|
||||
return self;
|
||||
},
|
||||
analyze: function(self: SoundEvent) {
|
||||
scope: function(self: SoundEvent) {
|
||||
self.updateValue("analyze", true)
|
||||
return self
|
||||
},
|
||||
|
||||
@ -5,7 +5,18 @@ export const oscilloscope = (application: Editor): string => {
|
||||
const makeExample = makeExampleFactory(application);
|
||||
return `# Oscilloscope
|
||||
|
||||
You can turn on the oscilloscope to generate interesting visuals or to inspect audio. Use the <ic>scope()</ic> function to turn it on and off. The oscilloscope is off by default.
|
||||
You can turn on the oscilloscope to generate interesting visuals or to inspect audio. Use the <ic>scope()</ic> function to turn on/off the oscilloscope and to configure it. The oscilloscope is off by default.
|
||||
|
||||
You need to manually feed the scope with the sounds you want to inspect:
|
||||
|
||||
${makeExample(
|
||||
"Feeding a sine to the oscilloscope",
|
||||
`
|
||||
beat(1)::sound('sine').freq(200).ad(0, .2).scope().out()
|
||||
`, true
|
||||
)}
|
||||
|
||||
Here is a layout of the scope configuration options:
|
||||
|
||||
${makeExample(
|
||||
"Oscilloscope configuration",
|
||||
|
||||
Reference in New Issue
Block a user