diff options
author | Martin Anderseck <martin.anderseck@ni.com> | 2024-02-23 14:36:57 +0100 |
---|---|---|
committer | joergho <48011876+joergho@users.noreply.github.com> | 2024-03-06 13:44:39 +0100 |
commit | 74096443d21b39d82bee5905913b38e6b90dfcd8 (patch) | |
tree | be2e076ff0abcc8d32ae55da17ed7122ea5d95c4 | |
parent | examples: fix rx_samples_to_file fail for multichannel fullpath (diff) | |
download | uhd-74096443d21b39d82bee5905913b38e6b90dfcd8.tar.xz uhd-74096443d21b39d82bee5905913b38e6b90dfcd8.zip |
doc: Improve wording for streamers
The documentation for the streamers was misleading as it said that there
can only be one TX streamer and one RX streamer while you can have many
of them as long as they don't try to share their channels. This commit
makes this clearer.
-rw-r--r-- | host/include/uhd/device.hpp | 16 |
1 files changed, 12 insertions, 4 deletions
diff --git a/host/include/uhd/device.hpp b/host/include/uhd/device.hpp index 7fffc59b6..8eab7503d 100644 --- a/host/include/uhd/device.hpp +++ b/host/include/uhd/device.hpp @@ -75,15 +75,23 @@ public: /*! \brief Make a new receive streamer from the streamer arguments * - * Note: There can always only be one streamer. When calling get_rx_stream() - * a second time, the first streamer must be destroyed beforehand. + * Note: For RFNoC devices, there can always be only one streamer per channel. When + * calling get_rx_stream() a second time, the first streamer connected to this channel + * must be destroyed beforehand. Multiple streamers for different channels are + * allowed. + * For non-RFNoC devices, you can only have one RX streamer at a time. Be careful to + * destroy the old one if you want to create a new one. */ virtual rx_streamer::sptr get_rx_stream(const stream_args_t& args) = 0; /*! \brief Make a new transmit streamer from the streamer arguments * - * Note: There can always only be one streamer. When calling get_tx_stream() - * a second time, the first streamer must be destroyed beforehand. + * Note: For RFNoC devices, there can always be only one streamer per channel. When + * calling get_tx_stream() a second time, the first streamer connected to this channel + * must be destroyed beforehand. Multiple streamers for different channels are + * allowed. + * For non-RFNoC devices, you can only have one TX streamer at a time. Be careful to + * destroy the old one if you want to create a new one. */ virtual tx_streamer::sptr get_tx_stream(const stream_args_t& args) = 0; |