Grabber::setFrameRate Method

Sets the time between two frames.

Syntax:

bool setFrameRate( long rate );

Parameter		Description


rate		Specifies the frame rate in milliseconds between the start of frame n and the start of frame n + 1.

Return value:

true on success, false otherwise.

Remarks:

This method is only available, if a device is open and valid. Furthermore, the method cannot set a frame rate in live mode.

Valid values for rate must be retrieved from a list, which can be retrieved by Grabber::getAvailableFrameRates. Any other value an application tries to pass will result in an error.

If an application wants to set a frame rate of 20 frames per second, a value of 50 must be passed to setFrameRate (1000 / 20 = 50). If the bandwidth is too low, the desired frame rate cannot be achieved. In this case Grabber::getCurrentActualFrameRate returns a value greater than the passed value (here 50).

<< Grabber