<html>
<head>
<title>Blinker - Rate Limiter</title>
</head>
<body>
<h1>Blinker - Rate Limiter</h1>
<p>
The frame rate limiter module reduces the frame rate of a stream by
delaying frames and/or dropping frames.
It receives a single input stream and passes it on with a possibly
reduced frame rate.
<br>
If a frame (frame B) occurs to fast after the previous one (frame A),
it is delayed so that the maximum frame rate is not violated. If another
frame (frame C) occurs before frame B is forwarded, frame B is dropped
and frame C will be forwarded with some delay (if no newer frame (frame D)
is received before frame C is forwarded).
</p>
<h2>Configuration</h2>
<p>
The configuration of the frame rate limiter module with name
<code>NAME</code> is located in the <code>ratelimiters/NAME</code>
subdirectory.
</p>
<h3>Input Stream</h3>
<p>
The file <code>instream</code> contains the name of the stream to
receive.
The frames received from this stream are passed to the output stream
if the delay in between is high enough so the maximum frame rate is
not violated.
</p>
<h3>Maximum Frame Rate</h3>
<p>
The file <code>maxrate</code> specifies the maximum allowed frame rate
format of the output stream in frames per second.
The file must contain a single floating point value, e.g.
<code>2.0</code> for limiting the frame rate to two frames per second.
</p>
<h3>Output Stream</h3>
<p>
The file <code>outstream</code> contains the name of the stream to
which to send the frames with reduced frame rate.
</p>
</body>
</html>
