onyx_online/voicemeeter
1
0
Fork 0
mirror of https://github.com/onyx-and-iris/voicemeeter.git synced 2024-11-15 17:40:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

upd minor ver in readme

Browse Source
This commit is contained in:
onyx-and-iris 2022-07-01 01:41:43 +01:00
parent ef5623f1c6
commit 6148d45b76
1 changed files with 100 additions and 74 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

174
README.md
View File

@ -21,7 +21,7 @@ For an outline of past/future changes refer to: [CHANGELOG](CHANGELOG.md)
Add to your `go.mod` file: Add to your `go.mod` file:
`require github.com/onyx-and-iris/voicemeeter-api-go v1.0.0` `require github.com/onyx-and-iris/voicemeeter-api-go v1.0.2`
Install voicemeeter-api-go package from your console Install voicemeeter-api-go package from your console
@ -54,7 +54,6 @@ func main() {
} }
``` ```
## `kindId` ## `kindId`
Pass the kind of Voicemeeter as an argument. kindId may be: Pass the kind of Voicemeeter as an argument. kindId may be:
@ -64,34 +63,61 @@ Pass the kind of Voicemeeter as an argument. kindId may be:
- `potato` - `potato`
## `Remote Type` ## `Remote Type`
#### `vmRem.Strip` #### `vmRem.Strip`
[]t_strip slice containing both physicalStrip and virtualStrip types []t_strip slice containing both physicalStrip and virtualStrip types
#### `vmRem.Bus` #### `vmRem.Bus`
[]t_bus slice containing both physicalBus and virtualBus types []t_bus slice containing both physicalBus and virtualBus types
#### `vmRem.Button` #### `vmRem.Button`
[]button slice containing button types, one for each macrobutton []button slice containing button types, one for each macrobutton
#### `vmRem.Command` #### `vmRem.Command`
pointer to command type, represents action type functions pointer to command type, represents action type functions
#### `vmRem.Vban` #### `vmRem.Vban`
pointer to vban type, containing both vbanInStream and vbanOutStream slices pointer to vban type, containing both vbanInStream and vbanOutStream slices
#### `vmRem.Device` #### `vmRem.Device`
pointer to device type, represents physical input/output hardware devices pointer to device type, represents physical input/output hardware devices
#### `vmRem.Recorder` #### `vmRem.Recorder`
pointer to recorder type, represents the recorder pointer to recorder type, represents the recorder
#### `vmRem.Type()` #### `vmRem.Type()`
returns the type of Voicemeeter as a string returns the type of Voicemeeter as a string
#### `vmRem.Version()` #### `vmRem.Version()`
returns the version of Voicemeeter as a string returns the version of Voicemeeter as a string
#### `vmRem.SendText(<script>)` #### `vmRem.SendText(<script>)`
sets many parameters in script format eg. ("Strip[0].Mute=1;Bus[3].Gain=3.6") sets many parameters in script format eg. ("Strip[0].Mute=1;Bus[3].Gain=3.6")
#### `vmRem.Register(o observer)` #### `vmRem.Register(o observer)`
register an object as an observer register an object as an observer
#### `vmRem.Deregister(o observer)` #### `vmRem.Deregister(o observer)`
deregister an object as an observer deregister an object as an observer
#### `vmRem.Pdirty()` #### `vmRem.Pdirty()`
returns True iff a GUI parameter has changed returns True iff a GUI parameter has changed
#### `vmRem.Mdirty()` #### `vmRem.Mdirty()`
returns True iff a macrobutton paramter has changed returns True iff a macrobutton paramter has changed
## `Available commands` ## `Available commands`
@ -100,26 +126,26 @@ returns True iff a macrobutton paramter has changed
The following functions are available The following functions are available
- `GetMute() bool` - `GetMute() bool`
- `SetMute(val bool)` - `SetMute(val bool)`
- `GetMono() bool` - `GetMono() bool`
- `SetMono(val bool)` - `SetMono(val bool)`
- `GetSolo() bool` - `GetSolo() bool`
- `SetSolo(val bool)` - `SetSolo(val bool)`
- `GetLimit() int` - `GetLimit() int`
- `SetLimit(val int)` from -40 to 12 - `SetLimit(val int)` from -40 to 12
- `GetLabel() string` - `GetLabel() string`
- `SetLabel(val string)` - `SetLabel(val string)`
- `GetGain() float64` - `GetGain() float64`
- `SetGain(val float32)` from -60.0 to 12.0 - `SetGain(val float32)` from -60.0 to 12.0
- `GetMc() bool` - `GetMc() bool`
- `SetMc(val bool)` - `SetMc(val bool)`
- `GetComp() float64` - `GetComp() float64`
- `SetComp(val float32)` from 0.0 to 10.0 - `SetComp(val float32)` from 0.0 to 10.0
- `GetGate() float64` - `GetGate() float64`
- `SetGate(val float32)` from 0.0 to 10.0 - `SetGate(val float32)` from 0.0 to 10.0
- `GetAudibility() float64` - `GetAudibility() float64`
- `SetAudibility(val float32)` from 0.0 to 10.0 - `SetAudibility(val float32)` from 0.0 to 10.0
- `GetA1() bool - GetA5() bool` - `GetA1() bool - GetA5() bool`
- `SetA1(val bool) - SetA5(val bool)` - `SetA1(val bool) - SetA5(val bool)`
@ -135,17 +161,17 @@ vmRem.Strip[4].SetA1(true)
The following functions are available The following functions are available
- `String() string` - `String() string`
- `GetMute() bool` - `GetMute() bool`
- `SetMute(val bool)` - `SetMute(val bool)`
- `GetEq() bool` - `GetEq() bool`
- `SetEq(val bool)` - `SetEq(val bool)`
- `GetMono() bool` - `GetMono() bool`
- `SetMono(val bool)` - `SetMono(val bool)`
- `GetLabel() string` - `GetLabel() string`
- `SetLabel(val string)` - `SetLabel(val string)`
- `GetGain() float64` - `GetGain() float64`
- `SetGain(val float32)` from -60.0 to 12.0 - `SetGain(val float32)` from -60.0 to 12.0
```go ```go
vmRem.Bus[3].SetEq(true) vmRem.Bus[3].SetEq(true)
@ -154,7 +180,7 @@ fmt.Println(vmRem.Bus[0].GetLabel())
##### Modes ##### Modes
- `vmRem.Bus[i].Mode()` - `vmRem.Bus[i].Mode()`
The following functions are available The following functions are available
@ -180,12 +206,12 @@ vmRem.Bus[3].Mode().SetAmix(true)
The following functions are available The following functions are available
- `GetState() bool` - `GetState() bool`
- `SetState(val bool)` - `SetState(val bool)`
- `GetStateOnly() bool` - `GetStateOnly() bool`
- `SetStateOnly(val bool)` - `SetStateOnly(val bool)`
- `GetTrigger() bool` - `GetTrigger() bool`
- `SetTrigger(val bool)` - `SetTrigger(val bool)`
example: example:
@ -198,11 +224,11 @@ fmt.Println(vmRem.Button[64].GetStateOnly())
The following functions are available The following functions are available
- `Show()` Show Voicemeeter GUI if it's hidden - `Show()` Show Voicemeeter GUI if it's hidden
- `Hide()` Hide Voicemeeter GUI if it's shown - `Hide()` Hide Voicemeeter GUI if it's shown
- `Shutdown()` Shuts down the GUI - `Shutdown()` Shuts down the GUI
- `Restart()` Restart the audio engine - `Restart()` Restart the audio engine
- `Lock(val bool)` Lock the Voicemeeter GUI - `Lock(val bool)` Lock the Voicemeeter GUI
example: example:
@ -221,24 +247,24 @@ vmRem.Command.Show()
The following functions are available The following functions are available
- `GetOn() bool` - `GetOn() bool`
- `SetOn(val bool)` - `SetOn(val bool)`
- `GetName() string` - `GetName() string`
- `SetName(val string)` - `SetName(val string)`
- `GetIp() string` - `GetIp() string`
- `SetIp(val string)` - `SetIp(val string)`
- `GetPort() int` - `GetPort() int`
- `SetPort(val int)` from 1024 to 65535 - `SetPort(val int)` from 1024 to 65535
- `GetSr() int` - `GetSr() int`
- `SetSr(val int)` (11025, 16000, 22050, 24000, 32000, 44100, 48000, 64000, 88200, 96000) - `SetSr(val int)` (11025, 16000, 22050, 24000, 32000, 44100, 48000, 64000, 88200, 96000)
- `GetChannel() int` - `GetChannel() int`
- `SetChannel(val int)` from 1 to 8 - `SetChannel(val int)` from 1 to 8
- `GetBit() int` - `GetBit() int`
- `SetBit(val int)` 16 or 24 - `SetBit(val int)` 16 or 24
- `GetQuality() int` - `GetQuality() int`
- `SetQuality(val int)` from 0 to 4 - `SetQuality(val int)` from 0 to 4
- `GetRoute() int` - `GetRoute() int`
- `SetRoute(val int)` from 0 to 8 - `SetRoute(val int)` from 0 to 8
example: example:
@ -257,10 +283,10 @@ vmRem.Vban.OutStream[3].SetBit(24)
The following functions are available The following functions are available
- `Ins` - `Ins`
- `Outs` - `Outs`
- `Input(val int)` - `Input(val int)`
- `Output(val int)` - `Output(val int)`
example: example:
@ -274,13 +300,13 @@ for i := 0; i < int(vmRem.Device.Ins()); i++ {
The following functions are available The following functions are available
- `Play()` - `Play()`
- `Stop()` - `Stop()`
- `Pause()` - `Pause()`
- `Replay()` - `Replay()`
- `Record()` - `Record()`
- `Ff()` - `Ff()`
- `Rew()` - `Rew()`
example: example: