File Meta Source: Difference between revisions

From GNU Radio
Jump to navigation Jump to search
(Created page with "Category:Block Docs Category:Stub Docs This is the template for the "Page-per-block Docs". This first section should describe what the block...")
 
No edit summary
Line 1: Line 1:
[[Category:Block Docs]]
[[Category:Block Docs]]
[[Category:Stub Docs]]
Reads stream from file with meta-data headers. Headers are parsed into tags.
This is the template for the [[:Category:Block_Docs|"Page-per-block Docs"]].  This first section should describe what the block does and how to use it, using however many paragraphs necessary.  Note that the title of the wiki page should match the block's name in GRC, i.e. the one defined in the block's .grc file. Look at the [[FFT]] Block for a good example.


As this is a basic template, it's also in the [[:Category:Stub_Docs|"Stub Docs category"]]. Please improve it.
The information in the metadata headers includes: Any item inside of the extra header dictionary is ready out and made into a stream tag.


== Parameters ==
== Parameters ==
(''R''): <span class="plainlinks">[https://wiki.gnuradio.org/index.php/GNURadioCompanion#Variable_Controls ''Run-time adjustable'']</span>
(''R''): <span class="plainlinks">[https://wiki.gnuradio.org/index.php/GNURadioCompanion#Variable_Controls ''Run-time adjustable'']</span>


; Param 1 (''R'')
; File (''R'')
: Description of parameter, provide any tips or recommended values.  Note that the name of the parameter above should match the param's label that shows up in grc (e.g. Sample Rate).
: Name of the file to read from


; Param 2
; Repeat (''R'')
: blah blah blah
: Repeats file when EOF is found.
 
; Detached header
: Set to true if header info is stored in a separate file
 
; Header file
: Name of detached header file if used. Defaults to 'filename.hdr' if detached_header is true but this field is an empty string.


== Example Flowgraph ==
== Example Flowgraph ==

Revision as of 16:15, 20 August 2019

Reads stream from file with meta-data headers. Headers are parsed into tags.

The information in the metadata headers includes: Any item inside of the extra header dictionary is ready out and made into a stream tag.

Parameters

(R): Run-time adjustable

File (R)
Name of the file to read from
Repeat (R)
Repeats file when EOF is found.
Detached header
Set to true if header info is stored in a separate file
Header file
Name of detached header file if used. Defaults to 'filename.hdr' if detached_header is true but this field is an empty string.

Example Flowgraph

Insert description of flowgraph here, then show a screenshot of the flowgraph and the output if there is an interesting GUI. Currently we have no standard method of uploading the actual flowgraph to the wiki or git repo, unfortunately. The plan is to have an example flowgraph showing how the block might be used, for every block, and the flowgraphs will live in the git repo.

Source Files

C++ files
TODO
Header files
TODO
Public header files
TODO
Block definition
TODO
Retrieved from "https://wiki.gnuradio.org/index.php?title=File_Meta_Source&oldid=5959"