voicemeeter_api_ruby 3.0.0 → 4.0.0

data/lib/vban.rb

@@ -1,67 +1,13 @@
+require_relative 'iremote'
 require_relative 'meta'
 require_relative 'errors'
 
-class IVban
+class VbanStream < IRemote
     '
-    Base Vban class
+    A class representing a VBAN stream
     '
     include Vban_Meta_Functions
 
-    def initialize(remote, index)
-        @remote = remote
-        @index = index
-    end
-
-    def getter(param, is_string = false)
-        @remote.get_parameter("#{self.cmd}.#{param}", is_string)
-    end
-
-    def setter(param, value)
-        @remote.set_parameter("#{self.cmd}.#{param}", value)
-    end
-
-    def cmd
-        "#{self.identifier}.#{self.direction}stream[#{@index}]"
-    end
-
-    def direction
-        raise 'Called abstract mehod: direction'
-    end
-
-    def set_multi(param_hash)
-        param_hash.each { |(key, val)| self.send("#{key}=", val) }
-    end
-end
-
-class Vban < IVban
-    '
-    Concrete Vban class
-    '
-    def self.make(remote, vban_streams)
-        '
-        Factory function for Vban class.
-
-        Returns a mixin of instream/outstream subclasses
-        '
-        class << self
-            attr_accessor :instream, :outstream, :remote
-
-            def enable
-                @remote.set_parameter('vban.enable', 1)
-            end
-            def disable
-                @remote.set_parameter('vban.enable', 0)
-            end
-        end
-
-        vban_in, vban_out = vban_streams.values
-        self.instream = (0...vban_in).map { |i| VbanInstream.new(remote, i) }
-        self.outstream = (0...vban_out).map { |i| VbanOutstream.new(remote, i) }
-
-        self.remote = remote
-        return self
-    end
-
     def initialize(remote, i)
         super
         self.make_accessor_bool :on
@@ -70,11 +16,15 @@ class Vban < IVban
     end
 
     def identifier
-        :vban
+        "vban.#{self.direction}stream[#{@index}]"
+    end
+
+    def direction
+        raise 'Called abstract mehod: direction'
     end
 end
 
-class VbanInstream < Vban
+class VbanInstream < VbanStream
     '
     A subclass representing a VBAN Instream
     '
@@ -88,7 +38,7 @@ class VbanInstream < Vban
     end
 end
 
-class VbanOutstream < Vban
+class VbanOutstream < VbanStream
     '
     A subclass representing a VBAN Outstream
     '
@@ -101,3 +51,28 @@ class VbanOutstream < Vban
         :out
     end
 end
+
+class Vban
+    attr_accessor :instream, :outstream
+
+    def initialize(remote, vban_streams)
+        '
+        Initializes a Vban class
+
+        Creates an array for each in/out stream
+        '
+        vban_in, vban_out = vban_streams.values
+        self.instream = (0...vban_in).map { |i| VbanInstream.new(remote, i) }
+        self.outstream = (0...vban_out).map { |i| VbanOutstream.new(remote, i) }
+
+        @remote = remote
+    end
+
+    def enable
+        @remote.set_parameter('vban.enable', 1)
+    end
+
+    def disable
+        @remote.set_parameter('vban.enable', 0)
+    end
+end

data/lib/version.rb

@@ -1,3 +1,3 @@
 module Voicemeeter_API_Ruby
-    VERSION = '3.0.0'
+    VERSION = '4.0.0'
 end

data/lib/voicemeeter.rb

@@ -1,4 +1,11 @@
 require_relative 'base'
+require_relative 'strip'
+require_relative 'bus'
+require_relative 'button'
+require_relative 'vban'
+require_relative 'command'
+require_relative 'recorder'
+require_relative 'device'
 
 module Voicemeeter
     include RunVM
@@ -14,30 +21,29 @@ module Voicemeeter
 
         Offers a run method for resource closure.
         '
-        def self.make(**kwargs)
-            '
-            Factory function that generates a Remote class for each kind.
-
-            Returns a hash of Remote classes.
-            '
-            Kinds.kinds_all.to_h do |kind|
-                [kind.name, Remote.new(kind, **kwargs)]
-            end
-        end
-
-        def initialize(kind)
+        def initialize(kind, **kwargs)
             super
             self.strip = Strip.make(self, kind.layout[:strip])
             self.bus = Bus.make(self, kind.layout[:bus])
             self.button = MacroButton.make(self, kind.layout[:mb])
-            self.vban = Vban.make(self, kind.layout[:vban])
+            self.vban = Vban.new(self, kind.layout[:vban])
             self.command = Command.new(self)
             self.recorder = Recorder.new(self)
+            self.device = Device.new(self)
         end
 
         def run
+            '
+            Handles login/logout
+
+            Starts/stops the observable thread.
+            '
+            login
+            init_thread
+
             yield if block_given?
         ensure
+            end_thread
             logout
         end
     end
@@ -46,16 +52,23 @@ module Voicemeeter
 
     def self.remote(kind_id, **kwargs)
         '
-        Request a Remote class of a kind and login to the API
+        Factory method for remotes.
+
+        Creates a hash of remote classes, one for each kind.
+
+        Handles kind_id request errors.
+
+        Returns a remote class of the kind requested.
         '
-        _remotes = Remote.make(**kwargs)
+        _remotes =
+            Kinds.kinds_all.to_h do |kind|
+                [kind.name.to_s, Remote.new(kind, **kwargs)]
+            end
 
         unless _remotes.key? kind_id
             raise VMRemoteErrors.new('Unknown Voicemeeter Kind.')
         end
-
-        _remotes[kind_id].login
-        return _remotes[kind_id]
+        _remotes[kind_id]
     end
 
     def self.testing

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: voicemeeter_api_ruby
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 4.0.0
 platform: ruby
 authors:
 - onyx_online
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-03 00:00:00.000000000 Z
+date: 2022-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -44,6 +44,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: observer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -74,13 +88,14 @@ files:
 - lib/bus.rb
 - lib/button.rb
 - lib/cbindings.rb
-- lib/channel.rb
 - lib/command.rb
+- lib/configs.rb
+- lib/device.rb
 - lib/errors.rb
 - lib/inst.rb
+- lib/iremote.rb
 - lib/kinds.rb
 - lib/meta.rb
-- lib/profiles.rb
 - lib/recorder.rb
 - lib/runvm.rb
 - lib/strip.rb
@@ -107,7 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.3.12
 signing_key:
 specification_version: 4
 summary: Voicemeeter API wrapper

data/lib/profiles.rb

@@ -1,28 +0,0 @@
-require 'toml'
-
-module Profiles
-    private
-
-    def get_profiles(kind)
-        filepath =
-            File.join(File.dirname(__dir__), "/profiles/#{kind.name}/*.toml")
-
-        Dir
-            .glob(filepath)
-            .to_h do |toml_file|
-                filename = File.basename(toml_file, '.toml')
-                puts "loading profile #{kind.name}/#{filename}"
-                [filename, TOML::Parser.new(File.read(toml_file)).parsed]
-            end
-    end
-
-    public
-
-    def set_profile(value)
-        unless @profiles.key? value
-            raise VMRemoteErrors.new("No profile with name #{value} was loaded")
-        end
-        self.send('set_multi', @profiles[value])
-        sleep(DELAY)
-    end
-end