onyx_online/voicemeeter-rb
1
0
Fork 0
mirror of https://github.com/onyx-and-iris/voicemeeter-rb.git synced 2024-11-22 09:50:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

Errors, Logging sections added to README

Browse Source
This commit is contained in:
onyx-and-iris 2023-07-17 14:15:04 +01:00
parent 06f36509ed
commit 8ca656e321
1 changed files with 22 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
README.md
View File

@ -27,10 +27,6 @@ bundle add 'voicemeeter'
bundle install bundle install
``` ```
### Gem
`gem install 'voicemeeter'`
## `Use` ## `Use`
Simplest use case, request a Remote class of a kind, then pass a block to run. Simplest use case, request a Remote class of a kind, then pass a block to run.
@ -428,7 +424,7 @@ current settings before loading a config. To set one you may do:
```ruby ```ruby
require "voicemeeter" require "voicemeeter"
vm = Voicemeeter.remote(:banana) vm = Voicemeeter::Remote.new(:banana)
vm.run { vm.apply_config(:example) } vm.run { vm.apply_config(:example) }
``` ```
@ -446,7 +442,7 @@ example:
require 'voicemeeter' require 'voicemeeter'
# Set updates to occur every 50ms # Set updates to occur every 50ms
# Listen for level updates # Listen for level updates
vm = Voicemeeter.remote('banana', ratelimit: 0.05, ldirty: true) vm = Voicemeeter::Remote.new(:banana, ratelimit: 0.05, ldirty: true)
vm.run { ... } vm.run { ... }
``` ```
@ -461,7 +457,7 @@ example:
class App(): class App():
def initialize(vm) def initialize(vm)
@vm = vm @vm = vm
@vm.register(method(:on_pdirty)) @vm.callback.register(method(:on_pdirty))
... ...
def on_pdirty def on_pdirty
@ -539,22 +535,33 @@ vm.set("Strip[4].Label", "stripname")
vm.set("Strip[0].Gain", -3.6) vm.set("Strip[0].Gain", -3.6)
``` ```
### Errors
- `Errors::VMError`: Error raised when general errors occur.
- `Errors::VMCAPIError`: Error raised when the C-API returns error values.
- Error codes are stored in {Error Class}.code. For a full list of error codes [check the VoicemeeterRemote header file][voicemeeter remote header].
### Logging
To enable logs set an environmental variable `LOG_LEVEL` to the appropriate level.
example in powershell:
```powershell
$env:LOG_LEVEL="DEBUG"
```
### Run tests ### Run tests
To run all tests: To run all tests:
``` ```
Bundle exec rspec Bundle exec rake
```
You can use tags to run only certain tests, for example:
```
Bundle exec rspec --tag 'higher'
``` ```
### Official Documentation ### Official Documentation
- [Voicemeeter Remote C API](https://github.com/onyx-and-iris/Voicemeeter-SDK/blob/main/VoicemeeterRemoteAPI.pdf) - [Voicemeeter Remote C API](https://github.com/onyx-and-iris/Voicemeeter-SDK/blob/update-docs/VoicemeeterRemoteAPI.pdf)
[license]: https://github.com/onyx-and-iris/voicemeeter-rb/blob/dev/LICENSE [license]: https://github.com/onyx-and-iris/voicemeeter-rb/blob/dev/LICENSE
[voicemeeter remote header]: https://github.com/onyx-and-iris/Voicemeeter-SDK/blob/update-docs/VoicemeeterRemote.h