From 498d2a41f924781f4b9073e54cb2ba937dbfbf42 Mon Sep 17 00:00:00 2001 From: Joel Wetzell Date: Sat, 23 Jul 2022 13:56:56 -0500 Subject: [PATCH] Update README.md --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index d2a19f9..7e98a74 100644 --- a/README.md +++ b/README.md @@ -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