upd changelog

This commit is contained in:
onyx-and-iris 2023-08-09 14:44:47 +01:00
parent 1c9c400f12
commit 5bda43131b

View File

@ -9,221 +9,221 @@ 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 ## [Unreleased] These changes have not been added to PSGallery yet
- [ ] - [x] Level methods for Strip,Bus classes implemented.
## [3.0.0] ## [3.0.0]
v3 introduces some breaking changes. They are as follows: v3 introduces some breaking changes. They are as follows:
- Strip[i].comp now references [Comp] class. (see README for details on settings strip.comp parameters) - Strip[i].comp now references [Comp] class. (see README for details on settings strip.comp parameters)
- Strip[i].gate now references [Gate] class. (see README for details on settings strip.gate parameters) - Strip[i].gate now references [Gate] class. (see README for details on settings strip.gate parameters)
- Strip[i].eq now references [Eq] class. (see README for details on settings strip.eq parameters) - Strip[i].eq now references [Eq] class. (see README for details on settings strip.eq parameters)
- Strip[i].device now references [Device] class. (see README for details on settings strip.device parameters) - Strip[i].device now references [Device] class. (see README for details on settings strip.device parameters)
- Bus[i].eq now references [Eq] class. (see README for details on settings bus.eq parameters) - Bus[i].eq now references [Eq] class. (see README for details on settings bus.eq parameters)
- Bus[i].mode now implemented as its own class [Mode]. (see README for details on settings bus.mode parameters) - Bus[i].mode now implemented as its own class [Mode]. (see README for details on settings bus.mode parameters)
There are other changes but they should not be breaking. There are other changes but they should not be breaking.
### Changed ### Changed
- meta functions refactored, they now use identifier() functions. - meta functions refactored, they now use identifier() functions.
- OBS example reworked, now using obs-powershell module. - OBS example reworked, now using obs-powershell module.
- Rethrow LoginError for unknown kind exceptions, let the consumer handle it from there. - Rethrow LoginError for unknown kind exceptions, let the consumer handle it from there.
### Added ### Added
- Entry/exit points Connect-Voicemeeter, Disconnect-Voicemeeter added to module. - Entry/exit points Connect-Voicemeeter, Disconnect-Voicemeeter added to module.
- Comp, Gate, Denoiser and Eq classes added to PhysicalStrip - Comp, Gate, Denoiser and Eq classes added to PhysicalStrip
- Device class added to PhysicalStrip/PhysicalBus - Device class added to PhysicalStrip/PhysicalBus
- AppGain(), AppMute() methods added to VirtualStrip - AppGain(), AppMute() methods added to VirtualStrip
- eq added to Bus - eq added to Bus
- interface classes IBus, IStrip and IVban added. getters/setters moved into interface classes. - interface classes IBus, IStrip and IVban added. getters/setters moved into interface classes.
- RemoteBasic, RemoteBanana and RemotePotato subclasses added. - RemoteBasic, RemoteBanana and RemotePotato subclasses added.
### Fixed ### Fixed
- Button getters return boolean values. - Button getters return boolean values.
### Removed ### Removed
- Bus[i].mode\_{param} members removed. Replaced with Bus[i].mode.{param} - Bus[i].mode\_{param} members removed. Replaced with Bus[i].mode.{param}
## [2.5.0] - 2022-10-27 ## [2.5.0] - 2022-10-27
### Added ### Added
- xy parameters added to strip/bus - xy parameters added to strip/bus
- fx parameters added to strip/bus - fx parameters added to strip/bus
- GetType, GetVersion added to Remote class. - GetType, GetVersion added to Remote class.
- SendText implemented (set parameters by script), added to Remote class. - SendText implemented (set parameters by script), added to Remote class.
- CLI example added - CLI example added
- README and CHANGELOG updated to reflect latest changes. - README and CHANGELOG updated to reflect latest changes.
### Changed ### Changed
- pester tests now support all kinds. - pester tests now support all kinds.
- GoToNextBus example refactored - GoToNextBus example refactored
- Previous console output now written to Debug stream. - Previous console output now written to Debug stream.
### Removed ### Removed
- setmulti, setandget and special examples. - setmulti, setandget and special examples.
## [2.4.0] - 2022-06-25 ## [2.4.0] - 2022-06-25
### Added ### Added
- fadeto, fadeby methods for strips/buses - fadeto, fadeby methods for strips/buses
- README and CHANGELOG updated to reflect latest changes. - README and CHANGELOG updated to reflect latest changes.
- Version 2.4 added to PSGAllery - Version 2.4 added to PSGAllery
### Changed ### Changed
- Move kinds, profiles into their own modules. - Move kinds, profiles into their own modules.
- remove global variable layout. added GetKind() to kinds. - remove global variable layout. added GetKind() to kinds.
- link to official documentation in readme now points to SDK repo. - link to official documentation in readme now points to SDK repo.
### Fixed ### Fixed
- number of macrobuttons - number of macrobuttons
## [2.3.0] - 2022-03-08 ## [2.3.0] - 2022-03-08
### Added ### Added
- mc, k properties added to virtual strips. - mc, k properties added to virtual strips.
- gainlayer properties added to all strips - gainlayer properties added to all strips
- busmode and eq_ab properties added to all buses. - busmode and eq_ab properties added to all buses.
- Added ability to load custom profiles in psd1 format. - Added ability to load custom profiles in psd1 format.
- Added hide command to Command class - Added hide command to Command class
- Added recorder module - Added recorder module
- Added recorder tests to higher.tests - Added recorder tests to higher.tests
- README and CHANGELOG updated to reflect latest changes. - README and CHANGELOG updated to reflect latest changes.
- Version 2.3 added to PSGAllery - Version 2.3 added to PSGAllery
### Changed ### Changed
- Pester tests refactored - Pester tests refactored
### Fixed ### Fixed
- eq, eq_ab getters now return boolean values - eq, eq_ab getters now return boolean values
- fixed bug with command action props - fixed bug with command action props
## [2.2.0] - 2022-01-19 ## [2.2.0] - 2022-01-19
### Added ### Added
- Add VMRemoteErrors class and subclass other error classes. - Add VMRemoteErrors class and subclass other error classes.
- Expose lower level setters and getters as well as polling parameters through Remote class. - Expose lower level setters and getters as well as polling parameters through Remote class.
- README and CHANGELOG updated to reflect latest changes. - README and CHANGELOG updated to reflect latest changes.
- Version 2.2 added to PSGAllery - Version 2.2 added to PSGAllery
### Changed ### Changed
- Rework set many parameters so class properties are set through the wrapper instead by VBVMR_SetParameters - Rework set many parameters so class properties are set through the wrapper instead by VBVMR_SetParameters
- Rework meta module. Separate functions for each member type. - Rework meta module. Separate functions for each member type.
- Update pester tests to reflect latest changes - Update pester tests to reflect latest changes
- Add throw LoginError if multiple login attempts are made. In testing the session was still crashing, however. - Add throw LoginError if multiple login attempts are made. In testing the session was still crashing, however.
## [2.1.0] - 2022-01-11 ## [2.1.0] - 2022-01-11
### Added ### Added
- Special command lock - Special command lock
- Special command showvbanchat - Special command showvbanchat
- vban.enable command added (toggle vban) - vban.enable command added (toggle vban)
- README and CHANGELOG updated to reflect latest changes. - README and CHANGELOG updated to reflect latest changes.
- Version 2.1 added to PSGAllery - Version 2.1 added to PSGAllery
### Changed ### Changed
- Subclass strip and bus classes into physical/virtual buses. - Subclass strip and bus classes into physical/virtual buses.
### Fixed ### Fixed
- Special command showvbanchat now accepts boolean - Special command showvbanchat now accepts boolean
## [2.0.0] - 2022-01-06 ## [2.0.0] - 2022-01-06
### Added ### Added
- README and CHANGELOG updated to reflect latest changes. - README and CHANGELOG updated to reflect latest changes.
- Version 2.0 added to PSGAllery - Version 2.0 added to PSGAllery
### Changed ### Changed
- Moved meta functions into own module - Moved meta functions into own module
- Vban class now custom object comprising of two arrays of subclasses for each stream type - Vban class now custom object comprising of two arrays of subclasses for each stream type
- Major version bumped due to changes to vban class - Major version bumped due to changes to vban class
- Pester tests updated to reflect changes. - Pester tests updated to reflect changes.
### Fixed ### Fixed
- Special commands now throw write only error on read attempt. - Special commands now throw write only error on read attempt.
## [1.8.0] - 2021-08-23 ## [1.8.0] - 2021-08-23
### Added ### Added
- Added special commands - Added special commands
### Changed ### Changed
- Add special section to README - Add special section to README
### Fixed ### Fixed
- Removed unneeded console output - Removed unneeded console output
## [1.6.0] - 2021-06-06 ## [1.6.0] - 2021-06-06
### Added ### Added
- Add vban commands - Add vban commands
- Added meta functions for bus/strip attrs - Added meta functions for bus/strip attrs
### Changed ### Changed
- Update tests to reflect changes - Update tests to reflect changes
- Add vban section to README - Add vban section to README
### Fixed ### Fixed
- Run 64bit exe for potato version if on 64bit OS - Run 64bit exe for potato version if on 64bit OS
## [1.5.0] - 2021-05-11 ## [1.5.0] - 2021-05-11
### Added ### Added
- Fetch dll path through registry (support for 32 and 64 bit) - Fetch dll path through registry (support for 32 and 64 bit)
- Add strip/bus commands section to README - Add strip/bus commands section to README
- Add label name command to Strips - Add label name command to Strips
## [1.4.0] - 2021-05-03 ## [1.4.0] - 2021-05-03
### Added ### Added
- Add gain, comp, limit to Strips - Add gain, comp, limit to Strips
- Update tests to reflect changes - Update tests to reflect changes
- Add logging + summary for tests - Add logging + summary for tests
- Add info to README about powershellget, nuget and psgallery - Add info to README about powershellget, nuget and psgallery
- Support other types of params in multi_set - Support other types of params in multi_set
### Changed ### Changed
- Multi_Set now accepts nested hash - Multi_Set now accepts nested hash
## [1.3.0] - 2021-04-30 ## [1.3.0] - 2021-04-30
### Added ### Added
- Updated README to include Installation instructions. - Updated README to include Installation instructions.
- Added FROM_SOURCE.md to explain alternative loading of scripts if directly - Added FROM_SOURCE.md to explain alternative loading of scripts if directly
downloaded. downloaded.
- Set_Multi command for setting many parameters at once. - Set_Multi command for setting many parameters at once.
## [1.0.0] - 2021-04-29 ## [1.0.0] - 2021-04-29
- Added module to PSGAllery - Added module to PSGAllery