md fix in readme, reword in changelog

This commit is contained in:
onyx-and-iris 2022-12-09 01:17:16 +00:00
parent 632cd9049f
commit 4b69952fd5
2 changed files with 29 additions and 9 deletions

View File

@ -18,10 +18,10 @@ V2 introduces some breaking changes.
### Changed ### Changed
- Removed Get prefix from field getters in Bus, Strip, Vban, Button and Output types. - Removed Get prefix from field getters in Bus, Strip, Vban, Button and Output types.
- Updates now require the consumer to pass a channel to receive updates. - Pooler now communicates event updates over a channel.
- strip.comp now references comp struct type - strip.comp now references comp struct type
- strip.gate now reference gate struct type - strip.gate now references gate struct type
- strip.eq, bus.eq now reference eQ struct types - strip.eq, bus.eq now reference eQ struct type
- All examples and tests have been updated to reflect the changes. - All examples and tests have been updated to reflect the changes.
### Added ### Added

View File

@ -213,7 +213,7 @@ vm.Strip[5].AppGain("Spotify", 0.5)
vm.Strip[5].AppMute("Spotify", true) vm.Strip[5].AppMute("Spotify", true)
``` ```
#### Comp ##### Comp
- `vm.Strip[i].Comp()` - `vm.Strip[i].Comp()`
@ -238,7 +238,13 @@ The following methods are available
- `MakeUp() bool` - `MakeUp() bool`
- `SetMakeUp(val bool)` - `SetMakeUp(val bool)`
#### Gate example:
```go
vm.Strip[3].Comp().SetRatio(3.5)
```
##### Gate
- `vm.Strip[i].Gate()` - `vm.Strip[i].Gate()`
@ -259,7 +265,13 @@ The following methods are available
- `Release() float64` - `Release() float64`
- `SetRelease(val float64)` from 0.0 to 5000.0 - `SetRelease(val float64)` from 0.0 to 5000.0
#### Denoiser example:
```go
fmt.Println(vm.Strip[4].Gate().Attack())
```
##### Denoiser
- `vm.Strip[i].Denoiser()` - `vm.Strip[i].Denoiser()`
@ -268,6 +280,12 @@ The following methods are available
- `Knob() float64` - `Knob() float64`
- `SetKnob(val float64)` from 0.0 to 10.0 - `SetKnob(val float64)` from 0.0 to 10.0
example:
```go
vm.Strip[1].Denoiser().SetKnob(4.2)
```
##### Gainlayer ##### Gainlayer
- `vm.Strip[i].Gainlayer()[j]` - `vm.Strip[i].Gainlayer()[j]`
@ -313,6 +331,8 @@ The following methods are available
- `Gain() float64` - `Gain() float64`
- `SetGain(val float64)` from -60.0 to 12.0 - `SetGain(val float64)` from -60.0 to 12.0
example:
```go ```go
vm.Bus[3].SetEq(true) vm.Bus[3].SetEq(true)
fmt.Println(vm.Bus[0].Label()) fmt.Println(vm.Bus[0].Label())
@ -372,9 +392,9 @@ fmt.Println(vm.Bus[1].Levels().All())
### Strip | Bus ### Strip | Bus
#### EQ ##### EQ
- `vm.Strip[i].Eq()` | `vm.Bus[i].Eq()` - `vm.Strip[i].Eq()` `vm.Bus[i].Eq()`
The following methods are available. The following methods are available.
@ -445,7 +465,7 @@ vm.Command.Show()
##### Instream | Outstream ##### Instream | Outstream
- `vm.Vban.InStream` `vm.Vban.OutStream` - `vm.Vban.InStream[i]` `vm.Vban.OutStream[i]`
The following methods are available The following methods are available