diff options
| author | Tom Rondeau <tom@trondeau.com> | 2014-07-25 22:57:34 -0400 |
|---|---|---|
| committer | Tom Rondeau <tom@trondeau.com> | 2014-07-25 22:57:34 -0400 |
| commit | 1059f8bcca4cb8402d8e8edfa8a7a94f08505b88 (patch) | |
| tree | 8e102b623c3c8d0b16cf8381e3bb796bd506253c /docs/doxygen/other/metadata.dox | |
| parent | 2b8888e03a4c8fff9527694a7f4526733eeb219f (diff) | |
| parent | 115254847e9c6db03a417749f4e476ed3db95e70 (diff) | |
Merge branch 'docs/structure'
Diffstat (limited to 'docs/doxygen/other/metadata.dox')
| -rw-r--r-- | docs/doxygen/other/metadata.dox | 15 |
1 files changed, 14 insertions, 1 deletions
diff --git a/docs/doxygen/other/metadata.dox b/docs/doxygen/other/metadata.dox index 03ebe591e4..e29adf306e 100644 --- a/docs/doxygen/other/metadata.dox +++ b/docs/doxygen/other/metadata.dox @@ -20,7 +20,20 @@ about the item size, data type, if it's complex, the sample rate of the segment, the time stamp of the first sample of the segment, and information regarding the header size and segment size. -Headers have two main tags associated with them: +The first static portion of the header file contains the following +information. + +- version: (char) version number (usually set to METADATA_VERSION) +- rx_rate: (double) Stream's sample rate +- rx_time: (pmt::pmt_t pair - (uint64_t, double)) Time stamp (format from UHD) +- size: (int) item size in bytes - reflects vector length if any. +- type: (int) data type (enum below) +- cplx: (bool) true if data is complex +- strt: (uint64_t) start of data relative to current header +- bytes: (uint64_t) size of following data segment in bytes + +An optional extra section of the header stores information in any +received tags. The two main tags associated with tags are: - rx_rate: the sample rate of the stream. - rx_time: the time stamp of the first item in the segment. |