Description

Renders the play range of the active view (3D Scene or cameras) to a video or image sequence. You must set the desired view and view options (either manually or via a script) before running this command. If you need to specify that the Cameras view should show only one camera instead of all cameras, see the camerasView command and use the option -primarySelectFull.

When rendering, a copy of the active view is opened in a floating window.

A progress bar is displayed during rendering. If you click Cancel, rendering stops and the video file is removed from disk.

Note
The playblast command overrides existing output files without prompting you. You may want to add a check that a file exists to your script before running playblast.

Functional area

Interface

Command syntax

Syntax

playblast "destinationFile"[-width integer] [-height integer]

Arguments

Name	Type	Required	Comments
`destinationFile`		No	Full path and filename (including extension) of the rendered video file. The extension defines the video output container (mov, mp4, avi, or mkv), or image sequence (jpg). If not specified, a mov is output with the same name as the scene name in the current save path.

Flags

Name	Flag arguments	Argument type	Exclusive to	Comments
`width`		integer		Output video resolution width (px). If not specified, the default (720) is used.
`height`		integer		Output video resolution height (px). If not specified, the default (480) is used.

Return value

void

Examples

playblast "G:/MOCAP/Playblast/fileName.mov" -width 1920 -height 1080;
// This produces a mov video of the active view to the path specified.
// The video resolution will be 1920 x 1080.

Browser not supported