2 Commits

Author SHA1 Message Date
359c2d61b5 reword 2024-07-01 07:32:41 +01:00
e586478729 fix WithTimeout name in README
move it above WithBits
2024-07-01 07:23:40 +01:00
2 changed files with 7 additions and 7 deletions

View File

@@ -15,7 +15,7 @@ Before any major/minor/patch bump all unit tests will be run to verify they pass
### Added ### Added
- Added a configurable timeout in seconds (defaults to 2). - Added a configurable login timeout in seconds (defaults to 2).
- Option function added for overriding the type of Voicemeeter GUI runVoicemeeter() will launch. - Option function added for overriding the type of Voicemeeter GUI runVoicemeeter() will launch.
- Explanation of Option functions added to README. - Explanation of Option functions added to README.

View File

@@ -81,18 +81,18 @@ Pass a delay in milliseconds to force the getters to wait for dirty parameters t
Useful if not listening for event updates. Useful if not listening for event updates.
### `voicemeeter.WithTimeout(timeout int)`
Set a login timeout, defaults to 2 seconds. For example to set it to 1s:
`voicemeeter.NewRemote("banana", 20, voicemeeter.WithTimeout(1))`
### `voicemeeter.WithBits(bits int)` ### `voicemeeter.WithBits(bits int)`
Override the type of Voicemeeter GUI to launch on 64 bit systems. For example, to force 32 bit GUI: Override the type of Voicemeeter GUI to launch on 64 bit systems. For example, to force 32 bit GUI:
`voicemeeter.NewRemote("banana", 20, voicemeeter.WithBits(32))` `voicemeeter.NewRemote("banana", 20, voicemeeter.WithBits(32))`
### `voicemeeter.WithBits(timeout int)`
Set a login timeout, defaults to 2 seconds. For example to set it to 1s:
`voicemeeter.NewRemote("banana", 20, voicemeeter.WithBits(1))`
## `Remote Type` ## `Remote Type`
#### `vm.Strip` #### `vm.Strip`