voicemeeter

package module
v2.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 1, 2024 License: MIT Imports: 14 Imported by: 3

README

Go Reference

A Go Wrapper for the Voicemeeter API

For an outline of past/future changes refer to: CHANGELOG

Tested against

  • Basic 1.1.1.1
  • Banana 2.1.1.1
  • Potato 3.1.1.1

Requirements

Installation

Initialize your own module then go get

go mod init github.com/x/y
go get github.com/onyx-and-iris/voicemeeter/v2

Use

main.go
package main

import (
	"fmt"
	"log"

	"github.com/onyx-and-iris/voicemeeter/v2"
)

func main() {
	vm, err := vmConnect()
	if err != nil {
		log.Fatal(err)
	}
	defer vm.Logout()

	vm.Strip[0].SetLabel("rode podmic")
	vm.Strip[0].SetMute(true)
	fmt.Printf("Strip 0 (%s) mute was set to %v\n", vm.Strip[0].Label(), vm.Strip[0].Mute())
}

func vmConnect() (*voicemeeter.Remote, error) {
	vm, err := voicemeeter.NewRemote("banana", 20)
	if err != nil {
		return nil, err
	}

	err = vm.Login()
	if err != nil {
		return nil, err
	}

	return vm, nil
}

voicemeeter.NewRemote(<kindId>, <delay>, opts ...Option)

kindId

Pass the kind of Voicemeeter as an argument. kindId may be:

  • basic
  • banana
  • potato
delay

Pass a delay in milliseconds to force the getters to wait for dirty parameters to clear.

Useful if not listening for event updates.

voicemeeter.WithBits(bits int)

Override the type of Voicemeeter GUI to launch on 64 bit systems. For example, to force 32 bit GUI:

voicemeeter.NewRemote("banana", 20, voicemeeter.WithBits(32))

voicemeeter.WithBits(timeout int)

Set a login timeout, defaults to 2 seconds. For example to set it to 1s:

voicemeeter.NewRemote("banana", 20, voicemeeter.WithBits(1))

Remote Type

vm.Strip

[]t_strip slice containing both physicalStrip and virtualStrip types

vm.Bus

[]t_bus slice containing both physicalBus and virtualBus types

vm.Button

[]button slice containing button types, one for each macrobutton

vm.Command

pointer to command type, represents action type functions

vm.Vban

pointer to vban type, containing both vbanInStream and vbanOutStream slices

vm.Device

pointer to device type, represents physical input/output hardware devices

vm.Recorder

pointer to recorder type, represents the recorder

vm.Midi

pointer to midi type, represents a connected midi device

vm.Type()

returns the type of Voicemeeter as a string

vm.Version()

returns the version of Voicemeeter as a string

vm.GetFloat(<param>)

gets a float parameter value

vm.SetFloat(<param>, <value>)

sets a float parameter value eg. vm.SetFloat("strip[0].mute", 1)

vm.GetString(<param>)

gets a string parameter value

vm.SetString(<param>, <value>)

sets a string parameter value eg. vm.SetString("strip[0].label", "podmic")

vm.SendText(<script>)

sets many parameters in script format eg. ("Strip[0].Mute=1;Bus[3].Gain=3.6")

vm.Register(o observer)

register an observer type as an observer

vm.Deregister(o observer)

deregister an observer type as an observer

vm.EventAdd(<events>)

adds a single or multiple events to the pooler. Accepts a string or slice of strings.

vm.EventRemove(<events>)

removes a single or multiple events from the pooler. Accepts a string or slice of strings.

vm.Pdirty()

returns True iff a GUI parameter has changed

vm.Mdirty()

returns True iff a macrobutton parameter has changed

vm.Sync()

Use this to force dirty parameters to clear after a delay in milliseconds.

Available commands

Strip

The following methods are available

  • Mute() bool
  • SetMute(val bool)
  • Mono() bool
  • SetMono(val bool)
  • Solo() bool
  • SetSolo(val bool)
  • Limit() int
  • SetLimit(val int) from -40 to 12
  • Label() string
  • SetLabel(val string)
  • Gain() float64
  • SetGain(val float64) from -60.0 to 12.0
  • Mc() bool
  • SetMc(val bool)
  • Audibility() float64
  • SetAudibility(val float64) from 0.0 to 10.0
  • A1() bool - A5() bool
  • SetA1(val bool) - SetA5(val bool)
  • B1() bool - B3() bool
  • SetB1(val bool) bool - SetB3(val bool) bool
  • AppGain(name string, gain float64)
  • AppMute(name string, val bool)

example:

vm.Strip[3].SetGain(3.7)
fmt.Println(vm.Strip[0].Label())
vm.Strip[4].SetA1(true)

vm.Strip[5].AppGain("Spotify", 0.5)
vm.Strip[5].AppMute("Spotify", true)
Comp
  • vm.Strip[i].Comp()

The following methods are available

  • Knob() float64
  • SetKnob(val float64) from 0.0 to 10.0
  • GainIn() float64
  • SetGainIn(val float64) from -24.0 to 24.0
  • Ratio() float64
  • SetRatio(val float64) from 1.0 to 8.0
  • Threshold() float64
  • SetThreshold(val float64) from -40.0 to -3.0
  • Attack() float64
  • SetAttack(val float64) from 0.0 to 200.0
  • Release() float64
  • SetRelease(val float64) from 0.0 to 5000.0
  • Knee() float64
  • SetKnee(val float64) from 0.0 to 1.0
  • GainOut() float64
  • SetGainOut(val float64) from -24.0 to 24.0
  • MakeUp() bool
  • SetMakeUp(val bool)

example:

vm.Strip[3].Comp().SetRatio(3.5)
Gate
  • vm.Strip[i].Gate()

The following methods are available

  • Knob() float64
  • SetKnob(val float64) from 0.0 to 10.0
  • Threshold() float64
  • SetThreshold(val float64) from -60.0 to -10.0
  • Damping() float64
  • SetDamping(val float64) from -60.0 to -10.0
  • BPSidechain() int
  • SetBPSidechain(val int) from 100 to 4000
  • Attack() float64
  • SetAttack(val float64) from 0.0 to 1000.0
  • Hold() float64
  • SetHold(val float64) from 0.0 to 5000.0
  • Release() float64
  • SetRelease(val float64) from 0.0 to 5000.0

example:

fmt.Println(vm.Strip[4].Gate().Attack())
Denoiser
  • vm.Strip[i].Denoiser()

The following methods are available

  • Knob() float64
  • SetKnob(val float64) from 0.0 to 10.0

example:

vm.Strip[1].Denoiser().SetKnob(4.2)
Gainlayer
  • vm.Strip[i].Gainlayer()[j]

The following methods are available

  • Get() float64
  • Set(val float64)

example:

vm.Strip[6].GainLayer()[3].Set(-13.6)
Levels
  • vm.Strip[i].Levels()

The following methods are available

  • PreFader() []float64
  • PostFader() []float64
  • PostMute() []float64

example:

fmt.Println(vm.Strip[5].Levels().PreFader())
Bus

The following methods are available

  • String() string
  • Mute() bool
  • SetMute(val bool)
  • Mono() bool
  • SetMono(val bool)
  • Label() string
  • SetLabel(val string)
  • Gain() float64
  • SetGain(val float64) from -60.0 to 12.0

example:

vm.Bus[3].SetEq(true)
fmt.Println(vm.Bus[0].Label())
Modes
  • vm.Bus[i].Mode()

The following methods are available

  • SetNormal(val bool)
  • Normal() bool
  • SetAmix(val bool)
  • Amix() bool
  • SetBmix(val bool)
  • Bmix() bool
  • SetRepeat(val bool)
  • Repeat() bool
  • SetComposite(val bool)
  • Composite() bool
  • SetTvMix(val bool)
  • TvMix() bool
  • SetUpMix21(val bool)
  • UpMix21() bool
  • SetUpMix41(val bool)
  • UpMix41() bool
  • SetUpMix61(val bool)
  • UpMix61() bool
  • SetCenterOnly(val bool)
  • CenterOnly() bool
  • SetLfeOnly(val bool)
  • LfeOnly() bool
  • SetRearOnly(val bool)
  • RearOnly() bool

example:

vm.Bus[3].Mode().SetAmix(true)
vm.Bus[4].Mode().SetCenterOnly(true)
Levels
  • vm.Bus[i].Levels()

The following methods are available

  • All() []float64

example:

fmt.Println(vm.Bus[1].Levels().All())
Strip | Bus
EQ
  • vm.Strip[i].Eq() vm.Bus[i].Eq()

