onyx_online/obsws-ruby
1
0
Fork 0
mirror of https://github.com/onyx-and-iris/obsws-ruby.git synced 2024-11-15 18:50:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

example in readme and main.rb refactored

Browse Source 
code style badge changed to standard
This commit is contained in:
onyx-and-iris 2023-07-19 15:14:28 +01:00
parent 73ae24eb4b
commit 5f08b97759
2 changed files with 16 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@ -1,15 +1,15 @@
[![Gem Version](https://badge.fury.io/rb/obsws.svg)](https://badge.fury.io/rb/obsws) [![Gem Version](https://badge.fury.io/rb/obsws.svg)](https://badge.fury.io/rb/obsws)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/onyx-and-iris/obsws-ruby/blob/dev/LICENSE) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/onyx-and-iris/obsws-ruby/blob/dev/LICENSE)
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/plugin-ruby) [![Ruby Code Style](https://img.shields.io/badge/code_style-standard-violet.svg)](https://github.com/standardrb/standard)
# A Ruby wrapper around OBS Studio WebSocket v5.0 # A Ruby wrapper around OBS Studio WebSocket v5.0
## Requirements ## Requirements
- [OBS Studio](https://obsproject.com/) - [OBS Studio](https://obsproject.com/)
- [OBS Websocket v5 Plugin](https://github.com/obsproject/obs-websocket/releases/tag/5.0.0) - [OBS Websocket v5 Plugin](https://github.com/obsproject/obs-websocket/releases/tag/5.0.0)
- With the release of OBS Studio version 28, Websocket plugin is included by default. But it should be manually installed for earlier versions of OBS. - With the release of OBS Studio version 28, Websocket plugin is included by default. But it should be manually installed for earlier versions of OBS.
- Ruby 3.0 or greater - Ruby 3.0 or greater
## Installation ## Installation
@ -34,17 +34,12 @@ pass `host`, `port` and `password` as keyword arguments.
require "obsws" require "obsws"
def main def main
r_client = OBSWS::Requests::Client
OBSWS::Requests::Client.new( .new(host: "localhost", port: 4455, password: "strongpassword")
host: "localhost", .run do |client|
port: 4455, # Toggle the mute state of your Mic input
password: "strongpassword" client.toggle_input_mute("Mic/Aux")
) end
r_client.run do
# Toggle the mute state of your Mic input
r_client.toggle_input_mute("Mic/Aux")
end
end end
main if $0 == __FILE__ main if $0 == __FILE__
@ -140,4 +135,4 @@ bundle exec rake -v
For the full documentation: For the full documentation:
- [OBS Websocket SDK](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#obs-websocket-501-protocol) - [OBS Websocket SDK](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#obs-websocket-501-protocol)

11
main.rb
View File

@ -1,17 +1,14 @@
require_relative "lib/obsws" require_relative "lib/obsws"
def main def main
r_client =
OBSWS::Requests::Client.new( OBSWS::Requests::Client.new(
host: "localhost", host: "localhost",
port: 4455, port: 4455,
password: "strongpassword" password: "strongpassword"
) ).run do |client|
# Toggle the mute state of your Mic input
r_client.run do client.toggle_input_mute("Mic/Aux")
# Toggle the mute state of your Mic input end
r_client.toggle_input_mute("Mic/Aux")
end
end end
main if $0 == __FILE__ main if $0 == __FILE__