173 lines
9.5 KiB
HTML
173 lines
9.5 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>JSDoc: Source: app/channel/media/queuedMedia.js</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">Source: app/channel/media/queuedMedia.js</h1>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<article>
|
|
<pre class="prettyprint source linenums"><code>/*Canopy - The next generation of stoner streaming software
|
|
Copyright (C) 2024-2025 Rainbownapkin and the TTN Community
|
|
|
|
This program is free software: you can redistribute it and/or modify
|
|
it under the terms of the GNU Affero General Public License as
|
|
published by the Free Software Foundation, either version 3 of the
|
|
License, or (at your option) any later version.
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU Affero General Public License for more details.
|
|
|
|
You should have received a copy of the GNU Affero General Public License
|
|
along with this program. If not, see <https://www.gnu.org/licenses/>.*/
|
|
|
|
//Local Imports
|
|
const media = require('./media');
|
|
|
|
/**
|
|
* Class extending media which represents a queued piece of media
|
|
* @extends media
|
|
*/
|
|
module.exports = class extends media{
|
|
/**
|
|
* Creates a new queued media object
|
|
* @param {Number} startTime - JS Epoch representing start time
|
|
* @param {Number} startTimeStamp - Media start time stamp in seconds (relative to duration)
|
|
* @param {Number} earlyEnd - Media end timestamp in seconds (relative to duration)
|
|
* @param {String} uuid - Media object's unique identifier
|
|
*/
|
|
constructor(title, fileName, url, id, type, duration, rawLink, startTime, startTimeStamp = 0, earlyEnd, uuid){
|
|
//Call derived constructor
|
|
super(title, fileName, url, id, type, duration, rawLink);
|
|
//Set media start time
|
|
this.startTime = startTime;
|
|
//Set the media start time stamp
|
|
this.startTimeStamp = startTimeStamp;
|
|
//Create empty variable to hold early end if media is stopped early
|
|
this.earlyEnd = earlyEnd;
|
|
//Set status for discriminator key
|
|
this.status = 'queued';
|
|
|
|
//If we have a null uuid (can't use default argument because of 'this')
|
|
if(uuid == null){
|
|
//Generate id unique to this specific entry of this specific file within this specific channel's queue
|
|
//That way even if we have six copies of the same video queued, we can still uniquely idenitify each instance
|
|
this.genUUID();
|
|
}else{
|
|
this.uuid = uuid;
|
|
}
|
|
}
|
|
|
|
//statics
|
|
/**
|
|
* Creates a queuedMedia object from a media object
|
|
* @param {media} media - Media object to queue
|
|
* @param {Number} startTime - Start time formatted as a JS Epoch
|
|
* @param {Number} startTimeStamp - Start time stamp in seconds
|
|
* @returns {queuedMedia} queuedMedia object created from given media object
|
|
*/
|
|
static fromMedia(media, startTime, startTimeStamp){
|
|
//Create and return queuedMedia object from given media object and arguments
|
|
return new this(
|
|
media.title,
|
|
media.fileName,
|
|
media.url,
|
|
media.id,
|
|
media.type,
|
|
media.duration,
|
|
media.rawLink,
|
|
startTime,
|
|
startTimeStamp);
|
|
}
|
|
|
|
/**
|
|
* Converts array of media objects into array of queuedMedia objects
|
|
* @param {Array} mediaList - Array of media objects to queue
|
|
* @param {Number} start - Start time formatted as JS Epoch
|
|
* @returns Array of converted queued media objects
|
|
*/
|
|
static fromMediaArray(mediaList, start){
|
|
//Queued Media List
|
|
const queuedMediaList = [];
|
|
//Start Time Offset
|
|
let startOffset = 0;
|
|
|
|
for(let media of mediaList){
|
|
//Convert mediaObj to queuedMedia and push to the back of the list
|
|
queuedMediaList.push(this.fromMedia(media, start + startOffset, 0));
|
|
|
|
//Set start offset to end of the current item
|
|
startOffset += (media.duration * 1000) + 5;
|
|
}
|
|
|
|
return queuedMediaList;
|
|
}
|
|
|
|
//methods
|
|
/**
|
|
* Generates new unique identifier for queued media
|
|
*/
|
|
genUUID(){
|
|
this.uuid = crypto.randomUUID();
|
|
}
|
|
|
|
/**
|
|
* return the end time of a given queuedMedia object
|
|
* @param {boolean} fullTime - Overrides early ends
|
|
* @returns end time of given queuedMedia object
|
|
*/
|
|
getEndTime(fullTime = false){
|
|
//If we have an early ending
|
|
if(this.earlyEnd == null || fullTime){
|
|
//Calculate our ending
|
|
return this.startTime + ((this.duration - this.startTimeStamp) * 1000);
|
|
}else{
|
|
//Return our early end
|
|
return this.startTime + (this.earlyEnd * 1000);
|
|
}
|
|
}
|
|
}</code></pre>
|
|
</article>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<nav>
|
|
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="chat.html">chat</a></li><li><a href="chatBuffer.html">chatBuffer</a></li><li><a href="commandProcessor.html">commandProcessor</a></li><li><a href="module.exports.html">exports</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#consoleWarn">consoleWarn</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#errorHandler">errorHandler</a></li><li><a href="global.html#errorMiddleware">errorMiddleware</a></li><li><a href="global.html#escapeRegex">escapeRegex</a></li><li><a href="global.html#exceptionHandler">exceptionHandler</a></li><li><a href="global.html#exceptionSmith">exceptionSmith</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#localExceptionHandler">localExceptionHandler</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#socketCriticalExceptionHandler">socketCriticalExceptionHandler</a></li><li><a href="global.html#socketErrorHandler">socketErrorHandler</a></li><li><a href="global.html#socketExceptionHandler">socketExceptionHandler</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 Tue Sep 02 2025 07:08:41 GMT-0400 (Eastern Daylight Time)
|
|
</footer>
|
|
|
|
<script> prettyPrint(); </script>
|
|
<script src="scripts/linenumber.js"> </script>
|
|
</body>
|
|
</html>
|