API_functions
Functions
addPlugin
â–¸ addPlugin(pluginClassName: string): string
Tries to find a class (prototype) with the name of a given string (reflection), then tries to cast it to a valid plugin class. If both worked, a plugin instance will be created, registered etc. and the item-id will be returned
Parameters:
| Name | Type | Description |
|---|---|---|
pluginClassName | string | The name of the class from which a plugin instance should be created |
Returns: string
addPluginClass
â–¸ addPluginClass(PluginClass: IPluginConstructor): void
Parameters:
| Name | Type |
|---|---|
PluginClass | IPluginConstructor |
Returns: void
addSeqPart
â–¸ addSeqPart(lengthInStepsPerBar?: undefined | number): string
Parameters:
| Name | Type |
|---|---|
lengthInStepsPerBar? | undefined | number |
Returns: string
connectPlugins
â–¸ connectPlugins(connection: [AudioEndpoint, AudioEndpoint]): void
Connects two audio endpoints and dispatches the new state. If the id of the input plugin is not valid, it connects to the soundcard input. If the id of the output plugin is not valid, it cancels the operation.
Parameters:
| Name | Type | Description |
|---|---|---|
connection | [AudioEndpoint, AudioEndpoint] | Audio endpoints to be connected |
Returns: void
dispatch
â–¸ dispatch(action: Action): void
Parameters:
| Name | Type |
|---|---|
action | Action |
Returns: void
getActionCreators
â–¸ getActionCreators(itemId: string): ActionCreatorsMapObject
Parameters:
| Name | Type |
|---|---|
itemId | string |
Returns: ActionCreatorsMapObject
getAudioContext
â–¸ getAudioContext(): AudioContext
Returns: AudioContext
getPluginClassNames
â–¸ getPluginClassNames(): string[]
Returns: string[]
getState
â–¸ getState(): IState
Returns: IState
getUnboundActionCreators
â–¸ getUnboundActionCreators(itemId: string): ActionCreatorsMapObject
Parameters:
| Name | Type |
|---|---|
itemId | string |
Returns: ActionCreatorsMapObject
removePlugin
â–¸ removePlugin(itemId: string): void
Parameters:
| Name | Type |
|---|---|
itemId | string |
Returns: void
removePluginClass
â–¸ removePluginClass(className: string): boolean
Parameters:
| Name | Type |
|---|---|
className | string |
Returns: boolean
removeSeqPart
â–¸ removeSeqPart(itemId: string): void
Parameters:
| Name | Type |
|---|---|
itemId | string |
Returns: void
resumeAudioContext
â–¸ resumeAudioContext(): void
Returns: void
Object literals
pluginClasses
â–ª Const pluginClasses: object
Properties:
| Name | Type | Value |
|---|---|---|
Delay | IPluginConstructor | IPluginConstructor |
Sampler | IPluginConstructor | IPluginConstructor |
Sequencer | IPluginConstructor | IPluginConstructor |
Synth | IPluginConstructor | IPluginConstructor |