Detailed Description
#include <fbvideo.h>
Public Member Functions |
|
| FBVideoIn (HIObject pObject=NULL) | |
| Constructor. |
|
| virtual bool | LiveSetCompressor (int pCompressorIndex) |
| Set the current compressor to be used when
recording. |
|
| virtual int | LiveGetCompressor () |
| Get the current compressor index. |
|
| virtual int | LiveGetCompressorCount () |
| Get the compressor count. |
|
| virtual char * | LiveGetCompressorName (int pCompressorIndex) |
| Get the compressor name at a particular
index. |
|
| virtual void | LiveSetResolutionFR (int pIndex) |
| Set the current resolution and frame rate
for the device. |
|
| virtual int | LiveGetResolutionFR () |
| Get the current resolution and frame rate
index. |
|
| virtual int | LiveGetResolutionFRCount () |
| Get the number of resolution and frame rate
available for the device. |
|
| virtual char * | LiveGetResolutionFRName (int pIndex) |
| Get the resolution and frame rate string
description at the specified index. |
|
| virtual FBVideoLiveType | LiveGetType () |
| Get the type of the video input device.
|
|
Public Attributes |
|
| FBPropertyBool | Online |
| Read Write Property: If true, the
device is online and will display the current video feed. |
|
| FBPropertyBool | Recording |
| Read Write Property: If true, the
device will record during a recording session. |
|
| FBPropertyBool | 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. |
|
Constructor & Destructor Documentation
| FBVideoIn | ( | HIObject | pObject = NULL |
) |
Constructor.
- Parameters:
-
pObject Internal parent object.
Member Function Documentation
| virtual bool LiveSetCompressor | ( | int | pCompressorIndex | ) | [virtual] |
Set the current compressor to be used when recording.
- Parameters:
-
pCompressorIndex Index of the compressor.
- Returns:
- True if successful.
| virtual int LiveGetCompressor | ( | ) | [virtual] |
Get the current compressor index.
- Returns:
- Index of the current compressor.
| virtual int LiveGetCompressorCount | ( | ) | [virtual] |
| virtual char* LiveGetCompressorName | ( | int | pCompressorIndex | ) | [virtual] |
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.
| virtual void LiveSetResolutionFR | ( | int | pIndex | ) | [virtual] |
Set the current resolution and frame rate for the device.
- Parameters:
-
pIndex Index of the resolution and frame rate.
| virtual int LiveGetResolutionFR | ( | ) | [virtual] |
Get the current resolution and frame rate index.
- Returns:
- Index of the current resolution and frame rate.
| virtual int LiveGetResolutionFRCount | ( | ) | [virtual] |
Get the number of resolution and frame rate available for the device.
- Returns:
- Number of available resolution and frame rate.
| virtual char* LiveGetResolutionFRName | ( | int | pIndex | ) | [virtual] |
Get the resolution and frame rate string description at the specified index.
- Parameters:
-
pIndex Index of the resolution and frame rate.
- Returns:
- Name of the resolution and frame rate.
| virtual FBVideoLiveType LiveGetType | ( | ) | [virtual] |
Get the type of the video input device.
- Returns:
- Type of the video input device.
Member Data Documentation
Read Write Property: If true, the device is online and will display the current video feed.
Read Write Property: If true, the device will record during a recording session.
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.
The documentation for this class was generated from the following file:
- fbsdk/fbvideo.h
