voicemeeter_api_ruby 4.1.2 → 4.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3cd92424de9feeec41ef5367eae28c9dfe4c5db4c62f3944e14e9fd4c632390d
-  data.tar.gz: e9dc4356b8b2fcb54337a6eea85c62e73f3c9259be339abd25bba00a805b42c3
+  metadata.gz: 29df5251a1e4d779dd265a785112c0c8907b89f5f9a30a45a9e50985ed2400e7
+  data.tar.gz: c4a9acbbbe3330aca966d4470373b9ec9f9fe3bcefa0b1f6e60ed665b853c712
 SHA512:
-  metadata.gz: 2f77f65c9099f66c1a1938c8b40658b3fb1e8ab00b1914819b4d6e99a21bd87ee94ae20043bd52e381e314864b272d65ba03773550dc25765b10caa3490f6661
-  data.tar.gz: 345b8c4b80b8fe8e2bfe62b729eba3c2067f550017c3d4de15425a6368384fdb698d2bd4d01f04324ef3d33f3c5e3c8450ea97c880114d8fddb79c3af0a2bbce
+  metadata.gz: c9e8f17bd773dbbbb9980f5bb91283b0f97be75acff6f2bf0c2315721fdfc9916509ec86a0a28e6db3d548fadbb161c3b40da9cbd8639b4fc98719fe309d1e27
+  data.tar.gz: 12d256fb220ab60c3492d65855ed6cdf714af851f1a7dfcb2d6b3297e2c844a9776162ff600351c9f4baeb71a3a2e99492e19388a588f459301ed1aff4259d7d

data/README.md

@@ -339,11 +339,11 @@ vm.run { (0...vm.device.ins).each { |i| puts vm.device.input(i) } }
 
 ### Multiple parameters
 
--   `set_multi`
+-   `apply`
     Set many strip/bus/macrobutton/vban parameters at once, for example:
 
 ```ruby
-vm.set_multi(
+vm.apply(
     {
         strip_0: {
             mute: true,
@@ -368,13 +368,13 @@ vm.set_multi(
 Or for each class you may do:
 
 ```ruby
-vm.strip[0].set_multi(mute: true, gain: 3.2, A1: true)
-vm.vban.outstream[0].set_multi(on: true, name: 'streamname', bit: 24)
+vm.strip[0].apply(mute: true, gain: 3.2, A1: true)
+vm.vban.outstream[0].apply(on: true, name: 'streamname', bit: 24)
 ```
 
 ## Config Files
 
-`vm.set_config(<configname>)`
+`vm.apply_config(<configname>)`
 
 You may load config files in TOML format.
 Three example configs have been included with the package. Remember to save
@@ -383,10 +383,10 @@ 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') }
+vm.run { vm.apply_config('example') }
 ```
 
-will load a config file at configs/banana/example.toml for Voicemeeter Banana.
+will load a config file at mydir/configs/banana/example.toml for Voicemeeter Banana.
 
 ## `Voicemeeter Module`
 

data/lib/base.rb

