Added JSDoc for Class Members of src/app/channel/*

This commit is contained in:
rainbow napkin 2025-09-06 00:32:37 -04:00
parent 1aa836ba48
commit f34ad4829c
110 changed files with 6072 additions and 317 deletions

View file

@ -292,6 +292,789 @@
<h3 class="subsection-title">Members</h3>
<h4 class="name" id="duration"><span class="type-signature"></span>duration<span class="type-signature"></span></h4>
<div class="description">
Length of media in seconds
</div>
<dl class="details">
<dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li>
<a href="media.html#duration">media#duration</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_media_media.js.html">app/channel/media/media.js</a>, <a href="app_channel_media_media.js.html#line60">line 60</a>
</li></ul></dd>
</dl>
<h4 class="name" id="earlyEnd"><span class="type-signature"></span>earlyEnd<span class="type-signature"></span></h4>
<div class="description">
Media ent timestamp in seconds (relative to duration)
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_media_queuedMedia.js.html">app/channel/media/queuedMedia.js</a>, <a href="app_channel_media_queuedMedia.js.html#line49">line 49</a>
</li></ul></dd>
</dl>
<h4 class="name" id="fileName"><span class="type-signature"></span>fileName<span class="type-signature"></span></h4>
<div class="description">
Original filename/title of media provided by source
</div>
<dl class="details">
<dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li>
<a href="media.html#fileName">media#fileName</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_media_media.js.html">app/channel/media/media.js</a>, <a href="app_channel_media_media.js.html#line40">line 40</a>
</li></ul></dd>
</dl>
<h4 class="name" id="id"><span class="type-signature"></span>id<span class="type-signature"></span></h4>
<div class="description">
Video ID from source (IE: youtube watch code/archive.org file path)
</div>
<dl class="details">
<dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li>
<a href="media.html#id">media#id</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_media_media.js.html">app/channel/media/media.js</a>, <a href="app_channel_media_media.js.html#line50">line 50</a>
</li></ul></dd>
</dl>
<h4 class="name" id="rawLink"><span class="type-signature"></span>rawLink<span class="type-signature"></span></h4>
<div class="description">
URL to raw file copy of media, not applicable to all sources
</div>
<dl class="details">
<dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li>
<a href="media.html#rawLink">media#rawLink</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_media_media.js.html">app/channel/media/media.js</a>, <a href="app_channel_media_media.js.html#line65">line 65</a>
</li></ul></dd>
</dl>
<h4 class="name" id="startTime"><span class="type-signature"></span>startTime<span class="type-signature"></span></h4>
<div class="description">
JS Epoch (millis) representing start time
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_media_queuedMedia.js.html">app/channel/media/queuedMedia.js</a>, <a href="app_channel_media_queuedMedia.js.html#line39">line 39</a>
</li></ul></dd>
</dl>
<h4 class="name" id="startTimeStamp"><span class="type-signature"></span>startTimeStamp<span class="type-signature"></span></h4>
<div class="description">
Media start time stamp in seconds (relative to duration)
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_media_queuedMedia.js.html">app/channel/media/queuedMedia.js</a>, <a href="app_channel_media_queuedMedia.js.html#line44">line 44</a>
</li></ul></dd>
</dl>
<h4 class="name" id="status"><span class="type-signature"></span>status<span class="type-signature"></span></h4>
<div class="description">
Media status type
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_media_queuedMedia.js.html">app/channel/media/queuedMedia.js</a>, <a href="app_channel_media_queuedMedia.js.html#line54">line 54</a>
</li></ul></dd>
</dl>
<h4 class="name" id="title"><span class="type-signature"></span>title<span class="type-signature"></span></h4>
<div class="description">
Chosen title of media
</div>
<dl class="details">
<dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li>
<a href="media.html#title">media#title</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_media_media.js.html">app/channel/media/media.js</a>, <a href="app_channel_media_media.js.html#line35">line 35</a>
</li></ul></dd>
</dl>
<h4 class="name" id="type"><span class="type-signature"></span>type<span class="type-signature"></span></h4>
<div class="description">
Original video source
</div>
<dl class="details">
<dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li>
<a href="media.html#type">media#type</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_media_media.js.html">app/channel/media/media.js</a>, <a href="app_channel_media_media.js.html#line55">line 55</a>
</li></ul></dd>
</dl>
<h4 class="name" id="url"><span class="type-signature"></span>url<span class="type-signature"></span></h4>
<div class="description">
Original URL to file
</div>
<dl class="details">
<dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li>
<a href="media.html#url">media#url</a>
</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_media_media.js.html">app/channel/media/media.js</a>, <a href="app_channel_media_media.js.html#line45">line 45</a>
</li></ul></dd>
</dl>
<h4 class="name" id="uuid"><span class="type-signature"></span>uuid<span class="type-signature"></span></h4>
<div class="description">
Media object's unique identifier
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_media_queuedMedia.js.html">app/channel/media/queuedMedia.js</a>, <a href="app_channel_media_queuedMedia.js.html#line65">line 65</a>
</li></ul></dd>
</dl>
<h3 class="subsection-title">Methods</h3>
@ -354,7 +1137,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_media_queuedMedia.js.html">app/channel/media/queuedMedia.js</a>, <a href="app_channel_media_queuedMedia.js.html#line103">line 103</a>
<a href="app_channel_media_queuedMedia.js.html">app/channel/media/queuedMedia.js</a>, <a href="app_channel_media_queuedMedia.js.html#line118">line 118</a>
</li></ul></dd>
@ -499,7 +1282,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_media_queuedMedia.js.html">app/channel/media/queuedMedia.js</a>, <a href="app_channel_media_queuedMedia.js.html#line112">line 112</a>
<a href="app_channel_media_queuedMedia.js.html">app/channel/media/queuedMedia.js</a>, <a href="app_channel_media_queuedMedia.js.html#line127">line 127</a>
</li></ul></dd>
@ -692,7 +1475,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_media_queuedMedia.js.html">app/channel/media/queuedMedia.js</a>, <a href="app_channel_media_queuedMedia.js.html#line62">line 62</a>
<a href="app_channel_media_queuedMedia.js.html">app/channel/media/queuedMedia.js</a>, <a href="app_channel_media_queuedMedia.js.html#line77">line 77</a>
</li></ul></dd>
@ -874,7 +1657,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="app_channel_media_queuedMedia.js.html">app/channel/media/queuedMedia.js</a>, <a href="app_channel_media_queuedMedia.js.html#line82">line 82</a>
<a href="app_channel_media_queuedMedia.js.html">app/channel/media/queuedMedia.js</a>, <a href="app_channel_media_queuedMedia.js.html#line97">line 97</a>
</li></ul></dd>
@ -936,7 +1719,7 @@
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.4</a> on Fri Sep 05 2025 08:36:32 GMT-0400 (Eastern Daylight Time)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.4</a> on Sat Sep 06 2025 00:30:24 GMT-0400 (Eastern Daylight Time)
</footer>
<script> prettyPrint(); </script>