Skip to content

Commit

Permalink
Apply suggestions
Browse files Browse the repository at this point in the history
Signed-off-by: tempate <danieldiaz@eprosima.com>
  • Loading branch information
Tempate committed Nov 22, 2023
1 parent 9183926 commit d19da1c
Showing 1 changed file with 5 additions and 14 deletions.
19 changes: 5 additions & 14 deletions docs/rst/replaying/usage/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -165,6 +165,11 @@ The ``max-tx-rate`` tag limits the frequency [Hz] at which samples are sent by d
It only accepts non-negative numbers.
By default it is set to ``0``; it sends samples at an unlimited transmission rate.

.. note::

The ``max-tx-rate`` tag can be set for topics and globally under the ``replayer`` tag.
If both are set, the configuration under topics prevails.

.. _replayer_manual_topics:

Manual Topics
Expand Down Expand Up @@ -346,20 +351,6 @@ By default, data is replayed at the same rate it was published/received.
However, a user might be interested in playing messages back at a rate different than the original one.
This can be accomplished through the playback ``rate`` tag, which accepts positive float values (e.g. 0.5 <--> half speed || 2 <--> double speed).

.. _replayer_usage_configuration_max_tx_rate:

Max Transmission Rate
---------------------

The ``max-tx-rate`` tag limits the frequency [Hz] at which samples are sent by discarding messages transmitted before :code:`1/max-tx-rate` seconds have passed since the last sent message.
It only accepts non-negative numbers.
By default it is set to ``0``; it sends samples at an unlimited transmission rate.

.. note::

The ``max-tx-rate`` tag can be set for topics and globally under the ``replayer`` tag.
If both are set, the configuration under topics prevails.

.. _replayer_replay_configuration_replaytypes:

Replay Types
Expand Down

0 comments on commit d19da1c

Please sign in to comment.