The following methods are available.

  • On() bool
  • SetOn(val bool)
  • Ab() bool
  • SetAb(val bool)

example:

vm.Strip[1].Eq().SetOn(true)
fmt.Println(vm.Bus[3].Eq().Ab())

The following methods are available.

  • FadeTo(target float64, time_ int): float, int
  • FadeBy(change float64, time_ int): float, int

Modify gain to or by the selected amount in db over a time interval in ms.

example:

vm.Strip[3].FadeBy(-8.3, 500)
vm.Bus[3].FadeTo(-12.8, 500)
Button

The following methods are available

  • State() bool
  • SetState(val bool)
  • StateOnly() bool
  • SetStateOnly(val bool)
  • Trigger() bool
  • SetTrigger(val bool)

example:

vm.Button[37].SetState(true)
fmt.Println(vm.Button[64].StateOnly())
Command

The following methods are available

  • Show() Show Voicemeeter GUI if it's hidden
  • Hide() Hide Voicemeeter GUI if it's shown
  • Shutdown() Shuts down the GUI
  • Restart() Restart the audio engine
  • Lock(val bool) Lock the Voicemeeter GUI

example:

vm.Command.Restart()
vm.Command.Show()
VBAN
  • vm.Vban.Enable() vm.Vban.Disable() Turn VBAN on or off
Instream | Outstream
  • vm.Vban.InStream[i] vm.Vban.OutStream[i]

The following methods are available

  • On() bool
  • SetOn(val bool)
  • Name() string
  • SetName(val string)
  • Ip() string
  • SetIp(val string)
  • Port() int
  • SetPort(val int) from 1024 to 65535
  • Sr() int
  • SetSr(val int) (11025, 16000, 22050, 24000, 32000, 44100, 48000, 64000, 88200, 96000)
  • Channel() int
  • SetChannel(val int) from 1 to 8
  • Bit() int
  • SetBit(val int) 16 or 24
  • Quality() int
  • SetQuality(val int) from 0 to 4
  • Route() int
  • SetRoute(val int) from 0 to 8

example:

# turn VBAN on
vm.Vban.Enable()

// turn on vban instream 0
vm.Vban.InStream[0].SetOn(true)

// set bit property for outstream 3 to 24
vm.Vban.OutStream[3].SetBit(24)
Device

The following methods are available

  • Ins()
  • Outs()
  • Input(val int)
  • Output(val int)

example:

for i := 0; i < int(vm.Device.Ins()); i++ {
	fmt.Println(vm.Device.Input(i))
}
Recorder

The following methods are available

  • Play()
  • Stop()
  • Pause()
  • Replay()
  • Record()
  • Ff()
  • Rew()

example:

vm.Recorder.Play()
vm.Recorder.Stop()

# Enable loop play
vm.Recorder.Loop(true)

# Disable recorder out channel B2
vm.Recorder.SetB2(false)
Midi

The following methods are available

  • Channel() returns the current midi channel
  • Current() returns the most recently pressed midi button
  • Get(<button>) returns the value in cache for the midi button

example:

var current = vm.Midi.Current()
var val = vm.Midi.Get(current)
Events

By default level updates are disabled. Any event may be enabled or disabled. The following events exist:

  • pdirty parameter updates
  • mdirty macrobutton updates
  • midi midi updates
  • ldirty level updates

example:

events := []string{"ldirty", "mdirty", "pdirty"}

vm.EventAdd(events...)

vm.EventRemove(events...)
Run tests

To run all tests:

go test ./...
Official Documentation

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Option added in v2.1.0

type Option func(*Remote)

func WithBits added in v2.1.0

func WithBits(bits int) Option

func WithTimeout added in v2.1.0

func WithTimeout(timeout int) Option

type PhysicalBus

type PhysicalBus struct {
	// contains filtered or unexported fields
}

PhysicalBus represents a single physical bus

func (*PhysicalBus) Eq

func (b *PhysicalBus) Eq() *eQ

Eq returns the eQ field

func (*PhysicalBus) FadeBy

func (b *PhysicalBus) FadeBy(change float32, time_ int)

FadeBy adjusts the value of gain by change over a time interval of time_

func (*PhysicalBus) FadeTo

func (b *PhysicalBus) FadeTo(target float32, time_ int)

FadeTo sets the value of gain to target over at time interval of time_

func (*PhysicalBus) Gain

