Skip to content

Video

Video node can playback a variety of video codecs. Most prominently Mov, Avi, Mpg Mpg4 and Hap

Please notice: If you want to use the HAP codec running on the GPU, place the video inside the ~/_assets/_videos/_hap folder (recommended). Otherwise the HAP codec will run on the CPU (slower).

Video Node

Reference

The following properties can be configured for this node:

Property Type Description
file - load and playback file
dispose - dispose the loaded file
start - start the video file
stop - stop the video file
loop - loop mode
render pass - select render pass
rate - playback rate (default = 1)
autostart - autostart the video after loading it
volume - if the video has a audio track, adjust it here.
unique - unique
frame - choose framenumber
interp - interpolate
cache_size - sets the cache size for the video engine. Reverse playback stutters may be the result of insufficient cache_size. Care should be taken when adjusting the cache_size, if the frame cache exceeds the available memory, the application may crash.
colormode - colormode
loopreport - reports the end of a loop
frame endtrigger - sets the trigger in number of frames before the video has reached its end
time endtrigger - sets the trigger in milliseconds before the video has reached its end
framereport - reports framenumber and drives the playbar. CAREFULL!! the playbar is resource hungry.
timereport - reports time in milliseconds.
filewatch - reloads automatically file if file changes.
Inlet Type Description
direct message direct messages to control video: enable | start | stop | dispose | frame refresh | frame time | frame duration | frame framecount | frame seekframe | frame seeknotify
properties properties properties | use message [set <propertyPath> <value(s)>] (without node/<nodeName> at the beginning) to set internal properties
Outlet Type Description
video texture video texture
audio audio audio left
audio audio audio right
dump message dump

Important Notes

Calibration Requirements

  • Currently only the follwing codecs are supported:
  • Hap
  • Hap alpha
  • Hap Q
  • Hap Q alpha is NOT supported for playing on the GPU. You can send the follwoing OSC-messages to the node /sparck/node/ start /sparck/node/ stop /sparck/node/ pause /sparck/node/ dispose Some info about HAP: Visit the Hap Github page (link on top) for more information. No additional installations are needed for playback, however in order to convert files to Hap codec, additional platform specific installs are necessary. Mac users can use the AVF Batch Converter application to convert existing files to use the Hap codec. The mac file format container must be Quicktime MOV. Windows users wishing to convert files should install the Renderheads DirectShow codec and use a compatible software such as Adobe Media Encoder. The Windows file format container must be AVI.

File Locations

~/_assets/_projectors/     # Calibration files
~/_assets/_model/          # Calibration models (.obj)

Need help or want to suggest improvements?

Report an issue Improve the Docs

Last updated: 2025-12-01 | Edit this page on GitHub