onyx_online/voicemeeter-api-powershell
1
0
Fork 0
mirror of https://github.com/onyx-and-iris/voicemeeter-api-powershell.git synced 2025-01-18 05:10:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

Errors section added to README

Browse Source
This commit is contained in:
onyx-and-iris 2023-08-17 02:56:38 +01:00
parent d0fbd6deef
commit 43367525c5
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -542,6 +542,15 @@ Access to lower level polling functions are provided with these functions:
- `$vmr.PDirty`: Returns true if a parameter has been updated.
- `$vmr.MDirty`: Returns true if a macrobutton has been updated.
### Errors
- `VMRemoteError`: Base custom error class.
- `LoginError`: Raised when a login error occurs.
- `CAPIError`: Raised when a C-API function returns an error code.
- The following class properties are available:
- `function`: The name of the C-API function that returned the error code.
- `code`: The error code.
### Run tests
Run tests using .\tests\pre-commit.ps1 which accepts the following parameters: