mirror of
https://github.com/onyx-and-iris/voicemeeter-api-powershell.git
synced 2025-12-05 05:07:47 +00:00
update docs
- pester tests for safety pass for all kinds - all manual tests pass
This commit is contained in:
parent
9b1b78100c
commit
bef4e64c9e
@ -9,6 +9,12 @@ Before any major/minor/patch is released all test units will be run to verify th
|
||||
|
||||
## [Unreleased] These changes have not been added to PSGallery yet
|
||||
|
||||
### Breaking Changes
|
||||
|
||||
AddActionMembers now adds ScriptMethods instead of ScriptProperties:
|
||||
- See Command section of README for details on using special commands
|
||||
- See Recorder section of README for details on using playback/record actions
|
||||
|
||||
### Added
|
||||
|
||||
- IRemote base class
|
||||
@ -35,6 +41,8 @@ Before any major/minor/patch is released all test units will be run to verify th
|
||||
- cast vban getters to types for consistency
|
||||
- Bus.Mono -> [int] for stereo reverse
|
||||
- Bus.Levels.Convert return type [float] -> [single] for naming consistency, no functional change
|
||||
- Meta: AddBoolMembers, AddIntMembers $arg types for consistency
|
||||
- Device: explicit $arg types for consistency
|
||||
|
||||
### Fixed
|
||||
|
||||
|
||||
23
README.md
23
README.md
@ -420,15 +420,15 @@ Certain 'special' commands are defined by the API as performing actions rather t
|
||||
|
||||
The following commands are available:
|
||||
|
||||
- show
|
||||
- hide
|
||||
- restart
|
||||
- shutdown
|
||||
- showvbanchat: bool, (write only)
|
||||
- lock: bool, (write only)
|
||||
|
||||
The following methods are available:
|
||||
|
||||
- Show()
|
||||
- Restart()
|
||||
- Shutdown()
|
||||
- Load($filepath): string
|
||||
- RunMacrobuttons(): Launches the macrobuttons app
|
||||
- CloseMacrobuttons(): Closes the macrobuttons app
|
||||
@ -436,7 +436,7 @@ The following methods are available:
|
||||
example:
|
||||
|
||||
```powershell
|
||||
$vmr.command.show
|
||||
$vmr.command.show()
|
||||
|
||||
$vmr.command.lock = $true
|
||||
|
||||
@ -525,12 +525,6 @@ $vmr.Option.buffer.asio = 0 # to use default buffer size
|
||||
|
||||
The following commands are available:
|
||||
|
||||
- play
|
||||
- stop
|
||||
- pause
|
||||
- record
|
||||
- ff
|
||||
- rew
|
||||
- A1 - A5: bool
|
||||
- B1 - B3: bool
|
||||
- samplerate: int, (22050, 24000, 32000, 44100, 48000, 88200, 96000, 176400, 192000)
|
||||
@ -540,6 +534,13 @@ The following commands are available:
|
||||
|
||||
The following methods are available:
|
||||
|
||||
- Play()
|
||||
- Stop()
|
||||
- Replay()
|
||||
- FF()
|
||||
- Rew()
|
||||
- Record()
|
||||
- Pause()
|
||||
- Load($filepath): string
|
||||
- GoTo($timestring): string, must match the format 'hh:mm:ss'
|
||||
- FileType($format): string, ('wav', 'aiff', 'bwf', 'mp3')
|
||||
@ -547,7 +548,7 @@ The following methods are available:
|
||||
example:
|
||||
|
||||
```powershell
|
||||
$vmr.recorder.play
|
||||
$vmr.recorder.play()
|
||||
$vmr.recorder.A1 = $true
|
||||
|
||||
$vmr.recorder.GoTo("00:01:15") # go to 1min 15sec into track
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user