Mute: 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...")
 
(add example flowgraph and Messages section)
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
[[Category:Block Docs]]
[[Category:Block Docs]]
[[Category:Stub Docs]]
output = input or zero if muted.  Similar to [[Selector]] block.  
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.


== 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'')
; Mute (''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).
: Whether or not to mute the input. To control with a variable, enter the variable name in place of the "False" value as shown here:
 
[[File:Mute_prop.png]]
 
== Messages ==


; Param 2
The 'set_mute' message port accepts only <b>raw</b> PMT messages of the form <code>pmt.to_pmt(False)</code> or <code>pmt.to_pmt(True)</code>
: blah blah blah


== Example Flowgraph ==
== 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.
[[File:Mute_test_fg.png]]


== Source Files ==
== Source Files ==

Latest revision as of 16:41, 13 December 2020

output = input or zero if muted. Similar to Selector block.

Parameters

(R): Run-time adjustable

Mute (R)
Whether or not to mute the input. To control with a variable, enter the variable name in place of the "False" value as shown here:

Mute prop.png

Messages

The 'set_mute' message port accepts only raw PMT messages of the form pmt.to_pmt(False) or pmt.to_pmt(True)

Example Flowgraph

Mute test fg.png

Source Files

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