Added JSDoc for Class Members of src/app/channel/*
This commit is contained in:
parent
1aa836ba48
commit
f34ad4829c
110 changed files with 6072 additions and 317 deletions
|
|
@ -62,38 +62,67 @@ class queue{
|
|||
* @param {activeChannel} channel - Parent Channel object for desired channel queue
|
||||
*/
|
||||
constructor(server, chanDB, channel){
|
||||
//Set server
|
||||
/**
|
||||
* Parent Server Object
|
||||
*/
|
||||
this.server = server
|
||||
//Set channel
|
||||
/**
|
||||
* Parent Chennel Object for desired channel queue
|
||||
*/
|
||||
this.channel = channel;
|
||||
|
||||
//Create map to hold currently queued media
|
||||
/**
|
||||
* Map containing current schedule
|
||||
*/
|
||||
this.schedule = new Map();
|
||||
|
||||
//Create variable to hold sync delta in ms
|
||||
/**
|
||||
* Sync Delta in MS
|
||||
*/
|
||||
this.syncDelta = 1000;
|
||||
//Create variable to hold current timestamp within the video
|
||||
/**
|
||||
* Current Timestamp in Media
|
||||
*/
|
||||
this.timestamp = 0;
|
||||
//Delay between pre-switch function call and start of media
|
||||
//This should be enough time to do things like pre-fetch updated raw links from youtube
|
||||
/**
|
||||
* Time before media switch to run pre-switch method call against next media
|
||||
*/
|
||||
this.preSwitchDelta = 10 * 1000;
|
||||
|
||||
//Create variable to hold sync timer
|
||||
/**
|
||||
* Syncronization Timer
|
||||
*/
|
||||
this.syncTimer = null;
|
||||
//Create variable to hold next playing item timer
|
||||
/**
|
||||
* Next Media Timer
|
||||
*/
|
||||
this.nextTimer = null;
|
||||
//Create vairable to hold pre-switch timer
|
||||
/**
|
||||
* Next Media Pre-Switch Timer
|
||||
*/
|
||||
this.preSwitchTimer = null;
|
||||
//Create variable to hold currently playing media object
|
||||
/**
|
||||
* Currently Playing Media Item
|
||||
*/
|
||||
this.nowPlaying = null;
|
||||
//Create variable to hold item that was playing during the last liveStream (can't check against full duration since it might've been stopped for other reasons)
|
||||
/**
|
||||
* Media interrupted by current live-stream
|
||||
*/
|
||||
this.liveRemainder = null;
|
||||
//Create variable to hold current live mode
|
||||
/**
|
||||
* Current live-stream schedule mode
|
||||
*/
|
||||
this.liveMode = null;
|
||||
|
||||
//Create variable to lock standard queuing functions during livestreams
|
||||
/**
|
||||
* Locks scheduling functionality during livestreams
|
||||
*/
|
||||
this.streamLock = false;
|
||||
//create boolean to hold schedule lock
|
||||
/**
|
||||
* Locks schedule upon admin request
|
||||
*/
|
||||
this.locked = false;
|
||||
|
||||
//Rehydrate channel queue from database
|
||||
|
|
@ -1795,7 +1824,7 @@ module.exports = queue;</code></pre>
|
|||
<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>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue