RateDrop

Examples of using a Filter are described in Using A Rate Drop Object.

RateDrop objects in C++ are referenced by the following shared pointer typedef:

typedef std::shared_ptr<rogue::interfaces::stream::RateDrop> rogue::interfaces::stream::RateDropPtr

Alias for using shared pointer as RateDropPtr.

The class description is shown below:

class RateDrop : public rogue::interfaces::stream::Master, public rogue::interfaces::stream::Slave

Stream Rate Drop.

Drops frames at a defined rate. The rate value will defined as either the number of frames to drop between each kept frame or the time interval between each kept frame. If the period flag is true the passed value will be interpreted as the time between kept frames in seconds. If the rate flag is false the value will be interpreted as the number of frames to drop between each ketp frame.

Public Static Functions

static std::shared_ptr<rogue::interfaces::stream::RateDrop> create(bool period, double value)

Create a RateDrop object and return as a RateDropPtr.

Parameters:

• period – Set to true to define the parameter as a period value.

• value – Period value or drop count

Returns:

RateDrop object as a RateDropPtr