<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>RadioLib: SSTVClient Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">RadioLib
</div>
<div id="projectbrief">Universal wireless communication library for Arduino</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('class_s_s_t_v_client.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="class_s_s_t_v_client-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">SSTVClient Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Client for SSTV transmissions.
<a href="class_s_s_t_v_client.html#details">More...</a></p>
<p><code>#include <<a class="el" href="_s_s_t_v_8h_source.html">SSTV.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:af15cf501c00172270d2d2c43d7a7100a"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_s_t_v_client.html#af15cf501c00172270d2d2c43d7a7100a">SSTVClient</a> (<a class="el" href="class_physical_layer.html">PhysicalLayer</a> *phy)</td></tr>
<tr class="memdesc:af15cf501c00172270d2d2c43d7a7100a"><td class="mdescLeft"> </td><td class="mdescRight">Constructor for 2-FSK mode. <a href="class_s_s_t_v_client.html#af15cf501c00172270d2d2c43d7a7100a">More...</a><br /></td></tr>
<tr class="separator:af15cf501c00172270d2d2c43d7a7100a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a99e46bec8403dfc36b9e5b102b1f7cf1"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_s_t_v_client.html#a99e46bec8403dfc36b9e5b102b1f7cf1">SSTVClient</a> (<a class="el" href="class_a_f_s_k_client.html">AFSKClient</a> *audio)</td></tr>
<tr class="memdesc:a99e46bec8403dfc36b9e5b102b1f7cf1"><td class="mdescLeft"> </td><td class="mdescRight">Constructor for AFSK mode. <a href="class_s_s_t_v_client.html#a99e46bec8403dfc36b9e5b102b1f7cf1">More...</a><br /></td></tr>
<tr class="separator:a99e46bec8403dfc36b9e5b102b1f7cf1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3769dcdebf8b1fa01eb2d8bd2bb3815a"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_s_t_v_client.html#a3769dcdebf8b1fa01eb2d8bd2bb3815a">begin</a> (float base, const <a class="el" href="struct_s_s_t_v_mode__t.html">SSTVMode_t</a> &mode)</td></tr>
<tr class="memdesc:a3769dcdebf8b1fa01eb2d8bd2bb3815a"><td class="mdescLeft"> </td><td class="mdescRight">Initialization method for 2-FSK. <a href="class_s_s_t_v_client.html#a3769dcdebf8b1fa01eb2d8bd2bb3815a">More...</a><br /></td></tr>
<tr class="separator:a3769dcdebf8b1fa01eb2d8bd2bb3815a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afd4257e858a88e5847854a46f166a9b0"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_s_t_v_client.html#afd4257e858a88e5847854a46f166a9b0">begin</a> (const <a class="el" href="struct_s_s_t_v_mode__t.html">SSTVMode_t</a> &mode)</td></tr>
<tr class="memdesc:afd4257e858a88e5847854a46f166a9b0"><td class="mdescLeft"> </td><td class="mdescRight">Initialization method for AFSK. <a href="class_s_s_t_v_client.html#afd4257e858a88e5847854a46f166a9b0">More...</a><br /></td></tr>
<tr class="separator:afd4257e858a88e5847854a46f166a9b0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0e9cc17123f26d1e7ae2a2b93546515e"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_s_t_v_client.html#a0e9cc17123f26d1e7ae2a2b93546515e">setCorrection</a> (float correction)</td></tr>
<tr class="memdesc:a0e9cc17123f26d1e7ae2a2b93546515e"><td class="mdescLeft"> </td><td class="mdescRight">Set correction coefficient for tone length. <a href="class_s_s_t_v_client.html#a0e9cc17123f26d1e7ae2a2b93546515e">More...</a><br /></td></tr>
<tr class="separator:a0e9cc17123f26d1e7ae2a2b93546515e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0126ac04934f589b8cb04a038c342044"><td class="memItemLeft" align="right" valign="top"><a id="a0126ac04934f589b8cb04a038c342044"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_s_t_v_client.html#a0126ac04934f589b8cb04a038c342044">idle</a> ()</td></tr>
<tr class="memdesc:a0126ac04934f589b8cb04a038c342044"><td class="mdescLeft"> </td><td class="mdescRight">Sends out tone at 1900 Hz. <br /></td></tr>
<tr class="separator:a0126ac04934f589b8cb04a038c342044"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a30741de183c81492402187b9d6d8c11e"><td class="memItemLeft" align="right" valign="top"><a id="a30741de183c81492402187b9d6d8c11e"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_s_t_v_client.html#a30741de183c81492402187b9d6d8c11e">sendHeader</a> ()</td></tr>
<tr class="memdesc:a30741de183c81492402187b9d6d8c11e"><td class="mdescLeft"> </td><td class="mdescRight">Sends synchronization header for the SSTV mode set in begin method. <br /></td></tr>
<tr class="separator:a30741de183c81492402187b9d6d8c11e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a772bfc68ac0a5f723c1031138dc27bd0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_s_t_v_client.html#a772bfc68ac0a5f723c1031138dc27bd0">sendLine</a> (uint32_t *imgLine)</td></tr>
<tr class="memdesc:a772bfc68ac0a5f723c1031138dc27bd0"><td class="mdescLeft"> </td><td class="mdescRight">Sends single picture line in the currently configured SSTV mode. <a href="class_s_s_t_v_client.html#a772bfc68ac0a5f723c1031138dc27bd0">More...</a><br /></td></tr>
<tr class="separator:a772bfc68ac0a5f723c1031138dc27bd0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad66e5082788b507f0f18e6e0e255314d"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_s_t_v_client.html#ad66e5082788b507f0f18e6e0e255314d">getPictureHeight</a> () const</td></tr>
<tr class="memdesc:ad66e5082788b507f0f18e6e0e255314d"><td class="mdescLeft"> </td><td class="mdescRight">Get picture height of the currently configured SSTV mode. <a href="class_s_s_t_v_client.html#ad66e5082788b507f0f18e6e0e255314d">More...</a><br /></td></tr>
<tr class="separator:ad66e5082788b507f0f18e6e0e255314d"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Client for SSTV transmissions. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="af15cf501c00172270d2d2c43d7a7100a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af15cf501c00172270d2d2c43d7a7100a">◆ </a></span>SSTVClient() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">SSTVClient::SSTVClient </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_physical_layer.html">PhysicalLayer</a> * </td>
<td class="paramname"><em>phy</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor for 2-FSK mode. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">phy</td><td>Pointer to the wireless module providing <a class="el" href="class_physical_layer.html" title="Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....">PhysicalLayer</a> communication. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a99e46bec8403dfc36b9e5b102b1f7cf1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a99e46bec8403dfc36b9e5b102b1f7cf1">◆ </a></span>SSTVClient() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">SSTVClient::SSTVClient </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_a_f_s_k_client.html">AFSKClient</a> * </td>
<td class="paramname"><em>audio</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor for AFSK mode. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">audio</td><td>Pointer to the AFSK instance providing audio. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="afd4257e858a88e5847854a46f166a9b0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afd4257e858a88e5847854a46f166a9b0">◆ </a></span>begin() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int16_t SSTVClient::begin </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="struct_s_s_t_v_mode__t.html">SSTVMode_t</a> & </td>
<td class="paramname"><em>mode</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialization method for AFSK. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mode</td><td>SSTV mode to be used. Currently supported modes are Scottie1, Scottie2, ScottieDX, Martin1, Martin2, Wrasse, PasokonP3, PasokonP5 and PasokonP7. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
</div>
</div>
<a id="a3769dcdebf8b1fa01eb2d8bd2bb3815a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3769dcdebf8b1fa01eb2d8bd2bb3815a">◆ </a></span>begin() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int16_t SSTVClient::begin </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>base</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="struct_s_s_t_v_mode__t.html">SSTVMode_t</a> & </td>
<td class="paramname"><em>mode</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialization method for 2-FSK. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">base</td><td>Base "0 Hz tone" RF frequency to be used in MHz. </td></tr>
<tr><td class="paramname">mode</td><td>SSTV mode to be used. Currently supported modes are Scottie1, Scottie2, ScottieDX, Martin1, Martin2, Wrasse, PasokonP3, PasokonP5 and PasokonP7. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
</div>
</div>
<a id="ad66e5082788b507f0f18e6e0e255314d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad66e5082788b507f0f18e6e0e255314d">◆ </a></span>getPictureHeight()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint16_t SSTVClient::getPictureHeight </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get picture height of the currently configured SSTV mode. </p>
<dl class="section return"><dt>Returns</dt><dd>Picture height of the currently configured SSTV mode in pixels. </dd></dl>
</div>
</div>
<a id="a772bfc68ac0a5f723c1031138dc27bd0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a772bfc68ac0a5f723c1031138dc27bd0">◆ </a></span>sendLine()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void SSTVClient::sendLine </td>
<td>(</td>
<td class="paramtype">uint32_t * </td>
<td class="paramname"><em>imgLine</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sends single picture line in the currently configured SSTV mode. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">imgLine</td><td>Image line to send, in 24-bit RGB. It is up to the user to ensure that imgLine has enough pixels to send it in the current SSTV mode. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a0e9cc17123f26d1e7ae2a2b93546515e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0e9cc17123f26d1e7ae2a2b93546515e">◆ </a></span>setCorrection()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int16_t SSTVClient::setCorrection </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>correction</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set correction coefficient for tone length. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">correction</td><td>Timing correction factor, used to adjust the length of timing pulses. Less than 1.0 leads to shorter timing pulses, defaults to 1.0 (no correction). </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/protocols/SSTV/<a class="el" href="_s_s_t_v_8h_source.html">SSTV.h</a></li>
<li>src/protocols/SSTV/SSTV.cpp</li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="class_s_s_t_v_client.html">SSTVClient</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>
</html>