func (b *PhysicalBus) Gain() float64

Gain returns the value of the Gain parameter

func (*PhysicalBus) Label

func (b *PhysicalBus) Label() string

Label returns the value of the MC parameter

func (*PhysicalBus) Levels

func (b *PhysicalBus) Levels() *levels

Levels returns the levels field

func (*PhysicalBus) Mode

func (b *PhysicalBus) Mode() *busMode

Mode returns address of a busMode struct

func (*PhysicalBus) Mono

func (b *PhysicalBus) Mono() bool

Mono returns the value of the Mute parameter

func (*PhysicalBus) Mute

func (b *PhysicalBus) Mute() bool

Mute returns the value of the Mute parameter

func (*PhysicalBus) SetGain

func (b *PhysicalBus) SetGain(val float64)

SetGain sets the value of the Gain parameter

func (*PhysicalBus) SetLabel

func (b *PhysicalBus) SetLabel(val string)

SetLabel sets the value of the MC parameter

func (*PhysicalBus) SetMono

func (b *PhysicalBus) SetMono(val bool)

SetMono sets the value of the Mute parameter

func (*PhysicalBus) SetMute

func (b *PhysicalBus) SetMute(val bool)

SetMute sets the value of the Mute parameter

func (*PhysicalBus) String

func (p *PhysicalBus) String() string

String implements the fmt.stringer interface

type PhysicalStrip

type PhysicalStrip struct {
	// contains filtered or unexported fields
}

PhysicalStrip represents a single physical strip

func (*PhysicalStrip) AppGain

func (v *PhysicalStrip) AppGain(name string, val float64)

AppGain sets the gain in db by val for the app matching name.

func (*PhysicalStrip) AppMute

func (v *PhysicalStrip) AppMute(name string, val bool)

AppMute sets mute state as val for the app matching name.

func (*PhysicalStrip) Audibility

func (p *PhysicalStrip) Audibility() float64

Audibility returns the value of the Audibility parameter

func (*PhysicalStrip) ColorX

func (p *PhysicalStrip) ColorX() float64

ColorX returns the value of the Color_X parameter

func (*PhysicalStrip) ColorY

func (p *PhysicalStrip) ColorY() float64

ColorY returns the value of the Color_Y parameter

func (*PhysicalStrip) Comp

func (p *PhysicalStrip) Comp() *comp

Comp returns the comp field

func (*PhysicalStrip) Denoiser

func (p *PhysicalStrip) Denoiser() *denoiser

Denoiser returns the denoiser field

func (*PhysicalStrip) Eq

func (s *PhysicalStrip) Eq() *eQ

Eq returns the eQ field

func (*PhysicalStrip) FadeBy

func (s *PhysicalStrip) FadeBy(change float64, time_ int)

FadeBy adjusts the value of gain by change over a time interval of time_

func (*PhysicalStrip) FadeTo

func (s *PhysicalStrip) FadeTo(target float64, time_ int)

FadeTo sets the value of gain to target over at time interval of time_

func (*PhysicalStrip) FxX

func (p *PhysicalStrip) FxX() float64

FxX returns the value of the Color_X parameter

func (*PhysicalStrip) FxY

func (p *PhysicalStrip) FxY() float64

FxY returns the value of the Color_Y parameter

func (*PhysicalStrip) Gain

func (s *PhysicalStrip) Gain() float64

Gain returns the value of the Gain parameter

func (*PhysicalStrip) GainLayer

func (s *PhysicalStrip) GainLayer() []gainLayer

GainLayer returns the gainlayer field

func (*PhysicalStrip) Gate

func (p *PhysicalStrip) Gate() *gate

Gate returns the gate field

func (*PhysicalStrip) Label

func (s *PhysicalStrip) Label() string

Label returns the value of the Label parameter

func (*PhysicalStrip) Levels

func (s *PhysicalStrip) Levels() *levels

Levels returns the levels field

func (*PhysicalStrip) Limit

func (s *PhysicalStrip) Limit() int

Limit returns the value of the Limit parameter

func (*PhysicalStrip) Mc

func (p *PhysicalStrip) Mc() bool

Mc logs a warning reason invalid parameter it always returns zero value

func (*PhysicalStrip) Mono

func (s *PhysicalStrip) Mono() bool

Mono returns the value of the Mono parameter

func (*PhysicalStrip) Mute

func (s *PhysicalStrip) Mute() bool

Mute returns the value of the Mute parameter

func (*PhysicalStrip) PanX

func (s *PhysicalStrip) PanX() float64

PanX returns the value of the Pan_X parameter

func (*PhysicalStrip) PanY

func (s *PhysicalStrip) PanY() float64

PanY returns the value of the Pan_Y parameter

func (*PhysicalStrip) SetAudibility

func (p *PhysicalStrip) SetAudibility(val float64)

SetAudibility sets the value of the Audibility parameter

func (*PhysicalStrip) SetColorX

func (p *PhysicalStrip) SetColorX(val float64)

SetColorX sets the value of the Color_X parameter

func (*PhysicalStrip) SetColorY

func (p *PhysicalStrip) SetColorY(val float64)

SetColorY sets the value of the Color_Y parameter

func (*PhysicalStrip) SetFxX

func (p *PhysicalStrip) SetFxX(val float64)

SetFxX sets the value of the Color_X parameter

func (*PhysicalStrip) SetFxY

func (p *PhysicalStrip) SetFxY(val float64)

SetFxY sets the value of the Color_Y parameter

func (*PhysicalStrip) SetGain

func (s *PhysicalStrip) SetGain(val float64)

SetGain sets the value of the Gain parameter

func (*PhysicalStrip) SetLabel

func (s *PhysicalStrip) SetLabel(val string)

SetLabel sets the value of the Label parameter

func (*PhysicalStrip) SetLimit

func (s *PhysicalStrip) SetLimit(val int)

SetLimit sets the value of the Limit parameter

func (*PhysicalStrip) SetMc

func (p *PhysicalStrip) SetMc(val bool)

SetMc logs a warning reason invalid parameter

func (*PhysicalStrip) SetMono

func (s *PhysicalStrip) SetMono(val bool)

SetMono sets the value of the Mono parameter

func (*PhysicalStrip) SetMute

func (s *PhysicalStrip) SetMute(val bool)

SetMute sets the value of the Mute parameter

func (*PhysicalStrip) SetPanX

func (s *PhysicalStrip) SetPanX(val float64)

SetPanX sets the value of the Pan_X parameter

func (*PhysicalStrip) SetPanY

func (s *PhysicalStrip) SetPanY(val float64)

SetPanY sets the value of the Pan_Y parameter

func (*PhysicalStrip) SetSolo

func (s *PhysicalStrip) SetSolo(val bool)

SetSolo sets the value of the Solo parameter

func (*PhysicalStrip) Solo

func (s *PhysicalStrip) Solo() bool

Solo returns the value of the Solo parameter

func (*PhysicalStrip) String

func (p *PhysicalStrip) String() string

String implements fmt.stringer interface

type Remote

type Remote struct {
	Kind     *kind
	Strip    []iStrip
	Bus      []iBus
	Button   []button
	Command  *command
	Vban     *vban
	Device   *device
	Recorder *recorder
	Midi     *midi_t
	// contains filtered or unexported fields
}

Remote represents the API for a kind

func NewRemote

func NewRemote(kindId string, delay int, opts ...Option) (*Remote, error)

NewRemote returns a Remote type for a kind this is the interface entry point

func (*Remote) EventAdd

func (r *Remote) EventAdd(events ...string)

EventAdd adds events to the Pooler

func (*Remote) EventRemove

func (r *Remote) EventRemove(events ...string)

EventRemove removes events from the Pooler

func (*Remote) GetFloat

func (r *Remote) GetFloat(name string) (float64, error)

GetFloat gets a float parameter value

func (*Remote) GetString

func (r *Remote) GetString(name string) (string, error)

GetString gets a string parameter value

func (*Remote) InitPooler

func (r *Remote) InitPooler()

InitPooler initiates the Pooler

func (*Remote) Login

func (r *Remote) Login() error

Login logs into the API then it intializes the pooler

func (*Remote) Logout

func (r *Remote) Logout() error

Logout logs out of the API it also terminates the pooler

func (*Remote) Mdirty

func (r *Remote) Mdirty() (bool, error)

Mdirty returns true iff a macrobutton value has changed

func (*Remote) Pdirty

func (r *Remote) Pdirty() (bool, error)

Pdirty returns true iff a parameter value has changed

func (*Remote) Register

func (r *Remote) Register(channel chan string)

Register forwards the register method to Pooler

func (*Remote) Run

