Video Grabbing Options. More...

#include <pyfbsdk.h>

Public Attributes
FBTimeSpan	TimeSpan
	Read Write Property: Start and stop selection time to grab.

FBTime	TimeSteps
	Read Write Property: Time step length between each grab.

FBCameraResolutionMode	CameraResolution
	Read Write Property: Camera Resolution.

FBVideoRenderDepth	BitsPerPixel
	Read Write Property: Video grab color depth.

FBVideoRenderFieldMode	FieldMode
	Read Write Property: Video grab field mode.

FBVideoRenderViewingMode	ViewingMode
	Read Write Property: Video grab viewing mode.

str	OutputFileName
	Read Write Property: Grabbing destination file.

bool	ShowSafeArea
	Read Write Property: If true, display safe area.

bool	ShowTimeCode
	Read Write Property: If true, display time code information.

bool	ShowCameraLabel
	Read Write Property: If true, display camera label information.

bool	AntiAliasing
	Read Write Property: If true, video frames will be anti-aliased.

bool	RenderAudio
	Read Write Property: If true and there's audio in the scene, render the audio as well.

FBAudioFmt	AudioRenderFormat
	Read Write Property: Audio render format.

K_DEPRECATED_2024 int	StillImageCompression
	Read Write Property:

int	StillImageQuality
	Read Write Property: Quality of the image for image formats that support it. Depends on the image format. For "jpeg": 0-100 where 0=(low visual quality, high compression), 100=(high visual quality, low compression).

int	StillImageCompressionType
	Read Write Property: Compression type of image for image formats that support it. Depends on the image format. For "tif": 0 = ( no compression ), 1 = ( LZW-compression ).

FBAudioOutputLocation	AudioOutputLocation
	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).

bool	AudioUseCustomStandaloneFileName
	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.

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

Detailed Description

Video Grabbing Options.

Contain options to control how the grabbing process will occur.

Member Data Documentation

◆ AntiAliasing

bool AntiAliasing

Read Write Property: If true, video frames will be anti-aliased.

◆ AudioCustomStandaloneFileName

FBString AudioCustomStandaloneFileName

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

◆ AudioOutputLocation

FBAudioOutputLocation AudioOutputLocation

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).

◆ AudioRenderFormat

FBAudioFmt AudioRenderFormat

Read Write Property: Audio render format.

◆ AudioUseCustomStandaloneFileName

bool AudioUseCustomStandaloneFileName

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.

◆ BitsPerPixel

FBVideoRenderDepth BitsPerPixel

Read Write Property: Video grab color depth.

◆ CameraResolution

FBCameraResolutionMode CameraResolution

Read Write Property: Camera Resolution.

◆ FieldMode

FBVideoRenderFieldMode FieldMode

Read Write Property: Video grab field mode.

◆ OutputFileName

str OutputFileName

Read Write Property: Grabbing destination file.

◆ RenderAudio

bool RenderAudio

Read Write Property: If true and there's audio in the scene, render the audio as well.

◆ ShowCameraLabel

bool ShowCameraLabel

Read Write Property: If true, display camera label information.

◆ ShowSafeArea

bool ShowSafeArea

Read Write Property: If true, display safe area.

◆ ShowTimeCode

bool ShowTimeCode

Read Write Property: If true, display time code information.

◆ StillImageCompression

K_DEPRECATED_2024 int StillImageCompression

Read Write Property:

Deprecated:: Use StillImageQuality instead.

◆ StillImageCompressionType

int StillImageCompressionType

Read Write Property: Compression type of image for image formats that support it. Depends on the image format. For "tif": 0 = ( no compression ), 1 = ( LZW-compression ).

◆ StillImageQuality

int StillImageQuality

Read Write Property: Quality of the image for image formats that support it. Depends on the image format. For "jpeg": 0-100 where 0=(low visual quality, high compression), 100=(high visual quality, low compression).

◆ TimeSpan

FBTimeSpan TimeSpan

Read Write Property: Start and stop selection time to grab.

◆ TimeSteps

FBTime TimeSteps

Read Write Property: Time step length between each grab.

◆ ViewingMode

FBVideoRenderViewingMode ViewingMode

Read Write Property: Video grab viewing mode.

Public Attributes