From 4b69952fd58a8a16d04f49d3d1bee4abe6cefa1f Mon Sep 17 00:00:00 2001 From: onyx-and-iris Date: Fri, 9 Dec 2022 01:17:16 +0000 Subject: [PATCH] md fix in readme, reword in changelog --- CHANGELOG.md | 6 +++--- README.md | 32 ++++++++++++++++++++++++++------ 2 files changed, 29 insertions(+), 9 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d4b1db1..1f6acde 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -18,10 +18,10 @@ V2 introduces some breaking changes. ### Changed - 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.gate now reference gate struct type -- strip.eq, bus.eq now reference eQ struct types +- strip.gate now references gate struct type +- strip.eq, bus.eq now reference eQ struct type - All examples and tests have been updated to reflect the changes. ### Added diff --git a/README.md b/README.md index 7474720..1145bfd 100644 --- a/README.md +++ b/README.md @@ -213,7 +213,7 @@ vm.Strip[5].AppGain("Spotify", 0.5) vm.Strip[5].AppMute("Spotify", true) ``` -#### Comp +##### Comp - `vm.Strip[i].Comp()` @@ -238,7 +238,13 @@ The following methods are available - `MakeUp() bool` - `SetMakeUp(val bool)` -#### Gate +example: + +```go +vm.Strip[3].Comp().SetRatio(3.5) +``` + +##### Gate - `vm.Strip[i].Gate()` @@ -259,7 +265,13 @@ The following methods are available - `Release() float64` - `SetRelease(val float64)` from 0.0 to 5000.0 -#### Denoiser +example: + +```go +fmt.Println(vm.Strip[4].Gate().Attack()) +``` + +##### Denoiser - `vm.Strip[i].Denoiser()` @@ -268,6 +280,12 @@ The following methods are available - `Knob() float64` - `SetKnob(val float64)` from 0.0 to 10.0 +example: + +```go +vm.Strip[1].Denoiser().SetKnob(4.2) +``` + ##### Gainlayer - `vm.Strip[i].Gainlayer()[j]` @@ -313,6 +331,8 @@ The following methods are available - `Gain() float64` - `SetGain(val float64)` from -60.0 to 12.0 +example: + ```go vm.Bus[3].SetEq(true) fmt.Println(vm.Bus[0].Label()) @@ -372,9 +392,9 @@ fmt.Println(vm.Bus[1].Levels().All()) ### 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. @@ -445,7 +465,7 @@ vm.Command.Show() ##### Instream | Outstream -- `vm.Vban.InStream` `vm.Vban.OutStream` +- `vm.Vban.InStream[i]` `vm.Vban.OutStream[i]` The following methods are available