BuboBubo/topos
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

renaming analyze to scope and documenting

Browse Source
This commit is contained in:
Raphaël Forment
2023-11-30 22:59:22 +01:00
parent c192988e70
commit 53821983e9
2 changed files with 21 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/classes/SoundEvent.ts
View File

@ -110,7 +110,7 @@ export class SoundEvent extends AudibleEvent {
self.updateValue("release", 0.0); self.updateValue("release", 0.0);
return self; return self;
}, },
analyze: function(self: SoundEvent) { scope: function(self: SoundEvent) {
self.updateValue("analyze", true) self.updateValue("analyze", true)
return self return self
}, },

17
src/documentation/more/oscilloscope.ts
View File

@ -5,7 +5,18 @@ export const oscilloscope = (application: Editor): string => {
const makeExample = makeExampleFactory(application); const makeExample = makeExampleFactory(application);
return `# Oscilloscope 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( ${makeExample(
"Oscilloscope configuration", "Oscilloscope configuration",
@ -24,7 +35,7 @@ scope({
}) })
`, `,
true, true,
)} )}
${makeExample( ${makeExample(
"Demo with multiple scope mode", "Demo with multiple scope mode",
@ -45,7 +56,7 @@ scope({enabled: true, thickness: 8,
size: 0.5, fftSize: 2048}) size: 0.5, fftSize: 2048})
`, `,
true, true,
)} )}
Note that these values can be patterned as well! You can transform the oscilloscope into its own light show if you want. The picture is not stable anyway so you won't have much use of it for precision work :) Note that these values can be patterned as well! You can transform the oscilloscope into its own light show if you want. The picture is not stable anyway so you won't have much use of it for precision work :)