FBVideoIn Class Reference


Detailed Description

Basic video input class, supporting webcam and DV device.

Examples
Samples/Video/VideoInput.py
Inheritance diagram for FBVideoIn:

List of all members.

Public Member Functions

 __init__ (object pObject=None)
 Constructor.
bool LiveSetCompressor (int pCompressorIndex)
 Set the current compressor to be used when recording.
int LiveGetCompressor ()
 Get the current compressor index.
int LiveGetCompressorCount ()
 Get the compressor count.
str LiveGetCompressorName (int pCompressorIndex)
 Get the compressor name at a particular index.
 LiveSetResolutionFR (int pIndex)
 Set the current resolution and frame rate for the device.
int LiveGetResolutionFR ()
 Get the current resolution and frame rate index.
int LiveGetResolutionFRCount ()
 Get the number of resolution and frame rate available for the device.
str LiveGetResolutionFRName (int pIndex)
 Get the resolution and frame rate string description at the specified index.
FBVideoLiveType LiveGetType ()
 Get the type of the video input device.

Public Attributes

FBPropertyBase Online
 Read Write Property: If true, the device is online and will display the current video feed.
FBPropertyBase Recording
 Read Write Property: If true, the device will record during a recording session.
FBPropertyBase RecordAudio
 Read Write Property: If true, the device will also record audio during a recording session.
FBPropertyString FilePath
 Read Write Property: Location of the generated movie file after a recording session.

Member Function Documentation

__init__ ( object  pObject = None)

Constructor.

Parameters:
pObjectInternal parent object.
Examples
Samples/Video/VideoInput.py

Reimplemented from FBComponent.

bool LiveSetCompressor ( int  pCompressorIndex)

Set the current compressor to be used when recording.

Parameters:
pCompressorIndexIndex of the compressor.
Returns:
True if successful.
int LiveGetCompressor ( )

Get the current compressor index.

Returns:
Index of the current compressor.
int LiveGetCompressorCount ( )

Get the compressor count.

Returns:
Number of available compressor.
str LiveGetCompressorName ( int  pCompressorIndex)

Get the compressor name at a particular index.

Returns:
Name of the compressor. If the pCompressorIndex is higher than the number of compressor, the function will return NULL.
LiveSetResolutionFR ( int  pIndex)

Set the current resolution and frame rate for the device.

Parameters:
pIndexIndex of the resolution and frame rate.
int LiveGetResolutionFR ( )

Get the current resolution and frame rate index.

Returns:
Index of the current resolution and frame rate.
int LiveGetResolutionFRCount ( )

Get the number of resolution and frame rate available for the device.

Returns:
Number of available resolution and frame rate.
str LiveGetResolutionFRName ( int  pIndex)

Get the resolution and frame rate string description at the specified index.

Parameters:
pIndexIndex of the resolution and frame rate.
Returns:
Name of the resolution and frame rate.
FBVideoLiveType LiveGetType ( )

Get the type of the video input device.

Returns:
Type of the video input device.

Member Data Documentation

FBPropertyBase Online

Read Write Property: If true, the device is online and will display the current video feed.

FBPropertyBase Recording

Read Write Property: If true, the device will record during a recording session.

FBPropertyBase RecordAudio

Read Write Property: If true, the device will also record audio during a recording session.

Read Write Property: Location of the generated movie file after a recording session.


FBVideoIn FBVideoIn FBVideoIn FBVideoIn FBVideoIn FBVideoIn FBVideoIn FBVideoIn FBVideoIn FBVideoIn
FBVideoIn FBVideoIn FBVideoIn FBVideoIn FBVideoIn FBVideoIn FBVideoIn FBVideoIn FBVideoIn FBVideoIn