Documentation
¶
Overview ¶
Package module provides built-in modules
Index ¶
- func Register(name string, fn func(Config) (Patcher, error))
- func RegisteredTypes() []string
- type Config
- type IO
- func (io *IO) AddInput(in *In) error
- func (io *IO) AddOutput(out *Out) error
- func (io *IO) Close() error
- func (io *IO) Expose(typ string, ins []*In, outs []*Out) error
- func (io *IO) ID() string
- func (io *IO) Inputs() map[string]*In
- func (io *IO) Output(name string) (*Out, error)
- func (io *IO) Outputs() map[string]*Out
- func (io *IO) OutputsActive(sinking bool) int
- func (io *IO) Patch(name string, t interface{}) error
- func (io *IO) Reset() error
- func (io *IO) ResetOnly(names []string) error
- func (io *IO) String() string
- func (io *IO) Type() string
- type Identifier
- type In
- type InitFunc
- type LuaMethod
- type Out
- type Patcher
- type Port
- type PortLister
- type Resetter
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Register ¶
Register registers a module under a specified name. This is then exposed as a constructor in the `eolian.synth` package at the Lua layer.
func RegisteredTypes ¶
func RegisteredTypes() []string
RegisteredTypes returns a list of all registered module types
Types ¶
type Config ¶
type Config map[string]interface{}
Config is the conduit for providing initialization information to a module
type IO ¶
type IO struct {
// contains filtered or unexported fields
}
IO is the input/output registry of a module. It manages the lifecycles of the ports; fascilitating connects and disconnects between them. This struct lazy initializes so it is useful by default. It is intended to just be embedded inside other structs that represent a module.
func (*IO) AddInput ¶ added in v0.0.12
AddInput registers a new input with the module. This is primarily used to allow for lazy-creation of inputs when patched instead of at the module's create-time.
func (*IO) AddOutput ¶ added in v0.0.12
AddOutput registers a new output with the module. Like AddInput, it is used for lazy-creation of outputs.
func (*IO) Expose ¶
Expose registers inputs and outputs of the module so that they can be used in patching
func (*IO) OutputsActive ¶
OutputsActive returns the total count of actively patched outputs
func (*IO) Reset ¶
Reset disconnects all inputs from their sources (closing them in the process) and re-assigns the input to its original default value
type Identifier ¶ added in v0.0.3
Identifier returns the identity and type of a module
type In ¶
type In struct {
Source dsp.Processor
Name string
ForceSinking bool
// contains filtered or unexported fields
}
In is a module input
func NewInBuffer ¶ added in v0.0.18
NewInBuffer returns a new buffered input
func (*In) IsSinking ¶ added in v0.0.11
IsSinking returns whether the input is sinking to audio output
func (*In) ProcessFrame ¶ added in v0.0.18
ProcessFrame reads an entire frame into the buffered input
func (*In) SourceName ¶ added in v0.0.8
SourceName returns the name of the connected output
type LuaMethod ¶ added in v0.0.15
type LuaMethod struct {
Lock bool
Func interface{}
}
LuaMethod is a function exposed to the Lua layer. If Lock is true, the synthesizer module graph will be locked when it is called to prevent race conditions.
type Out ¶
type Out struct {
Name string
Provider dsp.ProcessorProvider
// contains filtered or unexported fields
}
Out is a module output
func (*Out) DestinationNames ¶ added in v0.0.19
DestinationNames returns the name of the destination input
func (*Out) IsSinking ¶ added in v0.0.11
IsSinking returns whether the output is sinking to audio output
type Patcher ¶
type Patcher interface {
Identifier
PortLister
Resetter
io.Closer
Patch(string, interface{}) error
Output(string) (*Out, error)
}
Patcher is the patching behavior of a module
type PortLister ¶ added in v0.0.20
PortLister lists inputs and outputs of a module
Source Files
¶
- adsr.go
- ahd.go
- binary.go
- chance_gate.go
- clip.go
- clock.go
- compress.go
- concurrent.go
- control.go
- count.go
- coupler.go
- crossfade.go
- crossfeed.go
- debug.go
- delay.go
- direct.go
- distort.go
- edges.go
- expression.go
- file_source.go
- filter.go
- filtered_reverb.go
- fold.go
- follow.go
- gate_mix.go
- gate_sequencer.go
- glide.go
- interpolate.go
- invert.go
- io.go
- lpg.go
- mix.go
- multi_out_io.go
- multiple.go
- mux.go
- noise.go
- note_quantize.go
- oscillator.go
- pan.go
- pan_mix.go
- ping_pong_delay.go
- quantize.go
- random.go
- random_series.go
- random_trigger.go
- registry.go
- reverb.go
- sample_hold.go
- shape.go
- soft_clip.go
- stage_sequencer.go
- step_sequencer.go
- survey.go
- switch.go
- tank_reverb.go
- tap.go
- tape.go
- tape_markers.go
- tempo_detect.go
- toggle.go
- track_hold.go
- unary.go
- variable_random_series.go
- wavetable.go
- wrap.go
Directories