nmos-ledger
Version:
NMOS discovery and registration APIs
879 lines (246 loc) • 11.7 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Global</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Global</h1>
<section>
<header>
<h2></h2>
</header>
<article>
<div class="container-overview">
<dl class="details">
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id="capabilities"><span class="type-signature">(constant) </span>capabilities<span class="type-signature"></span></h4>
<div class="description">
Representation of a capability, a concept to be developed in future versions.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="model_Capabilities.js.html">model/Capabilities.js</a>, <a href="model_Capabilities.js.html#line24">line 24</a>
</li></ul></dd>
</dl>
<h4 class="name" id="deviceTypes"><span class="type-signature">(readonly) </span>deviceTypes<span class="type-signature"> :string</span></h4>
<div class="description">
Types of <a href="Device.html">device</a>.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>pipeline</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Value <code>urn:x-ipstudio:device:pipeline</code>.</td>
</tr>
<tr>
<td class="name"><code>generic</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Value <code>urn:x-ipstudio:device:generic</code>.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="model_DeviceTypes.js.html">model/DeviceTypes.js</a>, <a href="model_DeviceTypes.js.html#line23">line 23</a>
</li></ul></dd>
</dl>
<h4 class="name" id="formats"><span class="type-signature">(readonly) </span>formats<span class="type-signature"> :string</span></h4>
<div class="description">
A URN describing the data format of a video, audio or event
[flow]{@link Flow
<p>Sub-classifications of these core URNs may also be encountered within this
API version (such as urn:x-ipstudio:format:video.raw), and should still be
interpreted correctly by consumers up to the boundaries above.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>video</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Value <code>urn:x-ipstudio:format:video</code>.</td>
</tr>
<tr>
<td class="name"><code>audio</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Value <code>urn:x-ipstudio:format:audio</code>.</td>
</tr>
<tr>
<td class="name"><code>event</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Value <code>urn:x-ipstudio:format:event</code>.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="model_Formats.js.html">model/Formats.js</a>, <a href="model_Formats.js.html#line28">line 28</a>
</li></ul></dd>
</dl>
<h4 class="name" id="transports"><span class="type-signature">(readonly) </span>transports<span class="type-signature"> :string</span></h4>
<div class="description">
A URN describing the protocol used to send data (video, audio, events etc.)
over a network.
<p>For example, an RTP Transmitter sending to a multicast group should use the
transport 'urn:x-ipstudio:transport:rtp.mcast', but a receiver supporting
both unicast and multicast should present the transport
'urn:x-ipstudio:transport:rtp' to indicate its less restrictive state.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>rtp</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Value <code>urn:x-ipstudio:transport:rtp</code>.</td>
</tr>
<tr>
<td class="name"><code>rtp_ucast</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Value <code>urn:x-ipstudio:transport:rtp.ucast</code>.</td>
</tr>
<tr>
<td class="name"><code>rtp_mcast</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Value <code>urn:x-ipstudio:transport:rtp.mcast</code>.</td>
</tr>
<tr>
<td class="name"><code>dash</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Value <code>urn:x-ipstudio:transport:dash</code>.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="model_Transports.js.html">model/Transports.js</a>, <a href="model_Transports.js.html#line29">line 29</a>
</li></ul></dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="statusError"><span class="type-signature"></span>statusError<span class="signature">(status, message)</span><span class="type-signature"> → {Error}</span></h4>
<div class="description">
Add a status code to an error object.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>status</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">Status code for the error.</td>
</tr>
<tr>
<td class="name"><code>message</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Error message describing the error.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="api_NodeStore.js.html">api/NodeStore.js</a>, <a href="api_NodeStore.js.html#line23">line 23</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
The newly created error with status set.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Error</span>
</dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Device.html">Device</a></li><li><a href="Flow.html">Flow</a></li><li><a href="Node.html">Node</a></li><li><a href="NodeAPI.html">NodeAPI</a></li><li><a href="NodeRAMStore.html">NodeRAMStore</a></li><li><a href="Versionned.html">Versionned</a></li></ul><h3>Interfaces</h3><ul><li><a href="NodeStore.html">NodeStore</a></li></ul><h3>Global</h3><ul><li><a href="global.html#capabilities">capabilities</a></li><li><a href="global.html#deviceTypes">deviceTypes</a></li><li><a href="global.html#formats">formats</a></li><li><a href="global.html#statusError">statusError</a></li><li><a href="global.html#transports">transports</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Mon Dec 21 2015 17:19:49 GMT+0000 (GMT)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>