Compare commits

..

No commits in common. "3f255d6b45ed7933d9dafc850dfff5ee8b684cc8" and "662f14282fb7bcfdf1fa9cbaf4b1d61f7341c1d9" have entirely different histories.

5 changed files with 93 additions and 67 deletions

View File

@ -67,9 +67,7 @@ For a full list of requests refer to [Requests](https://github.com/obsproject/ob
### Events ### Events
Register blocks with the Event client using the `on` method. Event tokens should match the event name but snake cased. Register `on_` callback methods. Method names should match the api event but snake cased.
The event data will be passed to the block.
example: example:
@ -77,14 +75,23 @@ example:
class Observer class Observer
def initialize def initialize
@e_client = OBSWS::Events::Client.new(host: "localhost", port: 4455, password: "strongpassword") @e_client = OBSWS::Events::Client.new(host: "localhost", port: 4455, password: "strongpassword")
# register blocks on event types. # register callback methods with the Event client
@e_client.on :current_program_scene_changed do |data| @e_client.register(
[
method(:on_current_program_scene_changed),
method(:on_input_mute_state_changed)
]
)
end
# define "on_" event methods.
def on_current_program_scene_changed(data)
... ...
end end
@e_client.on :input_mute_state_changed do |data| def on_input_mute_state_changed(data)
... ...
end end
end ...
end end
``` ```
@ -97,12 +104,11 @@ For both request responses and event data you may inspect the available attribut
example: example:
```ruby ```ruby
resp = @r_client.get_version resp = cl.get_version
p resp.attrs p resp.attrs
@e_client.on :input_mute_state_changed do |data| def on_scene_created(data):
p data.attrs p data.attrs
end
``` ```
### Errors ### Errors

View File

@ -1,28 +1,19 @@
require_relative "../../lib/obsws" require_relative "../../lib/obsws"
require "yaml" require "yaml"
class Main class Main
def initialize(**kwargs) def initialize(**kwargs)
@r_client = OBSWS::Requests::Client.new(**kwargs) @r_client = OBSWS::Requests::Client.new(**kwargs)
@e_client = OBSWS::Events::Client.new(**kwargs) @e_client = OBSWS::Events::Client.new(**kwargs)
@e_client.add_observer(self)
@e_client.on :current_program_scene_changed do |data|
puts "Switched to scene #{data.scene_name}"
end
@e_client.on :scene_created do |data|
puts "scene #{data.scene_name} has been created"
end
@e_client.on :input_mute_state_changed do |data|
puts "#{data.input_name} mute toggled"
end
@e_client.on :exit_started do
puts "OBS closing!"
@r_client.close
@e_client.close
@running = false
end
puts infostring puts infostring
@running = true
end
def run
sleep(0.1) while @running
end end
def infostring def infostring
@ -33,9 +24,23 @@ class Main
].join(" ") ].join(" ")
end end
def run def on_current_program_scene_changed(data)
@running = true puts "Switched to scene #{data.scene_name}"
sleep(0.1) while @running end
def on_scene_created(data)
puts "scene #{data.scene_name} has been created"
end
def on_input_mute_state_changed(data)
puts "#{data.input_name} mute toggled"
end
def on_exit_started
puts "OBS closing!"
@r_client.close
@e_client.close
@running = false
end end
end end

View File

@ -13,13 +13,26 @@ class Main
def initialize(**kwargs) def initialize(**kwargs)
subs = OBSWS::Events::SUBS::LOW_VOLUME | OBSWS::Events::SUBS::INPUTVOLUMEMETERS subs = OBSWS::Events::SUBS::LOW_VOLUME | OBSWS::Events::SUBS::INPUTVOLUMEMETERS
@e_client = OBSWS::Events::Client.new(subs:, **kwargs) @e_client = OBSWS::Events::Client.new(subs:, **kwargs)
@e_client.register(
[
method(:on_input_mute_state_changed),
method(:on_input_volume_meters)
]
)
end
@e_client.on :input_mute_state_changed do |data| def run
puts "press <Enter> to quit"
loop { break if gets.chomp.empty? }
end
def on_input_mute_state_changed(data)
if data.input_name == DEVICE if data.input_name == DEVICE
puts "#{DEVICE} mute toggled" puts "#{DEVICE} mute toggled"
end end
end end
@e_client.on :input_volume_meters do |data|
def on_input_volume_meters(data)
fget = ->(x) { (x > 0) ? (20 * Math.log(x, 10)).round(1) : -200.0 } fget = ->(x) { (x > 0) ? (20 * Math.log(x, 10)).round(1) : -200.0 }
data.inputs.each do |d| data.inputs.each do |d|
@ -32,12 +45,6 @@ class Main
end end
end end
def run
puts "press <Enter> to quit"
loop { break if gets.chomp.empty? }
end
end
def conn_from_yaml def conn_from_yaml
YAML.load_file("obs.yml", symbolize_names: true)[:connection] YAML.load_file("obs.yml", symbolize_names: true)[:connection]
end end

View File

@ -28,35 +28,43 @@ module OBSWS
ALL = LOW_VOLUME | HIGH_VOLUME ALL = LOW_VOLUME | HIGH_VOLUME
end end
module EventDirector module Callbacks
include Util::String include Util::String
def observers def observers
@observers ||= {} @observers ||= []
end end
def on(event, method = nil, &block) def add_observer(observer)
(observers[event] ||= []) << (block || method) observer = [observer] unless observer.respond_to? :each
observer.each { |o| observers << o unless observers.include? o }
end end
def register(cbs) def remove_observer(observer)
cbs = [cbs] unless cbs.respond_to? :each observer = [observer] unless observer.respond_to? :each
cbs.each { |cb| on(cb.name[3..].to_sym, cb) } observers.reject! { |o| observer.include? o }
end end
def deregister(cbs) private def notify_observers(event, data)
cbs = [cbs] unless cbs.respond_to? :each observers.each do |o|
cbs.each { |cb| observers[cb.name[3..].to_sym]&.reject! { |o| cbs.include? o } } if o.is_a? Method
if o.name.to_s == "on_#{snakecase(event)}"
data.empty? ? o.call : o.call(data)
end
elsif o.respond_to? "on_#{snakecase(event)}"
data.empty? ? o.send("on_#{snakecase(event)}") : o.send("on_#{snakecase(event)}", data)
end
end
end end
def fire(event, data) alias_method :callbacks, :observers
observers[snakecase(event).to_sym]&.each { |block| data.empty? ? block.call : block.call(data) } alias_method :register, :add_observer
end alias_method :deregister, :remove_observer
end end
class Client class Client
include Logging include Logging
include EventDirector include Callbacks
include Mixin::TearDown include Mixin::TearDown
include Mixin::OPCodes include Mixin::OPCodes
@ -79,7 +87,7 @@ module OBSWS
logger.debug("received: #{data}") logger.debug("received: #{data}")
event = data[:eventType] event = data[:eventType]
data = data.fetch(:eventData, {}) data = data.fetch(:eventData, {})
fire(event, Mixin::Data.new(data, data.keys)) notify_observers(event, Mixin::Data.new(data, data.keys))
end end
} }
end end

View File

@ -7,11 +7,11 @@ module OBSWS
end end
def minor def minor
6 5
end end
def patch def patch
0 8
end end
def to_a def to_a