Rate
Top  Previous  Next

Description

Returns or sets the current frame rate.


Syntax


[VB]
objActiveDcam.Rate [= Value]


[C/C++]
HRESULT get_Rate( long *pRate );
HRESULT put_Rate( long Rate );



Data Type
[VB]

Float


Parameters
[C/C++]

pRate [out,retval]  
Pointer to the frame rate value  
Rate [in]  
The value of the frame rate  


Return Values


S_OK  
Success  
E_FAIL  
Failure.  
E_INVALIDARG  
The value is out of range  
 

Example


This VB example sets the current frame rate to 15 fps:

Private Sub
 Form_Load()

ActiveDcam1.Rate = 15.

End Sub

 

Remarks


DCAM compliant cameras support the following predefined frame rates: 1.875 fps, 3.75 fps, 7.5 fps, 15 fps, 30 fps, 60 fps. Additional frame rates can be provided by the camera manufacturer. A certain video Mode can only support certain frame rates. The list of rates available for the current video mode can be retrieved with GetRateList. If you use the property window of your development environment or ActiveDcam's property pages, the Rate property field will be presented as a list box containing all supported frame rates. If the property is set to a value which is not supported by the current mode, it will be reset to the nearest allowable frame rate.
 
Note that the Rate property is available only for the fixed video mode. If the current video mode is a partial scan one (Format 7), use PacketSize to modify the effective frame rate. For more information refer to "IIDC 1394-based Digital Camera Specification, Version 1.31" published by the 1394 Trade Association.