diff options
| author | Nicholas Corgan <nick.corgan@ettus.com> | 2012-03-29 14:47:54 -0700 |
|---|---|---|
| committer | Nicholas Corgan <nick.corgan@ettus.com> | 2012-03-29 14:47:54 -0700 |
| commit | d1ad808f78497db2770a346d560c9a7f21ff1f1f (patch) | |
| tree | 0bf27335a10927460f4a2c5747c8e74f64c9bdc9 /host/docs/stream.rst | |
| parent | a67486fff0b75a08072fe66b2c6c314cb4b3a16a (diff) | |
| download | uhd-d1ad808f78497db2770a346d560c9a7f21ff1f1f.tar.gz uhd-d1ad808f78497db2770a346d560c9a7f21ff1f1f.tar.bz2 uhd-d1ad808f78497db2770a346d560c9a7f21ff1f1f.zip | |
docs: Format consistency, such as representation of program names or filepaths
Diffstat (limited to 'host/docs/stream.rst')
| -rw-r--r-- | host/docs/stream.rst | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/host/docs/stream.rst b/host/docs/stream.rst index 9ffec22e5..054ec37dd 100644 --- a/host/docs/stream.rst +++ b/host/docs/stream.rst @@ -5,7 +5,7 @@ UHD - Device streaming .. contents:: Table of Contents ------------------------------------------------------------------------ -Introduction to streaming +Introduction to Streaming ------------------------------------------------------------------------ The concept of streaming refers to the transportation of samples between host and device. A stream is an object that facilitates streaming between host application and device. @@ -13,7 +13,7 @@ A RX stream allows the user to receive samples from the device. A TX stream allows the user to transmit samples to the device. ------------------------------------------------------------------------ -Link layer encapsulation +Link Layer Encapsulation ------------------------------------------------------------------------ The VITA49 standard provides encapsulation for sample data across a link layer. On all generation2 hardware, samples are encapsulated into VRT IF data packets. @@ -27,7 +27,7 @@ The length of an IF data packet can be limited by several factors: * Buffering on the device - size of BRAM FIFOs ------------------------------------------------------------------------ -Data types +Data Types ------------------------------------------------------------------------ There are two important data types to consider when streaming: @@ -45,7 +45,7 @@ The link-layer data type ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The link-layer or "over-the-wire" data type refers to the format of the samples sent through the link. Typically, this data type is complex-int16. -However, To increase throughput over the link-layer, +However, to increase throughput over the link-layer, at the expense of precision, complex-int8 may be used. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -54,6 +54,6 @@ Conversion The user may request arbitrary combinations of host and link data types; however, not all combinations are supported. The user may register custom data type formats and conversion routines. -See uhd/convert.hpp for futher documentation. +See **uhd/convert.hpp** for futher documentation. -TODO provide example of convert API +TODO: provide example of convert API |