voicemeeter 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07bc7810c8539267babd1a0ac6c1dc929e37b237f8b65b96d60ee2d6a823a0b5
-  data.tar.gz: 79c662a5e0b36a3787f4eb27d90892624a0990d3347165d7a6e036ee031ae9cc
+  metadata.gz: e3b54899e83b3462fbe37aeaf0650998d5071de096e10ffbab7175fe72ae8d7a
+  data.tar.gz: 6383c43139954ff774b74b8d1566c233ae4939021b99071422473765295d0c62
 SHA512:
-  metadata.gz: 5819aac96ad967b7da5195b8ada670825be2720a57ff70a540718c53cde98814f51154aec79ffa903269f39a12e12f27a87bd682f83545946119320203b65c58
-  data.tar.gz: 3c248695fcd6ab4f47582dc77c1bb2ad7d66dd08ef152261cdcacd268d7a65ed15c92749f3dafdf21256f044772b2a1dd90e767d9bf152edfee30c909afaf8ff
+  metadata.gz: 886a45d632d42562b743123c5f19b7127d7655aa49b708cb2f0aa748db8fea6367f78f9c5719b7c11a8a0acb9ddaea2b4d94442720897d536cb305c3fb1c03f9
+  data.tar.gz: '08de65bd94561a463f457eeefee2badf434b3720a5121f8123e6c709c9c60cab10a8ac75deca54f307bdd428c0d9f528b4abdf80b83b5793309d42a824ad26e3'

data/CHANGELOG.md

@@ -11,6 +11,12 @@ Before any major/minor/patch is released all unit tests will be run to verify th
 
 - [ ]
 
+## [1.1.0] - 2023-06-28
+
+### Added
+
+- Configurable kwarg `login_timeout`, defaults to 2s.
+
 ## [1.0.1] - 2023-09-14
 
 ### Added

data/README.md

@@ -10,9 +10,9 @@ For an outline of past/future changes refer to: [CHANGELOG](CHANGELOG.md)
 
 ## Tested against
 
-- Basic 1.0.8.8
-- Banana 2.0.6.8
-- Potato 3.0.2.8
+- Basic 1.1.1.1
+- Banana 2.1.1.1
+- Potato 3.1.1.1
 
 ## Requirements
 
@@ -630,7 +630,7 @@ vm.vban.outstream[0].apply(on: true, name: "streamname", bit: 24)
 
 `vm.apply_config(<configname>)`
 
-You may load config files in TOML format.
+You may load config files in YAML 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:
 
@@ -639,7 +639,7 @@ require "voicemeeter"
 Voicemeeter::Remote.new(:banana).run { |vm| vm.apply_config(:example) }
 ```
 
-will load a config file at mydir/configs/banana/example.toml for Voicemeeter Banana.
+will load a config file at mydir/configs/banana/example.yml for Voicemeeter Banana.
 
 ## Events
 
@@ -750,7 +750,7 @@ vm.set("Strip[0].Gain", -3.6)
   - The following attributes are available:
     - `fn_name`: name of the C-API function that failed.
     - `code`: error code.
-  - For a full list of error codes [check the VoicemeeterRemote header file][voicemeeter remote header].
+  - For a full list of error codes check the [VoicemeeterRemote header file][voicemeeter remote header].
 
 ### Logging
 
@@ -772,9 +772,9 @@ Bundle exec rake
 
 ### Official Documentation
 
-- [Voicemeeter Remote C API](https://github.com/onyx-and-iris/Voicemeeter-SDK/blob/update-docs/VoicemeeterRemoteAPI.pdf)
+- [Voicemeeter Remote C API](https://github.com/onyx-and-iris/Voicemeeter-SDK/blob/main/VoicemeeterRemoteAPI.pdf)
 
 [license]: https://github.com/onyx-and-iris/voicemeeter-rb/blob/dev/LICENSE
-[voicemeeter remote header]: https://github.com/onyx-and-iris/Voicemeeter-SDK/blob/update-docs/VoicemeeterRemote.h
+[voicemeeter remote header]: https://github.com/onyx-and-iris/Voicemeeter-SDK/blob/main/VoicemeeterRemote.h
 [code style]: https://img.shields.io/badge/code_style-standard-violet.svg
 [gem version]: https://badge.fury.io/rb/voicemeeter.svg

data/lib/voicemeeter/base.rb

@@ -4,18 +4,21 @@ module Voicemeeter
     include Logging
     include Worker
     include Events::Director
+    prepend Util::Timeout
     prepend Util::Cache
 
     attr_reader :kind, :midi, :event, :delay, :cache
 
     RATELIMIT = 0.033
     DELAY = 0.001
+    LOGIN_TIMEOUT = 2
 
     def initialize(kind, **kwargs)
       @kind = kind
       @sync = kwargs[:sync] || false
       @ratelimit = kwargs[:ratelimit] || RATELIMIT
       @delay = kwargs[:delay] || DELAY
+      @login_timeout = kwargs[:login_timeout] || LOGIN_TIMEOUT
       @event =
         Events::Tracker.new(
           **(kwargs.select { |k, _| %i[pdirty mdirty ldirty midi].include? k })
@@ -30,8 +33,6 @@ module Voicemeeter
 
     def login
       CBindings.call(:bind_login, ok: [0, 1]) == 1 and run_voicemeeter(kind.name)
-      clear_dirty
-      logger.info "Successfully logged into #{self} version #{version}"
     end
 
     def logout
@@ -72,7 +73,6 @@ module Voicemeeter
         logger.debug "Voicemeeter engine running but the GUI appears to be down... launching."
       end
       CBindings.call(:bind_run_voicemeeter, kinds[kind_id])
-      sleep(1)
     end
 
     def type

data/lib/voicemeeter/util.rb

@@ -18,6 +18,26 @@ module Voicemeeter
       end
     end
 
+    module Timeout
+      def login
+        super
+
+        err = nil
+        start = Time.now
+        begin
+          sleep 0.1
+          logger.info "Successfully logged into #{self} version #{version}"
+          logger.debug "login time: #{(Time.now - start).round(2)}"
+          err = nil
+        rescue Errors::VMCAPIError => e
+          err = e
+          retry if Time.now < start + @login_timeout
+        end
+        raise Errors::VMError.new "Timeout logging into the api" if err
+        clear_dirty
+      end
+    end
+
     module Cache
       def get(name, is_string = false)
         return cache.delete(name) if cache.key? name

data/lib/voicemeeter/version.rb

@@ -7,11 +7,11 @@ module Voicemeeter
     end
 
     def minor
-      0
+      1
     end
 
     def patch
-      1
+      0
     end
 
     def to_a

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: voicemeeter
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - onyx_online
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-14 00:00:00.000000000 Z
+date: 2024-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi