-
Notifications
You must be signed in to change notification settings - Fork 42
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
09cf08a
commit 4531069
Showing
97 changed files
with
1,389 additions
and
39 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,21 +1,79 @@ | ||
| - [Getting started](README.md) | ||
| - npm packages | ||
| - [@supercollider/dryads](packages/dryads/README.md) | ||
| - [API](packages/dryads/api.md) | ||
| - [supercolliderjs](packages/supercolliderjs/README.md) | ||
| - [API](packages/supercolliderjs/api.md) | ||
| - [server](packages/supercolliderjs/server.md) | ||
| - [dryads](packages/supercolliderjs/dryads.md) | ||
| - [lang](packages/supercolliderjs/lang.md) | ||
| - [map](packages/supercolliderjs/map.md) | ||
| - [msg](packages/supercolliderjs/msg.md) | ||
| - [SCLangError](packages/supercolliderjs/SCLangError.md) | ||
| - [resolveOptions](packages/supercolliderjs/resolveOptions.md) | ||
| - [@supercollider/server](packages/server/README.md) | ||
| - [API](packages/server/api.md) | ||
| - [Server](packages/server/Server.md) | ||
| - [boot](packages/server/boot.md) | ||
| - [resolveOptions](packages/server/resolveOptions.md) | ||
| - [msg](packages/server/msg.md) | ||
| - [mapping](packages/server/mapping.md) | ||
| - [ServerState](packages/server/ServerState.md) | ||
| - [watchNodeNotifications](packages/server/watchNodeNotifications.md) | ||
| - [onNodeGo](packages/server/onNodeGo.md) | ||
| - [whenNodeGo](packages/server/whenNodeGo.md) | ||
| - [onNodeEnd](packages/server/onNodeEnd.md) | ||
| - [whenNodeEnd](packages/server/whenNodeEnd.md) | ||
| - [updateNodeState](packages/server/updateNodeState.md) | ||
| - [deltaTimeTag](packages/server/deltaTimeTag.md) | ||
| - [@supercollider/server-plus](packages/server-plus/README.md) | ||
| - [API](packages/server-plus/api.md) | ||
| - [Group](packages/server-plus/Group.md) | ||
| - [Synth](packages/server-plus/Synth.md) | ||
| - [AudioBus](packages/server-plus/AudioBus.md) | ||
| - [ControlBus](packages/server-plus/ControlBus.md) | ||
| - [Buffer](packages/server-plus/Buffer.md) | ||
| - [SynthDef](packages/server-plus/SynthDef.md) | ||
| - [ServerPlus](packages/server-plus/ServerPlus.md) | ||
| - [boot](packages/server-plus/boot.md) | ||
| - [@supercollider/lang](packages/lang/README.md) | ||
| - [API](packages/lang/api.md) | ||
| - [@supercollider/logger](packages/logger/README.md) | ||
| - [API](packages/logger/api.md) | ||
| - [SCLang](packages/lang/SCLang.md) | ||
| - [boot](packages/lang/boot.md) | ||
| - [resolveOptions](packages/lang/resolveOptions.md) | ||
| - [SynthDefCompiler](packages/lang/SynthDefCompiler.md) | ||
| - [SCLangError](packages/lang/SCLangError.md) | ||
| - [@supercollider/dryads](packages/dryads/README.md) | ||
| - [API](packages/dryads/api.md) | ||
| - [SCServer](packages/dryads/SCServer.md) | ||
| - [SCLang](packages/dryads/SCLang.md) | ||
| - [Group](packages/dryads/Group.md) | ||
| - [Synth](packages/dryads/Synth.md) | ||
| - [AudioBus](packages/dryads/AudioBus.md) | ||
| - [SCSynthDef](packages/dryads/SCSynthDef.md) | ||
| - [SynthControl](packages/dryads/SynthControl.md) | ||
| - [SynthStream](packages/dryads/SynthStream.md) | ||
| - [SynthEventList](packages/dryads/SynthEventList.md) | ||
| - [layer](packages/dryads/layer.md) | ||
| - [dryadic](packages/dryads/dryadic.md) | ||
| - [play](packages/dryads/play.md) | ||
| - [h](packages/dryads/h.md) | ||
| - [@supercollider/osc](packages/osc/README.md) | ||
| - [API](packages/osc/api.md) | ||
| - [packMessage](packages/osc/packMessage.md) | ||
| - [packBundle](packages/osc/packBundle.md) | ||
| - [unpack](packages/osc/unpack.md) | ||
| - [unpackMessage](packages/osc/unpackMessage.md) | ||
| - [unpackBundle](packages/osc/unpackBundle.md) | ||
| - [pack](packages/osc/pack.md) | ||
| - [dateToTimetag](packages/osc/dateToTimetag.md) | ||
| - [timetagToDate](packages/osc/timetagToDate.md) | ||
| - [deltaTimeTag](packages/osc/deltaTimeTag.md) | ||
| - [asNTPTimeTag](packages/osc/asNTPTimeTag.md) | ||
| - [@supercollider/logger](packages/logger/README.md) | ||
| - [API](packages/logger/api.md) | ||
| - [Logger](packages/logger/Logger.md) | ||
| - [@supercollider/scapi](packages/scapi/README.md) | ||
| - [API](packages/scapi/api.md) | ||
| - [@supercollider/server](packages/server/README.md) | ||
| - [API](packages/server/api.md) | ||
| - [@supercollider/server-plus](packages/server-plus/README.md) | ||
| - [API](packages/server-plus/api.md) | ||
| - [supercolliderjs](packages/supercolliderjs/README.md) | ||
| - [API](packages/supercolliderjs/api.md) | ||
| - [SCAPI](packages/scapi/SCAPI.md) | ||
| - Guide | ||
| - [Guide](https://crucialfelix.gitbooks.io/supercollider-js-guide/content/) | ||
| - [Examples](https://github.com/crucialfelix/supercolliderjs-examples) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| # AudioBus | ||
| Package: <a href="#/packages/dryads/api">@supercollider/dryads</a> | ||
|
|
||
| <div class="entity-box"><div class="Class"><h3 class="class-header" id="AudioBus"><span class="token keyword">class</span> <span class="class">AudioBus</span></h3><span class="token keyword">extends</span> <span class="type reference">Dryad<<span class="type reference">Properties</span>></span><p class="short-text">Allocates an audio bus, making it available in the children's context as .out (integer) | ||
| and .numChannels (integer)</p><div class="section-heading">Constructor</div><div class="class-member"></div><div class="section-heading">Property</div><div class="class-member"><h4 id="children"><span class="token property">children</span> <span class="type ">[object Object]</span>[]</h4></div><div class="class-member"><h4 id="properties"><span class="token property">properties</span> <span class="type reference">Properties</span></h4></div><div class="section-heading">Accessor</div><div class="class-member"><h4 id="isDryad"><span class="token property">isDryad</span> <span class="type token entity">boolean</span></h4><p class="short-text">This method is never actually called, but merely because its implemented | ||
| (dryad.isDryad is not undefined) it marks the things as being a Dryad.</p></div><div class="section-heading">Method</div><div class="class-member"></div><div class="class-member"></div><div class="class-member"></div><div class="class-member"><h4 id="defaultProperties"><span class="token function">defaultProperties</span>(): <span class="type reference">Properties</span></h4></div><div class="class-member"></div><div class="class-member"><h4 id="prepareForAdd"><span class="token function">prepareForAdd</span>(): <span class="type reference">Command</span></h4></div><div class="class-member"><h4 id="remove"><span class="token function">remove</span>(): <span class="type reference">Command</span></h4></div><div class="class-member"><h4 id="requireParent"><span class="token function">requireParent</span>(): <span class="type token entity">string</span></h4><p class="short-text">If there is no SCServer in the parent context, | ||
| then this will wrap itself in an SCServer</p></div><div class="class-member"></div><div class="class-member"></div><div class="class-member"></div></div></div> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| # Group | ||
| Package: <a href="#/packages/dryads/api">@supercollider/dryads</a> | ||
|
|
||
| <div class="entity-box"><div class="Class"><h3 class="class-header" id="Group"><span class="token keyword">class</span> <span class="class">Group</span></h3><span class="token keyword">extends</span> <span class="type reference">Dryad</span><p class="short-text">Creates a group on the server; sets .group in context for its children, | ||
| so any Synths or Groups will be spawned inside this group.</p><div class="section-heading">Constructor</div><div class="class-member"></div><div class="section-heading">Property</div><div class="class-member"><h4 id="children"><span class="token property">children</span> <span class="type ">[object Object]</span>[]</h4></div><div class="class-member"><h4 id="properties"><span class="token property">properties</span> P</h4></div><div class="section-heading">Accessor</div><div class="class-member"><h4 id="isDryad"><span class="token property">isDryad</span> <span class="type token entity">boolean</span></h4><p class="short-text">This method is never actually called, but merely because its implemented | ||
| (dryad.isDryad is not undefined) it marks the things as being a Dryad.</p></div><div class="section-heading">Method</div><div class="class-member"><h4 id="add"><span class="token function">add</span>(): <span class="type reference">Command</span></h4></div><div class="class-member"></div><div class="class-member"></div><div class="class-member"></div><div class="class-member"></div><div class="class-member"><h4 id="prepareForAdd"><span class="token function">prepareForAdd</span>(): <span class="type reference">Command</span></h4></div><div class="class-member"><h4 id="remove"><span class="token function">remove</span>(): <span class="type reference">Command</span></h4></div><div class="class-member"><h4 id="requireParent"><span class="token function">requireParent</span>(): <span class="type token entity">string</span></h4><p class="short-text">If there is no SCServer in the parent context, | ||
| then this will wrap itself in an SCServer</p></div><div class="class-member"></div><div class="class-member"></div><div class="class-member"></div></div></div> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| # SCLang | ||
| Package: <a href="#/packages/dryads/api">@supercollider/dryads</a> | ||
|
|
||
| <div class="entity-box"><div class="Class"><h3 class="class-header" id="SCLang"><span class="token keyword">class</span> <span class="class">SCLang</span></h3><span class="token keyword">extends</span> <span class="type reference">Dryad<<span class="type reference">Properties</span>></span><p class="short-text">Boots a new SuperCollider language interpreter (sclang) making it available for all children as context.sclang</p><p class="">Always boots a new one, ignoring any possibly already existing one in the parent context. | ||
|
|
||
| `options` are the command line options supplied to sclang (note: not all options are passed through yet) | ||
| see {@link lang/SCLang} | ||
|
|
||
| Not to be confused with the other class named SCLang which does all the hard work. | ||
| This Dryad class is just a simple wrapper around that. | ||
| </p><div class="section-heading">Constructor</div><div class="class-member"></div><div class="section-heading">Property</div><div class="class-member"><h4 id="children"><span class="token property">children</span> <span class="type ">[object Object]</span>[]</h4></div><div class="class-member"><h4 id="properties"><span class="token property">properties</span> <span class="type reference">Properties</span></h4></div><div class="section-heading">Accessor</div><div class="class-member"><h4 id="isDryad"><span class="token property">isDryad</span> <span class="type token entity">boolean</span></h4><p class="short-text">This method is never actually called, but merely because its implemented | ||
| (dryad.isDryad is not undefined) it marks the things as being a Dryad.</p></div><div class="section-heading">Method</div><div class="class-member"></div><div class="class-member"></div><div class="class-member"></div><div class="class-member"><h4 id="defaultProperties"><span class="token function">defaultProperties</span>(): <span class="type reference">Properties</span></h4></div><div class="class-member"></div><div class="class-member"><h4 id="prepareForAdd"><span class="token function">prepareForAdd</span>(): <span class="type reference">Command</span></h4></div><div class="class-member"><h4 id="remove"><span class="token function">remove</span>(): <span class="type reference">Command</span></h4></div><div class="class-member"></div><div class="class-member"></div><div class="class-member"></div><div class="class-member"></div></div></div> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| # SCServer | ||
| Package: <a href="#/packages/dryads/api">@supercollider/dryads</a> | ||
|
|
||
| <div class="entity-box"><div class="Class"><h3 class="class-header" id="SCServer"><span class="token keyword">class</span> <span class="class">SCServer</span></h3><span class="token keyword">extends</span> <span class="type reference">Dryad<<span class="type reference">ServerProperties</span>></span><p class="short-text">Boots a new SuperCollider server (scsynth) making it available for all children as `context.scserver`</p><p class="">Always boots a new one, ignoring any possibly already existing one in the parent context. | ||
|
|
||
| `options` are the command line options supplied to scsynth (note: not all options are passed through yet) | ||
| see {@link Server} | ||
| </p><div class="section-heading">Constructor</div><div class="class-member"></div><div class="section-heading">Property</div><div class="class-member"><h4 id="children"><span class="token property">children</span> <span class="type ">[object Object]</span>[]</h4></div><div class="class-member"><h4 id="properties"><span class="token property">properties</span> <span class="type reference">ServerProperties</span></h4></div><div class="section-heading">Accessor</div><div class="class-member"><h4 id="isDryad"><span class="token property">isDryad</span> <span class="type token entity">boolean</span></h4><p class="short-text">This method is never actually called, but merely because its implemented | ||
| (dryad.isDryad is not undefined) it marks the things as being a Dryad.</p></div><div class="section-heading">Method</div><div class="class-member"></div><div class="class-member"></div><div class="class-member"></div><div class="class-member"><h4 id="defaultProperties"><span class="token function">defaultProperties</span>(): <span class="type reference">ServerProperties</span></h4></div><div class="class-member"><h4 id="initialContext"><span class="token function">initialContext</span>(): <span class="type reference">Context</span></h4></div><div class="class-member"><h4 id="prepareForAdd"><span class="token function">prepareForAdd</span>(): <span class="type reference">Command</span></h4></div><div class="class-member"><h4 id="remove"><span class="token function">remove</span>(): <span class="type reference">Command</span></h4></div><div class="class-member"></div><div class="class-member"></div><div class="class-member"></div><div class="class-member"></div></div></div> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| # SCSynthDef | ||
| Package: <a href="#/packages/dryads/api">@supercollider/dryads</a> | ||
|
|
||
| <div class="module"><span class="token keyword">module</span> SCSynthDef<div class="module-child entity-box"><div class="Class"><h3 class="class-header" id="SCSynthDef"><span class="token keyword">class</span> <span class="class">SCSynthDef</span></h3><span class="token keyword">extends</span> <span class="type reference">Dryad<<span class="type reference">Properties</span>></span><p class="short-text">Compile a SynthDef from sclang source code | ||
| or load a precompiled .scsyndef</p><p class="">If compilation is required then it will insert SCLang as a parent if necessary. | ||
|
|
||
| Note that the synthDefName is not known until after the source code is compiled. | ||
| </p><div class="section-heading">Constructor</div><div class="class-member"></div><div class="section-heading">Property</div><div class="class-member"><h4 id="children"><span class="token property">children</span> <span class="type ">[object Object]</span>[]</h4></div><div class="class-member"><h4 id="properties"><span class="token property">properties</span> <span class="type reference">Properties</span></h4></div><div class="section-heading">Accessor</div><div class="class-member"><h4 id="isDryad"><span class="token property">isDryad</span> <span class="type token entity">boolean</span></h4><p class="short-text">This method is never actually called, but merely because its implemented | ||
| (dryad.isDryad is not undefined) it marks the things as being a Dryad.</p></div><div class="section-heading">Method</div><div class="class-member"></div><div class="class-member"></div><div class="class-member"></div><div class="class-member"><h4 id="add"><span class="token function">add</span>(): <span class="type reference">Command</span></h4></div><div class="class-member"></div><div class="class-member"></div><div class="class-member"></div><div class="class-member"><h4 id="compileSource"><span class="token function">compileSource</span>(<span class="nowrap">context: <span class="type reference">Context</span></span>, <span class="nowrap">sourceCode: <span class="type token entity">string</span></span>, <span class="nowrap">pathName: <span class="type "><span class="type token entity">undefined</span> | <span class="type token entity">string</span></span></span>): <span class="type reference">Promise<<span class="type reference">CompiledSynthDef</span>></span></h4><p class="short-text">Returns a Promise for a SynthDef result object: name, bytes, synthDesc</p></div><div class="class-member"><h4 id="defaultProperties"><span class="token function">defaultProperties</span>(): <span class="type reference">Properties</span></h4></div><div class="class-member"></div><div class="class-member"><h4 id="prepareForAdd"><span class="token function">prepareForAdd</span>(): <span class="type reference">Command</span></h4></div><div class="class-member"></div><div class="class-member"><h4 id="remove"><span class="token function">remove</span>(): <span class="type reference">Command</span></h4></div><div class="class-member"><h4 id="requireParent"><span class="token function">requireParent</span>(): <span class="type "><span class="type token entity">string</span> | <span class="type token entity">void</span></span></h4><p class="short-text">If there is no SCLang in the parent context, | ||
| then this will wrap itself in an SCLang (language interpreter).</p></div><div class="class-member"></div><div class="class-member"><h4 id="value"><span class="token function">value</span>(<span class="nowrap">context: <span class="type reference">Context</span></span>): <span class="type reference">SynthDef</span></h4><p class="short-text">Return the value of this object, which is the synthDef: {name, bytes, synthDesc} | ||
| for use in /s_new.</p></div><div class="class-member"><h4 id="fromFile"><span class="token function">fromFile</span>(<span class="nowrap">path: <span class="type token entity">string</span></span>): <span class="type reference">SCSynthDef</span></h4></div><div class="class-member"><h4 id="fromSource"><span class="token function">fromSource</span>(<span class="nowrap">source: <span class="type token entity">string</span></span>): <span class="type reference">SCSynthDef</span></h4></div><div class="class-member"></div></div></div><div class="module-child entity-box"><div class="Interface"><h4 id="CompiledSynthDef"><span class="token keyword">interface</span> CompiledSynthDef</h4><ul class="no-dot"><li><h4 id="bytes"><span class="token property">bytes</span> <span class="type reference">Buffer</span></h4></li><li><h4 id="name"><span class="token property">name</span> <span class="type token entity">string</span></h4></li><li><h4 id="synthDesc"><span class="token property">synthDesc</span> <span class="type reference">SynthDesc</span></h4></li></ul></div></div><div class="module-child entity-box"><div class="Interface"><h4 id="LoadedSynthDef"><span class="token keyword">interface</span> LoadedSynthDef</h4><ul class="no-dot"><li><h4 id="name"><span class="token property">name</span> <span class="type token entity">string</span></h4></li></ul></div></div><div class="module-child entity-box"><div class="TypeAlias"><span class="token keyword">type</span> SynthDef = <span class="type "><span class="type reference">CompiledSynthDef</span> | <span class="type reference">LoadedSynthDef</span></span>;</div></div><div class="module-child entity-box"><div class="TypeAlias"><span class="token keyword">type</span> SynthDesc = <span class="type token entity">object</span>;</div></div></div> |
Oops, something went wrong.