group__cpp__kodi__addon__visualization.html

<!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>Kodi Development: Visualization</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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  $(document).ready(function() { init_search(); });
/* @license-end */
</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="projectlogo"><img alt="Logo" src="kodi-dev.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Kodi Development
   &#160;<span id="projectnumber">20.0</span>
   </div>
   <div id="projectbrief">for Binary and Script based Add-Ons</div>
  </td>
   <td>        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.svg"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
          </span>
        </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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
</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&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('group__cpp__kodi__addon__visualization.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="#groups">Modules</a>  </div>
  <div class="headertitle">
<div class="title">Visualization<div class="ingroups"><a class="el" href="group__cpp.html">C++</a> &raquo; <a class="el" href="group__cpp__kodi__addon.html">Interface - kodi::addon</a> &raquo; <a class="el" href="group__cpp__kodi__addon__instances.html">Addon type instances</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p> <h4><code><span style="font-style: italic;">Class: </span><span style="font-style: bold;"><font color=31363b><big> kodi::addon::CInstanceVisualization </big></font></span></code></h4>  <b>Visualization add-on instance</b><br  />
<a href="https://en.wikipedia.org/wiki/Music_visualization">Music visualization</a>, or music visualisation, is a feature in Kodi that generates animated imagery based on a piece of music. The imagery is usually generated and rendered in real time synchronized to the music. </p>
<p>Visualization techniques range from simple ones (e.g., a simulation of an oscilloscope display) to elaborate ones, which often include a plurality of composited effects. The changes in the music's loudness and frequency spectrum are among the properties used as input to the visualization.</p>
<p>Include the header #include &lt;kodi/addon-instance/Visualization.h&gt; to use this class.</p>
<p>This interface allows the creation of visualizations for Kodi, based upon <b>DirectX</b> or/and <b>OpenGL</b> rendering with <code>C++</code> code.</p>
<p>Additionally, there are several <a class="el" href="group__cpp__kodi__addon__visualization___c_b.html">other functions</a> available in which the child class can ask about the current hardware, including the device, display and several other parts.</p>
<hr  />
<p><b>Here's an example on addon.xml:</b> </p><div class="fragment"><div class="line">&lt;?<span class="keyword">xml</span> <span class="keyword">version</span>=<span class="stringliteral">&quot;1.0&quot;</span> <span class="keyword">encoding</span>=<span class="stringliteral">&quot;UTF-8&quot;</span>?&gt;</div>
<div class="line">&lt;<span class="keywordtype">addon</span></div>
<div class="line">  <span class="keyword">id</span>=<span class="stringliteral">&quot;visualization.myspecialnamefor&quot;</span></div>
<div class="line">  <span class="keyword">version</span>=<span class="stringliteral">&quot;1.0.0&quot;</span></div>
<div class="line">  <span class="keyword">name</span>=<span class="stringliteral">&quot;My special visualization addon&quot;</span></div>
<div class="line">  <span class="keyword">provider-name</span>=<span class="stringliteral">&quot;Your Name&quot;</span>&gt;</div>
<div class="line">  &lt;<span class="keywordtype">requires</span>&gt;@<span class="keyword">ADDON_DEPENDS</span>@&lt;/<span class="keywordtype">requires</span>&gt;</div>
<div class="line">  &lt;<span class="keywordtype">extension</span></div>
<div class="line">    <span class="keyword">point</span>=<span class="stringliteral">&quot;xbmc.player.musicviz&quot;</span></div>
<div class="line">    <span class="keyword">library_</span>@<span class="keyword">PLATFORM</span>@=<span class="stringliteral">&quot;@LIBRARY_FILENAME@&quot;</span>/&gt;</div>
<div class="line">  &lt;<span class="keywordtype">extension</span> <span class="keyword">point</span>=<span class="stringliteral">&quot;xbmc.addon.metadata&quot;</span>&gt;</div>
<div class="line">    &lt;<span class="keywordtype">summary</span> <span class="keyword">lang</span>=<span class="stringliteral">&quot;en_GB&quot;</span>&gt;<span class="keyword">My</span> <span class="keyword">visualization</span> <span class="keyword">addon</span> <span class="keyword">addon</span>&lt;/<span class="keywordtype">summary</span>&gt;</div>
<div class="line">    &lt;<span class="keywordtype">description</span> <span class="keyword">lang</span>=<span class="stringliteral">&quot;en_GB&quot;</span>&gt;<span class="keyword">My</span> <span class="keyword">visualization</span> <span class="keyword">addon</span> <span class="keyword">description</span>&lt;/<span class="keywordtype">description</span>&gt;</div>
<div class="line">    &lt;<span class="keywordtype">platform</span>&gt;@<span class="keyword">PLATFORM</span>@&lt;/<span class="keywordtype">platform</span>&gt;</div>
<div class="line">  &lt;/<span class="keywordtype">extension</span>&gt;</div>
<div class="line">&lt;/<span class="keywordtype">addon</span>&gt;</div>
</div><!-- fragment --><p>Description to visualization related addon.xml values: </p><table class="markdownTable">
<tr class="markdownTableHead">
<th class="markdownTableHeadLeft">Name   </th><th class="markdownTableHeadNone">Description    </th></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyLeft"><b><code>point</code></b>   </td><td class="markdownTableBodyNone">Addon type specification<br  />
At all addon types and for this kind always <b>"xbmc.player.musicviz"</b>.    </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyLeft"><b><code>library_@PLATFORM@</code></b>   </td><td class="markdownTableBodyNone">Sets the used library name, which is automatically set by cmake at addon build.   </td></tr>
</table>
<hr  />
<p><b>Here is an example of the minimum required code to start a visualization:</b> </p><div class="fragment"><div class="line"><span class="preprocessor">#include &lt;kodi/addon-instance/Visualization.h&gt;</span></div>
<div class="line"> </div>
<div class="line"><span class="keyword">class </span>CMyVisualization : <span class="keyword">public</span> <a class="code" href="classkodi_1_1addon_1_1_c_addon_base.html">kodi::addon::CAddonBase</a>,</div>
<div class="line">                         <span class="keyword">public</span> <a class="code" href="classkodi_1_1addon_1_1_c_instance_visualization.html">kodi::addon::CInstanceVisualization</a></div>
<div class="line">{</div>
<div class="line"><span class="keyword">public</span>:</div>
<div class="line">  CMyVisualization();</div>
<div class="line"> </div>
<div class="line">  <span class="keywordtype">bool</span> Start(<span class="keywordtype">int</span> channels, <span class="keywordtype">int</span> samplesPerSec, <span class="keywordtype">int</span> bitsPerSample, std::string songName) <span class="keyword">override</span>;</div>
<div class="line">  <span class="keywordtype">void</span> AudioData(<span class="keyword">const</span> <span class="keywordtype">float</span>* audioData, <span class="keywordtype">int</span> audioDataLength, <span class="keywordtype">float</span>* freqData, <span class="keywordtype">int</span> freqDataLength) <span class="keyword">override</span>;</div>
<div class="line">  <span class="keywordtype">void</span> Render() <span class="keyword">override</span>;</div>
<div class="line">};</div>
<div class="line"> </div>
<div class="line">CMyVisualization::CMyVisualization()</div>
<div class="line">{</div>
<div class="line">  ...</div>
<div class="line">}</div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">bool</span> CMyVisualization::Start(<span class="keywordtype">int</span> channels, <span class="keywordtype">int</span> samplesPerSec, <span class="keywordtype">int</span> bitsPerSample, std::string songName)</div>
<div class="line">{</div>
<div class="line">  ...</div>
<div class="line">  <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line">}</div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">void</span> CMyVisualization::AudioData(<span class="keyword">const</span> <span class="keywordtype">float</span>* audioData, <span class="keywordtype">int</span> audioDataLength, <span class="keywordtype">float</span>* freqData, <span class="keywordtype">int</span> freqDataLength)</div>
<div class="line">{</div>
<div class="line">  ...</div>
<div class="line">}</div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">void</span> CMyVisualization::Render()</div>
<div class="line">{</div>
<div class="line">  ...</div>
<div class="line">}</div>
<div class="line"> </div>
<div class="line">ADDONCREATOR(CMyVisualization)</div>
<div class="ttc" id="aclasskodi_1_1addon_1_1_c_addon_base_html"><div class="ttname"><a href="classkodi_1_1addon_1_1_c_addon_base.html">kodi::addon::CAddonBase</a></div><div class="ttdef"><b>Definition:</b> AddonBase.h:322</div></div>
<div class="ttc" id="aclasskodi_1_1addon_1_1_c_instance_visualization_html"><div class="ttname"><a href="classkodi_1_1addon_1_1_c_instance_visualization.html">kodi::addon::CInstanceVisualization</a></div><div class="ttdef"><b>Definition:</b> Visualization.h:396</div></div>
</div><!-- fragment --><hr  />
<p><b>Here is another example where the visualization is used together with other instance types:</b></p>
<div class="fragment"><div class="line"><span class="preprocessor">#include &lt;kodi/addon-instance/Visualization.h&gt;</span></div>
<div class="line"> </div>
<div class="line"><span class="keyword">class </span>CMyVisualization : <span class="keyword">public</span> <a class="code" href="classkodi_1_1addon_1_1_c_instance_visualization.html">kodi::addon::CInstanceVisualization</a></div>
<div class="line">{</div>
<div class="line"><span class="keyword">public</span>:</div>
<div class="line">  CMyVisualization(KODI_HANDLE instance, <span class="keyword">const</span> std::string&amp; version);</div>
<div class="line"> </div>
<div class="line">  <span class="keywordtype">bool</span> Start(<span class="keywordtype">int</span> channels, <span class="keywordtype">int</span> samplesPerSec, <span class="keywordtype">int</span> bitsPerSample, std::string songName) <span class="keyword">override</span>;</div>
<div class="line">  <span class="keywordtype">void</span> AudioData(<span class="keyword">const</span> <span class="keywordtype">float</span>* audioData, <span class="keywordtype">int</span> audioDataLength, <span class="keywordtype">float</span>* freqData, <span class="keywordtype">int</span> freqDataLength) <span class="keyword">override</span>;</div>
<div class="line">  <span class="keywordtype">void</span> Render() <span class="keyword">override</span>;</div>
<div class="line">};</div>
<div class="line"> </div>
<div class="line">CMyVisualization::CMyVisualization(KODI_HANDLE instance, <span class="keyword">const</span> std::string&amp; version)</div>
<div class="line">  : kodi::addon::CInstanceAudioDecoder(instance, version)</div>
<div class="line">{</div>
<div class="line">  ...</div>
<div class="line">}</div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">bool</span> CMyVisualization::Start(<span class="keywordtype">int</span> channels, <span class="keywordtype">int</span> samplesPerSec, <span class="keywordtype">int</span> bitsPerSample, std::string songName)</div>
<div class="line">{</div>
<div class="line">  ...</div>
<div class="line">  <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line">}</div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">void</span> CMyVisualization::AudioData(<span class="keyword">const</span> <span class="keywordtype">float</span>* audioData, <span class="keywordtype">int</span> audioDataLength, <span class="keywordtype">float</span>* freqData, <span class="keywordtype">int</span> freqDataLength)</div>
<div class="line">{</div>
<div class="line">  ...</div>
<div class="line">}</div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">void</span> CMyVisualization::Render()</div>
<div class="line">{</div>
<div class="line">  ...</div>
<div class="line">}</div>
<div class="line"> </div>
<div class="line"> </div>
<div class="line"><span class="comment">//----------------------------------------------------------------------</span></div>
<div class="line"> </div>
<div class="line"><span class="keyword">class </span>CMyAddon : <span class="keyword">public</span> <a class="code" href="classkodi_1_1addon_1_1_c_addon_base.html">kodi::addon::CAddonBase</a></div>
<div class="line">{</div>
<div class="line"><span class="keyword">public</span>:</div>
<div class="line">  CMyAddon() { }</div>
<div class="line">  <a class="code" href="group__cpp__kodi__addon__addonbase___defs___a_d_d_o_n___s_t_a_t_u_s.html#ga335347495ed00620451a69cfe3494502">ADDON_STATUS</a> <a class="code" href="group__cpp__kodi__addon__addonbase.html#ga74ea538a2191541a57115fa89790358c">CreateInstance</a>(<span class="keywordtype">int</span> instanceType,</div>
<div class="line">                              <span class="keyword">const</span> std::string&amp; instanceID,</div>
<div class="line">                              KODI_HANDLE instance,</div>
<div class="line">                              <span class="keyword">const</span> std::string&amp; version,</div>
<div class="line">                              KODI_HANDLE&amp; addonInstance) <span class="keyword">override</span>;</div>
<div class="line">};</div>
<div class="line"> </div>
<div class="line"><span class="comment">// If you use only one instance in your add-on, can be instanceType and</span></div>
<div class="line"><span class="comment">// instanceID ignored</span></div>
<div class="line"><a class="code" href="group__cpp__kodi__addon__addonbase___defs___a_d_d_o_n___s_t_a_t_u_s.html#ga335347495ed00620451a69cfe3494502">ADDON_STATUS</a> CMyAddon::CreateInstance(<span class="keywordtype">int</span> instanceType,</div>
<div class="line">                                      <span class="keyword">const</span> std::string&amp; instanceID,</div>
<div class="line">                                      KODI_HANDLE instance,</div>
<div class="line">                                      <span class="keyword">const</span> std::string&amp; version,</div>
<div class="line">                                      KODI_HANDLE&amp; addonInstance)</div>
<div class="line">{</div>
<div class="line">  <span class="keywordflow">if</span> (instanceType == <a class="code" href="group__cpp__kodi__addon__addonbase___defs___a_d_d_o_n___t_y_p_e.html#ggada0b4c3c9f9c168e5e1c27145ec72357a83120cb2f02fe5a4759f5bf0209bdfb5">ADDON_INSTANCE_VISUALIZATION</a>)</div>
<div class="line">  {</div>
<div class="line">    <a class="code" href="group__cpp__kodi.html#gaaa1f205f9375cd086229a1455ede11cc">kodi::Log</a>(<a class="code" href="group__cpp__kodi___defs___addon_log.html#gga913895aaf2ef685961947f8d6b93e038a63f8ea3699765964c764b141bf41e9cc">ADDON_LOG_INFO</a>, <span class="stringliteral">&quot;Creating my visualization&quot;</span>);</div>
<div class="line">    addonInstance = <span class="keyword">new</span> CMyVisualization(instance, version);</div>
<div class="line">    <span class="keywordflow">return</span> <a class="code" href="group__cpp__kodi__addon__addonbase___defs___a_d_d_o_n___s_t_a_t_u_s.html#gga335347495ed00620451a69cfe3494502a6925909b93ca05098ca5272f16e091c0">ADDON_STATUS_OK</a>;</div>
<div class="line">  }</div>
<div class="line">  <span class="keywordflow">else</span> <span class="keywordflow">if</span> (...)</div>
<div class="line">  {</div>
<div class="line">    ...</div>
<div class="line">  }</div>
<div class="line">  <span class="keywordflow">return</span> <a class="code" href="group__cpp__kodi__addon__addonbase___defs___a_d_d_o_n___s_t_a_t_u_s.html#gga335347495ed00620451a69cfe3494502ac0720dbdce3dcb194f12a0eceb59a501">ADDON_STATUS_UNKNOWN</a>;</div>
<div class="line">}</div>
<div class="line"> </div>
<div class="line">ADDONCREATOR(CMyAddon)</div>
<div class="ttc" id="agroup__cpp__kodi___defs___addon_log_html_gga913895aaf2ef685961947f8d6b93e038a63f8ea3699765964c764b141bf41e9cc"><div class="ttname"><a href="group__cpp__kodi___defs___addon_log.html#gga913895aaf2ef685961947f8d6b93e038a63f8ea3699765964c764b141bf41e9cc">ADDON_LOG_INFO</a></div><div class="ttdeci">@ ADDON_LOG_INFO</div><div class="ttdoc">1 : To include information messages in the log file.</div><div class="ttdef"><b>Definition:</b> addon_base.h:177</div></div>
<div class="ttc" id="agroup__cpp__kodi__addon__addonbase___defs___a_d_d_o_n___s_t_a_t_u_s_html_ga335347495ed00620451a69cfe3494502"><div class="ttname"><a href="group__cpp__kodi__addon__addonbase___defs___a_d_d_o_n___s_t_a_t_u_s.html#ga335347495ed00620451a69cfe3494502">ADDON_STATUS</a></div><div class="ttdeci">ADDON_STATUS</div><div class="ttdef"><b>Definition:</b> addon_base.h:128</div></div>
<div class="ttc" id="agroup__cpp__kodi__addon__addonbase___defs___a_d_d_o_n___s_t_a_t_u_s_html_gga335347495ed00620451a69cfe3494502a6925909b93ca05098ca5272f16e091c0"><div class="ttname"><a href="group__cpp__kodi__addon__addonbase___defs___a_d_d_o_n___s_t_a_t_u_s.html#gga335347495ed00620451a69cfe3494502a6925909b93ca05098ca5272f16e091c0">ADDON_STATUS_OK</a></div><div class="ttdeci">@ ADDON_STATUS_OK</div><div class="ttdoc">For everything OK and no error.</div><div class="ttdef"><b>Definition:</b> addon_base.h:130</div></div>
<div class="ttc" id="agroup__cpp__kodi__addon__addonbase___defs___a_d_d_o_n___s_t_a_t_u_s_html_gga335347495ed00620451a69cfe3494502ac0720dbdce3dcb194f12a0eceb59a501"><div class="ttname"><a href="group__cpp__kodi__addon__addonbase___defs___a_d_d_o_n___s_t_a_t_u_s.html#gga335347495ed00620451a69cfe3494502ac0720dbdce3dcb194f12a0eceb59a501">ADDON_STATUS_UNKNOWN</a></div><div class="ttdeci">@ ADDON_STATUS_UNKNOWN</div><div class="ttdoc">Unknown and incomprehensible error.</div><div class="ttdef"><b>Definition:</b> addon_base.h:142</div></div>
<div class="ttc" id="agroup__cpp__kodi__addon__addonbase___defs___a_d_d_o_n___t_y_p_e_html_ggada0b4c3c9f9c168e5e1c27145ec72357a83120cb2f02fe5a4759f5bf0209bdfb5"><div class="ttname"><a href="group__cpp__kodi__addon__addonbase___defs___a_d_d_o_n___t_y_p_e.html#ggada0b4c3c9f9c168e5e1c27145ec72357a83120cb2f02fe5a4759f5bf0209bdfb5">ADDON_INSTANCE_VISUALIZATION</a></div><div class="ttdeci">@ ADDON_INSTANCE_VISUALIZATION</div><div class="ttdoc">Music visualization instance, see kodi::addon::CInstanceVisualization.</div><div class="ttdef"><b>Definition:</b> versions.h:238</div></div>
<div class="ttc" id="agroup__cpp__kodi__addon__addonbase_html_ga74ea538a2191541a57115fa89790358c"><div class="ttname"><a href="group__cpp__kodi__addon__addonbase.html#ga74ea538a2191541a57115fa89790358c">kodi::addon::CAddonBase::CreateInstance</a></div><div class="ttdeci">virtual ADDON_STATUS CreateInstance(int instanceType, const std::string &amp;instanceID, KODI_HANDLE instance, const std::string &amp;version, KODI_HANDLE &amp;addonInstance)</div><div class="ttdoc">Instance created.</div><div class="ttdef"><b>Definition:</b> AddonBase.h:481</div></div>
<div class="ttc" id="agroup__cpp__kodi_html_gaaa1f205f9375cd086229a1455ede11cc"><div class="ttname"><a href="group__cpp__kodi.html#gaaa1f205f9375cd086229a1455ede11cc">kodi::Log</a></div><div class="ttdeci">void ATTRIBUTE_HIDDEN Log(const AddonLog loglevel, const char *format,...)</div><div class="ttdoc">Add a message to Kodi's log.</div><div class="ttdef"><b>Definition:</b> AddonBase.h:749</div></div>
</div><!-- fragment --><p>The destruction of the example class <code>CMyVisualization</code> is called from Kodi's header. Manually deleting the add-on instance is not required. </p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
Modules</h2></td></tr>
<tr class="memitem:group__cpp__kodi__addon__visualization___defs"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpp__kodi__addon__visualization___defs.html">Definitions, structures and enumerators</a></td></tr>
<tr class="memdesc:group__cpp__kodi__addon__visualization___defs"><td class="mdescLeft">&#160;</td><td class="mdescRight"><b>Visualization add-on instance definition values</b><br  />
All visualization functions associated data structures. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__cpp__kodi__addon__visualization___c_b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpp__kodi__addon__visualization___c_b.html">Information functions</a></td></tr>
<tr class="memdesc:group__cpp__kodi__addon__visualization___c_b"><td class="mdescLeft">&#160;</td><td class="mdescRight"><b>To get info about the device, display and several other parts</b><br  />
 These are functions to query any values or to transfer them to Kodi. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="gab77a4fc4d8b8c8cbb93f7a5632c5b5ee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab77a4fc4d8b8c8cbb93f7a5632c5b5ee">&#9670;&nbsp;</a></span>CInstanceVisualization() <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"><a class="el" href="classkodi_1_1addon_1_1_c_instance_visualization.html">CInstanceVisualization</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Visualization class constructor. </p>
<p>Used by an add-on that only supports visualizations. </p>

</div>
</div>
<a id="gafb30eb0829c52a091a4f67ffbe232c85"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gafb30eb0829c52a091a4f67ffbe232c85">&#9670;&nbsp;</a></span>CInstanceVisualization() <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"><a class="el" href="classkodi_1_1addon_1_1_c_instance_visualization.html">CInstanceVisualization</a> </td>
          <td>(</td>
          <td class="paramtype">KODI_HANDLE&#160;</td>
          <td class="paramname"><em>instance</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>kodiVersion</em> = <code>&quot;&quot;</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Visualization class constructor used to support multiple instance types. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">instance</td><td>The instance value given to <b><code>kodi::addon::CAddonBase::CreateInstance(...)</code></b>. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">kodiVersion</td><td>[opt] Version used in Kodi for this instance, to allow compatibility to older Kodi versions.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>Recommended to set <b><code>kodiVersion</code></b>.</dd></dl>
<hr  />
<p><b>Here's example about the use of this:</b> </p><div class="fragment"><div class="line"><span class="keyword">class </span>CMyVisualization : <span class="keyword">public</span> <a class="code" href="classkodi_1_1addon_1_1_c_instance_audio_decoder.html">kodi::addon::CInstanceAudioDecoder</a></div>
<div class="line">{</div>
<div class="line"><span class="keyword">public</span>:</div>
<div class="line">  CMyVisualization(KODI_HANDLE instance, <span class="keyword">const</span> std::string&amp; kodiVersion)</div>
<div class="line">    : kodi::addon::CInstanceAudioDecoder(instance, kodiVersion)</div>
<div class="line">  {</div>
<div class="line">     ...</div>
<div class="line">  }</div>
<div class="line"> </div>
<div class="line">  ...</div>
<div class="line">};</div>
<div class="line"> </div>
<div class="line"><a class="code" href="group__cpp__kodi__addon__addonbase___defs___a_d_d_o_n___s_t_a_t_u_s.html#ga335347495ed00620451a69cfe3494502">ADDON_STATUS</a> CMyAddon::CreateInstance(<span class="keywordtype">int</span> instanceType,</div>
<div class="line">                                      <span class="keyword">const</span> std::string&amp; instanceID,</div>
<div class="line">                                      KODI_HANDLE instance,</div>
<div class="line">                                      <span class="keyword">const</span> std::string&amp; version,</div>
<div class="line">                                      KODI_HANDLE&amp; addonInstance)</div>
<div class="line">{</div>
<div class="line">  <a class="code" href="group__cpp__kodi.html#gaaa1f205f9375cd086229a1455ede11cc">kodi::Log</a>(<a class="code" href="group__cpp__kodi___defs___addon_log.html#gga913895aaf2ef685961947f8d6b93e038a63f8ea3699765964c764b141bf41e9cc">ADDON_LOG_INFO</a>, <span class="stringliteral">&quot;Creating my visualization&quot;</span>);</div>
<div class="line">  addonInstance = <span class="keyword">new</span> CMyVisualization(instance, version);</div>
<div class="line">  <span class="keywordflow">return</span> <a class="code" href="group__cpp__kodi__addon__addonbase___defs___a_d_d_o_n___s_t_a_t_u_s.html#gga335347495ed00620451a69cfe3494502a6925909b93ca05098ca5272f16e091c0">ADDON_STATUS_OK</a>;</div>
<div class="line">}</div>
<div class="ttc" id="aclasskodi_1_1addon_1_1_c_instance_audio_decoder_html"><div class="ttname"><a href="classkodi_1_1addon_1_1_c_instance_audio_decoder.html">kodi::addon::CInstanceAudioDecoder</a></div><div class="ttdef"><b>Definition:</b> AudioDecoder.h:382</div></div>
</div><!-- fragment --> 
</div>
</div>
<a id="gaa8c552b512f4584d475fc6f0ff031f7d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa8c552b512f4584d475fc6f0ff031f7d">&#9670;&nbsp;</a></span>~CInstanceVisualization()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">~<a class="el" href="classkodi_1_1addon_1_1_c_instance_visualization.html">CInstanceVisualization</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">default</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Destructor. </p>

</div>
</div>
<a id="gaa4ba9bea676e0bccf5bcc7ac33b80f49"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa4ba9bea676e0bccf5bcc7ac33b80f49">&#9670;&nbsp;</a></span>Start()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool Start </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>channels</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>samplesPerSec</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>bitsPerSample</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">std::string&#160;</td>
          <td class="paramname"><em>songName</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Used to notify the visualization that a new song has been started. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">channels</td><td>Number of channels in the stream </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">samplesPerSec</td><td>Samples per second of stream </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">bitsPerSample</td><td>Number of bits in one sample </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">songName</td><td>The name of the currently-playing song </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if start successful done </dd></dl>

</div>
</div>
<a id="gaf6f113a64b92a63894b285b4f2a2c3a5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf6f113a64b92a63894b285b4f2a2c3a5">&#9670;&nbsp;</a></span>Stop()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void Stop </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Used to inform the visualization that the rendering control was stopped. </p>

</div>
</div>
<a id="ga5c8b4d62952a520f13d70c9133e65d2a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5c8b4d62952a520f13d70c9133e65d2a">&#9670;&nbsp;</a></span>AudioData()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void AudioData </td>
          <td>(</td>
          <td class="paramtype">const float *&#160;</td>
          <td class="paramname"><em>audioData</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>audioDataLength</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float *&#160;</td>
          <td class="paramname"><em>freqData</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>freqDataLength</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Pass audio data to the visualization. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">audioData</td><td>The raw audio data </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">audioDataLength</td><td>Length of the audioData array </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">freqData</td><td>The <a href="https://en.wikipedia.org/wiki/Fast_Fourier_transform">FFT</a> of the audio data </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">freqDataLength</td><td>Length of frequency data array</td></tr>
  </table>
  </dd>
</dl>
<p>Values <b>freqData</b> and <b>freqDataLength</b> are used if <a class="el" href="group__cpp__kodi__addon__visualization.html#ga5357e3fc0644da927689ec6161b2ef46" title="Used to get the number of buffers from the current visualization.">GetInfo()</a> returns true for the <code>wantsFreq</code> parameter. Otherwise, <b>freqData</b> is set to <code>nullptr</code> and <b>freqDataLength</b> is <code>0</code>. </p>

</div>
</div>
<a id="ga3f36305e1f63bdf8b80aca2cad779660"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3f36305e1f63bdf8b80aca2cad779660">&#9670;&nbsp;</a></span>IsDirty()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool IsDirty </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Used to inform Kodi that the rendered region is dirty and need an update. </p>
<dl class="section return"><dt>Returns</dt><dd>True if dirty </dd></dl>

</div>
</div>
<a id="ga0bc3f3606d9cf5304dac90cd7a619194"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0bc3f3606d9cf5304dac90cd7a619194">&#9670;&nbsp;</a></span>Render()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void Render </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Used to indicate when the add-on should render. </p>

</div>
</div>
<a id="ga5357e3fc0644da927689ec6161b2ef46"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5357e3fc0644da927689ec6161b2ef46">&#9670;&nbsp;</a></span>GetInfo()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void GetInfo </td>
          <td>(</td>
          <td class="paramtype">bool &amp;&#160;</td>
          <td class="paramname"><em>wantsFreq</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int &amp;&#160;</td>
          <td class="paramname"><em>syncDelay</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Used to get the number of buffers from the current visualization. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[out]</td><td class="paramname">wantsFreq</td><td>Indicates whether the add-on wants FFT data. If set to true, the <b>freqData</b> and <b>freqDataLength</b> parameters of <a class="el" href="group__cpp__kodi__addon__visualization.html#ga5c8b4d62952a520f13d70c9133e65d2a">AudioData()</a> are used </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">syncDelay</td><td>The number of buffers to delay before calling <a class="el" href="group__cpp__kodi__addon__visualization.html#ga5c8b4d62952a520f13d70c9133e65d2a">AudioData()</a></td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>If this function is not implemented, it will default to <code>wantsFreq</code> = false and <code>syncDelay</code> = 0. </dd></dl>

</div>
</div>
<a id="ga4d344677b35ca9a299a595ec6d9d0b6b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4d344677b35ca9a299a595ec6d9d0b6b">&#9670;&nbsp;</a></span>GetPresets()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool GetPresets </td>
          <td>(</td>
          <td class="paramtype">std::vector&lt; std::string &gt; &amp;&#160;</td>
          <td class="paramname"><em>presets</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Used to get a list of visualization presets the user can select. from. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[out]</td><td class="paramname">presets</td><td>The vector list containing the names of presets that the user can select </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Return true if successful, or false if there are no presets to choose from </dd></dl>

</div>
</div>
<a id="ga8e9a79d794d95fdd88c2700982e2f622"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8e9a79d794d95fdd88c2700982e2f622">&#9670;&nbsp;</a></span>GetActivePreset()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual int GetActivePreset </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Get the index of the current preset. </p>
<dl class="section return"><dt>Returns</dt><dd>Index number of the current preset </dd></dl>

</div>
</div>
<a id="gac4a06db92c95351b3478f4857bbe71be"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac4a06db92c95351b3478f4857bbe71be">&#9670;&nbsp;</a></span>IsLocked()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool IsLocked </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Check if the add-on is locked to the current preset. </p>
<dl class="section return"><dt>Returns</dt><dd>True if locked to the current preset </dd></dl>

</div>
</div>
<a id="ga4baaca37d21ec72b65b57022ed19fa8c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4baaca37d21ec72b65b57022ed19fa8c">&#9670;&nbsp;</a></span>PrevPreset()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool PrevPreset </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Load the previous visualization preset. </p>
<dl class="section return"><dt>Returns</dt><dd>Return true if the previous preset was loaded </dd></dl>

</div>
</div>
<a id="gaba3f4c18a139a731f20dc018b239a425"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaba3f4c18a139a731f20dc018b239a425">&#9670;&nbsp;</a></span>NextPreset()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool NextPreset </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Load the next visualization preset. </p>
<dl class="section return"><dt>Returns</dt><dd>Return true if the next preset was loaded </dd></dl>

</div>
</div>
<a id="ga3d8800ff2acd0c2f242459803cacd3a2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3d8800ff2acd0c2f242459803cacd3a2">&#9670;&nbsp;</a></span>LoadPreset()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool LoadPreset </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>select</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Load a visualization preset. </p>
<p>This function is called after a new preset is selected.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">select</td><td>Preset index to use </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Return true if the preset is loaded </dd></dl>

</div>
</div>
<a id="ga2797e92d4bf9b4eaef21f256a1867ed3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2797e92d4bf9b4eaef21f256a1867ed3">&#9670;&nbsp;</a></span>RandomPreset()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool RandomPreset </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Switch to a new random preset. </p>
<dl class="section return"><dt>Returns</dt><dd>Return true if a random preset was loaded </dd></dl>

</div>
</div>
<a id="ga0396c3e1569480032721836b7e139624"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0396c3e1569480032721836b7e139624">&#9670;&nbsp;</a></span>LockPreset()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool LockPreset </td>
          <td>(</td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>lockUnlock</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Lock the current visualization preset, preventing it from changing. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">lockUnlock</td><td>If set to true, the preset should be locked </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Return true if the current preset is locked </dd></dl>

</div>
</div>
<a id="gae12d00ba86095e80ec25c719592a1daa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae12d00ba86095e80ec25c719592a1daa">&#9670;&nbsp;</a></span>RatePreset()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool RatePreset </td>
          <td>(</td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>plusMinus</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Used to increase/decrease the visualization preset rating. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">plusMinus</td><td>If set to true the rating is increased, otherwise decreased </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Return true if the rating is modified </dd></dl>

</div>
</div>
<a id="gaa966fc12df9ac054bfd35b8969f67081"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa966fc12df9ac054bfd35b8969f67081">&#9670;&nbsp;</a></span>UpdateAlbumart()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool UpdateAlbumart </td>
          <td>(</td>
          <td class="paramtype">std::string&#160;</td>
          <td class="paramname"><em>albumart</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Inform the visualization of the current album art image. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">albumart</td><td>Path to the current album art image </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Return true if the image is used </dd></dl>

</div>
</div>
<a id="ga4b6accb100116250a962c345e8c36d7b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4b6accb100116250a962c345e8c36d7b">&#9670;&nbsp;</a></span>UpdateTrack()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool UpdateTrack </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classkodi_1_1addon_1_1_visualization_track.html">kodi::addon::VisualizationTrack</a> &amp;&#160;</td>
          <td class="paramname"><em>track</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Inform the visualization of the current track's tag information. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">track</td><td>Visualization track information structure </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Return true if the track information is used</dd></dl>
<hr  />
<p><b>The following table contains values that can be set with <a class="el" href="group__cpp__kodi__addon__visualization___defs___visualization_track.html">class VisualizationTrack</a> :</b> </p><table class="markdownTable">
<tr class="markdownTableHead">
<th class="markdownTableHeadNone">Name   </th><th class="markdownTableHeadNone">Type   </th><th class="markdownTableHeadNone">Set call   </th><th class="markdownTableHeadNone">Get call    </th></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone"><b>Title of the current song.</b>   </td><td class="markdownTableBodyNone"><code>std::string</code>   </td><td class="markdownTableBodyNone"><a class="el" href="group__cpp__kodi__addon__visualization___defs___visualization_track.html#ga54294c70e5c7d4e8edacbdde65a07ab3">SetTitle</a>   </td><td class="markdownTableBodyNone"><a class="el" href="group__cpp__kodi__addon__visualization___defs___visualization_track.html#gaeb3ac9b59cc3df1debe0ea758725cc8e">GetTitle</a>    </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone"><b>Artist names, as a single string</b>   </td><td class="markdownTableBodyNone"><code>std::string</code>   </td><td class="markdownTableBodyNone"><a class="el" href="group__cpp__kodi__addon__visualization___defs___visualization_track.html#ga5e75607d7b90b2fbd342203e0562530b">SetArtist</a>   </td><td class="markdownTableBodyNone"><a class="el" href="group__cpp__kodi__addon__visualization___defs___visualization_track.html#ga4bbce7b9d999d32415ff8e1e4663562b">GetArtist</a>    </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone"><b>Album that the current song is from.</b>   </td><td class="markdownTableBodyNone"><code>std::string</code>   </td><td class="markdownTableBodyNone"><a class="el" href="group__cpp__kodi__addon__visualization___defs___visualization_track.html#ga0b92a57fe710507ef937de56e12c6c88">SetAlbum</a>   </td><td class="markdownTableBodyNone"><a class="el" href="group__cpp__kodi__addon__visualization___defs___visualization_track.html#ga55803565d1b187d6fe1c9e4f36c404f6">GetAlbum</a>    </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone"><b>Album artist names, as a single string</b>   </td><td class="markdownTableBodyNone"><code>std::string</code>   </td><td class="markdownTableBodyNone"><a class="el" href="group__cpp__kodi__addon__visualization___defs___visualization_track.html#ga71090416a4d71dfd72639badbcb0b112">SetAlbumArtist</a>   </td><td class="markdownTableBodyNone"><a class="el" href="group__cpp__kodi__addon__visualization___defs___visualization_track.html#gaf38bbbd17f7b2e3c9635ec23d04adb81">GetAlbumArtist</a>    </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone"><b>The genre name from the music tag, if present</b>   </td><td class="markdownTableBodyNone"><code>std::string</code>   </td><td class="markdownTableBodyNone"><a class="el" href="group__cpp__kodi__addon__visualization___defs___visualization_track.html#gaf319c22917674b7f0c5584465b39c0c6">SetGenre</a>   </td><td class="markdownTableBodyNone"><a class="el" href="group__cpp__kodi__addon__visualization___defs___visualization_track.html#gae20ab752ab482acdb38664a742b9ed82">GetGenre</a>    </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone"><b>Duration of the current song, in seconds</b>   </td><td class="markdownTableBodyNone"><code>int</code>   </td><td class="markdownTableBodyNone"><a class="el" href="group__cpp__kodi__addon__visualization___defs___visualization_track.html#ga2a8c7b8b61c091d2ae6763b123805f2a">SetDuration</a>   </td><td class="markdownTableBodyNone"><a class="el" href="group__cpp__kodi__addon__visualization___defs___visualization_track.html#ga99c2eca8985fb3522ff6d815537da2ca">GetDuration</a>    </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone"><b>Track number of the current song</b>   </td><td class="markdownTableBodyNone"><code>int</code>   </td><td class="markdownTableBodyNone"><a class="el" href="group__cpp__kodi__addon__visualization___defs___visualization_track.html#ga0d08f3902fc7a7d7c9321b986cf09505">SetTrack</a>   </td><td class="markdownTableBodyNone"><a class="el" href="group__cpp__kodi__addon__visualization___defs___visualization_track.html#gae4ab98f56d54ab92a0230d66cf0a9055">GetTrack</a>    </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone"><b>Disc number of the current song stored in the ID tag info</b>   </td><td class="markdownTableBodyNone"><code>int</code>   </td><td class="markdownTableBodyNone"><a class="el" href="group__cpp__kodi__addon__visualization___defs___visualization_track.html#gab182b5fe23194300ab9e8f884549e549">SetDisc</a>   </td><td class="markdownTableBodyNone"><a class="el" href="group__cpp__kodi__addon__visualization___defs___visualization_track.html#ga00b0b46ded8db251c6937047df33ac2f">GetDisc</a>    </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone"><b>Year that the current song was released</b>   </td><td class="markdownTableBodyNone"><code>int</code>   </td><td class="markdownTableBodyNone"><a class="el" href="group__cpp__kodi__addon__visualization___defs___visualization_track.html#gad248b0d121f5add96356c5e469ce983f">SetYear</a>   </td><td class="markdownTableBodyNone"><a class="el" href="group__cpp__kodi__addon__visualization___defs___visualization_track.html#ga2db2a6f455cbf2cc0011da9326edae5f">GetYear</a>    </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone"><b>Lyrics of the current song, if available</b>   </td><td class="markdownTableBodyNone"><code>std::string</code>   </td><td class="markdownTableBodyNone"><a class="el" href="group__cpp__kodi__addon__visualization___defs___visualization_track.html#ga303498a405847125d7da25275612045e">SetLyrics</a>   </td><td class="markdownTableBodyNone"><a class="el" href="group__cpp__kodi__addon__visualization___defs___visualization_track.html#ga8b204053b83b041fb34d4eb41404ee14">GetLyrics</a>    </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone"><b>The user-defined rating of the current song</b>   </td><td class="markdownTableBodyNone"><code>int</code>   </td><td class="markdownTableBodyNone"><a class="el" href="group__cpp__kodi__addon__visualization___defs___visualization_track.html#gad0195fec98c12836339be97684ee47f7">SetRating</a>   </td><td class="markdownTableBodyNone"><a class="el" href="group__cpp__kodi__addon__visualization___defs___visualization_track.html#ga3a90c28fb1501523e660d51f2b44df40">GetRating</a>    </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone"><b>Comment of the current song stored in the ID tag info</b>   </td><td class="markdownTableBodyNone"><code>std::string</code>   </td><td class="markdownTableBodyNone"><a class="el" href="group__cpp__kodi__addon__visualization___defs___visualization_track.html#ga172c10e306c608ed9687a06d065dcf7d">SetComment</a>   </td><td class="markdownTableBodyNone"><a class="el" href="group__cpp__kodi__addon__visualization___defs___visualization_track.html#gaf6675a1e224eee3f3b8a6ef0923e77b0">GetComment</a>   </td></tr>
</table>
<hr  />
<p><b>Example:</b> </p><div class="fragment"><div class="line"><span class="preprocessor">#include &lt;kodi/addon-instance/Visualization.h&gt;</span></div>
<div class="line"> </div>
<div class="line"><span class="keyword">class </span>CMyVisualization : <span class="keyword">public</span> <a class="code" href="classkodi_1_1addon_1_1_c_instance_visualization.html">kodi::addon::CInstanceVisualization</a></div>
<div class="line">{</div>
<div class="line"><span class="keyword">public</span>:</div>
<div class="line">  CMyVisualization(KODI_HANDLE instance, <span class="keyword">const</span> std::string&amp; version);</div>
<div class="line"> </div>
<div class="line">  ...</div>
<div class="line"> </div>
<div class="line">private:</div>
<div class="line">  <a class="code" href="classkodi_1_1addon_1_1_visualization_track.html">kodi::addon::VisualizationTrack</a> m_runningTrack;</div>
<div class="line">};</div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">bool</span> CMyVisualization::UpdateTrack(<span class="keyword">const</span> <a class="code" href="classkodi_1_1addon_1_1_visualization_track.html">kodi::addon::VisualizationTrack</a>&amp; track)</div>
<div class="line">{</div>
<div class="line">  m_runningTrack = track;</div>
<div class="line">  <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line">}</div>
<div class="ttc" id="aclasskodi_1_1addon_1_1_visualization_track_html"><div class="ttname"><a href="classkodi_1_1addon_1_1_visualization_track.html">kodi::addon::VisualizationTrack</a></div><div class="ttdef"><b>Definition:</b> Visualization.h:40</div></div>
</div><!-- fragment --> 
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <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>