voicemeeter_api_ruby 3.0.0 → 4.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74364d7c7210a1b080f7903862f4a1811105a3b7cb69fb572cbc729325e577ca
-  data.tar.gz: 87289218250b0177ed6064777edf199f02d40c69d84458185d6cff5f798d2fe0
+  metadata.gz: e456329651c6151ed9756893125b802c099733fcefe64db8259f933539ee0587
+  data.tar.gz: 2d93a67a6f476d2ec173a267f479ecf5be9c6e333ead5a891e0f5ac1fbc74541
 SHA512:
-  metadata.gz: be94880faab9294919932abc5b1dc61177798f60deb2847c7672e6be0e7ca6dcc770e0a70983ab003ca098d8b08705b397ca3db3062b0756534dc881e5ed5725
-  data.tar.gz: 46f0cc75b33f53a4b35ac4f72064ac75f88dca55437b8c5727ae44c615bc0207546c9af8b9d83846750b777e186dc364008033b19c6688dfc55743ed73da2f9d
+  metadata.gz: dd26be5c5387a6c0ac1ca97d9c99e943205e05c76418e041d776e5fef6268a6a488bf98d63c10fc886e82469b5df140c5e0e8ea563b5ef955be878859b0f92b5
+  data.tar.gz: 5b04f810179c775e861b6ee1e79415d960ef9a7aac2cab490bd1b21019169b950cba869a9e0dc6a363fa9d9ceeb01dd27e93335b325aeeb934336f5f0700472c

data/CHANGELOG.md

@@ -5,13 +5,51 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-Before any major/minor/patch is released all test units will be run to verify they pass.
+Before any major/minor/patch is released all unit tests will be run to verify they pass.
 
 ## [Unreleased] - These changes have not been added to RubyGems yet
 
--   [ ] Update Readme for version 3 changes.
+-   [ ] add xy parameters to strip/bus
 
-## [3.0.0] - 2022-01-24
+## [4.1.0] - 2022-07-19
+
+### Added
+
+-   Conversion module in meta
+-   strip/bus levels implemented, ldirty added to notifications.
+
+### Changed
+
+-   1, 0 switched for true false in example configs
+-   observer example updated.
+-   minor version bump
+
+### Removed
+
+-   Boolean class monkey patch
+-   type checks
+
+## [4.0.0] - 2022-06-27
+
+### Added
+
+-   type, version added to base class
+-   device class implemented
+-   TOMLStrBuilder added to config, builds a default reset config
+-   support for observers to subscribe to updates
+-   observer example added
+-   device, sr, sel added to bus
+-   audibility, bass, mid, treble added to strip
+
+### Changed
+
+-   common interface iremote defined
+-   configs reworked. configs are now loaded lazily.
+-   command.reset now applies reset config from toml parser.
+-   profiles dir renamed to configs
+-   major version bump due to non-backwards compatible changes
+
+## [3.0.0] - 2022-05-03
 
 ### Added
 
@@ -171,7 +209,7 @@ README is up to date with version 2.0.2 onwards.
 
 ### Added
 
--   Added base0 test units for alias functions. This includes:
+-   Added base0 unit tests for alias functions. This includes:
     SetParamMultiBase0
     MacroButtonStatusWithAliasBase0
     SetParamMultiWithAliasBase0
@@ -185,7 +223,7 @@ README is up to date with version 2.0.2 onwards.
 
 ### Added
 
--   Base0 test units for each type.
+-   Base0 unit tests for each type.
 -   README updated to demonstrate set_multi, Macrobutton commands,
     Special commands and a brief description on how to run tests.
 
@@ -215,7 +253,7 @@ README is up to date with version 2.0.2 onwards.
 
 ### Added
 
--   test/<vbtype>/errors/errors_minitest.rb test unit files added to test
+-   test/<vbtype>/errors/errors_minitest.rb unit test files added to test
     custom error classes for each type of voicemeeter. Errors tests:
     APIError
     LoginError
@@ -267,5 +305,5 @@ README is up to date with version 2.0.2 onwards.
 
 -   Initial Commit
 -   Core of API
--   Test units
+-   Unit tests
 -   README.md

data/README.md

