rainbownapkin/canopy
1
0
Fork 0
Code Issues 2 Pull requests Actions Packages Projects Releases Wiki Activity
canopy/www/doc/server/queuedMedia.html

1728 lines
23 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: queuedMedia</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">Class: queuedMedia</h1>
<section>
<header>
<h2><span class="attribs"><span class="type-signature"></span></span>queuedMedia<span class="signature">(startTime, startTimeStamp, earlyEnd, uuid)</span><span class="type-signature"></span></h2>
<div class="class-description">Class extending media which represents a queued piece of media</div>
</header>
<article>
<div class="container-overview">
<h2>Constructor</h2>
<h4 class="name" id="queuedMedia"><span class="type-signature"></span>new queuedMedia<span class="signature">(startTime, startTimeStamp, earlyEnd, uuid)</span><span class="type-signature"></span></h4>
<div class="description">
Creates a new queued media object
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>startTime</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
</td>
<td class="description last">JS Epoch representing start time</td>
</tr>
<tr>
<td class="name"><code>startTimeStamp</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
0
</td>
<td class="description last">Media start time stamp in seconds (relative to duration)</td>
</tr>
<tr>
<td class="name"><code>earlyEnd</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="default">
</td>
<td class="description last">Media end timestamp in seconds (relative to duration)</td>
</tr>
<tr>
<td class="name"><code>uuid</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="default">
</td>
<td class="description last">Media object's unique identifier</td>
</tr>
</tbody>
</table>
<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#line24">line 24</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Extends</h3>
<ul>
<li><a href="media.html">media</a></li>
</ul>
<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>
<h4 class="name" id="genUUID"><span class="type-signature"></span>genUUID<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Generates new unique identifier for queued media
</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#line118">line 118</a>
</li></ul></dd>
</dl>
<h4 class="name" id="getEndTime"><span class="type-signature"></span>getEndTime<span class="signature">(fullTime)</span><span class="type-signature"></span></h4>
<div class="description">
return the end time of a given queuedMedia object
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>fullTime</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="default">
false
</td>
<td class="description last">Overrides early ends</td>
</tr>
</tbody>
</table>
<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#line127">line 127</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
end time of given queuedMedia object
</div>
<h4 class="name" id=".fromMedia"><span class="type-signature">(static) </span>fromMedia<span class="signature">(media, startTime, startTimeStamp)</span><span class="type-signature"> &rarr; {<a href="queuedMedia.html">queuedMedia</a>}</span></h4>
<div class="description">
Creates a queuedMedia object from a media 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>media</code></td>
<td class="type">
<span class="param-type"><a href="media.html">media</a></span>
</td>
<td class="description last">Media object to queue</td>
</tr>
<tr>
<td class="name"><code>startTime</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">Start time formatted as a JS Epoch</td>
</tr>
<tr>
<td class="name"><code>startTimeStamp</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">Start time stamp in seconds</td>
</tr>
</tbody>
</table>
<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#line77">line 77</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
queuedMedia object created from given media object
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="queuedMedia.html">queuedMedia</a></span>
</dd>
</dl>
<h4 class="name" id=".fromMediaArray"><span class="type-signature">(static) </span>fromMediaArray<span class="signature">(mediaList, start)</span><span class="type-signature"></span></h4>
<div class="description">
Converts array of media objects into array of queuedMedia objects
</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>mediaList</code></td>
<td class="type">
<span class="param-type">Array</span>
</td>
<td class="description last">Array of media objects to queue</td>
</tr>
<tr>
<td class="name"><code>start</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">Start time formatted as JS Epoch</td>
</tr>
</tbody>
</table>
<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#line97">line 97</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Array of converted queued media objects
</div>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="activeChannel.html">activeChannel</a></li><li><a href="channelManager.html">channelManager</a></li><li><a href="chat.html">chat</a></li><li><a href="chatBuffer.html">chatBuffer</a></li><li><a href="chatHandler.html">chatHandler</a></li><li><a href="commandPreprocessor.html">commandPreprocessor</a></li><li><a href="commandProcessor.html">commandProcessor</a></li><li><a href="connectedUser.html">connectedUser</a></li><li><a href="media.html">media</a></li><li><a href="playlistHandler.html">playlistHandler</a></li><li><a href="queue.html">queue</a></li><li><a href="queuedMedia.html">queuedMedia</a></li><li><a href="tokebot.html">tokebot</a></li></ul><h3>Global</h3><ul><li><a href="global.html#authenticateSession">authenticateSession</a></li><li><a href="global.html#cache">cache</a></li><li><a href="global.html#channelBanSchema">channelBanSchema</a></li><li><a href="global.html#channelPermissionSchema">channelPermissionSchema</a></li><li><a href="global.html#channelSchema">channelSchema</a></li><li><a href="global.html#chatSchema">chatSchema</a></li><li><a href="global.html#comparePassword">comparePassword</a></li><li><a href="global.html#daysToExpire">daysToExpire</a></li><li><a href="global.html#emailChangeSchema">emailChangeSchema</a></li><li><a href="global.html#emoteSchema">emoteSchema</a></li><li><a href="global.html#escapeRegex">escapeRegex</a></li><li><a href="global.html#failedAttempts">failedAttempts</a></li><li><a href="global.html#fetchMetadata">fetchMetadata</a></li><li><a href="global.html#fetchVideoMetadata">fetchVideoMetadata</a></li><li><a href="global.html#fetchYoutubeMetadata">fetchYoutubeMetadata</a></li><li><a href="global.html#fetchYoutubePlaylistMetadata">fetchYoutubePlaylistMetadata</a></li><li><a href="global.html#flairSchema">flairSchema</a></li><li><a href="global.html#genCaptcha">genCaptcha</a></li><li><a href="global.html#getLoginAttempts">getLoginAttempts</a></li><li><a href="global.html#getMediaType">getMediaType</a></li><li><a href="global.html#hashIP">hashIP</a></li><li><a href="global.html#hashPassword">hashPassword</a></li><li><a href="global.html#kickoff">kickoff</a></li><li><a href="global.html#killSession">killSession</a></li><li><a href="global.html#lifetime">lifetime</a></li><li><a href="global.html#mailem">mailem</a></li><li><a href="global.html#markLink">markLink</a></li><li><a href="global.html#maxAttempts">maxAttempts</a></li><li><a href="global.html#mediaSchema">mediaSchema</a></li><li><a href="global.html#passwordResetSchema">passwordResetSchema</a></li><li><a href="global.html#permissionSchema">permissionSchema</a></li><li><a href="global.html#playlistMediaProperties">playlistMediaProperties</a></li><li><a href="global.html#playlistSchema">playlistSchema</a></li><li><a href="global.html#processExpiredAttempts">processExpiredAttempts</a></li><li><a href="global.html#queuedProperties">queuedProperties</a></li><li><a href="global.html#rankEnum">rankEnum</a></li><li><a href="global.html#refreshRawLink">refreshRawLink</a></li><li><a href="global.html#schedule">schedule</a></li><li><a href="global.html#securityCheck">securityCheck</a></li><li><a href="global.html#sendAddressVerification">sendAddressVerification</a></li><li><a href="global.html#spent">spent</a></li><li><a href="global.html#statSchema">statSchema</a></li><li><a href="global.html#throttleAttempts">throttleAttempts</a></li><li><a href="global.html#tokeCommandSchema">tokeCommandSchema</a></li><li><a href="global.html#transporter">transporter</a></li><li><a href="global.html#typeEnum">typeEnum</a></li><li><a href="global.html#userBanSchema">userBanSchema</a></li><li><a href="global.html#userSchema">userSchema</a></li><li><a href="global.html#verify">verify</a></li><li><a href="global.html#yankMedia">yankMedia</a></li><li><a href="global.html#ytdlpFetch">ytdlpFetch</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.4</a> on Sat Sep 06 2025 01:35:59 GMT-0400 (Eastern Daylight Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>
Reference in a new issue View git blame Copy permalink