CVB++ 14.0
RecordingSettings Class Reference

Settings for initializing a recorder. More...

#include <cvb/movie2/recording_settings.hpp>

Inherited by DirectShowSettings, and RawVideoSettings.

Public Member Functions

double FrameRate () const noexcept
 Gets the frame rate the video uses for playback. More...
 
void SetFrameRate (double frameRate)
 Sets the frame rate the video uses for playback. More...
 
RecordingEngineType EngineType () const noexcept
 Returns the engine type. More...
 

Detailed Description

Settings for initializing a recorder.

Member Function Documentation

◆ EngineType()

RecordingEngineType EngineType ( ) const
inlinenoexcept

Returns the engine type.

Exceptions
Doesnot throw any exception.

◆ FrameRate()

double FrameRate ( ) const
inlinenoexcept

Gets the frame rate the video uses for playback.

Returns
double
Exceptions
Anyexception derived from std::exception including CvbException.

This value is always used despite the rate images are added to the recorder.

◆ SetFrameRate()

void SetFrameRate ( double  frameRate)
inline

Sets the frame rate the video uses for playback.

Parameters
[in]frameRateThe new frame rate
Exceptions
Anyexception derived from std::exception including CvbException.

This value is always used despite the rate images are added to the recorder.