@@ -1,221 +1,220 @@
-require 'observer'
-
-require_relative 'runvm'
-require_relative 'configs'
-require_relative 'errors'
-
-class Base
-    '
-    Base class responsible for wrapping the C Remote API
-
-    Mixin required modules
-    '
-    include Observable
-    include Configs
-    include RunVM
-
-    attr_accessor :strip, :bus, :button, :vban, :command, :recorder, :device
-    attr_accessor :strip_mode
-
-    attr_reader :kind, :p_in, :v_in, :p_out, :v_out, :retval, :cache
-    attr_reader :running, :_strip_comp, :_bus_comp
-
-    DELAY = 0.001
-    SYNC = false
-    RATELIMIT = 0.033
-    SIZE = 1
-
-    def initialize(kind, **kwargs)
-        @kind = kind
-        @p_in, @v_in = kind.layout[:strip].values
-        @p_out, @v_out = kind.layout[:bus].values
-        @cache = Hash.new
-        @sync = kwargs[:sync] || SYNC
-        @ratelimit = kwargs[:ratelimit] || RATELIMIT
-        @running = false
-        @strip_mode = 0
-        @delay = DELAY
-    end
-
-    def init_thread
-        @running = true
-        @cache['strip_level'], @cache['bus_level'] = _get_levels
-        Thread.new do
-            loop do
-                Thread.stop if !@running
-                if pdirty?
-                    changed
-                    notify_observers('pdirty')
-                end
-                if mdirty?
-                    changed
-                    notify_observers('mdirty')
-                end
-                if ldirty?
-                    changed
-                    @_strip_comp =
-                        @cache['strip_level'].map.with_index do |x, i|
-                            !(x == @strip_buf[i])
-                        end
-                    @_bus_comp =
-                        @cache['bus_level'].map.with_index do |x, i|
-                            !(x == @bus_buf[i])
-                        end
-                    @cache['strip_level'] = @strip_buf
-                    @cache['bus_level'] = @bus_buf
-                    notify_observers('ldirty')
-                end
-                sleep(@ratelimit)
-            end
-        end
-    end
-
-    def end_thread
-        @running = false
-    end
-
-    def login
-        @@cdll.call(:login)
-        clear_polling
-    rescue CAPIErrors => error
-        case
-        when error.value == 1
-            self.start(@kind.name)
-            clear_polling
-        when error.value < 0
-            raise
-        end
-    end
-
-    def logout
-        clear_polling
-        sleep(0.1)
-        @@cdll.call(:logout)
-    end
-
-    def type
-        c_type = FFI::MemoryPointer.new(:long, SIZE)
-        @@cdll.call(:vmtype, c_type)
-        types = { 1 => 'basic', 2 => 'banana', 3 => 'potato' }
-        types[c_type.read_long]
-    end
-
-    def version
-        c_ver = FFI::MemoryPointer.new(:long, SIZE)
-        @@cdll.call(:vmversion, c_ver)
-        v1 = (c_ver.read_long & 0xFF000000) >> 24
-        v2 = (c_ver.read_long & 0x00FF0000) >> 16
-        v3 = (c_ver.read_long & 0x0000FF00) >> 8
-        v4 = c_ver.read_long & 0x000000FF
-        "#{v1}.#{v2}.#{v3}.#{v4}"
-    end
-
-    def get_parameter(name, is_string = false)
-        self.polling('get_parameter', name: name) do
-            if is_string
-                c_get = FFI::MemoryPointer.new(:string, 512, true)
-                @@cdll.call(:get_parameter_string, name, c_get)
-                c_get.read_string
-            else
-                c_get = FFI::MemoryPointer.new(:float, SIZE)
-                @@cdll.call(:get_parameter_float, name, c_get)
-                c_get.read_float.round(1)
-            end
-        end
-    end
-
-    def set_parameter(name, value)
-        if value.is_a? String
-            @@cdll.call(:set_parameter_string, name, value)
-        else
-            @@cdll.call(:set_parameter_float, name, value.to_f)
-        end
-        @cache.store(name, value)
-    end
-
-    def get_buttonstatus(id, mode)
-        self.polling('get_buttonstatus', id: id, mode: mode) do
-            c_get = FFI::MemoryPointer.new(:float, SIZE)
-            @@cdll.call(:get_buttonstatus, id, c_get, mode)
-            c_get.read_float.to_i
-        end
-    end
-
-    def set_buttonstatus(id, state, mode)
-        @@cdll.call(:set_buttonstatus, id, state, mode)
-        @cache.store("mb_#{id}_#{mode}", state)
-    end
-
-    def set_parameter_multi(param_hash)
-        param_hash.each do |(key, val)|
-            prop, m2, m3, *rem = key.to_s.split('_')
-            if m2.to_i.to_s == m2
-                m2 = m2.to_i
-            elsif m3.to_i.to_s == m3
-                m3 = m3.to_i
-            end
-
-            case prop
-            when 'strip'
-                self.strip[m2].set_multi(val)
-            when 'bus'
-                self.bus[m2].set_multi(val)
-            when 'button', 'mb'
-                self.button[m2].set_multi(val)
-            when 'vban'
-                if %w[instream in].include? m2
-                    self.vban.instream[m3].set_multi(val)
-                elsif %w[outstream out].include? m2
-                    self.vban.outstream[m3].set_multi(val)
-                end
-            end
-            sleep(DELAY)
-        end
-    end
-
-    def get_level(type, index)
-        c_get = FFI::MemoryPointer.new(:float, SIZE)
-        @@cdll.call(:get_level, type, index, c_get)
-        c_get.read_float
-    end
-
-    def _get_levels
-        s = (0...(2 * @p_in + 8 * @v_in)).map { |i| get_level(@strip_mode, i) }
-        b = (0...(8 * (@p_out + @v_out))).map { |i| get_level(3, i) }
-        [s, b]
-    end
-
-    def get_num_devices(direction)
-        unless %w[in out].include? direction
-            raise VMRemoteErrors.new('expected in or out')
-        end
-        if direction == 'in'
-            val = @@cdll.call(:get_num_indevices)
-        else
-            val = @@cdll.call(:get_num_outdevices)
-        end
-        val[0]
-    end
-
-    def get_device_description(index, direction)
-        unless %w[in out].include? direction
-            raise VMRemoteErrors.new('expected in or out')
-        end
-        c_type = FFI::MemoryPointer.new(:long, SIZE)
-        c_name = FFI::MemoryPointer.new(:string, 256, true)
-        c_hwid = FFI::MemoryPointer.new(:string, 256, true)
-        if direction == 'in'
-            @@cdll.call(:get_desc_indevices, index, c_type, c_name, c_hwid)
-        else
-            @@cdll.call(:get_desc_outdevices, index, c_type, c_name, c_hwid)
-        end
-        [c_name.read_string, c_type.read_long, c_hwid.read_string]
-    end
-
-    alias_method 'set_multi', :set_parameter_multi
-    alias_method 'get', :get_parameter
-    alias_method 'set', :set_parameter
-    alias_method 'pdirty', :pdirty?
-    alias_method 'mdirty', :mdirty?
-    alias_method 'ldirty', :ldirty?
-end
+require "observer"
+
+require_relative "runvm"
+require_relative "configs"
+require_relative "errors"
+
+class Base
+  "
+  Base class responsible for wrapping the C Remote API
+
+  Mixin required modules
+  "
+  include Observable
+  include Configs
+  include RunVM
+
+  attr_accessor :strip, :bus, :button, :vban, :command, :recorder, :device
+  attr_accessor :strip_mode
+
+  attr_reader :kind, :p_in, :v_in, :p_out, :v_out, :retval, :cache
+  attr_reader :running, :_strip_comp, :_bus_comp, :delay
+
+  DELAY = 0.001
+  SYNC = false
+  RATELIMIT = 0.033
+  SIZE = 1
+
+  def initialize(kind, **kwargs)
+    @kind = kind
+    @p_in, @v_in = kind.layout[:strip].values
+    @p_out, @v_out = kind.layout[:bus].values
+    @cache = Hash.new
+    @sync = kwargs[:sync] || SYNC
+    @ratelimit = kwargs[:ratelimit] || RATELIMIT
+    @running = false
+    @strip_mode = 0
+    @delay = DELAY
+  end
+
+  def init_thread
+    @running = true
+    @cache["strip_level"], @cache["bus_level"] = _get_levels
+    Thread.new do
+      loop do
+        Thread.stop if !@running
+        if pdirty?
+          changed
+          notify_observers("pdirty")
+        end
+        if mdirty?
+          changed
+          notify_observers("mdirty")
+        end
+        if ldirty?
+          changed
+          @_strip_comp =
+            @cache["strip_level"].map.with_index do |x, i|
+              !(x == @strip_buf[i])
+            end
+          @_bus_comp =
+            @cache["bus_level"].map.with_index { |x, i| !(x == @bus_buf[i]) }
+          @cache["strip_level"] = @strip_buf
+          @cache["bus_level"] = @bus_buf
+          notify_observers("ldirty")
+        end
+        sleep(@ratelimit)
+      end
+    end
+  end
+
+  def end_thread
+    @running = false
+  end
+
+  def login
+    @@cdll.call(:login)
+    clear_polling
+  rescue CAPIErrors => error
+    case
+    when error.value == 1
+      self.start(@kind.name)
+      clear_polling
+    when error.value < 0
+      raise
+    end
+  end
+
+  def logout
+    clear_polling
+    sleep(0.1)
+    @@cdll.call(:logout)
+  end
+
+  def type
+    c_type = FFI::MemoryPointer.new(:long, SIZE)
+    @@cdll.call(:vmtype, c_type)
+    types = { 1 => "basic", 2 => "banana", 3 => "potato" }
+    types[c_type.read_long]
+  end
+
+  def version
+    c_ver = FFI::MemoryPointer.new(:long, SIZE)
+    @@cdll.call(:vmversion, c_ver)
+    v1 = (c_ver.read_long & 0xFF000000) >> 24
+    v2 = (c_ver.read_long & 0x00FF0000) >> 16
+    v3 = (c_ver.read_long & 0x0000FF00) >> 8
+    v4 = c_ver.read_long & 0x000000FF
+    "#{v1}.#{v2}.#{v3}.#{v4}"
+  end
+
+  def get_parameter(name, is_string = false)
+    self.polling("get_parameter", name: name) do
+      if is_string
+        c_get = FFI::MemoryPointer.new(:string, 512, true)
+        @@cdll.call(:get_parameter_string, name, c_get)
+        c_get.read_string
+      else
+        c_get = FFI::MemoryPointer.new(:float, SIZE)
+        @@cdll.call(:get_parameter_float, name, c_get)
+        c_get.read_float.round(1)
+      end
+    end
+  end
+
+  def set_parameter(name, value)
+    if value.is_a? String
+      @@cdll.call(:set_parameter_string, name, value)
+    else
+      @@cdll.call(:set_parameter_float, name, value.to_f)
+    end
+    @cache.store(name, value)
+  end
+
+  def get_buttonstatus(id, mode)
+    self.polling("get_buttonstatus", id: id, mode: mode) do
+      c_get = FFI::MemoryPointer.new(:float, SIZE)
+      @@cdll.call(:get_buttonstatus, id, c_get, mode)
+      c_get.read_float.to_i
+    end
+  end
+
+  def set_buttonstatus(id, state, mode)
+    @@cdll.call(:set_buttonstatus, id, state, mode)
+    @cache.store("mb_#{id}_#{mode}", state)
+  end
+
+  def set_parameter_multi(param_hash)
+    param_hash.each do |(key, val)|
+      prop, m2, m3, *rem = key.to_s.split("_")
+      if m2.to_i.to_s == m2
+        m2 = m2.to_i
+      elsif m3.to_i.to_s == m3
+        m3 = m3.to_i
+      end
+
+      case prop
+      when "strip"
+        self.strip[m2].set_multi(val)
+      when "bus"
+        self.bus[m2].set_multi(val)
+      when "button", "mb"
+        self.button[m2].set_multi(val)
+      when "vban"
+        if %w[instream in].include? m2
+          self.vban.instream[m3].set_multi(val)
+        elsif %w[outstream out].include? m2
+          self.vban.outstream[m3].set_multi(val)
+        end
+      end
+      sleep(DELAY)
+    end
+  end
+
+  def get_level(type, index)
+    c_get = FFI::MemoryPointer.new(:float, SIZE)
+    @@cdll.call(:get_level, type, index, c_get)
+    c_get.read_float
+  end
+
+  def _get_levels
+    s = (0...(2 * @p_in + 8 * @v_in)).map { |i| get_level(@strip_mode, i) }
+    b = (0...(8 * (@p_out + @v_out))).map { |i| get_level(3, i) }
+    [s, b]
+  end
+
+  def get_num_devices(direction)
+    unless %w[in out].include? direction
+      raise VMRemoteErrors.new("expected in or out")
+    end
+    if direction == "in"
+      val = @@cdll.call(:get_num_indevices)
+    else
+      val = @@cdll.call(:get_num_outdevices)
+    end
+    val[0]
+  end
+
+  def get_device_description(index, direction)
+    unless %w[in out].include? direction
+      raise VMRemoteErrors.new("expected in or out")
+    end
+    c_type = FFI::MemoryPointer.new(:long, SIZE)
+    c_name = FFI::MemoryPointer.new(:string, 256, true)
+    c_hwid = FFI::MemoryPointer.new(:string, 256, true)
+    if direction == "in"
+      @@cdll.call(:get_desc_indevices, index, c_type, c_name, c_hwid)
+    else
+      @@cdll.call(:get_desc_outdevices, index, c_type, c_name, c_hwid)
+    end
+    [c_name.read_string, c_type.read_long, c_hwid.read_string]
+  end
+
+  alias_method "set_multi", :set_parameter_multi
+  alias_method "apply", :set_parameter_multi
+  alias_method "get", :get_parameter
+  alias_method "set", :set_parameter
+  alias_method "pdirty", :pdirty?
+  alias_method "mdirty", :mdirty?
+  alias_method "ldirty", :ldirty?
+end