func (r *Remote) Run(kindId string) error

Run launches the Voicemeeter GUI for a kind.

func (*Remote) SendText

func (r *Remote) SendText(script string) error

SendText sets multiple parameters by script

func (*Remote) SetFloat

func (r *Remote) SetFloat(name string, value float64) error

SetFloat sets a float paramter value

func (*Remote) SetString

func (r *Remote) SetString(name, value string) error

SetString sets a string parameter value

func (*Remote) String

func (r *Remote) String() string

String implements the fmt.stringer interface

func (*Remote) Sync

func (r *Remote) Sync()

Sync is a helper method that waits for dirty parameters to clear

func (*Remote) Type

func (r *Remote) Type() string

Type returns the type of Voicemeeter (basic, banana, potato)

func (*Remote) Version

func (r *Remote) Version() string

Version returns the version of Voicemeeter as a string

type VbanInstream

type VbanInstream struct {
	// contains filtered or unexported fields
}

func (*VbanInstream) Bit

func (v *VbanInstream) Bit() int

Bit returns the value of the Bit parameter

func (*VbanInstream) Channel

func (v *VbanInstream) Channel() int

Channel returns the value of the Channel parameter

func (*VbanInstream) Ip

func (v *VbanInstream) Ip() string

Ip returns the value of the Ip parameter

func (*VbanInstream) Name

func (v *VbanInstream) Name() string

Name returns the value of the Name parameter

func (*VbanInstream) On

func (v *VbanInstream) On() bool

On returns the value of the On parameter

func (*VbanInstream) Port

func (v *VbanInstream) Port() int

Port returns the value of the Port parameter

func (*VbanInstream) Quality

func (v *VbanInstream) Quality() int

Quality returns the value of the Quality parameter

func (*VbanInstream) Route

func (v *VbanInstream) Route() int

Route returns the value of the Route parameter

func (*VbanInstream) SetBit

func (vbi *VbanInstream) SetBit(val int)

SetBit logs a warning reason read only

func (*VbanInstream) SetChannel

func (vbi *VbanInstream) SetChannel(val int)

SetChannel logs a warning reason read only

func (*VbanInstream) SetIp

func (v *VbanInstream) SetIp(val string)

SetIp sets the value of the Ip parameter

func (*VbanInstream) SetName

func (v *VbanInstream) SetName(val string)

SetLabel sets the value of the Name parameter

func (*VbanInstream) SetOn

func (v *VbanInstream) SetOn(val bool)

SetOn sets the value of the On parameter

func (*VbanInstream) SetPort

func (v *VbanInstream) SetPort(val int)

SetPort sets the value of the Port parameter

func (*VbanInstream) SetQuality

func (v *VbanInstream) SetQuality(val int)

SetQuality sets the value of the Quality parameter

func (*VbanInstream) SetRoute

func (v *VbanInstream) SetRoute(val int)

SetRoute sets the value of the Route parameter

func (*VbanInstream) SetSr

func (vbi *VbanInstream) SetSr(val int)

SetSr logs a warning reason read only

func (*VbanInstream) Sr

func (v *VbanInstream) Sr() int

Sr returns the value of the Sr parameter

type VbanOutStream

type VbanOutStream struct {
	// contains filtered or unexported fields
}

func (*VbanOutStream) Bit

func (v *VbanOutStream) Bit() int

Bit returns the value of the Bit parameter

func (*VbanOutStream) Channel

func (v *VbanOutStream) Channel() int

Channel returns the value of the Channel parameter

func (*VbanOutStream) Ip

func (v *VbanOutStream) Ip() string

Ip returns the value of the Ip parameter

func (*VbanOutStream) Name

func (v *VbanOutStream) Name() string

Name returns the value of the Name parameter

func (*VbanOutStream) On

func (v *VbanOutStream) On() bool

On returns the value of the On parameter

func (*VbanOutStream) Port

func (v *VbanOutStream) Port() int

Port returns the value of the Port parameter

func (*VbanOutStream) Quality

func (v *VbanOutStream) Quality() int

Quality returns the value of the Quality parameter

func (*VbanOutStream) Route

func (v *VbanOutStream) Route() int

Route returns the value of the Route parameter

func (*VbanOutStream) SetBit

func (v *VbanOutStream) SetBit(val int)

SetBit sets the value of the Bit parameter

func (*VbanOutStream) SetChannel

func (v *VbanOutStream) SetChannel(val int)

SetChannel sets the value of the Channel parameter

func (*VbanOutStream) SetIp

func (v *VbanOutStream) SetIp(val string)

SetIp sets the value of the Ip parameter

func (*VbanOutStream) SetName

func (v *VbanOutStream) SetName(val string)

SetLabel sets the value of the Name parameter

func (*VbanOutStream) SetOn

func (v *VbanOutStream) SetOn(val bool)

SetOn sets the value of the On parameter

func (*VbanOutStream) SetPort

func (v *VbanOutStream) SetPort(val int)

SetPort sets the value of the Port parameter

func (*VbanOutStream) SetQuality

func (v *VbanOutStream) SetQuality(val int)

SetQuality sets the value of the Quality parameter

func (*VbanOutStream) SetRoute

func (v *VbanOutStream) SetRoute(val int)

SetRoute sets the value of the Route parameter

func (*VbanOutStream) SetSr

func (v *VbanOutStream) SetSr(val int)

SetSr sets the value of the Sr parameter

func (*VbanOutStream) Sr

func (v *VbanOutStream) Sr() int

Sr returns the value of the Sr parameter

type VirtualBus

type VirtualBus struct {
	// contains filtered or unexported fields
}

VirtualBus represents a single virtual bus

func (*VirtualBus) Eq

func (b *VirtualBus) Eq() *eQ

Eq returns the eQ field

func (*VirtualBus) FadeBy

func (b *VirtualBus) FadeBy(change float32, time_ int)

FadeBy adjusts the value of gain by change over a time interval of time_

func (*VirtualBus) FadeTo

func (b *VirtualBus) FadeTo(target float32, time_ int)

FadeTo sets the value of gain to target over at time interval of time_

func (*VirtualBus) Gain

func (b *VirtualBus) Gain() float64

Gain returns the value of the Gain parameter

func (*VirtualBus) Label

func (b *VirtualBus) Label() string

Label returns the value of the MC parameter

func (*VirtualBus) Levels

func (b *VirtualBus) Levels() *levels

Levels returns the levels field

func (*VirtualBus) Mode

func (b *VirtualBus) Mode() *busMode

Mode returns address of a busMode struct

func (*VirtualBus) Mono

func (b *VirtualBus) Mono() bool

Mono returns the value of the Mute parameter

func (*VirtualBus) Mute

func (b *VirtualBus) Mute() bool

Mute returns the value of the Mute parameter

func (*VirtualBus) SetGain

func (b *VirtualBus) SetGain(val float64)

SetGain sets the value of the Gain parameter

func (*VirtualBus) SetLabel

func (b *VirtualBus) SetLabel(val string)

SetLabel sets the value of the MC parameter

func (*VirtualBus) SetMono

func (b *VirtualBus) SetMono(val bool)

SetMono sets the value of the Mute parameter

func (*VirtualBus) SetMute

func (b *VirtualBus) SetMute(val bool)

SetMute sets the value of the Mute parameter

func (*VirtualBus) String

func (v *VirtualBus) String() string

String implements the fmt.stringer interface

type VirtualStrip

type VirtualStrip struct {
	// contains filtered or unexported fields
}

VirtualStrip represents a single virtual strip

func (*VirtualStrip) AppGain

func (v *VirtualStrip) AppGain(name string, val float64)

AppGain sets the gain in db by val for the app matching name.

func (*VirtualStrip) AppMute

func (v *VirtualStrip) AppMute(name string, val bool)

AppMute sets mute state as val for the app matching name.

func (*VirtualStrip) Audibility

func (v *VirtualStrip) Audibility() float64

Audibility logs a warning reason invalid parameter it always returns zero value

func (*VirtualStrip) ColorX

func (v *VirtualStrip) ColorX() float64

ColorX logs a warning reason invalid parameter it always returns zero value

func (*VirtualStrip) ColorY

func (v *VirtualStrip) ColorY() float64

ColorY logs a warning reason invalid parameter it always returns zero value

func (*VirtualStrip) Comp

func (v *VirtualStrip) Comp() *comp

Comp returns the comp field

func (*VirtualStrip) Denoiser

func (v *VirtualStrip) Denoiser() *denoiser

Denoiser returns the denoiser field

func (*VirtualStrip) Eq

func (s *VirtualStrip) Eq() *eQ

Eq returns the eQ field

func (*VirtualStrip) FadeBy

func (s *VirtualStrip) FadeBy(change float64, time_ int)

FadeBy adjusts the value of gain by change over a time interval of time_

func (*VirtualStrip) FadeTo

func (s *VirtualStrip) FadeTo(target float64, time_ int)

FadeTo sets the value of gain to target over at time interval of time_

func (*VirtualStrip) FxX

func (v *VirtualStrip) FxX() float64

FxX logs a warning reason invalid parameter it always returns zero value

func (*VirtualStrip) FxY

func (v *VirtualStrip) FxY() float64

FxY logs a warning reason invalid parameter it always returns zero value

func (*VirtualStrip) Gain

func (s *VirtualStrip) Gain() float64

Gain returns the value of the Gain parameter

func (*VirtualStrip) GainLayer

func (s *VirtualStrip) GainLayer() []gainLayer

GainLayer returns the gainlayer field

func (*VirtualStrip) Gate

func (v *VirtualStrip) Gate() *gate

Gate returns the gate field

func (*VirtualStrip) Label

func (s *VirtualStrip) Label() string

Label returns the value of the Label parameter

func (*VirtualStrip) Levels

func (s *VirtualStrip) Levels() *levels

Levels returns the levels field

func (*VirtualStrip) Limit

func (s *VirtualStrip) Limit() int

Limit returns the value of the Limit parameter

func (*VirtualStrip) Mc

func (v *VirtualStrip) Mc() bool

Mc returns the value of the MC parameter

func (*VirtualStrip) Mono

func (s *VirtualStrip) Mono() bool

Mono returns the value of the Mono parameter

func (*VirtualStrip) Mute

func (s *VirtualStrip) Mute() bool

Mute returns the value of the Mute parameter

func (*VirtualStrip) PanX

func (s *VirtualStrip) PanX() float64

PanX returns the value of the Pan_X parameter

func (*VirtualStrip) PanY

func (s *VirtualStrip) PanY() float64

PanY returns the value of the Pan_Y parameter

func (*VirtualStrip) SetAudibility

func (v *VirtualStrip) SetAudibility(val float64)

SetAudibility logs a warning reason invalid parameter

func (*VirtualStrip) SetColorX

func (v *VirtualStrip) SetColorX(val float64)

SetColorX logs a warning reason invalid parameter

func (*VirtualStrip) SetColorY

func (v *VirtualStrip) SetColorY(val float64)

SetColorY logs a warning reason invalid parameter

func (*VirtualStrip) SetFxX

func (v *VirtualStrip) SetFxX(val float64)

SetFxX logs a warning reason invalid parameter

func (*VirtualStrip) SetFxY

func (v *VirtualStrip) SetFxY(val float64)

SetFxY logs a warning reason invalid parameter

func (*VirtualStrip) SetGain

func (s *VirtualStrip) SetGain(val float64)

SetGain sets the value of the Gain parameter

func (*VirtualStrip) SetLabel

func (s *VirtualStrip) SetLabel(val string)

SetLabel sets the value of the Label parameter

func (*VirtualStrip) SetLimit

func (s *VirtualStrip) SetLimit(val int)

SetLimit sets the value of the Limit parameter

func (*VirtualStrip) SetMc

func (v *VirtualStrip) SetMc(val bool)

SetMc sets the value of the MC parameter

func (*VirtualStrip) SetMono

func (s *VirtualStrip) SetMono(val bool)

SetMono sets the value of the Mono parameter

func (*VirtualStrip) SetMute

func (s *VirtualStrip) SetMute(val bool)

SetMute sets the value of the Mute parameter

func (*VirtualStrip) SetPanX

func (s *VirtualStrip) SetPanX(val float64)

SetPanX sets the value of the Pan_X parameter

func (*VirtualStrip) SetPanY

func (s *VirtualStrip) SetPanY(val float64)

SetPanY sets the value of the Pan_Y parameter

func (*VirtualStrip) SetSolo

func (s *VirtualStrip) SetSolo(val bool)

SetSolo sets the value of the Solo parameter

func (*VirtualStrip) Solo

func (s *VirtualStrip) Solo() bool

Solo returns the value of the Solo parameter

func (*VirtualStrip) String

func (v *VirtualStrip) String() string

String implements fmt.stringer interface

Directories

Path Synopsis
examples

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL