FBVideoGrabOptions Struct Reference

FBVideoGrabOptions Struct Reference

#include <fbvideograbber.h>

Class Description

Video Grabbing Options structure.

Contain options to control how the grabbing process will occur.

Definition at line 98 of file fbvideograbber.h.

Public Attributes

FBTimeSpan mTimeSpan
 Start and stop selection time to grab. More...
 
FBTime mTimeSteps
 Time step length between each grab. More...
 
FBCameraResolutionMode mCameraResolution
 Camera Resolution. More...
 
FBVideoRenderDepth mBitsPerPixel
 Video grab color depth. More...
 
FBVideoRenderFieldMode mFieldMode
 Video grab field mode. More...
 
FBVideoRenderViewingMode mViewingMode
 Video grab viewing mode. More...
 
FBStereoDisplayMode mStereoDisplayMode
 Video grab stereo display mode. More...
 
int mRendererCallbackIndex
 Specify renderer callback index. More...
 
int mRendererCallbackPrefIndex
 Specify custom renderer callback's preference index. More...
 
FBString mOutputFileName
 Grabbing destination file. More...
 
bool mShowSafeArea
 If true, display safe area. More...
 
bool mShowTimeCode
 If true, display time code information. More...
 
bool mShowCameraLabel
 If true, display camera label information. More...
 
bool mAntiAliasing
 If true, video frames will be anti-aliased. More...
 
bool mRenderAudio
 If true and there's audio in the scene, render the audio as well. More...
 
FBAudioFmt mAudioRenderFormat
 Audio render format. More...
 
int mStillImageCompression
 Compression ratio for image(jpg) 0-100 where 0=Greatest compression, 100=Least Compression. More...
 
FBAudioOutputLocation mAudioOutputLocation
 Audio output location when rendering using a video format (for still image formats & SWF (Flash) format, the audio is always rendered in a standalone file). More...
 
bool mAudioUseCustomStandaloneFileName
 If true and if the audio is rendered in a standalone output file, the audio file is generated at the file location specified by mAudioCustomStandaloneFileName, otherwise the audio file is generated in the same directory as the rendered images/video files based on their names. More...
 
FBString mAudioCustomStandaloneFileName
 Destination for the custom audio standalone file, if mAudioUseCustomStandaloneFileName is set to true. More...
 

Member Data Documentation

bool mAntiAliasing

If true, video frames will be anti-aliased.

Definition at line 113 of file fbvideograbber.h.

FBString mAudioCustomStandaloneFileName

Destination for the custom audio standalone file, if mAudioUseCustomStandaloneFileName is set to true.

Definition at line 119 of file fbvideograbber.h.

FBAudioOutputLocation mAudioOutputLocation

Audio output location when rendering using a video format (for still image formats & SWF (Flash) format, the audio is always rendered in a standalone file).

Definition at line 117 of file fbvideograbber.h.

FBAudioFmt mAudioRenderFormat

Audio render format.

Definition at line 115 of file fbvideograbber.h.

bool mAudioUseCustomStandaloneFileName

If true and if the audio is rendered in a standalone output file, the audio file is generated at the file location specified by mAudioCustomStandaloneFileName, otherwise the audio file is generated in the same directory as the rendered images/video files based on their names.

Definition at line 118 of file fbvideograbber.h.

FBVideoRenderDepth mBitsPerPixel

Video grab color depth.

Definition at line 103 of file fbvideograbber.h.

FBCameraResolutionMode mCameraResolution

Camera Resolution.

Definition at line 102 of file fbvideograbber.h.

Video grab field mode.

Definition at line 104 of file fbvideograbber.h.

FBString mOutputFileName

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.

Definition at line 109 of file fbvideograbber.h.

bool mRenderAudio

If true and there's audio in the scene, render the audio as well.

Definition at line 114 of file fbvideograbber.h.

int mRendererCallbackIndex

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.

Definition at line 107 of file fbvideograbber.h.

int mRendererCallbackPrefIndex

Specify custom renderer callback's preference index.

Definition at line 108 of file fbvideograbber.h.

bool mShowCameraLabel

If true, display camera label information.

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

Definition at line 112 of file fbvideograbber.h.

bool mShowSafeArea

If true, display safe area.

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

Definition at line 110 of file fbvideograbber.h.

bool mShowTimeCode

If true, display time code information.

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

Definition at line 111 of file fbvideograbber.h.

FBStereoDisplayMode mStereoDisplayMode

Video grab stereo display mode.

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

Definition at line 106 of file fbvideograbber.h.

int mStillImageCompression

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

Definition at line 116 of file fbvideograbber.h.

FBTimeSpan mTimeSpan

Start and stop selection time to grab.

Definition at line 100 of file fbvideograbber.h.

FBTime mTimeSteps

Time step length between each grab.

Definition at line 101 of file fbvideograbber.h.

Video grab viewing mode.

Definition at line 105 of file fbvideograbber.h.


The documentation for this struct was generated from the following file: