wut/group__avm__cec.html

281 lines
14 KiB
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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>wut: AVM HDMI CEC</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="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 id="projectrow">
<td id="projectalign">
<div id="projectname">wut<span id="projectnumber">&#160;v1.9.1</span>
</div>
<div id="projectbrief">Wii U Toolchain</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- 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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">AVM HDMI CEC<div class="ingroups"><a class="el" href="group__avm.html">avm</a></div></div></div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Collaboration diagram for AVM HDMI CEC:</div>
<div class="dyncontent">
<div class="center"><img src="group__avm__cec.png" border="0" usemap="#agroup____avm____cec" alt=""/></div>
<map name="agroup____avm____cec" id="agroup____avm____cec">
<area shape="rect" href="group__avm.html" title="Audio/Video Manager." alt="" coords="5,5,56,31"/>
<area shape="rect" title=" " alt="" coords="104,5,225,31"/>
</map>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gaa11dffbdc87e630bd96be3dcf30be6ce" id="r_gaa11dffbdc87e630bd96be3dcf30be6ce"><td class="memItemLeft" align="right" valign="top"><a class="el" href="wut__types_8h.html#a975dbe9e4396bf9e0064ce01827fa372">BOOL</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__avm__cec.html#gaa11dffbdc87e630bd96be3dcf30be6ce">AVMCECInit</a> (void)</td></tr>
<tr class="memdesc:gaa11dffbdc87e630bd96be3dcf30be6ce"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes CEC. <br /></td></tr>
<tr class="separator:gaa11dffbdc87e630bd96be3dcf30be6ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4530882866f472ce7196b7e2781e3c7f" id="r_ga4530882866f472ce7196b7e2781e3c7f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__avm__cec.html#ga4530882866f472ce7196b7e2781e3c7f">AVMEnableCEC</a> (void)</td></tr>
<tr class="memdesc:ga4530882866f472ce7196b7e2781e3c7f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable CEC. <br /></td></tr>
<tr class="separator:ga4530882866f472ce7196b7e2781e3c7f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf128b956529848d9e7930134e2faacf8" id="r_gaf128b956529848d9e7930134e2faacf8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__avm__cec.html#gaf128b956529848d9e7930134e2faacf8">AVMDisableCEC</a> (void)</td></tr>
<tr class="memdesc:gaf128b956529848d9e7930134e2faacf8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disable CEC. <br /></td></tr>
<tr class="separator:gaf128b956529848d9e7930134e2faacf8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf96f9f1f22f6cf5eedf471070cfbd03f" id="r_gaf96f9f1f22f6cf5eedf471070cfbd03f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="wut__types_8h.html#a975dbe9e4396bf9e0064ce01827fa372">BOOL</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__avm__cec.html#gaf96f9f1f22f6cf5eedf471070cfbd03f">AVMCECSendCommand</a> (<a class="el" href="group__tve__cec.html#ga2371fde1382bc53d313d8d9853d3aa24">TVECECLogicalAddress</a> destination, <a class="el" href="group__tve__cec.html#gaeb39246d9c49c7445e04c7cd8cfb468e">TVECECOpCode</a> opCode, uint8_t *parameters, uint8_t numParameters)</td></tr>
<tr class="memdesc:gaf96f9f1f22f6cf5eedf471070cfbd03f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sends a CEC command. <br /></td></tr>
<tr class="separator:gaf96f9f1f22f6cf5eedf471070cfbd03f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad0eb1d3a89cc07501a8bf625422721ce" id="r_gad0eb1d3a89cc07501a8bf625422721ce"><td class="memItemLeft" align="right" valign="top"><a class="el" href="wut__types_8h.html#a975dbe9e4396bf9e0064ce01827fa372">BOOL</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__avm__cec.html#gad0eb1d3a89cc07501a8bf625422721ce">AVMCECReceiveCommand</a> (<a class="el" href="group__tve__cec.html#ga2371fde1382bc53d313d8d9853d3aa24">TVECECLogicalAddress</a> *outInitiator, <a class="el" href="group__tve__cec.html#gaeb39246d9c49c7445e04c7cd8cfb468e">TVECECOpCode</a> *outOpCode, uint8_t *outParameters, uint8_t *outNumParameters)</td></tr>
<tr class="memdesc:gad0eb1d3a89cc07501a8bf625422721ce"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the last receieved CEC command. <br /></td></tr>
<tr class="separator:gad0eb1d3a89cc07501a8bf625422721ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Function Documentation</h2>
<a id="gaa11dffbdc87e630bd96be3dcf30be6ce" name="gaa11dffbdc87e630bd96be3dcf30be6ce"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa11dffbdc87e630bd96be3dcf30be6ce">&#9670;&#160;</a></span>AVMCECInit()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="wut__types_8h.html#a975dbe9e4396bf9e0064ce01827fa372">BOOL</a> AVMCECInit </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initializes CEC. </p>
<dl class="section return"><dt>Returns</dt><dd><code>TRUE</code> on success. </dd></dl>
</div>
</div>
<a id="ga4530882866f472ce7196b7e2781e3c7f" name="ga4530882866f472ce7196b7e2781e3c7f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4530882866f472ce7196b7e2781e3c7f">&#9670;&#160;</a></span>AVMEnableCEC()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void AVMEnableCEC </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enable CEC. </p>
</div>
</div>
<a id="gaf128b956529848d9e7930134e2faacf8" name="gaf128b956529848d9e7930134e2faacf8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf128b956529848d9e7930134e2faacf8">&#9670;&#160;</a></span>AVMDisableCEC()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void AVMDisableCEC </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Disable CEC. </p>
</div>
</div>
<a id="gaf96f9f1f22f6cf5eedf471070cfbd03f" name="gaf96f9f1f22f6cf5eedf471070cfbd03f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf96f9f1f22f6cf5eedf471070cfbd03f">&#9670;&#160;</a></span>AVMCECSendCommand()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="wut__types_8h.html#a975dbe9e4396bf9e0064ce01827fa372">BOOL</a> AVMCECSendCommand </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__tve__cec.html#ga2371fde1382bc53d313d8d9853d3aa24">TVECECLogicalAddress</a>&#160;</td>
<td class="paramname"><em>destination</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__tve__cec.html#gaeb39246d9c49c7445e04c7cd8cfb468e">TVECECOpCode</a>&#160;</td>
<td class="paramname"><em>opCode</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t *&#160;</td>
<td class="paramname"><em>parameters</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>numParameters</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sends a CEC command. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">destination</td><td>Logical address of the device where the command should be sent to.</td></tr>
<tr><td class="paramname">opCode</td><td>The op code of the command to send.</td></tr>
<tr><td class="paramname">parameters</td><td>Pointer to optional command parameters.</td></tr>
<tr><td class="paramname">numParameters</td><td>The amount of additional parameters.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>TRUE</code> on success. </dd></dl>
</div>
</div>
<a id="gad0eb1d3a89cc07501a8bf625422721ce" name="gad0eb1d3a89cc07501a8bf625422721ce"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad0eb1d3a89cc07501a8bf625422721ce">&#9670;&#160;</a></span>AVMCECReceiveCommand()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="wut__types_8h.html#a975dbe9e4396bf9e0064ce01827fa372">BOOL</a> AVMCECReceiveCommand </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__tve__cec.html#ga2371fde1382bc53d313d8d9853d3aa24">TVECECLogicalAddress</a> *&#160;</td>
<td class="paramname"><em>outInitiator</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__tve__cec.html#gaeb39246d9c49c7445e04c7cd8cfb468e">TVECECOpCode</a> *&#160;</td>
<td class="paramname"><em>outOpCode</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t *&#160;</td>
<td class="paramname"><em>outParameters</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t *&#160;</td>
<td class="paramname"><em>outNumParameters</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the last receieved CEC command. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">outInitiator</td><td>Pointer to store the logical address of the initiator of the command to.</td></tr>
<tr><td class="paramname">outOpCode</td><td>Pointer to store the op code of the command to.</td></tr>
<tr><td class="paramname">outParameters</td><td>Pointer to store additional parameters to.</td></tr>
<tr><td class="paramname">numParameters</td><td>Pointer to store the amount of additional parameters to.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>TRUE</code> on success.</dd></dl>
<dl class="section warning"><dt>Warning</dt><dd>This will return success even if no new command has been receieved. The caller should check that the parameters were actually written to. </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>