voicemeeter_api_ruby 2.0.4 → 3.0.0

data/lib/channel.rb

@@ -1,34 +1,46 @@
-require_relative 'meta'
-require_relative 'errors'
-
-class IChannel
-    """
-    Base class for audio channels
-    """
-    include Channel_Meta_Functions
-
-    attr_accessor :remote, :index
-
-    def initialize(remote, i)
-        self.remote = remote
-        self.index = i
-    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
-        raise NotImplementedError
-    end
-
-    def set_multi(param_hash)
-        param_hash.each do |(key,val)|
-            self.send("#{key}=", val)
-        end
-    end
-end
+require_relative 'meta'
+require_relative 'errors'
+
+class IChannel
+    '
+    Base Channel class
+    '
+    include Channel_Meta_Functions
+
+    def initialize(remote, i)
+        @remote = remote
+        @index = i
+    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}[#{@index}]"
+    end
+
+    def identifier
+        raise 'Called abstract mehod: identifier'
+    end
+
+    def set_multi(param_hash)
+        param_hash.each { |(key, val)| self.send("#{key}=", val) }
+    end
+end
+
+module Fades
+    def fadeto(target, time)
+        self.setter('FadeTo', "(#{target}, #{time})")
+        sleep(@remote.delay)
+    end
+
+    def fadeby(change, time)
+        self.setter('FadeBy', "(#{change}, #{time})")
+        sleep(@remote.delay)
+    end
+end

data/lib/command.rb

@@ -1,41 +1,41 @@
-require_relative 'meta'
-
-
-class ICommand
-    include Commands_Meta_Functions
-
-    attr_accessor :remote
-
-    def initialize(remote)
-        self.remote = remote
-    end
-
-    def setter(param, value)
-        @remote.set_parameter("#{self.cmd}.#{param}", value)
-    end
-
-    def cmd
-        return "command"
-    end
-end
-
-
-class Command < ICommand
-    def initialize(remote)
-        super
-        self.make_action_prop :show, :restart, :reset, :shutdown
-        self.make_writer_bool :showvbanchat, :lock
-    end
-
-    def load(value)
-        raise VMRemoteErrors.new("Expected a string") unless value.is_a? String
-        self.setter("load", value)
-        sleep(0.2)
-    end
-
-    def save(value)
-        raise VMRemoteErrors.new("Expected a string") unless value.is_a? String
-        self.setter("save", value)
-        sleep(0.2)
-    end
-end
+require_relative 'meta'
+
+class ICommand
+    include Commands_Meta_Functions
+
+    def initialize(remote)
+        @remote = remote
+    end
+
+    def setter(param, value)
+        @remote.set_parameter("#{self.identifier}.#{param}", value)
+    end
+
+    def identifier
+        :command
+    end
+end
+
+class Command < ICommand
+    def initialize(remote)
+        super
+        self.make_action_prop :show, :restart, :reset, :shutdown
+        self.make_writer_bool :showvbanchat, :lock
+    end
+
+    def hide
+        self.setter('show', 0)
+    end
+
+    def load(value)
+        raise VMRemoteErrors.new('Expected a string') unless value.is_a? String
+        self.setter('load', value)
+        sleep(0.2)
+    end
+
+    def save(value)
+        raise VMRemoteErrors.new('Expected a string') unless value.is_a? String
+        self.setter('save', value)
+        sleep(0.2)
+    end
+end

data/lib/errors.rb

@@ -1,37 +1,39 @@
-module Errors
-    class VMRemoteErrors < StandardError; end
-
-    class InstallErrors < VMRemoteErrors; end
-
-    class CAPIErrors < VMRemoteErrors
-        attr_accessor :value, :func
-
-        def initialize(value, func)
-            self.value = value
-            self.func = func
-        end
-
-        def message
-            "When attempting to run function #{@func} the
-            C API returned value #{@value}. See documentation for further info"
-        end
-    end
-
-    class OutOfBoundsErrors < VMRemoteErrors
-        attr_accessor :range
-
-        def initialize(range)
-            self.range = range
-        end
-
-        def message
-            if @range.kind_of?(Range)
-                "Value error, expected value in range (#{range.first}..#{range.last})"
-            elsif @range.kind_of?(Array)
-                "Value error, expected one of: #{@range}"
-            else
-                "Value error, expected #{@range}"
-            end
-        end
-    end
-end
+module Errors
+    class VMRemoteErrors < StandardError
+    end
+
+    class InstallErrors < VMRemoteErrors
+    end
+
+    class CAPIErrors < VMRemoteErrors
+        attr_accessor :value, :func
+
+        def initialize(value, func)
+            self.value = value
+            self.func = func
+        end
+
+        def message
+            "When attempting to run function #{@func} the
+            C API returned value #{@value}. See documentation for further info"
+        end
+    end
+
+    class OutOfBoundsErrors < VMRemoteErrors
+        attr_accessor :range
+
+        def initialize(range)
+            self.range = range
+        end
+
+        def message
+            if @range.kind_of?(Range)
+                "Value error, expected value in range (#{range.first}..#{range.last})"
+            elsif @range.kind_of?(Array)
+                "Value error, expected one of: #{@range}"
+            else
+                "Value error, expected #{@range}"
+            end
+        end
+    end
+end

data/lib/inst.rb

@@ -1,36 +1,38 @@
-require 'win32/registry'
-require 'pathname'
-require_relative 'errors'
-
-include Errors
-
-module InstallationFunctions
-    private
-    def get_arch
-        key = 'SYSTEM\CurrentControlSet\Control\Session Manager\Environment'
-        Win32::Registry::HKEY_LOCAL_MACHINE.open(key) do |reg|
-            os_bits = reg["PROCESSOR_ARCHITECTURE"]
-            if os_bits.include? 64.to_s
-                return 64
-            end
-            return 32
-        end
-    end
-
-    def get_vmpath(os_bits)
-        vm_key = "VB:Voicemeeter {17359A74-1236-5467}"
-        reg_key = "Software#{os_bits == 64 ? "\\WOW6432Node" : ""}\\Microsoft\\Windows\\CurrentVersion\\Uninstall\\"
-        Win32::Registry::HKEY_LOCAL_MACHINE.open(reg_key + vm_key) do |reg|           
-            value = reg["UninstallString"]
-
-            pn = Pathname.new(value)
-            return pn.dirname
-        end
-        raise InstallErrors.new('Could not get the Voicemeeter path')
-    end
-
-    def vmr_dll=(value)
-        raise InstallErrors.new('Could not fetch the dll file') unless value.file?
-        @vmr_dll = value
-    end
-end
+require 'win32/registry'
+require 'pathname'
+require_relative 'errors'
+
+include Errors
+
+module InstallationFunctions
+    private
+
+    def get_arch
+        key = 'SYSTEM\CurrentControlSet\Control\Session Manager\Environment'
+        Win32::Registry::HKEY_LOCAL_MACHINE.open(key) do |reg|
+            os_bits = reg['PROCESSOR_ARCHITECTURE']
+            return 64 if os_bits.include? '64'
+            return 32
+        end
+    end
+
+    def get_vmpath(os_bits)
+        vm_key = 'VB:Voicemeeter {17359A74-1236-5467}'
+        reg_key =
+            "Software#{os_bits == 64 ? "\\WOW6432Node" : ''}\\Microsoft\\Windows\\CurrentVersion\\Uninstall\\"
+        Win32::Registry::HKEY_LOCAL_MACHINE.open(reg_key + vm_key) do |reg|
+            value = reg['UninstallString']
+
+            pn = Pathname.new(value)
+            return pn.dirname
+        end
+        raise InstallErrors.new('Could not get the Voicemeeter path')
+    end
+
+    def vmr_dll=(value)
+        unless value.file?
+            raise InstallErrors.new('Could not fetch the dll file')
+        end
+        @vmr_dll = value
+    end
+end

data/lib/kinds.rb

@@ -0,0 +1,77 @@
+module Kinds
+    '
+    A Kind struct for each version of Voicemeeter
+    '
+    attr_reader :kind_map, :kinds_all
+
+    Kind = Struct.new(:name, :layout)
+    basic =
+        Kind.new(
+            'basic',
+            {
+                strip: {
+                    p_in: 2,
+                    v_in: 1,
+                },
+                bus: {
+                    p_out: 1,
+                    v_out: 1,
+                },
+                vban: {
+                    instream: 4,
+                    outstream: 4,
+                },
+                mb: 80,
+            },
+        )
+
+    banana =
+        Kind.new(
+            'banana',
+            {
+                strip: {
+                    p_in: 3,
+                    v_in: 2,
+                },
+                bus: {
+                    p_out: 3,
+                    v_out: 2,
+                },
+                vban: {
+                    instream: 8,
+                    outstream: 8,
+                },
+                mb: 80,
+            },
+        )
+
+    potato =
+        Kind.new(
+            'potato',
+            {
+                strip: {
+                    p_in: 5,
+                    v_in: 3,
+                },
+                bus: {
+                    p_out: 5,
+                    v_out: 3,
+                },
+                vban: {
+                    instream: 8,
+                    outstream: 8,
+                },
+                mb: 80,
+            },
+        )
+
+    @kind_map = [basic, banana, potato].to_h { |kind| [kind.name, kind] }
+
+    def get_kind(kind_id)
+        @kind_map[kind_id]
+    end
+
+    @kinds_all = @kind_map.values
+
+    module_function :get_kind
+end