Go to: Synopsis. Return value. Flags. MEL examples.

Synopsis

thumbnailCaptureComponent [-capture] [-capturedFrameCount] [-closeCurrentSession] [-delete] [-endFrame int] [-fileDialogCallback string] [-isSessionOpened] [-launchedFromOptionsBox] [-previewPath] [-removeProjectThumbnail string] [-save string] [-startFrame int] [string]

thumbnailCaptureComponent is NOT undoable, queryable, and NOT editable.

This command is used to generate a thumbnail/playblast sequence from the scene.

Return value

None

In query mode, return type is based on queried flag.

Flags

capture, capturedFrameCount, closeCurrentSession, delete, endFrame, fileDialogCallback, isSessionOpened, launchedFromOptionsBox, previewPath, removeProjectThumbnail, save, startFrame
Long name (short name) Argument types Properties
-capture(-c) create
Create a new component to capture a sequence of image for the current scene.
-capturedFrameCount(-cfc) query
Query only. Return the number of frames that have been captured.
-closeCurrentSession(-ccs) create
Delete the current thumbnail component (preview image will be destroyed).
-delete(-d) create
Delete the generated image sequence and preview for the current capture session.
-endFrame(-ef) int createquery
Set the end captured frame. Only valid when the -c/capture flag is set. If -sf/startFrame is set and not -ef/endFrame, or if endFrame is smaller than startFrame, endFrame will be automatically set to startFrame.
-fileDialogCallback(-fdc) string create
MEL only. Set the callback file dialog which is called after the capture component window has been closed. Only valid when the -c/capture flag is set.
-isSessionOpened(-iso) query
Returns true if a thumbnail/playblast capture session is currently running (already opened and still not cancelled/saved).
-launchedFromOptionsBox(-lfo) query
Returns true if the thumbnail capture component was launched through the options dialog box, else false.
-previewPath(-pp) query
Returns the generated preview path (the first frame of generated sequence resized to 100x100 px).
-removeProjectThumbnail(-rpt) string create
Remove all captured thumbnail/playblast from the given project file path.
-save(-s) string create
Save the generated image sequence for the given file to disk. The file path must be an absolute path.
-startFrame(-sf) int createquery
Set the start captured frame. Only valid when -c/capture flag is set.
Flag can appear in Create mode of command Flag can appear in Edit mode of command
Flag can appear in Query mode of command Flag can be used more than once in a command.

MEL examples

//    Launch an option box used to capture the scene
//

thumbnailCaptureComponent -capture -startFrame 20 -endFrame 60;

//    Save the generated image sequence for "mesh.mb"
//

thumbnailCaptureComponent -save "C:/maya/projects/default/scenes/mesh.mb"


//    Delete generated thumbnails for current capture session
//

thumbnailCaptureComponent -delete;


//    Return the path of generated sequence preview.
//

thumbnailCaptureComponent -q -previewPath;
// Result: C:/Users/toto/Documents/maya/projects/default/images/.MayaTempCaptureComponent/tmp.preview //