WebCCExporter Class Reference

The WebCCExporter JavaScript global object. Generate movies encoded in H.264. More...

Public Slots
void	exportMovieFromWriteModules (int fromFrame=1, int toFrame=-1)
void	exportMovieFromWriteModule (String &moduleName, int firstFrame=1, int lastFrame=-1, bool withSound=true, String &movieFile=String())
void	exportMovieFromFiles (String &movieFilename, StringList &framesFilenames, int firstFrame=1, int lastFrame=-1, bool withSound=true)

Detailed Description

The WebCCExporter JavaScript global object. Generate movies encoded in H.264.

This is an interface used by WebCC to generate a movie encoded in H.264 using a plugin that must be downloaded separately from Cisco website. The plugin name is OpenH264.
Using this API, user may generate valid H264 movie without using the QuickTime Technology from Apple. This plugin works on Linux, where QuickTime is not available and will also work on Windows and OSX.

See usage example in script: TB_WebCC_Render.js

Member Function Documentation

exportMovieFromFiles

void WebCCExporter::exportMovieFromFiles ( String &  movieFilename, StringList &  framesFilenames, int  firstFrame = 1, int  lastFrame = -1, bool  withSound = true  )

slot

Generate a H264 movie with or without sound, using a list of images. The range of frames is only used when including sound. The frame rate of the movie is the scene frame rate.

Typically, you would use this function in a two stage render:

• you render the scene and write individual images to the file system - as PNG or any other supported format.
• you call this function to assemble the movie using the list of individual images.

Parameters

movieFilename	the filename of the movie to generate
framesFilenames	an Array of filenames, each of the filename is a frame of the movie.
firstFrame	the initial start frame of the movie - used when extracting soundtrack - default : 1
lastFrame	the last frame rendered - default: -1 (all frames)
withSound	include soundtrack or not - default: true

exportMovieFromWriteModule

void WebCCExporter::exportMovieFromWriteModule ( String &  moduleName, int  firstFrame = 1, int  lastFrame = -1, bool  withSound = true, String &  movieFile = String()  )

slot

Generates a movie for the specified WRITE node. The node must be configured to render for QUICKTIME.

This function triggers a softrender for the specified write, it captures the images and sends them to the OpenH264 plugins to generate a movie. If sound is required, it will also produce a soundtrack, uncompressed.

The user can control the start frame and end frame.

Parameters

moduleName	the name of the WRITE module - as used by the node interface (ie. 'Top/Write' ).
firstFrame	the initial start frame of the movie - default : 1
lastFrame	the last frame rendered - default: -1 (all frames)
withSound	include soundtrack or not - default: true
movieFile	the name of the movie file generated - default: empty - so, it uses the filename specified in the WRITE node.

exportMovieFromWriteModules

void WebCCExporter::exportMovieFromWriteModules ( int  fromFrame = 1, int  toFrame = -1  )

slot

Generates a movie for each WRITE node configured to render with QuickTime. Basically, this function scans the whole scene and trigger a softrender for each write nodes. The write node must be enabled and must already configured to render with QuickTime (ie. render a movie, at least).

The sound track is rendered in movie.

The user can control the start frame and end frame.

Parameters

fromFrame	the initial start frame of each movies - default : 1
toFrame	the last frame rendered - default: -1 (all frames)