Movie2 Control Reference 14.0
Properties

Variables

Movie2_Acq_Mode AcquisitionMode
 Aquisition mode. More...
 
LONG CompressionCodecIndex
 Specify the video compression codec to be used. More...
 
double FrameRate
 Set frame rate with which the CVB Movie2 control should record the video signal. More...
 
__int3264 Image
 Sets or gets the image object, which is to be used as the source for AVI recording. More...
 
VARIANT_BOOL IsRecording
 Checks whether the Movie2 OCX is currently recording AVI streams to disk. More...
 
LONG NumAcquiredFrames
 Query the number of frames that have so far been acquired during the running acquisition. More...
 
LONG NumCompressors
 Retrieve the number of compression codecs installed on the system. More...
 
LONG NumDroppedFrames
 Query the number of frames that have so far been dropped during the running acquisition. More...
 
Movie2_Sync_Mode SynchronizationMode
 Synchronization mode. More...
 
BSTR TargetFileName
 Set the name of the file into which the AVI sequence is to be recorded. More...
 
VARIANT_BOOL UseMetaData
 Specifies whether the meta data should be written to the AVI file or not. More...
 

Detailed Description

Variable Documentation

◆ AcquisitionMode

Movie2_Acq_Mode AcquisitionMode
property

Aquisition mode.

With this property, you can determine how the CVB Movie2 control acquires the images that are stored in the AVI file.

Parameters
[in,out]AcquisitionModeAcquisition mode to be set. See Movie2_Acq_Mode for possible modes.
Returns
Acquisition mode.
Supported platforms:
Win32
Win64
Examples:

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

◆ CompressionCodecIndex

LONG CompressionCodecIndex
property

Specify the video compression codec to be used.

Use the property NumCompressors and the method GetCompressorName to find out which and how many codecs are available.

Parameters
[in,out]CompressionCodecIndexIndex of the compressor to be used for the next recording.
Returns
Index of the compressionc codec.
Supported platforms:
Win32
Win64
Examples:

Visual Basic - VB Movie2 OCX Example

◆ FrameRate

double FrameRate
property

Set frame rate with which the CVB Movie2 control should record the video signal.

Note
This is usually just an information inside the resulting video file. If you specify a frame rate of 25 here, but your signal was recorded at 30 fps then playback will happen with 25 frames per second - which is visibly slower than real time.
So this frame rate property has no connection to the rate at which the video signal was acquired, and it is the responsibility of the programmer writing a Movie2 application to set the frame rate to a value that reasonably represents the frame rate of his acquisition device (if unsure, consult the manuals of your acquisition device(s) for details about the frame rate or contact the vendor.
Parameters
[in,out]FrameRateFrame rate to be set.
Returns
Frame rate.
Supported platforms:
Win32
Win64

◆ Image

__int3264 Image
property

Sets or gets the image object, which is to be used as the source for AVI recording.

Parameters
[in,out]ImageHandle of the image object be used for recording.
Returns
Image object handle.
Supported platforms:
Win32
Win64
Examples:

Visual Basic - VB Movie2 OCX Example

◆ IsRecording

VARIANT_BOOL IsRecording
propertyreadonly

Checks whether the Movie2 OCX is currently recording AVI streams to disk.

Parameters
[out]IsRecordingTRUE if it is currently recording, FALSE otherwise.
Returns
TRUE indicates that the OCX is currently recording, FALSE otherwise.
Supported platforms:
Win32
Win64
Examples:

Visual Basic - VB Movie2 OCX Example

◆ NumAcquiredFrames

LONG NumAcquiredFrames
propertyreadonly

Query the number of frames that have so far been acquired during the running acquisition.

Usually the number is reset at the beginning of the acquisition. It may also be reset by a call to ResetAcquiredFramesCounter.

Parameters
[out]NumAcquiredFramesNumber of frames that have been acqurired.
Returns
Number of frames.
Supported platforms:
Win32
Win64
Examples:

Visual Basic - VB Movie2 OCX Example

◆ NumCompressors

LONG NumCompressors
propertyreadonly

Retrieve the number of compression codecs installed on the system.

Parameters
[out]NumCompressorsNumber of compression codecs installed on the system.
Returns
Number of compression codecs.
Supported platforms:
Win32
Win64
Examples:

Visual Basic - VB Movie2 OCX Example

◆ NumDroppedFrames

LONG NumDroppedFrames
propertyreadonly

Query the number of frames that have so far been dropped during the running acquisition.

Usually the number is reset at the beginning of the acquisition. It may also be reset by a call to ResetDroppedFramesCounter.

Parameters
[out]NumDroppedFramesNumber of frames that have been dropped.
Returns
Number of frames that have been dropped..
Supported platforms:
Win32
Win64
Examples:

Visual Basic - VB Movie2 OCX Example

◆ SynchronizationMode

Movie2_Sync_Mode SynchronizationMode
property

Synchronization mode.

With this property, you can determine how the CVB Movie2 control acquires the images that are stored in the AVI file.

Note
When not working in Event driven mode (AddFrame), then the SyncMode tells when the client should be informed about the arrival of a new image: Movie2_Sync_AfterCopy means that the ImageSnapped events will fire after the copy Movie2_Sync_BeforeCopy mean that they will fire before the copy.
Parameters
[in,out]SynchronizationModeSynchronization mode to be set. See Movie2_Sync_Mode for possible modes.
Returns
Synchronization mode.
Supported platforms:
Win32
Win64
Examples:

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

◆ TargetFileName

BSTR TargetFileName
property

Set the name of the file into which the AVI sequence is to be recorded.

Parameters
[in,out]TargetFileNameName of file to write AVI sequence to.
Returns
Name of file.
Supported platforms:
Win32
Win64
Examples:

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

◆ UseMetaData

VARIANT_BOOL UseMetaData
property

Specifies whether the meta data should be written to the AVI file or not.

The ProvideMetaData Event is fired when new MetaData can be written to the AVI file.

Meta data are (ANSI-) strings with up to 64k characters, one per image being recorded. For example, the MetaData can be used to save the corresponding timestamp as a string for every recorded frame within the AVI container.
To read out the MetaData you can implement the CVB Notify Interface (INotify) of the Driver.dll in your own application. If you prefer the Grabber OCX you can use the ImageNotificationString Event. As examples the VCMovie2PlayerExample and the CSMovie2PlayerExample are included in Movie2.

Note
Please note that some media players or AVI Editors may get confused by the presence of a text stream in the AVI container. When an AVI Editor does not support the text stream the MetaData is lost after editing the AVI file. For Example VirtualDub with DirectStreamCopy writes only the text of the first frame to all other frames.
Our Movie Interactive 2 is the only application we know which can handle text streams as MetaData. So if you want to recompress your recorded movie and dont want to lose the MetaData use Movie Interactive 2.
Parameters
[in,out]UseMetaDataTRUE if meta data should be written to the AVI file, FALSE otherwise.
Returns
TRUE if meta data should be written to the AVI file, FALSE otherwise.
Supported platforms:
Win32
Win64
Examples:

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