VVQCComposition Class Reference

Load a Quartz Composer composition and parse it as a text file (QC comps are basically big plists) to retrieve data about the composition without invoking the Quartz Composer runtime, which can be slow. More...

#import <VVQCComposition.h>

Inherits NSObject.

Instance Methods
(id)	- initWithFile:
	Init an instance of VVQCComposition from a file at the given path.
(NSDictionary *)	- publishedInputsDict
	Retruns an NSDictionary describing the top-level published inputs in the composition.
(NSDictionary *)	- publishedOutputsDict
	Returns an NSDictionary describing the top-level published output in the composition.
(NSString *)	- compositionName
	Returns the name of the composition.
(NSString *)	- compositionPath
	Returns the path of the composition.
(NSArray *)	- inputKeys
	Returns an array of strings. Each string is the name of a published input splitter- the strings are ordered according to their order in the QC editor.
(NSString *)	- category
	Returns the category of the composition.
(NSString *)	- description
	Returns the description of the composition.
(NSArray *)	- protocols
	Returns an array of NSStrings describing the protocol that this composition conforms to.
(BOOL)	- hasLiveInput
	Returns YES if this composition has a live input.

Class Methods
(BOOL)	+ pathLooksLikeALegitComposition:
	returns NO if the path begins with a period (invisible), doesn't have an extension, or doesn't end in "qtz" (case-insensitive)
(id)	+ compositionWithFile:
	Creates and returns an auto-released instance of VVQCComposition from a file at the given path.

Detailed Description

Load a Quartz Composer composition and parse it as a text file (QC comps are basically big plists) to retrieve data about the composition without invoking the Quartz Composer runtime, which can be slow.

OTHER NOTES ON THE LAYOUT OF QUARTZ COMPOSER DOCUMENTS:

• a QC file at its top level is a dictionary
• the "inputParameters" key of the top-level dictionary points to another dictionary
  • each key of "inputParameters" corresponds to a top-level published input
  • the item corresponding to each key is the default value of the input port. this does not describe the full splitter settings (no max/min/etc.), just the default value!
  • boolean, number, and string inputs work exactly as expected
  • colors are represented by a dict, keys "red", "green", "blue", and "alpha"
  • "structure" inputs- which do not have a default value- are not listed here! this means that i can't use this dict to populate inputs!
  • the value of "index" inputs (menus) is represented as the selected index (no strings!)
• the "portAttributes" key of the top-level dictionary points to another dictionary
  • each key of the "portAttributes" dict represents a top-level published input or output
  • the keys of "portAttributes" are the names of the published inputs and output
  • every item in "portAttributes" is a dictionary.
    • the "name" key of this dict points to a string
    • the value of the "name" string is either "Input" (if it's an input), or "Output" (if it's an output)
• the "rootPatch" key of the top-level dictionary points to another dictionary
  • the "state" key of "rootPatch" points to another dictionary.
  • the "state" dictionary has 3 keys of interest:
    • the "publishedInputPorts" key points to an array
      • each item in "publishedInputPorts" is a dict
        • the "key" key in the dict points to a string, which is the name of the published input
        • the "node" key in the dict points to a string, which is the name of the node
    • the "publishedOutputPorts" key points to an array, and is just like "publishedInputPorts"
    • the "nodes" key points to an array
      • each item in "nodes" is a dict
        • the "key" key in the dict points to a string, which is the name of the node
        • the "class" key in the dict points to a string, which is the name of the class
        • the "state" key in the dict points to another dict, which describes the state of the input

---

The documentation for this class was generated from the following files:

• VVBufferPool/VVQCComposition.h
• VVBufferPool/VVQCComposition.m