jwetzell/QControlKit
1
0
Fork 0
mirror of https://github.com/jwetzell/QControlKit.git synced 2026-07-26 10:38:54 +00:00
Code Issues Packages Projects Releases 1 Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Joel Wetzell
2022-07-23 13:56:56 -05:00
committed by GitHub
parent 730e7bc554
commit 498d2a41f9
1 changed files with 9 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+9
View File
@@ -2,6 +2,15 @@
This is an unofficial .NET library port of Figure53's [QLabKit](https://github.com/Figure53/QLabKit.objc).
## Components
- **QBrowser**: Searches for an maintains a list of QLab "instances" using bonjour
- **QClient**: Wrapper over underlying TCP/UDP connection as well as providing event handlers for common QLab replies (i.e. cue needs updated, workspace need updated, etc.)
- **QCue**: The most basic object in QLab, contains shared properties and methods for a cue in a cuelist (cuelists are also a cue) is extended for other cue types (Text, Midi, etc.)
- **QMessage**: Wrapper over underlying OSC Message, has methods to quickly determine the message type and parts (Workspace info, address, arguments, etc.)
- **QServer**: This class represents a computer that is running QLab, it has host information (IP, Port) as well as discovered workspaces on that computer.
- **QWorkspace**: This class represents a workspace on a QServer, it contains methods and properties to interact with a workspace as well as access the underlying QCues and QClient that is facilitating communication
## Todo: give a basic example of the workflow