@@ -1,6 +1,8 @@
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/onyx-and-iris/voicemeeter-api-ruby/blob/dev/LICENSE)
 [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/plugin-ruby)
 ![tests: failed count](https://img.shields.io/badge/dynamic/json?color=blue&label=tests&query=summary.failure_count&suffix=%20failed&url=https%3A%2F%2Fraw.githubusercontent.com%2Fonyx-and-iris%2Fvoicemeeter-api-ruby%2Fdev%2Fspec%2Frspec.json)
+[![Gem Version](https://badge.fury.io/rb/voicemeeter_api_ruby.svg)](https://badge.fury.io/rb/voicemeeter_api_ruby)
+![](https://ruby-gem-downloads-badge.herokuapp.com/voicemeeter_api_ruby?type=total&color=red)
 
 # Ruby Wrapper for Voicemeeter API
 
@@ -21,30 +23,25 @@ For an outline of past/future changes refer to: [CHANGELOG](CHANGELOG.md)
 
 ## Installation
 
-### Gem
-
-Install voicemeeter_api_ruby gem from your console
-
-`gem install voicemeeter_api_ruby`
-
 ### Bundler
 
 Put this in your Gemfile:
 
-`gem 'voicemeeter_api_ruby', require: false`
+`gem 'voicemeeter_api_ruby'`
+
+### Gem
 
-or use bundlers built in git functionality:
+Install voicemeeter_api_ruby gem from your console
 
-`gem "voicemeeter_api_ruby", :git => "git://github.com/onyx-and-iris/voicemeeter-api-ruby"`
+`gem install 'voicemeeter_api_ruby'`
 
 ## `Use`
 
-Simplest use case, request a Remote class of a kind, then pass a block to run:
+Simplest use case, request a Remote class of a kind, then pass a block to run.
 
-as gem:
-`ruby .\main.rb`
-with bundler:
-`bundle exec ruby .\main.rb`
+Login and logout are handled for you in this scenario.
+
+#### `main.rb`
 
 ```ruby
 require 'voicemeeter'
@@ -54,21 +51,21 @@ kind_id = 'banana'
 # start Voicemeeter GUI
 Voicemeeter.start(kind_id)
 
-vmr = Voicemeeter.remote(kind_id)
+vm = Voicemeeter.remote(kind_id)
 
-# vmr.run accepts a block
-vmr.run do
+# vm.run accepts a block
+vm.run do
     # mute the leftmost strip
-    vmr.strip[0].mute = true
-    puts vmr.strip[0].mute
+    vm.strip[0].mute = true
+    puts vm.strip[0].mute
 
     # disable eq for second from left bus
-    vmr.bus[1].eq = false
-    puts vmr.bus[1].eq
+    vm.bus[1].eq = false
+    puts vm.bus[1].eq
 end
 ```
 
-Login and logout are handled for you in this scenario.
+Otherwise you must remember to call `vm.login` `vm.logout` at the start/end of your code.
 
 ## `kind_id`
 
@@ -80,18 +77,90 @@ Pass the kind of Voicemeeter as an argument. kind_id may be:
 
 ## `Available commands`
 
-### Channels (strip/bus)
+### Strip
 
-The following properties exist for audio channels.
+The following properties are available.
 
 -   `mono`: boolean
+-   `solo`: boolean
 -   `mute`: boolean
--   `gain`: float, from -60 to 12
--   `mc`, `k`: boolean
--   `comp`, `gate`: float, from 0 to 10
+-   `gain`: float, from -60.0 to 12.0
+-   `comp`: float, from 0.0 to 10.0
+-   `gate`: float, from 0.0 to 10.0
+-   `audibility`: float, from 0.0 to 10.0
 -   `limit`: int, from -40 to 12
 -   `A1 - A5`, `B1 - B3`: boolean
+-   `label`: string
+-   `device`: string
+-   `sr`: int
+-   `mc`: boolean
+-   `k`: int, from 0 to 4
+-   `bass`: float, from -12.0 to 12.0
+-   `mid`: float, from -12.0 to 12.0
+-   `treble`: float, from -12.0 to 12.0
+
+example:
+
+```ruby
+vm.strip[3].gain = 3.7
+puts vm.strip[0].label
+```
+
+The following methods are available.
+
+-   `appgain(name, value)`: string, float, from 0.0 to 1.0
+
+Set the gain in db by value for the app matching name.
+
+-   `appmute(name, value)`: string, bool
+
+Set mute state as value for the app matching name.
+
+example:
+
+```ruby
+vm.strip[5].appgain('Spotify', 0.5)
+vm.strip[5].appmute('Spotify', true)
+```
+
+##### Gainlayers
+
+-   `gain`: float, from -60.0 to 12.0
+
+example:
+
+```ruby
+vm.strip[3].gainlayer[3].gain = 3.7
+```
+
+Gainlayers are defined for potato version only.
+
+##### Levels
+
+The following properties are available.
+
+-   `prefader`
+-   `postfader`
+-   `postmute`
+
+example:
+
+```ruby
+puts vm.strip[3].levels.prefader
+```
+
+Level properties will return -200.0 if no audio detected.
+
+### Bus
+
+The following properties are available.
+
+-   `mono`: boolean
+-   `mute`: boolean
 -   `eq`: boolean
+-   `eq_ab`: boolean
+-   `sel`: boolean
+-   `gain`: float, from -60.0 to 12.0
 -   `label`: string
 -   `device`: string
 -   `sr`: int
@@ -99,10 +168,60 @@ The following properties exist for audio channels.
 example:
 
 ```ruby
-vmr.strip[3].gain = 3.7
-puts strip[0].label
+vm.bus[3].gain = 3.7
+puts vm.bus[0].label
 
-vmr.bus[4].mono = true
+vm.bus[4].mono = true
+```
+
+##### Modes
+
+-   `normal`: boolean
+-   `amix`: boolean
+-   `bmix`: boolean
+-   `composite`: boolean
+-   `tvmix`: boolean
+-   `upmix21`: boolean
+-   `upmix41`: boolean
+-   `upmix61`: boolean
+-   `centeronly`: boolean
+-   `lfeonly`: boolean
+-   `rearonly`: boolean
+
+example:
+
+```ruby
+vm.bus[4].mode.amix = true
+```
+
+##### Levels
+
+The following properties are available.
+
+-   `all`
+
+example:
+
+```ruby
+puts vm.bus[0].levels.all
+```
+
+`levels.all` will return -200.0 if no audio detected.
+
+### Strip | Bus
+
+The following methods are Available
+
+-   `fadeto(amount, time)`: float, int
+-   `fadeby(amount, time)`: float, int
+
+Modify gain to or by the selected amount in db over a time interval in ms.
+
+example:
+
+```ruby
+vm.strip[0].fadeto(-10.3, 1000)
+vm.bus[3].fadeby(-5.6, 500)
 ```
 
 ### Macrobuttons
@@ -116,12 +235,18 @@ Three modes defined: state, stateonly and trigger.
 example:
 
 ```ruby
-vmr.button[37].state = true
-vmr.button[55].trigger = false
+vm.button[37].state = true
+vm.button[55].trigger = false
 ```
 
 ### Recorder
 
+The following properties accept boolean values.
+
+-   `loop`: boolean
+-   `A1 - A5`: boolean
+-   `B1 - A3`: boolean
+
 The following methods are Available
 
 -   `play`
@@ -130,34 +255,31 @@ The following methods are Available
 -   `record`
 -   `ff`
 -   `rew`
-    The following properties accept boolean values.
--   `loop`: boolean
--   `A1 - A5`: boolean
--   `B1 - A3`: boolean
-    Load accepts a string:
--   `load`: string
+-   `load(filepath)`: string
 
 example:
 
 ```ruby
-vmr.recorder.play
-vmr.recorder.stop
+vm.recorder.play
+vm.recorder.stop
 
 # Enable loop play
-vmr.recorder.loop = True
+vm.recorder.loop = True
 
 # Disable recorder out channel B2
-vmr.recorder.B2 = False
+vm.recorder.B2 = False
 
 # filepath as string
-vmr.recorder.load('C:\music\mytune.mp3')
+vm.recorder.load('C:\music\mytune.mp3')
 ```
 
 ### VBAN
 
--   `vmr.vban.enable` `vmr.vban.disable` Turn VBAN on or off
+-   `vm.vban.enable` `vm.vban.disable` Turn VBAN on or off
 
-For each vban in/out stream the following properties are defined:
+##### Instream | Outstream
+
+The following properties are available.
 
 -   `on`: boolean
 -   `name`: string
@@ -175,13 +297,13 @@ example:
 
 ```ruby
 # turn VBAN on
-vmr.vban.enable
+vm.vban.enable
 
 # turn on vban instream 0
-vmr.vban.instream[0].on = True
+vm.vban.instream[0].on = True
 
 # set bit property for outstream 3 to 24
-vmr.vban.outstream[3].bit = 24
+vm.vban.outstream[3].bit = 24
 ```
 
 ### Command
@@ -200,8 +322,19 @@ The following properties are write only and accept boolean values.
 example:
 
 ```ruby
-vmr.command.restart
-vmr.command.showvbanchat = true
+vm.command.restart
+vm.command.showvbanchat = true
+```
+
+### Device
+
+-   `ins` `outs` : Returns the number of input/output devices
+-   `input(i)` `output(i)` : Returns a hash of device properties for device[i]
+
+example:
+
+```ruby
+vm.run { (0...vm.device.ins).each { |i| puts vm.device.input(i) } }
 ```
 
 ### Multiple parameters
@@ -210,7 +343,7 @@ vmr.command.showvbanchat = true
     Set many strip/bus/macrobutton/vban parameters at once, for example:
 
 ```ruby
-vmr.set_multi(
+vm.set_multi(
     {
         strip_0: {
             mute: true,
@@ -235,30 +368,46 @@ vmr.set_multi(
 Or for each class you may do:
 
 ```ruby
-vmr.strip[0].set_multi(mute: true, gain: 3.2, A1: true)
-vmr.vban.outstream[0].set_multi(on: true, name: 'streamname', bit: 24)
+vm.strip[0].set_multi(mute: true, gain: 3.2, A1: true)
+vm.vban.outstream[0].set_multi(on: true, name: 'streamname', bit: 24)
+```
+
+## Config Files
+
+`vm.set_config(<configname>)`
+
+You may load config files in TOML format.
+Three example configs have been included with the package. Remember to save
+current settings before loading a config. To set one you may do:
+
+```ruby
+require 'voicemeeter'
+vm = Voicemeeter.remote('banana')
+vm.run { vm.set_config('example') }
 ```
 
+will load a config file at configs/banana/example.toml for Voicemeeter Banana.
+
 ## `Voicemeeter Module`
 
 ### Remote class
 
 Access to lower level Getters and Setters are provided with these functions:
 
--   `vmr.get(param, string=false)`: For getting the value of any parameter. Set string to true if getting a property value expected to return a string.
--   `vmr.set(param, value)`: For setting the value of any parameter.
+-   `vm.get(param, string=false)`: For getting the value of any parameter. Set string to true if getting a property value expected to return a string.
+-   `vm.set(param, value)`: For setting the value of any parameter.
 
 Access to lower level polling functions are provided with these functions:
 
--   `vmr.pdirty?`: Returns true if a parameter has been updated.
--   `vmr.mdirty?`: Returns true if a macrobutton has been updated.
+-   `vm.pdirty?`: Returns true if a parameter has been updated.
+-   `vm.mdirty?`: Returns true if a macrobutton has been updated.
 
 example:
 
 ```ruby
-vmr.get('Strip[2].Mute')
-vmr.set('Strip[4].Label', 'stripname')
-vmr.set('Strip[0].Gain', -3.6)
+vm.get('Strip[2].Mute')
+vm.set('Strip[4].Label', 'stripname')
+vm.set('Strip[0].Gain', -3.6)
 ```
 
 #### Voicemeeter::start
@@ -271,24 +420,6 @@ require 'voicemeeter'
 Voicemeeter.start('banana')
 ```
 
-## Config Files
-
-`vmr.set_profile('config')`
-
-You may load config files in TOML format.
-Three example profiles have been included with the package. Remember to save
-current settings before loading a profile. To test them simply rename \_profiles
-directory to profiles. They will be loaded into memory but not set. To set one
-you may do:
-
-```ruby
-require 'voicemeeter'
-vmr = Voicemeeter.remote('banana')
-vmr.run { vmr.set_profile('config') }
-```
-
-will load a config file at profiles/banana/config.toml for Voicemeeter Banana.
-
 ### Run tests
 
 To run all tests:
@@ -305,4 +436,4 @@ Bundle exec rspec --tag 'higher'
 
 ### Official Documentation
 
--   [Voicemeeter Remote C API](https://forum.vb-audio.com/viewtopic.php?f=8&t=346)
+-   [Voicemeeter Remote C API](https://github.com/onyx-and-iris/Voicemeeter-SDK/blob/main/VoicemeeterRemoteAPI.pdf)