Skip to content

Commit 6512b35

Browse files
committed
added Option function sections to README.
1 parent 5aabd0a commit 6512b35

File tree

1 file changed

+17
-7
lines changed

1 file changed

+17
-7
lines changed

README.md

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,14 @@
11
[![Go Reference](https://pkg.go.dev/badge/github.com/onyx-and-iris/voicemeeter.svg)](https://pkg.go.dev/github.com/onyx-and-iris/voicemeeter/v2)
22

3-
# A Go Wrapper for Voicemeeter API
4-
5-
This package offers a Go interface for the Voicemeeter Remote C API.
3+
# A Go Wrapper for the Voicemeeter API
64

75
For an outline of past/future changes refer to: [CHANGELOG](CHANGELOG.md)
86

97
## Tested against
108

11-
- Basic 1.0.8.8
12-
- Banana 2.0.6.8
13-
- Potato 3.0.2.8
9+
- Basic 1.1.1.1
10+
- Banana 2.1.1.1
11+
- Potato 3.1.1.1
1412

1513
## Requirements
1614

@@ -67,7 +65,7 @@ func vmConnect() (*voicemeeter.Remote, error) {
6765
}
6866
```
6967

70-
## `voicemeeter.NewRemote(<kindId>, <delay>)`
68+
## `voicemeeter.NewRemote(<kindId>, <delay>, opts ...Option)`
7169

7270
### `kindId`
7371

@@ -83,6 +81,18 @@ Pass a delay in milliseconds to force the getters to wait for dirty parameters t
8381

8482
Useful if not listening for event updates.
8583

84+
### `voicemeeter.WithBits(bits int)`
85+
86+
Override the type of Voicemeeter GUI to launch on 64 bit systems. For example, to force 32 bit GUI:
87+
88+
`voicemeeter.NewRemote("banana", 20, voicemeeter.WithBits(32))`
89+
90+
### `voicemeeter.WithBits(timeout int)`
91+
92+
Set a login timeout, defaults to 2 seconds. For example to set it to 1s:
93+
94+
`voicemeeter.NewRemote("banana", 20, voicemeeter.WithBits(1))`
95+
8696
## `Remote Type`
8797

8898
#### `vm.Strip`

0 commit comments

Comments
 (0)