A protocol is a predetermined set of published ports with certain names and data types. Vuo supports the following protocols:
Image Filter — Alters an image.
Published input ports:
image (Image) — The original image.
time (Real) — A number that changes over time, used to control animations or other changing effects. When previewing the composition in the Vuo Editor, this number is the time, in seconds, since the composition started running. In other applications, this number should be described in their instructions for creating Vuo compositions.
Published output ports:
outputImage — The altered image.
Image Generator — Creates an image.
Published input ports:
width (Integer) — The requested width of the image, in pixels.
height (Integer) — The requested height of the image, in pixels.
time (Real) — A number that changes over time, used to control animations or other changing effects. When previewing the composition in the Vuo Editor, this number is the time, in seconds, since the composition started running. In other applications, this number should be described in their instructions for creating Vuo compositions.
offlineRender
(Boolean) — Optional. In the Vuo Editor and the
vuo-export command-line tool, this
port’s value is true if the
composition is being exported to a movie and
false otherwise.
offlineFramerate
(Real) — Optional. In the Vuo Editor and the
vuo-export command-line tool, this
port’s value is the movie framerate, in frames per
second, if the composition is being exported to a
movie and 0 otherwise.
offlineMotionBlur
(Integer) — Optional. In the Vuo Editor and the
vuo-export command-line tool, this
port’s value is the number of frames rendered per
output frame. 1 means motion blur is disabled; 2, 4,
8, 16, 32, or 64 means motion blur is enabled.
Published output ports:
outputImage — The created image. Its width and height should match the width and height published input ports.
To create a composition that conforms to a protocol, go to . If you’ve already started working on a composition and want to make it conform to a protocol, go to and choose a protocol.
Optional published ports (offlineRender and offlineFramerate) don’t automatically appear in the Vuo Editor, but you can add them just as you would other published ports. Be sure to type the names exactly as they appear in this documentation (case-sensitive).
The Vuo Editor provides some examples of protocol-compliant compositions under .
When you run a protocol-compliant composition in the Vuo Editor, events and data are automatically fed into its input ports, and the resulting image is displayed in a window. This makes it easy to preview how your composition will look when run inside some other application.
When you run an Image Filter composition in the Vuo Editor, you can change the image being filtered by dropping an image file onto the running composition’s window.