engine

Documentation

Overview

Package engine provides output through PortAudio

Index

• type Engine
  • func New(deviceIndex int) (*Engine, error)
  • func (e *Engine) Errors() chan error
  • func (e *Engine) Latency() time.Duration
  • func (e *Engine) Load() float64
  • func (e *Engine) LuaMethods() map[string]module.LuaMethod
  • func (e *Engine) Run()
  • func (e *Engine) Stop() error
  • func (e *Engine) TotalElapsed() time.Duration

Types

type Engine

type Engine struct {
	sync.Mutex
	module.IO
	// contains filtered or unexported fields
}

Engine is the connection of the synthesizer to PortAudio

func New

func New(deviceIndex int) (*Engine, error)

New returns a new Enngine

func (*Engine) Errors

func (e *Engine) Errors() chan error

Errors returns a channel that expresses any errors during operation of the Engine

func (*Engine) Latency

func (e *Engine) Latency() time.Duration

Latency returns the current latency within the PortAudio callback. It's an indicator of how computationally expensive your Rack is, and does not include any latency between PortAudio and your speakers.

func (*Engine) Load

func (e *Engine) Load() float64

Load returns the current CPU load of the underlying audio engine

func (*Engine) LuaMethods

func (e *Engine) LuaMethods() map[string]module.LuaMethod

LuaMethods exposes methods on the module at the Lua layer

func (*Engine) Run

func (e *Engine) Run()

Run starts the Engine; running the audio stream

func (*Engine) Stop

func (e *Engine) Stop() error

Stop shuts down the Engine

func (*Engine) TotalElapsed

func (e *Engine) TotalElapsed() time.Duration

TotalElapsed returns the current wallclock duration of the session