[processor-sdk/performance-audio-sr.git] / processor_audio_sdk_1_00_00_00 / psdk_cust / ipc_3_43_00_00_eng / docs / doxygen / html / struct_gate_m_p___params.html
diff --git a/processor_audio_sdk_1_00_00_00/psdk_cust/ipc_3_43_00_00_eng/docs/doxygen/html/struct_gate_m_p___params.html b/processor_audio_sdk_1_00_00_00/psdk_cust/ipc_3_43_00_00_eng/docs/doxygen/html/struct_gate_m_p___params.html
+++ /dev/null
@@ -1,193 +0,0 @@
-<!-- HTML header for doxygen 1.8.9.1-->
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.9.1"/>
-<title>IPC API: GateMP_Params Struct 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="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">
- $(document).ready(function() { init_search(); });
-</script>
-<link href="doxygen.css" rel="stylesheet" type="text/css" />
-</head>
-<body>
-<table width="100%">
-<tr>
- <td bgcolor="black" width="1"><a href="http://www.ti.com"><img border="0" src="tilogo.gif" /></a></td>
- <td bgcolor="red"><img src="titagline.gif" /></td>
-</tr>
-</table>
-<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 style="padding-left: 0.5em;">
- <div id="projectname">IPC API
-  <span id="projectnumber">3.43.00.00_eng</span>
- </div>
- </td>
- </tr>
- </tbody>
-</table>
-</div>
-<!-- end header part -->
-<!-- Generated by Doxygen 1.8.9.1 -->
-<script type="text/javascript">
-var searchBox = new SearchBox("searchBox", "search",false,'Search');
-</script>
- <div id="navrow1" class="tabs">
- <ul class="tablist">
- <li><a href="index.html"><span>Main Page</span></a></li>
- <li><a href="modules.html"><span>Modules</span></a></li>
- <li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
- <li><a href="files.html"><span>Files</span></a></li>
- <li><a href="pages.html"><span>Related Pages</span></a></li>
- <li>
- <div id="MSearchBox" class="MSearchBoxInactive">
- <span class="left">
- <img id="MSearchSelect" src="search/mag_sel.png"
- 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.png" alt=""/></a>
- </span>
- </div>
- </li>
- </ul>
- </div>
- <div id="navrow2" class="tabs2">
- <ul class="tablist">
- <li><a href="annotated.html"><span>Data Structures</span></a></li>
- <li><a href="classes.html"><span>Data Structure Index</span></a></li>
- <li><a href="functions.html"><span>Data Fields</span></a></li>
- </ul>
- </div>
-<!-- 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><!-- top -->
-<div class="header">
- <div class="summary">
-<a href="#pub-attribs">Data Fields</a> </div>
- <div class="headertitle">
-<div class="title">GateMP_Params Struct Reference</div> </div>
-</div><!--header-->
-<div class="contents">
-
-<p>Structure defining parameters for the GateMP module.
- <a href="struct_gate_m_p___params.html#details">More...</a></p>
-
-<p><code>#include <<a class="el" href="_gate_m_p_8h_source.html">GateMP.h</a>></code></p>
-<div class="dynheader">
-Collaboration diagram for GateMP_Params:</div>
-<div class="dyncontent">
-<div class="center"><img src="struct_gate_m_p___params__coll__graph.png" border="0" usemap="#_gate_m_p___params_coll__map" alt="Collaboration graph"/></div>
-<map name="_gate_m_p___params_coll__map" id="_gate_m_p___params_coll__map">
-</map>
-</div>
-<table class="memberdecls">
-<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
-Data Fields</h2></td></tr>
-<tr class="memitem:a159f61c6e36fe603775dc4840121969b"><td class="memItemLeft" align="right" valign="top">String </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_gate_m_p___params.html#a159f61c6e36fe603775dc4840121969b">name</a></td></tr>
-<tr class="separator:a159f61c6e36fe603775dc4840121969b"><td class="memSeparator" colspan="2"> </td></tr>
-<tr class="memitem:a5af9a96f1fcf6f29b69c07207a33d453"><td class="memItemLeft" align="right" valign="top">UInt16 </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_gate_m_p___params.html#a5af9a96f1fcf6f29b69c07207a33d453">regionId</a></td></tr>
-<tr class="separator:a5af9a96f1fcf6f29b69c07207a33d453"><td class="memSeparator" colspan="2"> </td></tr>
-<tr class="memitem:ac080433fff177b3d5b1cd5dcafc9e28c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_gate_m_p_8h.html#a3877bd64627d7449d3687e8b06939652">GateMP_LocalProtect</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_gate_m_p___params.html#ac080433fff177b3d5b1cd5dcafc9e28c">localProtect</a></td></tr>
-<tr class="separator:ac080433fff177b3d5b1cd5dcafc9e28c"><td class="memSeparator" colspan="2"> </td></tr>
-<tr class="memitem:a32a1870109d6aa6f583932aff19ebb50"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_gate_m_p_8h.html#a88716d5706d8fa8c6a3b9a4f023ef1d8">GateMP_RemoteProtect</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_gate_m_p___params.html#a32a1870109d6aa6f583932aff19ebb50">remoteProtect</a></td></tr>
-<tr class="separator:a32a1870109d6aa6f583932aff19ebb50"><td class="memSeparator" colspan="2"> </td></tr>
-</table>
-<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
-<div class="textblock"><p>Structure defining parameters for the GateMP module. </p>
-</div><h2 class="groupheader">Field Documentation</h2>
-<a class="anchor" id="a159f61c6e36fe603775dc4840121969b"></a>
-<div class="memitem">
-<div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">String GateMP_Params::name</td>
- </tr>
- </table>
-</div><div class="memdoc">
-<p>Name of this instance.</p>
-<p>The name (if not NULL) must be unique among all GateMP instances in the entire system. The name does not have to be in persistent memory. The supplied string is copied into persistent memory. If no name is supplied, the instance cannot be opened calling <a class="el" href="_gate_m_p_8h.html#acefd091d723ca21a0a02e1e1d5600fc8" title="Open a created GateMP by name. ">GateMP_open()</a>. The max length of the name is defined by the maxNameLen of the NameServer instance. </p>
-
-</div>
-</div>
-<a class="anchor" id="a5af9a96f1fcf6f29b69c07207a33d453"></a>
-<div class="memitem">
-<div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">UInt16 GateMP_Params::regionId</td>
- </tr>
- </table>
-</div><div class="memdoc">
-<p>Shared region ID</p>
-<p>The index corresponding to the shared region from which shared memory is allocated for the instance. If not specified, the default of '0' is used, otherwise the specified SharedRegion is used. The amount of shared memory allocated can be determined by calling GateMP_sharedMemReq(). </p>
-
-</div>
-</div>
-<a class="anchor" id="ac080433fff177b3d5b1cd5dcafc9e28c"></a>
-<div class="memitem">
-<div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="_gate_m_p_8h.html#a3877bd64627d7449d3687e8b06939652">GateMP_LocalProtect</a> GateMP_Params::localProtect</td>
- </tr>
- </table>
-</div><div class="memdoc">
-<p>Local protection level</p>
-<p>The default value is <a class="el" href="_gate_m_p_8h.html#a3877bd64627d7449d3687e8b06939652a257bc8d4b8d6d19bdbe96cae37cbd908">GateMP_LocalProtect_THREAD</a> </p>
-
-</div>
-</div>
-<a class="anchor" id="a32a1870109d6aa6f583932aff19ebb50"></a>
-<div class="memitem">
-<div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="_gate_m_p_8h.html#a88716d5706d8fa8c6a3b9a4f023ef1d8">GateMP_RemoteProtect</a> GateMP_Params::remoteProtect</td>
- </tr>
- </table>
-</div><div class="memdoc">
-<p>Remote protection level</p>
-<p>The default value is <a class="el" href="_gate_m_p_8h.html#a88716d5706d8fa8c6a3b9a4f023ef1d8aba4e153ee33cce1d32dc84254261c557">GateMP_RemoteProtect_SYSTEM</a> </p>
-
-</div>
-</div>
-<hr/>The documentation for this struct was generated from the following file:<ul>
-<li>ti/ipc/<a class="el" href="_gate_m_p_8h_source.html">GateMP.h</a></li>
-</ul>
-</div><!-- contents -->
-<!-- HTML footer for doxygen 1.8.9.1-->
-<!-- start footer part -->
-<hr class="footer"/><small>
-Copyright 2016, Texas Instruments Incorporated
-</small>
-</body>
-</html>