.. _interfaces_stream_rate_drop:

========
RateDrop
========

For conceptual usage, see:

- :doc:`/stream_interface/built_in_modules`
- :ref:`interfaces_stream_using_rate_drop`


Python binding
--------------

This C++ class is also exported into Python as ``rogue.interfaces.stream.RateDrop``.

Python API page:
- :doc:`/api/python/rogue/interfaces/stream/ratedrop`

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

.. doxygentypedef:: rogue::interfaces::stream::RateDropPtr

The class description is shown below:

.. doxygenclass:: rogue::interfaces::stream::RateDrop
   :members: