diff options
| author | Martin Braun <martin.braun@ettus.com> | 2018-07-20 11:07:43 -0700 |
|---|---|---|
| committer | Martin Braun <martin.braun@ettus.com> | 2018-07-20 11:07:43 -0700 |
| commit | 13f9b5723d10b38ec47192670b08158f0021fa09 (patch) | |
| tree | 35ef4cb67f74f51fc3dff92768992e991f948c37 /host/include | |
| parent | ca09fd2bea0128c18eac4b0ff8a9b30fccdf7698 (diff) | |
| download | uhd-13f9b5723d10b38ec47192670b08158f0021fa09.tar.gz uhd-13f9b5723d10b38ec47192670b08158f0021fa09.tar.bz2 uhd-13f9b5723d10b38ec47192670b08158f0021fa09.zip | |
docs: Add comments on block port and ID for stream args
Diffstat (limited to 'host/include')
| -rw-r--r-- | host/include/uhd/stream.hpp | 13 |
1 files changed, 12 insertions, 1 deletions
diff --git a/host/include/uhd/stream.hpp b/host/include/uhd/stream.hpp index d408dafb8..757198dde 100644 --- a/host/include/uhd/stream.hpp +++ b/host/include/uhd/stream.hpp @@ -31,7 +31,7 @@ namespace uhd{ * uhd::stream_args_t stream_args("fc32", "sc16"); * // 2. Set the channel list, we want 3 streamers coming from channels * // 0, 1 and 2, in that order: - * stream_args.channels = boost::assign::list_of(0)(1)(2); + * stream_args.channels = {0, 1, 2}; * // 3. Set optional args: * stream_args.args["spp"] = "200"; // 200 samples per packet * // Now use these args to create an rx streamer: @@ -43,6 +43,17 @@ namespace uhd{ * * \b Note: Not all combinations of CPU and OTW format have conversion support. * You may however write and register your own conversion routines. + * + * If you are creating stream args to connect to an RFNoC block, then you might + * want to specify block ID and port, too: + * \code{.cpp} + * stream_args.args["block_id0"] = "0/Radio_0"; + * stream_args.args["block_id1"] = "0/Radio_1"; + * stream_args.args["block_id2"] = "0/Radio_1"; // Chan 1 and 2 go to the same radio + * stream_args.args["block_port0"] = "0"; + * stream_args.args["block_port1"] = "0"; + * stream_args.args["block_port2"] = "1"; + * \endcode */ struct UHD_API stream_args_t{ |