FBVideoGrabOptions Class Reference

#include <mobu-python-api.h>

Class Description

Video Grabbing Options structure.

Contain options to control how the grabbing process will occur.

+ Inheritance diagram for FBVideoGrabOptions:

Public Member Functions

 __reduce__ ()
 
 __init__ (object arg1)
 

Public Attributes

ORSDK2018::FBTimeSpan TimeSpan
 Start and stop selection time to grab. More...
 
ORSDK2018::FBTime TimeSteps
 Time step length between each grab. More...
 
FBCameraResolutionMode CameraResolution
 Camera Resolution. More...
 
FBVideoRenderDepth BitsPerPixel
 Video grab color depth. More...
 
FBVideoRenderFieldMode FieldMode
 Video grab field mode. More...
 
FBVideoRenderViewingMode ViewingMode
 Video grab viewing mode. More...
 
FBStereoDisplayMode StereoDisplayMode
 Video grab stereo display mode. More...
 
int RendererCallbackIndex
 Specify renderer callback index. More...
 
int RendererCallbackPrefIndex
 Specify custom renderer callback's preference index. More...
 
ORSDK2018::FBString OutputFileName
 Grabbing destination file. More...
 
bool ShowSafeArea
 If true, display safe area. More...
 
bool ShowTimeCode
 If true, display time code information. More...
 
bool ShowCameraLabel
 If true, display camera label information. More...
 
bool AntiAliasing
 If true, video frames will be anti-aliased. More...
 
bool RenderAudio
 If true and there's audio in the scene, add audio to the output file. More...
 
FBAudioFmt AudioRenderFormat
 Audio render format. More...
 
int StillImageCompression
 Compression ratio for image(jpg) 0-100 where 0=Greatest compression, 100=Least Compression. More...
 

Member Function Documentation

__init__ ( object  arg1)

Python Docstring:

__init__( (object)arg1) -> None 
__reduce__ ( )

Member Data Documentation

bool AntiAliasing

If true, video frames will be anti-aliased.

FBAudioFmt AudioRenderFormat

Audio render format.

FBVideoRenderDepth BitsPerPixel

Video grab color depth.

FBCameraResolutionMode CameraResolution

Camera Resolution.

Video grab field mode.

ORSDK2018::FBString OutputFileName

Grabbing destination file.

When the image files are being rendered, the hash letters (###) specified in the file name will be replaced with the frame number. Zeros will be inserted when the digits of the frame number is less than the number of hash letters. All hash letters will NOT be altered except the one closest to the file extension.

bool RenderAudio

If true and there's audio in the scene, add audio to the output file.

int RendererCallbackIndex

Specify renderer callback index.

Set to -1 to use MotionBuilder default renderer, or any valid non-negative index corresponding to registered custom callback. Any other invalid values, e.g., -2 (default value) means that the renderer attached to the current viewpane will be used.

int RendererCallbackPrefIndex

Specify custom renderer callback's preference index.

bool ShowCameraLabel

If true, display camera label information.

NOTE: If you use your own FBView, set also this option in FBViewingOptions.

bool ShowSafeArea

If true, display safe area.

NOTE: If you use your own FBView, set also this option in FBViewingOptions.

bool ShowTimeCode

If true, display time code information.

NOTE: If you use your own FBView, set also this option in FBViewingOptions.

FBStereoDisplayMode StereoDisplayMode

Video grab stereo display mode.

default (kFBStereoDisplayModeCount) to use current viewpane's setting.

int StillImageCompression

Compression ratio for image(jpg) 0-100 where 0=Greatest compression, 100=Least Compression.

ORSDK2018::FBTimeSpan TimeSpan

Start and stop selection time to grab.

ORSDK2018::FBTime TimeSteps

Time step length between each grab.

Video grab viewing mode.