Methods

Functions
VARIANT_BOOL	AddFrame (void)
	Adds a new frame to the AVI file which is currently being filled with data. More...
BSTR	GetCompressorName (long CompressorIndex)
	This method returns the so-called "friendly name" of the compression codec indicated by CompressorIndex. More...
VARIANT_BOOL	PreStartRecording (void)
	Prepare the start of AVI recording. More...
void	ResetAcquiredFramesCounter (void)
	Reset the counter for acquired frames. On an error the CVCError event is fired. More...
void	ResetDroppedFramesCounter (void)
	Reset the counter for dropped frames. On an error the CVCError event is fired. More...
VARIANT_BOOL	ShowCodecPropertyPage (void)
	Show property page of codec. More...
VARIANT_BOOL	StartRecording (void)
	Start continuous recording of AVI data into a file according to the settings made before this method has been called. More...
VARIANT_BOOL	StopRecording (void)
	Stop continuous recording of AVI data. More...

Detailed Description

Function Documentation

AddFrame()

VARIANT_BOOL AddFrame

(

void

)

Adds a new frame to the AVI file which is currently being filled with data.

This method must not be called before StartRecording has been called. It only is effective, if the AcquisitionMode has been set to Movie2_Acq_AddFrame (value = 0).

Returns

TRUE if succeeded, FALSE otherwise.

Supported platforms:

Win32
Win64

Examples:

Visual Basic - VB Movie2 OCX Example
Visual C++ - VC Movie2 OCX Example

GetCompressorName()

BSTR GetCompressorName

(

long

CompressorIndex

)

This method returns the so-called "friendly name" of the compression codec indicated by CompressorIndex.

The Index refers to the internal list of codecs, that contains all codecs present on the computer in alphabetical order of their friendly name. 0 indicates uncompressed streaming. Use the property NumCompressors to find out how many codecs are available.

Parameters

[in]

CompressorIndex

Index of the codec for which to retrieve the name.

Returns

Readable name of the codec.

Supported platforms:

Win32
Win64

Examples:

Visual Basic - VB Movie2 OCX Example

PreStartRecording()

VARIANT_BOOL PreStartRecording

(

void

)

Prepare the start of AVI recording.

This method may be called any time prior to StartRecording to speed up the initialization process and allow the recorder to react to the "start" signal more promptly. If it has not been called prior to StartRecording, StartRecording will call PreStartRecording to do the necessary initializations.

Returns

TRUE if succeeded, FALSE otherwise.

Supported platforms:

Win32
Win64

Examples:

Visual Basic - VB Movie2 OCX Example

ResetAcquiredFramesCounter()

void ResetAcquiredFramesCounter

(

void

)

Reset the counter for acquired frames. On an error the CVCError event is fired.

Supported platforms:

Win32
Win64

Examples:

Visual Basic - VB Movie2 OCX Example

ResetDroppedFramesCounter()

void ResetDroppedFramesCounter

(

void

)

Reset the counter for dropped frames. On an error the CVCError event is fired.

Supported platforms:

Win32
Win64

Examples:

Visual Basic - VB Movie2 OCX Example

ShowCodecPropertyPage()

VARIANT_BOOL ShowCodecPropertyPage

(

void

)

Show property page of codec.

Some video compression codecs have property page(s) in which parameters for encoding may be changed (e.g. the Intel Indeo 5.10 codec even has two). To show these property pages to the user, use this function.

Returns

TRUE if succeeded, FALSE otherwise and the CVCError event will be raised.

Supported platforms:

Win32
Win64

StartRecording()

VARIANT_BOOL StartRecording

(

void

)

Start continuous recording of AVI data into a file according to the settings made before this method has been called.

If you want to speed up the StartRecording you can use PreStartRecording to initalize the Recording.

Returns

TRUE if succeeded, FALSE otherwise.

Supported platforms:

Win32
Win64

Examples:

Visual Basic - VB Movie2 OCX Example
Visual C++ - VC Movie2 OCX Example

StopRecording()

VARIANT_BOOL StopRecording

(

void

)

Stop continuous recording of AVI data.

Returns

TRUE if succeeded, FALSE otherwise.

Supported platforms:

Win32
Win64

Examples:

Visual Basic - VB Movie2 OCX Example
Visual C++ - VC Movie2 OCX Example