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

reword errors section in readme

Browse Source
This commit is contained in:
onyx-and-iris 2023-08-30 10:16:03 +01:00
parent 4774d447eb
commit 9cfc409049
1 changed files with 13 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -491,7 +491,7 @@ vm.patch.postfxinsert = false
##### asio[i] ##### asio[i]
- `get()`: int - `get`: int
- `set(patch_in)`: int, valid range determined by connected device. - `set(patch_in)`: int, valid range determined by connected device.
example: example:
@ -504,7 +504,7 @@ i, from 0 to 10
##### A2[i] - A5[i] ##### A2[i] - A5[i]
- `get()`: int - `get`: int
- `set(patch_out)`: int, valid range determined by connected device. - `set(patch_out)`: int, valid range determined by connected device.
example: example:
@ -517,7 +517,7 @@ i, from 0 to 8.
##### composite[i] ##### composite[i]
- `get()`: int - `get`: int
- `set(channel)`: int, from 0 up to number of channels depending on version. - `set(channel)`: int, from 0 up to number of channels depending on version.
example: example:
@ -572,7 +572,7 @@ vm.option.buffer.wdm = 512
##### delay[i] ##### delay[i]
- `get()`: int - `get`: int
- `set(delay)`: int, from 0 to 500 - `set(delay)`: int, from 0 to 500
example: example:
@ -702,9 +702,9 @@ The following methods are available:
example: example:
```ruby ```ruby
vm.event.add(%w[pdirty mdirty midi ldirty]) vm.event.add(%i[pdirty mdirty midi ldirty])
vm.event.remove(%w[pdirty mdirty midi ldirty]) vm.event.remove(%i[pdirty mdirty midi ldirty])
# get a list of currently subscribed # get a list of currently subscribed
p vm.event.get p vm.event.get
@ -712,8 +712,6 @@ p vm.event.get
## `Voicemeeter Module` ## `Voicemeeter Module`
### Remote class
#### Voicemeeter::Remote #### Voicemeeter::Remote
You may pass the following optional keyword arguments: You may pass the following optional keyword arguments:
@ -745,9 +743,13 @@ vm.set("Strip[0].Gain", -3.6)
### Errors ### Errors
- `Errors::VMError`: Error raised when general errors occur. - `Errors::VMError`: Base Voicemeeter error class.
- `Errors::VMCAPIError`: Error raised when the C-API returns error values. - `Errors::VMInstallError`: Raised when errors occur during installation.
- Error codes are stored in {Error Class}.code. For a full list of error codes [check the VoicemeeterRemote header file][voicemeeter remote header]. - `Errors::VMCAPIError`: Raised when the C-API returns error codes.
- The following attributes are available:
- `fn_name`: name of the C-API function that failed.
- `code`: error code.
- For a full list of error codes [check the VoicemeeterRemote header file][voicemeeter remote header].
### Logging ### Logging