onyx_online/obsws-ruby
1
0
Fork 0
mirror of https://github.com/onyx-and-iris/obsws-ruby.git synced 2026-04-18 05:23:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

raekfile updated

Browse Source 
rework examples
This commit is contained in:
onyx-and-iris
2023-07-21 06:37:14 +01:00
parent 15dcaeedda
commit 15c4baf5d7
12 changed files with 42 additions and 131 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
README.md
View File

@@ -28,37 +28,39 @@ bundle install
#### Example `main.rb`
pass `host`, `port` and `password` as keyword arguments.
Pass `host`, `port` and `password` as keyword arguments.
```ruby
require "obsws"
def main
OBSWS::Requests::Client
.new(host: "localhost", port: 4455, password: "strongpassword")
.run do |client|
# Toggle the mute state of your Mic input
client.toggle_input_mute("Mic/Aux")
end
class Main
def run
OBSWS::Requests::Client
.new(host: "localhost", port: 4455, password: "strongpassword")
.run do |client|
# Toggle the mute state of your Mic input
client.toggle_input_mute("Mic/Aux")
end
end
end
main if $0 == __FILE__
Main.new.run if $PROGRAM_NAME == __FILE__
```
Passing OBSWS::Requests::Client.run a block closes the socket once the block returns.
### Requests
Method names for requests match the API calls but snake cased. `run` accepts a block that closes the socket once you are done.
Method names for requests match the API calls but snake cased.
example:
```ruby
r_client.run do
# GetVersion
resp = r_client.get_version
# GetVersion
resp = r_client.get_version
# SetCurrentProgramScene
r_client.set_current_program_scene("BRB")
end
# SetCurrentProgramScene
r_client.set_current_program_scene("BRB")
```
For a full list of requests refer to [Requests](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#requests)