From b683677a2ce75522081d328f6fc4981c4ea2fa56 Mon Sep 17 00:00:00 2001 From: Dmytro Demchenko Date: Thu, 26 Sep 2024 17:31:14 +0300 Subject: [PATCH] Delete docs/v2.0 directory --- docs/v2.0/assets/custom.css | 45 - docs/v2.0/assets/highlight.css | 141 -- docs/v2.0/assets/icons.js | 18 - docs/v2.0/assets/icons.svg | 1 - docs/v2.0/assets/main.js | 60 - docs/v2.0/assets/material-style.css | 247 --- docs/v2.0/assets/navigation.js | 1 - docs/v2.0/assets/search.js | 1 - docs/v2.0/assets/style.css | 1448 ----------------- .../classes/p2p_media_loader_core.Core.html | 253 --- ...2p_media_loader_core.CoreRequestError.html | 180 -- .../p2p_media_loader_core.RequestError.html | 184 --- ...p2p_media_loader_hlsjs.HlsJsP2PEngine.html | 228 --- ...p2p_media_loader_shaka.ShakaP2PEngine.html | 225 --- docs/v2.0/index.html | 280 ---- .../p2p_media_loader_core.SegmentStorage.html | 224 --- docs/v2.0/modules/p2p_media_loader_core.html | 206 --- docs/v2.0/modules/p2p_media_loader_hlsjs.html | 180 -- docs/v2.0/modules/p2p_media_loader_shaka.html | 178 -- .../p2p_media_loader_core.ByteRange.html | 177 -- ...2p_media_loader_core.CommonCoreConfig.html | 194 --- .../p2p_media_loader_core.CoreConfig.html | 184 --- .../p2p_media_loader_core.CoreEventMap.html | 201 --- ...p_media_loader_core.DefinedCoreConfig.html | 177 -- .../p2p_media_loader_core.DownloadSource.html | 177 -- ...p_media_loader_core.DynamicCoreConfig.html | 180 -- ...a_loader_core.DynamicStreamProperties.html | 175 -- ...p2p_media_loader_core.EngineCallbacks.html | 179 -- ...edia_loader_core.HttpRequestErrorType.html | 175 -- .../p2p_media_loader_core.PeerDetails.html | 177 -- ...2p_media_loader_core.PeerErrorDetails.html | 178 -- ...edia_loader_core.PeerRequestErrorType.html | 175 -- ...dia_loader_core.RequestAbortErrorType.html | 175 -- ...2p_media_loader_core.RequestErrorType.html | 175 -- .../types/p2p_media_loader_core.Segment.html | 181 --- ...media_loader_core.SegmentAbortDetails.html | 179 -- ...media_loader_core.SegmentErrorDetails.html | 180 -- ..._media_loader_core.SegmentLoadDetails.html | 180 -- ...p2p_media_loader_core.SegmentResponse.html | 177 -- ...media_loader_core.SegmentStartDetails.html | 178 -- ...p_media_loader_core.SegmentWithStream.html | 175 -- .../types/p2p_media_loader_core.Stream.html | 178 -- .../p2p_media_loader_core.StreamConfig.html | 270 --- .../p2p_media_loader_core.StreamType.html | 175 -- ..._media_loader_core.StreamWithSegments.html | 176 -- ...media_loader_core.TrackerErrorDetails.html | 177 -- ...dia_loader_core.TrackerWarningDetails.html | 176 -- ...der_hlsjs.DynamicHlsJsP2PEngineConfig.html | 176 -- ...dia_loader_hlsjs.HlsJsP2PEngineConfig.html | 176 -- ...p_media_loader_hlsjs.HlsWithP2PConfig.html | 176 -- ...media_loader_hlsjs.HlsWithP2PInstance.html | 177 -- ...der_hlsjs.PartialHlsJsP2PEngineConfig.html | 176 -- ...der_shaka.DynamicShakaP2PEngineConfig.html | 176 -- ...loader_shaka.PartialShakaEngineConfig.html | 176 -- ...dia_loader_shaka.ShakaP2PEngineConfig.html | 176 -- 55 files changed, 10610 deletions(-) delete mode 100644 docs/v2.0/assets/custom.css delete mode 100644 docs/v2.0/assets/highlight.css delete mode 100644 docs/v2.0/assets/icons.js delete mode 100644 docs/v2.0/assets/icons.svg delete mode 100644 docs/v2.0/assets/main.js delete mode 100644 docs/v2.0/assets/material-style.css delete mode 100644 docs/v2.0/assets/navigation.js delete mode 100644 docs/v2.0/assets/search.js delete mode 100644 docs/v2.0/assets/style.css delete mode 100644 docs/v2.0/classes/p2p_media_loader_core.Core.html delete mode 100644 docs/v2.0/classes/p2p_media_loader_core.CoreRequestError.html delete mode 100644 docs/v2.0/classes/p2p_media_loader_core.RequestError.html delete mode 100644 docs/v2.0/classes/p2p_media_loader_hlsjs.HlsJsP2PEngine.html delete mode 100644 docs/v2.0/classes/p2p_media_loader_shaka.ShakaP2PEngine.html delete mode 100644 docs/v2.0/index.html delete mode 100644 docs/v2.0/interfaces/p2p_media_loader_core.SegmentStorage.html delete mode 100644 docs/v2.0/modules/p2p_media_loader_core.html delete mode 100644 docs/v2.0/modules/p2p_media_loader_hlsjs.html delete mode 100644 docs/v2.0/modules/p2p_media_loader_shaka.html delete mode 100644 docs/v2.0/types/p2p_media_loader_core.ByteRange.html delete mode 100644 docs/v2.0/types/p2p_media_loader_core.CommonCoreConfig.html delete mode 100644 docs/v2.0/types/p2p_media_loader_core.CoreConfig.html delete mode 100644 docs/v2.0/types/p2p_media_loader_core.CoreEventMap.html delete mode 100644 docs/v2.0/types/p2p_media_loader_core.DefinedCoreConfig.html delete mode 100644 docs/v2.0/types/p2p_media_loader_core.DownloadSource.html delete mode 100644 docs/v2.0/types/p2p_media_loader_core.DynamicCoreConfig.html delete mode 100644 docs/v2.0/types/p2p_media_loader_core.DynamicStreamProperties.html delete mode 100644 docs/v2.0/types/p2p_media_loader_core.EngineCallbacks.html delete mode 100644 docs/v2.0/types/p2p_media_loader_core.HttpRequestErrorType.html delete mode 100644 docs/v2.0/types/p2p_media_loader_core.PeerDetails.html delete mode 100644 docs/v2.0/types/p2p_media_loader_core.PeerErrorDetails.html delete mode 100644 docs/v2.0/types/p2p_media_loader_core.PeerRequestErrorType.html delete mode 100644 docs/v2.0/types/p2p_media_loader_core.RequestAbortErrorType.html delete mode 100644 docs/v2.0/types/p2p_media_loader_core.RequestErrorType.html delete mode 100644 docs/v2.0/types/p2p_media_loader_core.Segment.html delete mode 100644 docs/v2.0/types/p2p_media_loader_core.SegmentAbortDetails.html delete mode 100644 docs/v2.0/types/p2p_media_loader_core.SegmentErrorDetails.html delete mode 100644 docs/v2.0/types/p2p_media_loader_core.SegmentLoadDetails.html delete mode 100644 docs/v2.0/types/p2p_media_loader_core.SegmentResponse.html delete mode 100644 docs/v2.0/types/p2p_media_loader_core.SegmentStartDetails.html delete mode 100644 docs/v2.0/types/p2p_media_loader_core.SegmentWithStream.html delete mode 100644 docs/v2.0/types/p2p_media_loader_core.Stream.html delete mode 100644 docs/v2.0/types/p2p_media_loader_core.StreamConfig.html delete mode 100644 docs/v2.0/types/p2p_media_loader_core.StreamType.html delete mode 100644 docs/v2.0/types/p2p_media_loader_core.StreamWithSegments.html delete mode 100644 docs/v2.0/types/p2p_media_loader_core.TrackerErrorDetails.html delete mode 100644 docs/v2.0/types/p2p_media_loader_core.TrackerWarningDetails.html delete mode 100644 docs/v2.0/types/p2p_media_loader_hlsjs.DynamicHlsJsP2PEngineConfig.html delete mode 100644 docs/v2.0/types/p2p_media_loader_hlsjs.HlsJsP2PEngineConfig.html delete mode 100644 docs/v2.0/types/p2p_media_loader_hlsjs.HlsWithP2PConfig.html delete mode 100644 docs/v2.0/types/p2p_media_loader_hlsjs.HlsWithP2PInstance.html delete mode 100644 docs/v2.0/types/p2p_media_loader_hlsjs.PartialHlsJsP2PEngineConfig.html delete mode 100644 docs/v2.0/types/p2p_media_loader_shaka.DynamicShakaP2PEngineConfig.html delete mode 100644 docs/v2.0/types/p2p_media_loader_shaka.PartialShakaEngineConfig.html delete mode 100644 docs/v2.0/types/p2p_media_loader_shaka.ShakaP2PEngineConfig.html diff --git a/docs/v2.0/assets/custom.css b/docs/v2.0/assets/custom.css deleted file mode 100644 index 9ed07131..00000000 --- a/docs/v2.0/assets/custom.css +++ /dev/null @@ -1,45 +0,0 @@ -.tsd-filter-visibility { - display: none; -} - -.tsd-typography ul { - margin: 0.2em 0; -} - -.tsd-page-title h2 { - font-size: 32px; -} - -code, -pre { - font-family: Menlo, Monaco, Consolas, "Courier New", monospace !important; -} - -html * { - scrollbar-width: auto; - scrollbar-color: auto; -} - -.tsd-navigation::-webkit-scrollbar { - background-color: #ffffff; - border-radius: 10px; -} - -.tsd-navigation::-webkit-scrollbar-thumb { - background-color: #f6e0bb; - border-radius: 10px; -} - -.tsd-navigation::-webkit-scrollbar-button { - display: none !important; -} - -#tsd-theme { - width: 100%; - padding: 8px; - border: 1px solid #ccc; - border-radius: 5px; - background-color: white; - color: #333; - cursor: pointer; -} diff --git a/docs/v2.0/assets/highlight.css b/docs/v2.0/assets/highlight.css deleted file mode 100644 index 7f3d87ba..00000000 --- a/docs/v2.0/assets/highlight.css +++ /dev/null @@ -1,141 +0,0 @@ -:root { - --light-hl-0: #795E26; - --dark-hl-0: #DCDCAA; - --light-hl-1: #000000; - --dark-hl-1: #D4D4D4; - --light-hl-2: #A31515; - --dark-hl-2: #CE9178; - --light-hl-3: #008000; - --dark-hl-3: #6A9955; - --light-hl-4: #AF00DB; - --dark-hl-4: #C586C0; - --light-hl-5: #001080; - --dark-hl-5: #9CDCFE; - --light-hl-6: #0000FF; - --dark-hl-6: #569CD6; - --light-hl-7: #0070C1; - --dark-hl-7: #4FC1FF; - --light-hl-8: #800000; - --dark-hl-8: #808080; - --light-hl-9: #800000; - --dark-hl-9: #569CD6; - --light-hl-10: #E50000; - --dark-hl-10: #9CDCFE; - --light-hl-11: #000000FF; - --dark-hl-11: #D4D4D4; - --light-hl-12: #0000FF; - --dark-hl-12: #CE9178; - --light-hl-13: #098658; - --dark-hl-13: #B5CEA8; - --light-hl-14: #267F99; - --dark-hl-14: #4EC9B0; - --light-hl-15: #000000; - --dark-hl-15: #C8C8C8; - --light-hl-16: #0451A5; - --dark-hl-16: #9CDCFE; - --light-code-background: #FFFFFF; - --dark-code-background: #1E1E1E; -} - -@media (prefers-color-scheme: light) { :root { - --hl-0: var(--light-hl-0); - --hl-1: var(--light-hl-1); - --hl-2: var(--light-hl-2); - --hl-3: var(--light-hl-3); - --hl-4: var(--light-hl-4); - --hl-5: var(--light-hl-5); - --hl-6: var(--light-hl-6); - --hl-7: var(--light-hl-7); - --hl-8: var(--light-hl-8); - --hl-9: var(--light-hl-9); - --hl-10: var(--light-hl-10); - --hl-11: var(--light-hl-11); - --hl-12: var(--light-hl-12); - --hl-13: var(--light-hl-13); - --hl-14: var(--light-hl-14); - --hl-15: var(--light-hl-15); - --hl-16: var(--light-hl-16); - --code-background: var(--light-code-background); -} } - -@media (prefers-color-scheme: dark) { :root { - --hl-0: var(--dark-hl-0); - --hl-1: var(--dark-hl-1); - --hl-2: var(--dark-hl-2); - --hl-3: var(--dark-hl-3); - --hl-4: var(--dark-hl-4); - --hl-5: var(--dark-hl-5); - --hl-6: var(--dark-hl-6); - --hl-7: var(--dark-hl-7); - --hl-8: var(--dark-hl-8); - --hl-9: var(--dark-hl-9); - --hl-10: var(--dark-hl-10); - --hl-11: var(--dark-hl-11); - --hl-12: var(--dark-hl-12); - --hl-13: var(--dark-hl-13); - --hl-14: var(--dark-hl-14); - --hl-15: var(--dark-hl-15); - --hl-16: var(--dark-hl-16); - --code-background: var(--dark-code-background); -} } - -:root[data-theme='light'] { - --hl-0: var(--light-hl-0); - --hl-1: var(--light-hl-1); - --hl-2: var(--light-hl-2); - --hl-3: var(--light-hl-3); - --hl-4: var(--light-hl-4); - --hl-5: var(--light-hl-5); - --hl-6: var(--light-hl-6); - --hl-7: var(--light-hl-7); - --hl-8: var(--light-hl-8); - --hl-9: var(--light-hl-9); - --hl-10: var(--light-hl-10); - --hl-11: var(--light-hl-11); - --hl-12: var(--light-hl-12); - --hl-13: var(--light-hl-13); - --hl-14: var(--light-hl-14); - --hl-15: var(--light-hl-15); - --hl-16: var(--light-hl-16); - --code-background: var(--light-code-background); -} - -:root[data-theme='dark'] { - --hl-0: var(--dark-hl-0); - --hl-1: var(--dark-hl-1); - --hl-2: var(--dark-hl-2); - --hl-3: var(--dark-hl-3); - --hl-4: var(--dark-hl-4); - --hl-5: var(--dark-hl-5); - --hl-6: var(--dark-hl-6); - --hl-7: var(--dark-hl-7); - --hl-8: var(--dark-hl-8); - --hl-9: var(--dark-hl-9); - --hl-10: var(--dark-hl-10); - --hl-11: var(--dark-hl-11); - --hl-12: var(--dark-hl-12); - --hl-13: var(--dark-hl-13); - --hl-14: var(--dark-hl-14); - --hl-15: var(--dark-hl-15); - --hl-16: var(--dark-hl-16); - --code-background: var(--dark-code-background); -} - -.hl-0 { color: var(--hl-0); } -.hl-1 { color: var(--hl-1); } -.hl-2 { color: var(--hl-2); } -.hl-3 { color: var(--hl-3); } -.hl-4 { color: var(--hl-4); } -.hl-5 { color: var(--hl-5); } -.hl-6 { color: var(--hl-6); } -.hl-7 { color: var(--hl-7); } -.hl-8 { color: var(--hl-8); } -.hl-9 { color: var(--hl-9); } -.hl-10 { color: var(--hl-10); } -.hl-11 { color: var(--hl-11); } -.hl-12 { color: var(--hl-12); } -.hl-13 { color: var(--hl-13); } -.hl-14 { color: var(--hl-14); } -.hl-15 { color: var(--hl-15); } -.hl-16 { color: var(--hl-16); } -pre, code { background: var(--code-background); } diff --git a/docs/v2.0/assets/icons.js b/docs/v2.0/assets/icons.js deleted file mode 100644 index e88e8ca7..00000000 --- a/docs/v2.0/assets/icons.js +++ /dev/null @@ -1,18 +0,0 @@ -(function() { - addIcons(); - function addIcons() { - if (document.readyState === "loading") return document.addEventListener("DOMContentLoaded", addIcons); - const svg = document.body.appendChild(document.createElementNS("http://www.w3.org/2000/svg", "svg")); - svg.innerHTML = `""`; - svg.style.display = "none"; - if (location.protocol === "file:") updateUseElements(); - } - - function updateUseElements() { - document.querySelectorAll("use").forEach(el => { - if (el.getAttribute("href").includes("#icon-")) { - el.setAttribute("href", el.getAttribute("href").replace(/.*#/, "#")); - } - }); - } -})() \ No newline at end of file diff --git a/docs/v2.0/assets/icons.svg b/docs/v2.0/assets/icons.svg deleted file mode 100644 index e371b8b5..00000000 --- a/docs/v2.0/assets/icons.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/docs/v2.0/assets/main.js b/docs/v2.0/assets/main.js deleted file mode 100644 index 35728810..00000000 --- a/docs/v2.0/assets/main.js +++ /dev/null @@ -1,60 +0,0 @@ -"use strict"; -window.translations={"copy":"Copy","copied":"Copied!","normally_hidden":"This member is normally hidden due to your filter settings."}; -"use strict";(()=>{var Pe=Object.create;var ie=Object.defineProperty;var Oe=Object.getOwnPropertyDescriptor;var _e=Object.getOwnPropertyNames;var Re=Object.getPrototypeOf,Me=Object.prototype.hasOwnProperty;var Fe=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var De=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of _e(e))!Me.call(t,i)&&i!==n&&ie(t,i,{get:()=>e[i],enumerable:!(r=Oe(e,i))||r.enumerable});return t};var Ae=(t,e,n)=>(n=t!=null?Pe(Re(t)):{},De(e||!t||!t.__esModule?ie(n,"default",{value:t,enumerable:!0}):n,t));var ue=Fe((ae,le)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(n){e.console&&console.warn&&console.warn(n)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,u],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. -`,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?d+=2:a==l&&(n+=r[u+1]*i[d+1],u+=2,d+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),m=s.str.charAt(1),p;m in s.node.edges?p=s.node.edges[m]:(p=new t.TokenSet,s.node.edges[m]=p),s.str.length==1&&(p.final=!0),i.push({node:p,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof ae=="object"?le.exports=n():e.lunr=n()}(this,function(){return t})})()});var se=[];function G(t,e){se.push({selector:e,constructor:t})}var U=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible()),document.body.style.display||(this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}createComponents(e){se.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}showPage(){document.body.style.display&&(document.body.style.removeProperty("display"),this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}scrollToHash(){if(location.hash){let e=document.getElementById(location.hash.substring(1));if(!e)return;e.scrollIntoView({behavior:"instant",block:"start"})}}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e&&!Ve(e)){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r,document.querySelector(".col-sidebar").scrollTop=r}}updateIndexVisibility(){let e=document.querySelector(".tsd-index-content"),n=e?.open;e&&(e.open=!0),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let i=Array.from(r.querySelectorAll(".tsd-index-link")).every(s=>s.offsetParent==null);r.style.display=i?"none":"block"}),e&&(e.open=n)}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(!n)return;let r=n.offsetParent==null,i=n;for(;i!==document.body;)i instanceof HTMLDetailsElement&&(i.open=!0),i=i.parentElement;if(n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let s=document.createElement("p");s.classList.add("warning"),s.textContent=window.translations.normally_hidden,n.prepend(s)}r&&e.scrollIntoView()}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent=window.translations.copied,e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent=window.translations.copy},100)},1e3)})})}};function Ve(t){let e=t.getBoundingClientRect(),n=Math.max(document.documentElement.clientHeight,window.innerHeight);return!(e.bottom<0||e.top-n>=0)}var oe=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var pe=Ae(ue());async function ce(t,e){if(!window.searchData)return;let n=await fetch(window.searchData),r=new Blob([await n.arrayBuffer()]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();t.data=i,t.index=pe.Index.load(i.index),e.classList.remove("loading"),e.classList.add("ready")}function fe(){let t=document.getElementById("tsd-search");if(!t)return;let e={base:t.dataset.base+"/"},n=document.getElementById("tsd-search-script");t.classList.add("loading"),n&&(n.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),n.addEventListener("load",()=>{ce(e,t)}),ce(e,t));let r=document.querySelector("#tsd-search input"),i=document.querySelector("#tsd-search .results");if(!r||!i)throw new Error("The input field or the result list wrapper was not found");i.addEventListener("mouseup",()=>{te(t)}),r.addEventListener("focus",()=>t.classList.add("has-focus")),He(t,i,r,e)}function He(t,e,n,r){n.addEventListener("input",oe(()=>{Ne(t,e,n,r)},200)),n.addEventListener("keydown",i=>{i.key=="Enter"?Be(e,t):i.key=="ArrowUp"?(de(e,n,-1),i.preventDefault()):i.key==="ArrowDown"&&(de(e,n,1),i.preventDefault())}),document.body.addEventListener("keypress",i=>{i.altKey||i.ctrlKey||i.metaKey||!n.matches(":focus")&&i.key==="/"&&(i.preventDefault(),n.focus())}),document.body.addEventListener("keyup",i=>{t.classList.contains("has-focus")&&(i.key==="Escape"||!e.matches(":focus-within")&&!n.matches(":focus"))&&(n.blur(),te(t))})}function te(t){t.classList.remove("has-focus")}function Ne(t,e,n,r){if(!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s;if(i){let o=i.split(" ").map(a=>a.length?`*${a}*`:"").join(" ");s=r.index.search(o)}else s=[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o`,d=he(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=` - ${he(l.parent,i)}.${d}`);let m=document.createElement("li");m.classList.value=l.classes??"";let p=document.createElement("a");p.href=r.base+l.url,p.innerHTML=u+d,m.append(p),p.addEventListener("focus",()=>{e.querySelector(".current")?.classList.remove("current"),m.classList.add("current")}),e.appendChild(m)}}function de(t,e,n){let r=t.querySelector(".current");if(!r)r=t.querySelector(n==1?"li:first-child":"li:last-child"),r&&r.classList.add("current");else{let i=r;if(n===1)do i=i.nextElementSibling??void 0;while(i instanceof HTMLElement&&i.offsetParent==null);else do i=i.previousElementSibling??void 0;while(i instanceof HTMLElement&&i.offsetParent==null);i?(r.classList.remove("current"),i.classList.add("current")):n===-1&&(r.classList.remove("current"),e.focus())}}function Be(t,e){let n=t.querySelector(".current");if(n||(n=t.querySelector("li:first-child")),n){let r=n.querySelector("a");r&&(window.location.href=r.href),te(e)}}function he(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(ee(t.substring(s,o)),`${ee(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(ee(t.substring(s))),i.join("")}var je={"&":"&","<":"<",">":">","'":"'",'"':"""};function ee(t){return t.replace(/[&<>"'"]/g,e=>je[e])}var I=class{constructor(e){this.el=e.el,this.app=e.app}};var F="mousedown",ye="mousemove",N="mouseup",J={x:0,y:0},me=!1,ne=!1,qe=!1,D=!1,ve=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(ve?"is-mobile":"not-mobile");ve&&"ontouchstart"in document.documentElement&&(qe=!0,F="touchstart",ye="touchmove",N="touchend");document.addEventListener(F,t=>{ne=!0,D=!1;let e=F=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(ye,t=>{if(ne&&!D){let e=F=="touchstart"?t.targetTouches[0]:t,n=J.x-(e.pageX||0),r=J.y-(e.pageY||0);D=Math.sqrt(n*n+r*r)>10}});document.addEventListener(N,()=>{ne=!1});document.addEventListener("click",t=>{me&&(t.preventDefault(),t.stopImmediatePropagation(),me=!1)});var X=class extends I{constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener(N,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(F,n=>this.onDocumentPointerDown(n)),document.addEventListener(N,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){D||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!D&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var re;try{re=localStorage}catch{re={getItem(){return null},setItem(){}}}var Q=re;var ge=document.head.appendChild(document.createElement("style"));ge.dataset.for="filters";var Y=class extends I{constructor(e){super(e),this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),ge.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } -`,this.app.updateIndexVisibility()}fromLocalStorage(){let e=Q.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){Q.setItem(this.key,e.toString()),this.value=e,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),this.app.updateIndexVisibility()}};var Z=class extends I{constructor(e){super(e),this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.dataset.key??this.summary.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`;let n=Q.getItem(this.key);this.el.open=n?n==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update());let r=this.summary.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)}),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function Ee(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,xe(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),xe(t.value)})}function xe(t){document.documentElement.dataset.theme=t}var K;function we(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",Le),Le())}async function Le(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let n=await(await fetch(window.navigationData)).arrayBuffer(),r=new Blob([n]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();K=t.dataset.base,K.endsWith("/")||(K+="/"),t.innerHTML="";for(let s of i)Se(s,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function Se(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-accordion`:"tsd-accordion";let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.dataset.key=i.join("$"),o.innerHTML='',be(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let l=a.appendChild(document.createElement("ul"));l.className="tsd-nested-navigation";for(let u of t.children)Se(u,l,i)}else be(t,r,t.class)}function be(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));r.href=K+t.path,n&&(r.className=n),location.pathname===r.pathname&&r.classList.add("current"),t.kind&&(r.innerHTML=``),r.appendChild(document.createElement("span")).textContent=t.text}else e.appendChild(document.createElement("span")).textContent=t.text}G(X,"a[data-toggle]");G(Z,".tsd-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var Te=document.getElementById("tsd-theme");Te&&Ee(Te);var $e=new U;Object.defineProperty(window,"app",{value:$e});fe();we();})(); -/*! Bundled license information: - -lunr/lunr.js: - (** - * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9 - * Copyright (C) 2020 Oliver Nightingale - * @license MIT - *) - (*! - * lunr.utils - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.Set - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.tokenizer - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.Pipeline - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.Vector - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.stemmer - * Copyright (C) 2020 Oliver Nightingale - * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt - *) - (*! - * lunr.stopWordFilter - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.trimmer - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.TokenSet - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.Index - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.Builder - * Copyright (C) 2020 Oliver Nightingale - *) -*/ diff --git a/docs/v2.0/assets/material-style.css b/docs/v2.0/assets/material-style.css deleted file mode 100644 index b7e1d318..00000000 --- a/docs/v2.0/assets/material-style.css +++ /dev/null @@ -1,247 +0,0 @@ -@import url("https://fonts.googleapis.com/css2?family=Space+Grotesk:wght@300;400;500;600;700&family=Space+Mono:ital,wght@0,400;0,700;1,400;1,700&display=swap"); - -:root, -:root[data-theme="light"], -:root[data-theme="dark"] { - --font-sans: "Space Grotesk", sans-serif; - --font-mono: "Space Mono", monospace; - - --color-background: var(--md-sys-color-surface-container); - --color-background-secondary: var(--md-sys-color-surface-container-high); - --color-background-warning: var(--md-sys-color-error-container); - --color-warning-text: var(--md-sys-color-on-error-container); - --color-icon-background: var(--md-sys-color-on-primary); - --color-accent: var(--md-sys-color-secondary-container); - --color-active-menu-item: var(--md-sys-color-surface-container-highest); - --color-text: var(--md-sys-color-on-surface); - --color-text-aside: var(--md-sys-color-on-surface-variant); - --color-link: var(--md-sys-color-primary); - - --color-ts-project: var(--md-sys-color-secondary); - --color-ts-module: var(--color-ts-project); - --color-ts-namespace: var(--color-ts-project); - - --color-ts-enum: var(--md-sys-color-tertiary); - --color-ts-enum-member: var(--color-ts-enum); - - --color-ts-variable: var(--md-sys-color-primary); - --color-ts-function: var(--md-sys-color-secondary); - --color-ts-class: var(--md-sys-color-tertiary); - --color-ts-interface: var(--md-sys-color-tertiary); - - --color-ts-constructor: var(--md-sys-color-inverse-primary); - - --color-ts-property: var(--md-sys-color-on-background); - --color-ts-method: var(--color-ts-function); - - --color-ts-call-signature: var(--color-ts-method); - --color-ts-index-signature: var(--color-ts-property); /* ? */ - --color-ts-constructor-signature: var(--color-ts-function); - --color-ts-parameter: var(--md-sys-color-primary); - - --color-ts-type-parameter: var(--md-sys-color-tertiary); - --color-ts-accessor: var(--color-ts-property); - --color-ts-get-signature: var(--color-ts-accessor); - --color-ts-set-signature: var(--color-ts-accessor); - --color-ts-type-alias: var(--md-sys-color-tertiary); - - /* --external-icon: var(--md-sys-external-icon); - --color-scheme: var(--md-sys-color-scheme); */ - - --top-app-bar-height: 4.5rem; - --footer-height: 3.5rem; -} - -body { - font-family: var(--font-sans); -} -code, -pre { - font-family: var(--font-mono); -} - -img { - max-width: 100%; -} - -*::-webkit-scrollbar { - width: 8px; - height: 8px; -} -*::-webkit-scrollbar-track { - background: none; -} -*::-webkit-scrollbar-thumb { - border: none; -} - -.container-main { - min-height: calc(100vh - var(--top-app-bar-height) - var(--footer-height)); -} -.col-content { - overflow: hidden; - box-sizing: border-box; - padding: 1.75rem; - border-radius: 28px; - background-color: var(--md-sys-color-surface); -} -.page-menu { - height: fit-content; - padding: 0.75rem 1.75rem; - border-radius: 28px; - background-color: var(--md-sys-color-surface); -} -.site-menu > *, -.page-menu > * { - position: relative; -} -.title { - display: block; - max-width: calc(100% - 5rem); - white-space: nowrap; - overflow: hidden; - text-overflow: ellipsis; - font-size: 22px; -} - -.tsd-page-toolbar { - padding: 8px 0; - height: calc(var(--top-app-bar-height) - 16px); - background-color: var(--color-background); - border-bottom: none; -} -.tsd-page-toolbar .tsd-toolbar-contents { - height: 56px; -} -.tsd-page-toolbar .table-cell { - height: 56px; - margin-left: 1.5rem; -} -.tsd-page-toolbar .tsd-toolbar-icon { - padding: 20px 0; -} -#tsd-search { - line-height: 56px; - border-radius: 22px; -} -#tsd-search .results { - z-index: -1; - top: calc(56px - 22px); - padding-top: 22px; - box-shadow: 0px 4px 2px rgba(0, 0, 0, 0.125); - background-color: var(--color-background-secondary); - border-bottom-left-radius: 22px; - border-bottom-right-radius: 22px; - overflow: hidden; -} -#tsd-search .results li { - background: none; -} -#tsd-search .results a { - padding: 1rem 0.25rem; -} -.col-sidebar { - padding-top: 0; - margin-right: 1rem; -} - -.tsd-signature { - padding: 1rem 1.5rem; - border-radius: 24px; - background-color: var(--md-sys-color-surface-container); -} - -.tsd-page-navigation ul { - padding-left: 0.44rem; -} -.tsd-navigation a, -.tsd-navigation summary > span, -.tsd-page-navigation a { - padding: 0.88rem; - border-radius: 24px; -} -.tsd-navigation a:hover, -.tsd-page-navigation a:hover { - text-decoration: none; - background-color: var(--md-sys-color-surface-container-high); -} -.page-menu .tsd-accordion-summary svg { - position: absolute; - right: 0; -} -.site-menu .tsd-navigation .tsd-accordion-summary { - display: flex; - flex-direction: row-reverse; - width: 100%; -} - -.tsd-small-nested-navigation { - margin-left: 1rem; -} -.tsd-nested-navigation { - margin-left: 2.5rem; -} -.tsd-nested-navigation > li > a, -.tsd-nested-navigation > li > span { - width: 100%; -} -.tsd-navigation > a, -.tsd-navigation .tsd-accordion-summary { - width: 100%; -} -.tsd-index-accordion .tsd-accordion-summary > svg { - position: absolute; - right: 1.5rem; - margin-top: 1rem; -} -.tsd-accordion-summary .tsd-kind-icon ~ span { - margin-right: 2.5rem; -} -.tsd-accordion-summary .tsd-nested-navigation > li > a, -.tsd-nested-navigation > li > span { - width: calc(100% - 0.44rem); -} -.tsd-kind-icon ~ span { - white-space: nowrap; - overflow: hidden; - text-overflow: ellipsis; -} -.tsd-generator { - padding: 0; - border-top: none; - height: var(--footer-height); - line-height: var(--footer-height); -} -.tsd-generator > p { - padding: 0 2rem; -} - -@media (max-width: 769px) { - .container { - padding: 1rem; - } - .col-sidebar { - margin-right: 0; - } -} -@media (min-width: 770px) { - .container-main { - margin: 0 auto; - } - .site-menu { - margin-right: 0.5rem; - } -} -@media (min-width: 1200px) { - .page-menu, - .site-menu { - max-height: calc(100vh - var(--footer-height) - var(--top-app-bar-height)); - top: var(--top-app-bar-height); - } - .page-menu { - margin-left: 1rem; - } - .col-sidebar { - margin-right: 0; - } -} diff --git a/docs/v2.0/assets/navigation.js b/docs/v2.0/assets/navigation.js deleted file mode 100644 index d00a373e..00000000 --- a/docs/v2.0/assets/navigation.js +++ /dev/null @@ -1 +0,0 @@ -window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA6WXb2/TMBCHv4tft8AijT99B12lgUCK2kl7MU3VLbkmpo4dbBeoEN8dNemKkyb12Xt/z+/JOb7o8vCHWfxt2YzVST2tMOcwFQpy1NNMaWQTVoMt2YxVKt8JNK/rpF43Zeu2bH0oe1XaSrAJ23KZs1kyYVnJRa5RstnDSTDv5GUCjBnNm5+FXiXv/05OWSssKpR2ZZWGwknl0qLeQDYa3AV7z3391lVYjVDd7Wsn3u7r8eRTfS/1zYd3V9eJk/xpb3EJsiAGn8p9ucfeiI/bFhMz77kt2waD0v9jXk9T1dS3qAk5dZejmULSfYk3uOES88OdnSu54QUt/AzzevYSKp61D5VqVaO2HIkHNQITncG99TGfZ66qSslQTZ/yW0LzqcntuYZku4T3Lahf8sCu1E5nxM9GlyHO+cqCtjdogQvqAJ6DRNdCa6VjXC5IdH18UnF9uSDR9VVBHqNyOJ8pRQw7OQegZIe/mj7ls9xpyLYxogGQ6LoHLbksYmxdlPKVWfxEab9BTf/OPBO+9CX+2KFpL2ZzCvQVZRD1+W6trY9goG6IpNy+ONsQSTzLuGOMslAXYJchLMJLNLWShrqqdiHKfY7poc9d6mMhCy5xDkI8QbYlTmcPGu7j0bGc/eOUwnx3ZKM/OU0d6S/nVpgvJk3S47PRFoI2fgj1zgtoy0G8wHohgbgcvkB+IcH7XRLmsPanSfpZGguSsBedjrkH0lWh77ODETTOKRCmbOjanA/ZxQEwJWyBMABNHWkAnn80DkDopWgtFxK8K1i8NUZ3nJ0GjVCO4WFdEi7KUIdDF+XxH1icI6EPEgAA" \ No newline at end of file diff --git a/docs/v2.0/assets/search.js b/docs/v2.0/assets/search.js deleted file mode 100644 index beab45ce..00000000 --- a/docs/v2.0/assets/search.js +++ /dev/null @@ -1 +0,0 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA9VdXZPbNrL9L/KrolWD337Ljp0b37ITl51sHqZSLlrCzHAjkbokNfasK//9FkBSagANCvxQJvvk8QzRPGgcNBp9QPLboiy+VIuXt98Wf2T5dvGSLRd5uueLl4sDO3y359ss/W5XpFtefrcpSr5YLo7lbvFysS+2xx2v/nFgh0/yqk/NVZ/EVauHer9bLBebXVpVvFq8XCz+XHZ3ABaf7nGDTbZXW0ze0HaXi0Na8ry2AkY3XjP/dOdXr3/4/te3v3y6+fndu59/+nTz84fXn25+/umHN/8zFM+LXlMDoEqTl/B+/OXD6+/fTYWqW5mAMoAzZTZFXtXlcVMX5WBoatsJgNjaPxPsntc3RX6X3Q/Gg1vOhSY9HHZPr57ydJ9tRsIiTcyGb7t9/cjz+m1W1TznwweRMDAXtpLvi0c+DR5tYy6EFa/fpXl2x6v6A68ORV7xX8vdYJBWM3PhfEirj/x+L5oPxaY0nXGOfqxLnu7HzNFTyxnnQGPzzd1PRc5ff82quhozEUgrc6E8HrZpzUe6TWs8FyZx3VhiqW1nG8vPRVm3Zt8W6TbLRwRc0sa84/h+lz59Tjd/jBxJ1HzGWPb9ps4e+Vv+yHf/zOoyrQdnai9sVmZE+aZ6mz2OQnZqORearEI0ST/vhqOiLMyFbsuruiyeBmM6t5uCJAhPQNoufqyLMr0/+yjLa17epRsrJLXdtK2AOm55VmfpLvvPNDAvFDtDnKV5xAKzyLt5/quc9dtpaClz1wDdXveB/9+RVzOgJuzND7uqi5Lra9kowJql+aGKHKi58FVap9PAGrauAvfXauq8f4GszAIxDALvHKE+faqfDjMhXHU/fAerk93xmFeGXVvBoC7qdHeTHtJNVj9dqy8r/S5z9qzzl6WDx4pvr94/7SbX7d6lXdqozo3esrmHHxHiuuz9zbaaHoNMg1cI8adYd/OQ5vf8Jt3tlBx8XLi3W52/C3pKNwrxuPyuB2ASQXAuCTa7zF9wPBWstyI8XT41wVNh/POp5h/EgDihOF09DUTvquJ+/xej1o1zjy3xs6rTsh4PZ9W1HwXqQmzn+XYCsqb1TLgMQmtBuZfNzbXPxCJ893Ec6vpqGaXymNfZnr9xGysCzgpbGAHsEou+1rzM090EgIqJ+REeUX14KLTj4KKwG6bPg0IlhQxbmB+fjDu/ZPvx+LCFK7Au305Cd24/CzZL/Potqx+08rED0HOreZfnxqa03tyoGpAt4GbXgDUAynNF+vPNRwb6pqPzxHkDzPgw35jqn28TvLQa7aoLmLJ8y7+OBdU1ngOVzuhX/C7L+VaUZzUBug+k0WreadbK2U0f3pfFgZd1xt1CgKXtVQAO9Zreal5QN8V+X+QDMemNnilgkTDGhS7DDba0oVkh3vF9UT61+9a32T5zy+T7AK/6TE/pyoUgszlWdbFXd+I/pOIAzdP0PvUbn7dXV6FRXw9aCN/BPF3pdVbfBB44da8TR5rQOQAIbvCsCc/k2KF03baUV+/Z+1dZJeTYIQkQwUjd1FioF+LCQ3b/8Irv02Yf8VuWb4sv04BbLF4Lf10fXhVfctF8th7YbF6pDwc2exdsJq/UgyrbH3d1mvPiWP2IvDdkZ0atlT1m/4KeiAk4f0c0q1fqxxf++UO9eZd+fccrISB9xCcWRvXBYvF6c+Knov7ANzx7zPJ7UXOtBJOLY/1u4mBcMn29Hr3J0+aEk7TwqhFT5uvVRfNXjMHXGqyLtq/Yp9dlWZQfeF267i97e6FZux7L5oNtGrsS6jTPi2O+4b+U6eYPXk6ETVi7Eu6y1o/mjwKMzVwJad344maX8bz+Fy+rrMjfl/wuG1J5IqD32r3WGv0lLfeDCozUknwyciWUj+kukwdu2ftBMqANMGlvPuyzb68IwGO30gRyyh09obw9AfiR18fD9FCuWfs7D4IOtxsCb4YhMFzRUxRtM96PxbHcuHVJbTJzGaOrvqRl/YrXabZzXHLMds+r1xtIJmn3ij/6S6NzgFxV4+IYYbU/FG+Hs+8SdMPkdXtw4LwcdjLBivxkanbEllkmU8gRswy3e95ZZiCZNMsUf9jOBYhr5oC46ixNBHopJRseFayIJ0WFAZjHRwUr9DmiwoAeDI8KVuRTosIQngw84XmJKtjc7Mgt8ex78ZDfiHiG2z1vPDOQTIpnij/miw82kNPig2L1WvHBCn2O+DCgB8PjgxX5lPgwAPG4+GCnysT40I/cEh9E+XVEeEDNnjc66EAmBQfsjP7Y8Ouw460WlCvF2jTADmdfq7c8v68f5gCumrsq8vGRzQZ+jsDmjn94XLPhnhLW3PGOi2pWhk8Mar249Zj2nvNBezd0/TNFMR3BuPCF+z2dhRZM4+iHjc3KOxvK0YTrRUoxbXCpQG/0jJybqUhguGEe9s278TMszs7D+bd8AzG7V2B64Y4pv1xGqs+dVukcPH2Ids80g2xIxk0iyh/zcPMCzvH0pAzPxdBLoMeQ1Amvhae/pWWe5fcjmKq2fF6uElgmsVXzyqx8tWOdzFjN9IVjac3FM0E/W7sCbuoEtnwb4LvUTULGDZ7t0QkNwtjHJlDXLSN7etmOPH3mlpjY4K1MY2PhzvoAgRva8Q8MGLANR1xy/mvnNeFyb16PWBWezfUS7NjDDb2eb9xwyfGyUjhTXzpb/xWOl2A7xwdzOr5xwyXHf3R+M8Xlvnwc8ZaKZ3O8BNs5PprT8Y0brI4X25ObIs/5ZrLfVVN/b7cjrJ3Xk1m8jp3Q7/RdUc3TjdbQf4HDBdLTgjrPinr2QK+3Z1lKsaG/v7eVRRTmWUXPHrB6++bhmP/RHfebnjqa5v7entfwnvw/z2Kqe6N/FH49zDgGyNh/wQh0aE/+n2dNVT1h9T4up0ztjmbr7+17DPbk+nkWVsUPlzz/24DKxOXu/DaqMvFs3m/hdv5n8yy0mi/spZX2ELlM+OVoOZe3yJbznhX/8XzKfRg2quG80MTaOgoa1XBeaKNgzQsJfzsIWz5Bac06gJkIRHkQK9vzqk73h7EwXmALQyap4oMzumnf5DHhjf82jwWg/QVOgz03vPRpwWQ5+tV9g2XIMY+uzfMe+lJQTDrxdfKB7fARfvP4SGSr7ehXjp/MXTjclebbL9l22NEuEiq2NC9e7dtoI2Kc3mwaB6d/3WvOaGK4ZHpEoSGOFFQcI8vr/D7LT6+GdhNLtTbPFFkoFOMii+4De034uNnwaryTUJH1ZGkC0BlzeCe0Y5UnGjbygtXh7vvV/g6M2as+l7MnSU1WVxtxAL/SQTX0sKv+fea49eOa8jJi7vdsdXbV/4r307Qgnd5s0NyFajkw7DS9mjZ6F8AMjj52e9b37OGPlE5CuWpNTYbqcPQyLcXHiMYPf4+BiSywvF1zPNQeA89G2EuYRvK2z1eT6euIeRSL+2xfJPOPu0q85Pk9e/8mr+o0v/yAw2nqaO1mpu75BgMjq9JqIii8aVD9ezkHpkLMZB8p31b7N9/U77KvWT4BzAvVzITwadnaaDN7GsIV+nnEV5/Ie1jMz7FTs/dp1Ebtgtcnfm/YDnb8p4eHIB71FWI76EkfJB6C+/Q16x+KUraYgpoyNg/m3vV2DqQr4zenGTpki0Xe0eFmtjX6rnm/31/X1dX5jlfu8qXn/v7ynh+er+djP03v0PcrBegRH6zvCdETvl0/BPXnLN/+uJsU4s4mroDP+VO8dnyDv9p2CZ+9NFE9pH+kl0sT8rJBpYnu0w2i4cB9X3OzHgMDc9imj9P2fW6YBu/7Lpqdsu8bhHngvu+y7Yv7vvHU+FtxYm4yXIcFVxn+cePe1p5k4+Fjb2s9cfzxNlvt1uVATjljIpzR+z0rlnH7Pcpc38LcXLlLn1ySPjtW09QV8I5Jf+yQp6Q/Q1APSCztYEckloM8O3jn3+PX0Tv/IYhH7fztoCft/Ifgdk427VgHJ5vD/Hov+l++3x3vs9whae/zqW7qCniP+YyIKWOTMP++bL899/Lb4rF5dffi5YKtvJU4f3uX8d22Wry8bTqzXGyKffvetW2xOcoff28v+xcX64C4uLn6H+vF8na9hGS1TmAJ3Q+s+8FbQrhiLP799+VtZ1e2kb/ozJ9/I23CYnnrLb1gFYaB0hCMhqA0ZIvlrb8M1qsgYkpDZjRkSkNvsbwNqIae0dBTGvqL5W249KKVF3pKQ99o6CsNg8XyNlr6sEoC1TmB0TBQGoaL5W1MNQyNhqHSMFosbxOqYWQ0jJSG8WJ5C2uqZWy0jJWWiWgJlF8To2WiUkAwAtjSD1ZelKgkMOkDGn8EK8Cj7gsEhVQOgWAGkCwCk0ag8kg8SnMLJJPApBKoXALBEAjJxiadQOWTeIjkFiKysUkpUDkFgikQk41NWoHKK/H4xC0kZGOTWqByCwRh2JpsbLILVHqJpwduGckvMAkGKsOY4AxjSy9Z+Wt17jKTYUxlmDg3f8tIhjGTYUyLUoIzjI5TRKBSGcYEZxjJMGYyjKkMY4IzjGQYMxnGVIYxwRlGMoyZDGMqw5jgDCMZxkyGMZVhTHCGkQxjJsOYyjAmOOOtlxCtPFAjCTMZxlSGMcEZj2QYMxnGVIZ5gjMeI5cVk2GeyjAPrAHQMxnmqQzzBGc8kp6eyTBPWwsFZzySnh6xHKoM83zrrPJMhnkqwzzBGS9YemyVeJHa2GSYpzLME5zxQtJhJsM8lWFeZCWJZzLMUxnmSYaRE8MzGeapDPMkw8iJ4ZkM81SG+ZJhCeVt32SYrzLMB2uffZNhvsowX6Zaa8rbvskwX2WYLzjjk7PKNxnmaxmX4IxPziqfSLpUhvmBlSS+yTBfZZgvOOOTs8o3GearDPMFZ3xyVvkmw3yVYb7gjE8Gfd9kmK8yzBec8cmg75sM81WGBYIzPsntwGRYoDIssDMsMBkWqAwL7AwLTIYFKsMCyTAyTQ5MhgUqwwLJMHK5CUyGBVpeLzgTkAlNQKT2KsMCwZmAnBiBybBAZVggOBOQEyMwGRaoDAsEZwKS24HJsEBlWJDYx9lkWKAyLBScCciJEZoMC1WGhYIzATkxQpNhocqwkFlhhybDQpVhodwykrMqNBkWqgwLBWcCclaFJsNClWFhYIdtMizUdo+SYeRyExIbSJVhoWQYOTFCk2GhyrBQcCYkJ0ZoMixUGRYKzoTkxAhNhoUqwyLBmZCcGJHJsEhlWCQ4E5ITIzIZFqkMiwRnQpLbkcmwSGVYJDgTktyOTIZFKsMiWZgg6RmZDItUhkWCMyFJz8hkWKQyLBKcCUmGRSbDIq1GITgTkgyLiDKFyrBIcCYiGRaZDItUhkWCMxHJsMhkWKQyLBaciUiGxSbDYpVhseBMRDIsNhkWqwyLBWcikmGxybBYZVjsWSNJbDIsVhkWC85EJD1jk2GxyrDYHsNik2GxyrBYcCYiq26xybBYZVgsOBOR3I5NhsVaJcy+l4yJWpjKsDixJuuxybBYZViytvY5MRmWqAxLJMNiqqKamAxLVIYlkmHklExMhiUqwxI7wxKTYYnKsERwJiYLj4nJsERlWBJYvZ2YDEtUhiV2hiUmwxKVYUlk97bJsERlWBJbt8CJybBEK7cKzsR0vZUouOoV17V1rJq/qc3R79r2YPV48ze9vVZ3XTOr05u/6e210uvas/q9+ZveXqu+rn2r65u/6e21AuxacCgmF4Hmb3p7rQa7Dnv8T1Rh11oZdi2YFNNV7zVRiF1rldi1IFNMF77XRC12rRVj10nP+BHl2LXGP1nEt4wfVfM3iv5gHz+y7K/xT5byY7p2T1X+9dI/2GMdUMV/vfovC/q2/hP80wUAsFfPgJIAdA1AlvVjWn6gVABdBgB7DQ0oIUBXAmRx39Z/gn+6GCDr+7b+E/zT9ACQJX56uQFCEQBNEgBZ5Y9pBYYQBUBTBYDZt6NA6AKgCQMga/2W/hPSAGjaADD7cguEOgCaPACy4h/TIhIhEICmEADriX+ERgCaSACy7m/rP8E/TScAWfqPaR2LUApAkwpAVv8TWsoixALQ1ALwetZfQi8ATTAAqQEktBpGSAagaQbg9fCPUA1Akw1AKgEJvf4RwgFoygFIMcB2f4J/mngAUg9I6PWPkA9A0w/A6+EfoSCAJiGAVAUSev0kRATQVATw7JsLIHQE0IQEkNpAYtGeCf5pWgL4Pfwj1ATQ5ASQCkFika8J/mmKAvg9/CM0BdBEBZA6QULHX0JWAE1XAL+Hf4SyAJq0AFItSOj4R4gLoKkL4Pfwj9AXQBMYQGoGCR2/CIkBNI0B/B7+ESoDaDIDSOUA1nQAJJQG0KQGCHoISIgNoKkNIAUEWNMRkBAcQFMcIOhhIKE5gCY6gNQRYE2HQEJ3AE14AKklwJqOYYT2AJr4AFJPgDUdhAj9ATQBAqSmAGs6ihAaBGgiBEhdAdZ0GCB0CNCECAia40aWkywEDzUxAqS+QG9DCDUCNDkCpMJAS0dACBKgKRIQNiy0HKYhWKipEtAjSwChS4AmTEDYsJAOBIQ2AZo4AVJvAKAnMqFPgCZQgNQcgD74BYRGAZpIAVJ3oIeQUClAkylAKg+2ISQoqCkVIMUHAHoeE2IFaGoFhHZBDAi9AjTBAqQGAZYTbIRmAZpoAZFdeQVCtgBNtwApRYDlFBwhXYCmXUDUsxkm1AvQ5AuQikTPuVKAYMm81Ro00wQ7NXEDooaddIQi9A3QBA6IehZqQuIATeMAKVvQ51sJkQM0lQOihp10gCSEDtCUDoiaY5l0hCLEDtDUDoh7FmpC7wBN8IDYfsCXUDxAkzwgbshJBzhC9QBN9gCpZIDt1CHBTk36AKlmgOXkIaF+gCZ/gFQ0gNERhlBAQJNAIO7hICGCgKaCgBQ26AhLyCCg6SAgpQ3yMDEQQghoSgjEifVIMRBaCGhiCCTN6WA6PhJ6CGiCCCQ98ZGQREDTREDKHECf4QRCFgFNF4GkoSCdZxHSCGjaCEi5gzxADoQ4Apo6AlLwoFdIQh4BTR8BKXkAfZIUCIkENI0EpOxBnxMEQiUBTSYBqXz0rQ8sotYHQkMBTUQBqYsAfVYVCB0FNCGF9QgpjBBSmCaksLU1PDJCR2GajsLWDTfp47KEkMI0IYWt7Ws3I4QUpgkprBFSaPzEKWNNR2FSFwGPjM6MEFKYJqQwKYyA5dQuoaQwTUlha2twZISQwjQhhUlhBOiDv4xQUpimpDCpjJCTkxFCCtOEFNYIKWRzQkdhmo7CpC5CxnZGyChMk1FY8/wEGdsZIaMwTUZhUhaxnMsnZBSmySiseYqCPvzMCB2FaToKa56koA9AM0JI6X4nH7J65GXNt2+ah61ub08PhH9bfGqfwPLW3UNj3xYsXrz89udy4UXNvz40/wbdv0nzb8jaf4Pm39hr/+3+39pJ2t8Lbbb9IWx/gO5P0N5L6AftD901XtfK6/7k+d0Pp2vaW4nyX/tDd7HfXex3F/vdxUF3cdBdHJ5+aPso9iDtDx3UqLMTd83j7jdJezHreiqi0Mtvf/55fnpN/robJfk3MWyp+IBA1bxxWTwzJ7/dcB4diM6jA4Gbxe2Wiwc2d6cHNs/mkrO1zu3dWImJ42i++XBndpcXOedfs6quFMg+gszcbOZ5ccw3vG6+26CYixA/o9jNnHiEeds8wrxpHw8+G4zP9k6jF3SDljjdAL1ZG/UbEFJRg3CylOXbh53qPxYiO0nobEc+a3loHzRH9jyGZvjazYWfn2pepvm9GioQsG4C+m6kFPaqHc/vVZ/FmCuO0MRfi1y85sEc28A72wtczaHXCZwtoa52YaSLfqK+086dqONN5HivUnXo+SZdROlCzWl6ngLL6Qc3ZlkchPoVukUoYUgGlL34/CyKJZjuzG3iCFtl8/rx9tPPeP4Anj9uvNocq7rYt/Gzqosyved3qRjMJ6XbAeq2W5xrXvSP4K0TDM/Nd1t+lx539aeGs/Idz5/MQUGTwC1edmabQExYRN11BprlfGshDRrpwG1cTg/jn60wJQy1iUY3t5JuJoEj3va7YlVxLDfKnIoQw7vlOWlvl3QTd92t9o4B/7SYkO5BHQvcAkFrT77u6sAOXD4Xb1oWRbEz56JBWJvVoMc2w7aTYbYl7w5lceBlnXFl+QrQLA7cFi+eb5WoiIB5brh4vhUfp1EmFZpVvtuotK46f/EAjwTDs99taTFCXIwmUtJRv5sL4gCLk9WvNS/zdJcpTvOR2323OXS3a18xiEmBF+TELRrd89qkF8pbg26O+90cXw+ze1eU7ZvnMVIPI3W22C4VenTHk4G5sVYYq4uSb1uT2VYB6CF8nrMjm5mlpm+on25L1z2vj1Wq5m4MrV7MbTo8iDd8yK6pjscpWxvG3XA9ZPcPW75Pm8n6Jcu3xRcldCCMoSNGgxcQ4JDpNqXUOKz2Ficl8RhzVFjHGX7ktqI+7KovWf1wYAcqluNcLHab/meD2el15RgjTndiNwI/1PWhW5npIQ4RUMcoKozKSFryutQWmxBN28ht2gpzeVGXfMOzxyy/lzsTAbY41nvVOIphroNU1wec3+rFFnGWAu3nHel0Nlrx+qgk4RFiuyM7m5Z46UAj7QgpyzPx8rrsP2qMwYmsG2Oat4Tvm1emY0LjKBO7OT8Tc26bVennHVfWxgBv+d1YklWoJiMMKv3EMcEtQTGXWtTBLgGITtmw28yQCTARoXF0cRtP+c4mxcZ0dEW+EV+g3aLvIaPNI04+HWsIrcHjgTCHg5VjtlfkxBYUpz+RG4WL/MB5uWm+bI4gKaPgtkC2prrv0iNjeFFzzIkbY0YfE1xRdMwUi1yUlURSfDxs01r1PUPYmKu9lray+qmgw/HRc+VFa83sK44i3kBsBMvwvHfMeU7mumVB9R0iiWP6fzJY1anmO0xez3USVN33xvA0wKMQueXWRd5Wb81ZtcbZie/K3tbcl+6DxtggHojAbSAOTFk419MDnFht+pMdBDN067bIGm25Di7eu42uzO3STZ098mYBassydLqDuOiYNx+YayqFYkTkNg8PzftxL+fSOJ45CgStbVkisRpWhLG1WygSEXfL6zRTS/oxDt+OmsgpeFP28NoCbhmNsKeWDCK0Bnf6VVeHg/VJn+umB3TTAxydzHnZnwvjeOVYVzxQNQvs3cSNXd0LLQ/dCy3xwKPoxxwTqOZFqVbdDUtDnQYZt3ICcyRE60u5ZFocipe7wNURlmr8GnPMsazZP9x4mBwrg2VNCHgRCquONdHymIu4pJXM0KB0onHgNhZE1u2h8Nxp0d0Qd/oirN3WKpwdUdMfOcCxcIszJMJihMA7Vv1QlkRBVKpEbnO7tbjn+6J8arWcXbbPFDcHKGiEbpnJKQHrPpGNSYn3IY7KEM6/KF+iBSl2mzeqfqUkiEosGmJMvO0XDwhO6RzlytaSqBKZdUkfTWffbUWoeN0mI/yR7z5ndZnW6nDgbZwrxjqrdtmj6jWlHOZqZ5/m2Z1IkFqiaB7E8qTrpOvKzZsHoaV3yoISNhCfHXco7adO8AqIcyDH7FXVh9QFEHDm4xapL8tNuAC9dowx2f64q9OcF8cK1xbV3BKFGse9CraLsnjVLJowkePM03dkHhoXz3FYhA1Dy0JYfMfxENIEsUxhqjDHuGzOfazuOLpcGiHEU2TK8cxMY8o4x4Y173a9Tbpca33KXbsDFtAtydCd6mBdxusojzQwZHBsw7fiInyAxDFcfEnLvZaio4GP3UgouFPV6f6grnPKOTI3KtZFne426SHdZLWi5Cvxwa1v7WZ+s8t4XrevfD+U/C5TKtERmsqxG69w0YHKQ3C/HRdQtfBAGcVJg+Mk0unqIxtBx7yw22s5ql/nF/OT+xhcjnc8PNjU97pqn2JOyZQGGCMkTaWa6WZKXYt9RBTfLWocK74lyYxMeW6cexTiu3ATOxARNkJud9TNiBpXjFMh5jZhv/DPZb3Zp1/3vBL6b6XpMyFC5lLc/n25OGQHvhP5wcvb3//88/8BdQfxqIjxAAA="; \ No newline at end of file diff --git a/docs/v2.0/assets/style.css b/docs/v2.0/assets/style.css deleted file mode 100644 index 9d619a64..00000000 --- a/docs/v2.0/assets/style.css +++ /dev/null @@ -1,1448 +0,0 @@ -:root { - /* Light */ - --light-color-background: #f2f4f8; - --light-color-background-secondary: #eff0f1; - --light-color-warning-text: #222; - --light-color-background-warning: #e6e600; - --light-color-icon-background: var(--light-color-background); - --light-color-accent: #c5c7c9; - --light-color-active-menu-item: var(--light-color-accent); - --light-color-text: #222; - --light-color-text-aside: #6e6e6e; - --light-color-link: #1f70c2; - --light-color-focus-outline: #3584e4; - - --light-color-ts-keyword: #056bd6; - --light-color-ts-project: #b111c9; - --light-color-ts-module: var(--light-color-ts-project); - --light-color-ts-namespace: var(--light-color-ts-project); - --light-color-ts-enum: #7e6f15; - --light-color-ts-enum-member: var(--light-color-ts-enum); - --light-color-ts-variable: #4760ec; - --light-color-ts-function: #572be7; - --light-color-ts-class: #1f70c2; - --light-color-ts-interface: #108024; - --light-color-ts-constructor: var(--light-color-ts-class); - --light-color-ts-property: var(--light-color-ts-variable); - --light-color-ts-method: var(--light-color-ts-function); - --light-color-ts-call-signature: var(--light-color-ts-method); - --light-color-ts-index-signature: var(--light-color-ts-property); - --light-color-ts-constructor-signature: var(--light-color-ts-constructor); - --light-color-ts-parameter: var(--light-color-ts-variable); - /* type literal not included as links will never be generated to it */ - --light-color-ts-type-parameter: #a55c0e; - --light-color-ts-accessor: var(--light-color-ts-property); - --light-color-ts-get-signature: var(--light-color-ts-accessor); - --light-color-ts-set-signature: var(--light-color-ts-accessor); - --light-color-ts-type-alias: #d51270; - /* reference not included as links will be colored with the kind that it points to */ - --light-color-document: #000000; - - --light-external-icon: url("data:image/svg+xml;utf8,"); - --light-color-scheme: light; - - /* Dark */ - --dark-color-background: #2b2e33; - --dark-color-background-secondary: #1e2024; - --dark-color-background-warning: #bebe00; - --dark-color-warning-text: #222; - --dark-color-icon-background: var(--dark-color-background-secondary); - --dark-color-accent: #9096a2; - --dark-color-active-menu-item: #5d5d6a; - --dark-color-text: #f5f5f5; - --dark-color-text-aside: #dddddd; - --dark-color-link: #00aff4; - --dark-color-focus-outline: #4c97f2; - - --dark-color-ts-keyword: #3399ff; - --dark-color-ts-project: #e358ff; - --dark-color-ts-module: var(--dark-color-ts-project); - --dark-color-ts-namespace: var(--dark-color-ts-project); - --dark-color-ts-enum: #f4d93e; - --dark-color-ts-enum-member: var(--dark-color-ts-enum); - --dark-color-ts-variable: #798dff; - --dark-color-ts-function: #a280ff; - --dark-color-ts-class: #8ac4ff; - --dark-color-ts-interface: #6cff87; - --dark-color-ts-constructor: var(--dark-color-ts-class); - --dark-color-ts-property: var(--dark-color-ts-variable); - --dark-color-ts-method: var(--dark-color-ts-function); - --dark-color-ts-call-signature: var(--dark-color-ts-method); - --dark-color-ts-index-signature: var(--dark-color-ts-property); - --dark-color-ts-constructor-signature: var(--dark-color-ts-constructor); - --dark-color-ts-parameter: var(--dark-color-ts-variable); - /* type literal not included as links will never be generated to it */ - --dark-color-ts-type-parameter: #e07d13; - --dark-color-ts-accessor: var(--dark-color-ts-property); - --dark-color-ts-get-signature: var(--dark-color-ts-accessor); - --dark-color-ts-set-signature: var(--dark-color-ts-accessor); - --dark-color-ts-type-alias: #ff6492; - /* reference not included as links will be colored with the kind that it points to */ - --dark-color-document: #ffffff; - - --dark-external-icon: url("data:image/svg+xml;utf8,"); - --dark-color-scheme: dark; -} - -@media (prefers-color-scheme: light) { - :root { - --color-background: var(--light-color-background); - --color-background-secondary: var(--light-color-background-secondary); - --color-background-warning: var(--light-color-background-warning); - --color-warning-text: var(--light-color-warning-text); - --color-icon-background: var(--light-color-icon-background); - --color-accent: var(--light-color-accent); - --color-active-menu-item: var(--light-color-active-menu-item); - --color-text: var(--light-color-text); - --color-text-aside: var(--light-color-text-aside); - --color-link: var(--light-color-link); - --color-focus-outline: var(--light-color-focus-outline); - - --color-ts-keyword: var(--light-color-ts-keyword); - --color-ts-module: var(--light-color-ts-module); - --color-ts-namespace: var(--light-color-ts-namespace); - --color-ts-enum: var(--light-color-ts-enum); - --color-ts-enum-member: var(--light-color-ts-enum-member); - --color-ts-variable: var(--light-color-ts-variable); - --color-ts-function: var(--light-color-ts-function); - --color-ts-class: var(--light-color-ts-class); - --color-ts-interface: var(--light-color-ts-interface); - --color-ts-constructor: var(--light-color-ts-constructor); - --color-ts-property: var(--light-color-ts-property); - --color-ts-method: var(--light-color-ts-method); - --color-ts-call-signature: var(--light-color-ts-call-signature); - --color-ts-index-signature: var(--light-color-ts-index-signature); - --color-ts-constructor-signature: var( - --light-color-ts-constructor-signature - ); - --color-ts-parameter: var(--light-color-ts-parameter); - --color-ts-type-parameter: var(--light-color-ts-type-parameter); - --color-ts-accessor: var(--light-color-ts-accessor); - --color-ts-get-signature: var(--light-color-ts-get-signature); - --color-ts-set-signature: var(--light-color-ts-set-signature); - --color-ts-type-alias: var(--light-color-ts-type-alias); - --color-document: var(--light-color-document); - - --external-icon: var(--light-external-icon); - --color-scheme: var(--light-color-scheme); - } -} - -@media (prefers-color-scheme: dark) { - :root { - --color-background: var(--dark-color-background); - --color-background-secondary: var(--dark-color-background-secondary); - --color-background-warning: var(--dark-color-background-warning); - --color-warning-text: var(--dark-color-warning-text); - --color-icon-background: var(--dark-color-icon-background); - --color-accent: var(--dark-color-accent); - --color-active-menu-item: var(--dark-color-active-menu-item); - --color-text: var(--dark-color-text); - --color-text-aside: var(--dark-color-text-aside); - --color-link: var(--dark-color-link); - --color-focus-outline: var(--dark-color-focus-outline); - - --color-ts-keyword: var(--dark-color-ts-keyword); - --color-ts-module: var(--dark-color-ts-module); - --color-ts-namespace: var(--dark-color-ts-namespace); - --color-ts-enum: var(--dark-color-ts-enum); - --color-ts-enum-member: var(--dark-color-ts-enum-member); - --color-ts-variable: var(--dark-color-ts-variable); - --color-ts-function: var(--dark-color-ts-function); - --color-ts-class: var(--dark-color-ts-class); - --color-ts-interface: var(--dark-color-ts-interface); - --color-ts-constructor: var(--dark-color-ts-constructor); - --color-ts-property: var(--dark-color-ts-property); - --color-ts-method: var(--dark-color-ts-method); - --color-ts-call-signature: var(--dark-color-ts-call-signature); - --color-ts-index-signature: var(--dark-color-ts-index-signature); - --color-ts-constructor-signature: var( - --dark-color-ts-constructor-signature - ); - --color-ts-parameter: var(--dark-color-ts-parameter); - --color-ts-type-parameter: var(--dark-color-ts-type-parameter); - --color-ts-accessor: var(--dark-color-ts-accessor); - --color-ts-get-signature: var(--dark-color-ts-get-signature); - --color-ts-set-signature: var(--dark-color-ts-set-signature); - --color-ts-type-alias: var(--dark-color-ts-type-alias); - --color-document: var(--dark-color-document); - - --external-icon: var(--dark-external-icon); - --color-scheme: var(--dark-color-scheme); - } -} - -html { - color-scheme: var(--color-scheme); -} - -body { - margin: 0; -} - -:root[data-theme="light"] { - --color-background: var(--light-color-background); - --color-background-secondary: var(--light-color-background-secondary); - --color-background-warning: var(--light-color-background-warning); - --color-warning-text: var(--light-color-warning-text); - --color-icon-background: var(--light-color-icon-background); - --color-accent: var(--light-color-accent); - --color-active-menu-item: var(--light-color-active-menu-item); - --color-text: var(--light-color-text); - --color-text-aside: var(--light-color-text-aside); - --color-link: var(--light-color-link); - --color-focus-outline: var(--light-color-focus-outline); - - --color-ts-keyword: var(--light-color-ts-keyword); - --color-ts-module: var(--light-color-ts-module); - --color-ts-namespace: var(--light-color-ts-namespace); - --color-ts-enum: var(--light-color-ts-enum); - --color-ts-enum-member: var(--light-color-ts-enum-member); - --color-ts-variable: var(--light-color-ts-variable); - --color-ts-function: var(--light-color-ts-function); - --color-ts-class: var(--light-color-ts-class); - --color-ts-interface: var(--light-color-ts-interface); - --color-ts-constructor: var(--light-color-ts-constructor); - --color-ts-property: var(--light-color-ts-property); - --color-ts-method: var(--light-color-ts-method); - --color-ts-call-signature: var(--light-color-ts-call-signature); - --color-ts-index-signature: var(--light-color-ts-index-signature); - --color-ts-constructor-signature: var( - --light-color-ts-constructor-signature - ); - --color-ts-parameter: var(--light-color-ts-parameter); - --color-ts-type-parameter: var(--light-color-ts-type-parameter); - --color-ts-accessor: var(--light-color-ts-accessor); - --color-ts-get-signature: var(--light-color-ts-get-signature); - --color-ts-set-signature: var(--light-color-ts-set-signature); - --color-ts-type-alias: var(--light-color-ts-type-alias); - --color-document: var(--light-color-document); - - --external-icon: var(--light-external-icon); - --color-scheme: var(--light-color-scheme); -} - -:root[data-theme="dark"] { - --color-background: var(--dark-color-background); - --color-background-secondary: var(--dark-color-background-secondary); - --color-background-warning: var(--dark-color-background-warning); - --color-warning-text: var(--dark-color-warning-text); - --color-icon-background: var(--dark-color-icon-background); - --color-accent: var(--dark-color-accent); - --color-active-menu-item: var(--dark-color-active-menu-item); - --color-text: var(--dark-color-text); - --color-text-aside: var(--dark-color-text-aside); - --color-link: var(--dark-color-link); - --color-focus-outline: var(--dark-color-focus-outline); - - --color-ts-keyword: var(--dark-color-ts-keyword); - --color-ts-module: var(--dark-color-ts-module); - --color-ts-namespace: var(--dark-color-ts-namespace); - --color-ts-enum: var(--dark-color-ts-enum); - --color-ts-enum-member: var(--dark-color-ts-enum-member); - --color-ts-variable: var(--dark-color-ts-variable); - --color-ts-function: var(--dark-color-ts-function); - --color-ts-class: var(--dark-color-ts-class); - --color-ts-interface: var(--dark-color-ts-interface); - --color-ts-constructor: var(--dark-color-ts-constructor); - --color-ts-property: var(--dark-color-ts-property); - --color-ts-method: var(--dark-color-ts-method); - --color-ts-call-signature: var(--dark-color-ts-call-signature); - --color-ts-index-signature: var(--dark-color-ts-index-signature); - --color-ts-constructor-signature: var( - --dark-color-ts-constructor-signature - ); - --color-ts-parameter: var(--dark-color-ts-parameter); - --color-ts-type-parameter: var(--dark-color-ts-type-parameter); - --color-ts-accessor: var(--dark-color-ts-accessor); - --color-ts-get-signature: var(--dark-color-ts-get-signature); - --color-ts-set-signature: var(--dark-color-ts-set-signature); - --color-ts-type-alias: var(--dark-color-ts-type-alias); - --color-document: var(--dark-color-document); - - --external-icon: var(--dark-external-icon); - --color-scheme: var(--dark-color-scheme); -} - -*:focus-visible, -.tsd-accordion-summary:focus-visible svg { - outline: 2px solid var(--color-focus-outline); -} - -.always-visible, -.always-visible .tsd-signatures { - display: inherit !important; -} - -h1, -h2, -h3, -h4, -h5, -h6 { - line-height: 1.2; -} - -h1 { - font-size: 1.875rem; - margin: 0.67rem 0; -} - -h2 { - font-size: 1.5rem; - margin: 0.83rem 0; -} - -h3 { - font-size: 1.25rem; - margin: 1rem 0; -} - -h4 { - font-size: 1.05rem; - margin: 1.33rem 0; -} - -h5 { - font-size: 1rem; - margin: 1.5rem 0; -} - -h6 { - font-size: 0.875rem; - margin: 2.33rem 0; -} - -dl, -menu, -ol, -ul { - margin: 1em 0; -} - -dd { - margin: 0 0 0 40px; -} - -.container { - max-width: 1700px; - padding: 0 2rem; -} - -/* Footer */ -footer { - border-top: 1px solid var(--color-accent); - padding-top: 1rem; - padding-bottom: 1rem; - max-height: 3.5rem; -} -footer > p { - margin: 0 1em; -} - -.container-main { - margin: 0 auto; - /* toolbar, footer, margin */ - min-height: calc(100vh - 41px - 56px - 4rem); -} - -@keyframes fade-in { - from { - opacity: 0; - } - to { - opacity: 1; - } -} -@keyframes fade-out { - from { - opacity: 1; - visibility: visible; - } - to { - opacity: 0; - } -} -@keyframes fade-in-delayed { - 0% { - opacity: 0; - } - 33% { - opacity: 0; - } - 100% { - opacity: 1; - } -} -@keyframes fade-out-delayed { - 0% { - opacity: 1; - visibility: visible; - } - 66% { - opacity: 0; - } - 100% { - opacity: 0; - } -} -@keyframes pop-in-from-right { - from { - transform: translate(100%, 0); - } - to { - transform: translate(0, 0); - } -} -@keyframes pop-out-to-right { - from { - transform: translate(0, 0); - visibility: visible; - } - to { - transform: translate(100%, 0); - } -} -body { - background: var(--color-background); - font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", "Noto Sans", - Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji"; - font-size: 16px; - color: var(--color-text); -} - -a { - color: var(--color-link); - text-decoration: none; -} -a:hover { - text-decoration: underline; -} -a.external[target="_blank"] { - background-image: var(--external-icon); - background-position: top 3px right; - background-repeat: no-repeat; - padding-right: 13px; -} -a.tsd-anchor-link { - color: var(--color-text); -} - -code, -pre { - font-family: Menlo, Monaco, Consolas, "Courier New", monospace; - padding: 0.2em; - margin: 0; - font-size: 0.875rem; - border-radius: 0.8em; -} - -pre { - position: relative; - white-space: pre; - white-space: pre-wrap; - word-wrap: break-word; - padding: 10px; - border: 1px solid var(--color-accent); -} -pre code { - padding: 0; - font-size: 100%; -} -pre > button { - position: absolute; - top: 10px; - right: 10px; - opacity: 0; - transition: opacity 0.1s; - box-sizing: border-box; -} -pre:hover > button, -pre > button.visible { - opacity: 1; -} - -blockquote { - margin: 1em 0; - padding-left: 1em; - border-left: 4px solid gray; -} - -.tsd-typography { - line-height: 1.333em; -} -.tsd-typography ul { - list-style: square; - padding: 0 0 0 20px; - margin: 0; -} -.tsd-typography .tsd-index-panel h3, -.tsd-index-panel .tsd-typography h3, -.tsd-typography h4, -.tsd-typography h5, -.tsd-typography h6 { - font-size: 1em; -} -.tsd-typography h5, -.tsd-typography h6 { - font-weight: normal; -} -.tsd-typography p, -.tsd-typography ul, -.tsd-typography ol { - margin: 1em 0; -} -.tsd-typography table { - border-collapse: collapse; - border: none; -} -.tsd-typography td, -.tsd-typography th { - padding: 6px 13px; - border: 1px solid var(--color-accent); -} -.tsd-typography thead, -.tsd-typography tr:nth-child(even) { - background-color: var(--color-background-secondary); -} - -.tsd-breadcrumb { - margin: 0; - padding: 0; - color: var(--color-text-aside); -} -.tsd-breadcrumb a { - color: var(--color-text-aside); - text-decoration: none; -} -.tsd-breadcrumb a:hover { - text-decoration: underline; -} -.tsd-breadcrumb li { - display: inline; -} -.tsd-breadcrumb li:after { - content: " / "; -} - -.tsd-comment-tags { - display: flex; - flex-direction: column; -} -dl.tsd-comment-tag-group { - display: flex; - align-items: center; - overflow: hidden; - margin: 0.5em 0; -} -dl.tsd-comment-tag-group dt { - display: flex; - margin-right: 0.5em; - font-size: 0.875em; - font-weight: normal; -} -dl.tsd-comment-tag-group dd { - margin: 0; -} -code.tsd-tag { - padding: 0.25em 0.4em; - border: 0.1em solid var(--color-accent); - margin-right: 0.25em; - font-size: 70%; -} -h1 code.tsd-tag:first-of-type { - margin-left: 0.25em; -} - -dl.tsd-comment-tag-group dd:before, -dl.tsd-comment-tag-group dd:after { - content: " "; -} -dl.tsd-comment-tag-group dd pre, -dl.tsd-comment-tag-group dd:after { - clear: both; -} -dl.tsd-comment-tag-group p { - margin: 0; -} - -.tsd-panel.tsd-comment .lead { - font-size: 1.1em; - line-height: 1.333em; - margin-bottom: 2em; -} -.tsd-panel.tsd-comment .lead:last-child { - margin-bottom: 0; -} - -.tsd-filter-visibility h4 { - font-size: 1rem; - padding-top: 0.75rem; - padding-bottom: 0.5rem; - margin: 0; -} -.tsd-filter-item:not(:last-child) { - margin-bottom: 0.5rem; -} -.tsd-filter-input { - display: flex; - width: -moz-fit-content; - width: fit-content; - align-items: center; - -webkit-user-select: none; - -moz-user-select: none; - -ms-user-select: none; - user-select: none; - cursor: pointer; -} -.tsd-filter-input input[type="checkbox"] { - cursor: pointer; - position: absolute; - width: 1.5em; - height: 1.5em; - opacity: 0; -} -.tsd-filter-input input[type="checkbox"]:disabled { - pointer-events: none; -} -.tsd-filter-input svg { - cursor: pointer; - width: 1.5em; - height: 1.5em; - margin-right: 0.5em; - border-radius: 0.33em; - /* Leaving this at full opacity breaks event listeners on Firefox. - Don't remove unless you know what you're doing. */ - opacity: 0.99; -} -.tsd-filter-input input[type="checkbox"]:focus-visible + svg { - outline: 2px solid var(--color-focus-outline); -} -.tsd-checkbox-background { - fill: var(--color-accent); -} -input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { - stroke: var(--color-text); -} -.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-background { - fill: var(--color-background); - stroke: var(--color-accent); - stroke-width: 0.25rem; -} -.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-checkmark { - stroke: var(--color-accent); -} - -.settings-label { - font-weight: bold; - text-transform: uppercase; - display: inline-block; -} - -.tsd-filter-visibility .settings-label { - margin: 0.75rem 0 0.5rem 0; -} - -.tsd-theme-toggle .settings-label { - margin: 0.75rem 0.75rem 0 0; -} - -.tsd-hierarchy { - list-style: square; - margin: 0; -} -.tsd-hierarchy .target { - font-weight: bold; -} - -.tsd-full-hierarchy:not(:last-child) { - margin-bottom: 1em; - padding-bottom: 1em; - border-bottom: 1px solid var(--color-accent); -} -.tsd-full-hierarchy, -.tsd-full-hierarchy ul { - list-style: none; - margin: 0; - padding: 0; -} -.tsd-full-hierarchy ul { - padding-left: 1.5rem; -} -.tsd-full-hierarchy a { - padding: 0.25rem 0 !important; - font-size: 1rem; - display: inline-flex; - align-items: center; - color: var(--color-text); -} - -.tsd-panel-group.tsd-index-group { - margin-bottom: 0; -} -.tsd-index-panel .tsd-index-list { - list-style: none; - line-height: 1.333em; - margin: 0; - padding: 0.25rem 0 0 0; - overflow: hidden; - display: grid; - grid-template-columns: repeat(3, 1fr); - column-gap: 1rem; - grid-template-rows: auto; -} -@media (max-width: 1024px) { - .tsd-index-panel .tsd-index-list { - grid-template-columns: repeat(2, 1fr); - } -} -@media (max-width: 768px) { - .tsd-index-panel .tsd-index-list { - grid-template-columns: repeat(1, 1fr); - } -} -.tsd-index-panel .tsd-index-list li { - -webkit-page-break-inside: avoid; - -moz-page-break-inside: avoid; - -ms-page-break-inside: avoid; - -o-page-break-inside: avoid; - page-break-inside: avoid; -} - -.tsd-flag { - display: inline-block; - padding: 0.25em 0.4em; - border-radius: 4px; - color: var(--color-comment-tag-text); - background-color: var(--color-comment-tag); - text-indent: 0; - font-size: 75%; - line-height: 1; - font-weight: normal; -} - -.tsd-anchor { - position: relative; - top: -100px; -} - -.tsd-member { - position: relative; -} -.tsd-member .tsd-anchor + h3 { - display: flex; - align-items: center; - margin-top: 0; - margin-bottom: 0; - border-bottom: none; -} - -.tsd-navigation.settings { - margin: 1rem 0; -} -.tsd-navigation > a, -.tsd-navigation .tsd-accordion-summary { - width: calc(100% - 0.25rem); - display: flex; - align-items: center; -} -.tsd-navigation a, -.tsd-navigation summary > span, -.tsd-page-navigation a { - display: flex; - width: calc(100% - 0.25rem); - align-items: center; - padding: 0.25rem; - color: var(--color-text); - text-decoration: none; - box-sizing: border-box; -} -.tsd-navigation a.current, -.tsd-page-navigation a.current { - background: var(--color-active-menu-item); -} -.tsd-navigation a:hover, -.tsd-page-navigation a:hover { - text-decoration: underline; -} -.tsd-navigation ul, -.tsd-page-navigation ul { - margin-top: 0; - margin-bottom: 0; - padding: 0; - list-style: none; -} -.tsd-navigation li, -.tsd-page-navigation li { - padding: 0; - max-width: 100%; -} -.tsd-navigation .tsd-nav-link { - display: none; -} -.tsd-nested-navigation { - margin-left: 3rem; -} -.tsd-nested-navigation > li > details { - margin-left: -1.5rem; -} -.tsd-small-nested-navigation { - margin-left: 1.5rem; -} -.tsd-small-nested-navigation > li > details { - margin-left: -1.5rem; -} - -.tsd-page-navigation-section { - margin-left: 10px; -} -.tsd-page-navigation-section > summary { - padding: 0.25rem; -} -.tsd-page-navigation-section > div { - margin-left: 20px; -} -.tsd-page-navigation ul { - padding-left: 1.75rem; -} - -#tsd-sidebar-links a { - margin-top: 0; - margin-bottom: 0.5rem; - line-height: 1.25rem; -} -#tsd-sidebar-links a:last-of-type { - margin-bottom: 0; -} - -a.tsd-index-link { - padding: 0.25rem 0 !important; - font-size: 1rem; - line-height: 1.25rem; - display: inline-flex; - align-items: center; - color: var(--color-text); -} -.tsd-accordion-summary { - list-style-type: none; /* hide marker on non-safari */ - outline: none; /* broken on safari, so just hide it */ -} -.tsd-accordion-summary::-webkit-details-marker { - display: none; /* hide marker on safari */ -} -.tsd-accordion-summary, -.tsd-accordion-summary a { - -moz-user-select: none; - -webkit-user-select: none; - -ms-user-select: none; - user-select: none; - - cursor: pointer; -} -.tsd-accordion-summary a { - width: calc(100% - 1.5rem); -} -.tsd-accordion-summary > * { - margin-top: 0; - margin-bottom: 0; - padding-top: 0; - padding-bottom: 0; -} -.tsd-accordion .tsd-accordion-summary > svg { - margin-left: 0.25rem; - vertical-align: text-top; -} -.tsd-index-content > :not(:first-child) { - margin-top: 0.75rem; -} -.tsd-index-heading { - margin-top: 1.5rem; - margin-bottom: 0.75rem; -} - -.tsd-kind-icon { - margin-right: 0.5rem; - width: 1.25rem; - height: 1.25rem; - min-width: 1.25rem; - min-height: 1.25rem; -} -.tsd-kind-icon path { - transform-origin: center; - transform: scale(1.1); -} -.tsd-signature > .tsd-kind-icon { - margin-right: 0.8rem; -} - -.tsd-panel { - margin-bottom: 2.5rem; -} -.tsd-panel.tsd-member { - margin-bottom: 4rem; -} -.tsd-panel:empty { - display: none; -} -.tsd-panel > h1, -.tsd-panel > h2, -.tsd-panel > h3 { - margin: 1.5rem -1.5rem 0.75rem -1.5rem; - padding: 0 1.5rem 0.75rem 1.5rem; -} -.tsd-panel > h1.tsd-before-signature, -.tsd-panel > h2.tsd-before-signature, -.tsd-panel > h3.tsd-before-signature { - margin-bottom: 0; - border-bottom: none; -} - -.tsd-panel-group { - margin: 2rem 0; -} -.tsd-panel-group.tsd-index-group { - margin: 2rem 0; -} -.tsd-panel-group.tsd-index-group details { - margin: 2rem 0; -} -.tsd-panel-group > .tsd-accordion-summary { - margin-bottom: 1rem; -} - -#tsd-search { - transition: background-color 0.2s; -} -#tsd-search .title { - position: relative; - z-index: 2; -} -#tsd-search .field { - position: absolute; - left: 0; - top: 0; - right: 2.5rem; - height: 100%; -} -#tsd-search .field input { - box-sizing: border-box; - position: relative; - top: -50px; - z-index: 1; - width: 100%; - padding: 0 10px; - opacity: 0; - outline: 0; - border: 0; - background: transparent; - color: var(--color-text); -} -#tsd-search .field label { - position: absolute; - overflow: hidden; - right: -40px; -} -#tsd-search .field input, -#tsd-search .title, -#tsd-toolbar-links a { - transition: opacity 0.2s; -} -#tsd-search .results { - position: absolute; - visibility: hidden; - top: 40px; - width: 100%; - margin: 0; - padding: 0; - list-style: none; - box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); -} -#tsd-search .results li { - background-color: var(--color-background); - line-height: initial; - padding: 4px; -} -#tsd-search .results li:nth-child(even) { - background-color: var(--color-background-secondary); -} -#tsd-search .results li.state { - display: none; -} -#tsd-search .results li.current:not(.no-results), -#tsd-search .results li:hover:not(.no-results) { - background-color: var(--color-accent); -} -#tsd-search .results a { - display: flex; - align-items: center; - padding: 0.25rem; - box-sizing: border-box; -} -#tsd-search .results a:before { - top: 10px; -} -#tsd-search .results span.parent { - color: var(--color-text-aside); - font-weight: normal; -} -#tsd-search.has-focus { - background-color: var(--color-accent); -} -#tsd-search.has-focus .field input { - top: 0; - opacity: 1; -} -#tsd-search.has-focus .title, -#tsd-search.has-focus #tsd-toolbar-links a { - z-index: 0; - opacity: 0; -} -#tsd-search.has-focus .results { - visibility: visible; -} -#tsd-search.loading .results li.state.loading { - display: block; -} -#tsd-search.failure .results li.state.failure { - display: block; -} - -#tsd-toolbar-links { - position: absolute; - top: 0; - right: 2rem; - height: 100%; - display: flex; - align-items: center; - justify-content: flex-end; -} -#tsd-toolbar-links a { - margin-left: 1.5rem; -} -#tsd-toolbar-links a:hover { - text-decoration: underline; -} - -.tsd-signature { - margin: 0 0 1rem 0; - padding: 1rem 0.5rem; - border: 1px solid var(--color-accent); - font-family: Menlo, Monaco, Consolas, "Courier New", monospace; - font-size: 14px; - overflow-x: auto; -} - -.tsd-signature-keyword { - color: var(--color-ts-keyword); - font-weight: normal; -} - -.tsd-signature-symbol { - color: var(--color-text-aside); - font-weight: normal; -} - -.tsd-signature-type { - font-style: italic; - font-weight: normal; -} - -.tsd-signatures { - padding: 0; - margin: 0 0 1em 0; - list-style-type: none; -} -.tsd-signatures .tsd-signature { - margin: 0; - border-color: var(--color-accent); - border-width: 1px 0; - transition: background-color 0.1s; -} -.tsd-signatures .tsd-index-signature:not(:last-child) { - margin-bottom: 1em; -} -.tsd-signatures .tsd-index-signature .tsd-signature { - border-width: 1px; -} -.tsd-description .tsd-signatures .tsd-signature { - border-width: 1px; -} - -ul.tsd-parameter-list, -ul.tsd-type-parameter-list { - list-style: square; - margin: 0; - padding-left: 20px; -} -ul.tsd-parameter-list > li.tsd-parameter-signature, -ul.tsd-type-parameter-list > li.tsd-parameter-signature { - list-style: none; - margin-left: -20px; -} -ul.tsd-parameter-list h5, -ul.tsd-type-parameter-list h5 { - font-size: 16px; - margin: 1em 0 0.5em 0; -} -.tsd-sources { - margin-top: 1rem; - font-size: 0.875em; -} -.tsd-sources a { - color: var(--color-text-aside); - text-decoration: underline; -} -.tsd-sources ul { - list-style: none; - padding: 0; -} - -.tsd-page-toolbar { - position: sticky; - z-index: 1; - top: 0; - left: 0; - width: 100%; - color: var(--color-text); - background: var(--color-background-secondary); - border-bottom: 1px var(--color-accent) solid; - transition: transform 0.3s ease-in-out; -} -.tsd-page-toolbar a { - color: var(--color-text); - text-decoration: none; -} -.tsd-page-toolbar a.title { - font-weight: bold; -} -.tsd-page-toolbar a.title:hover { - text-decoration: underline; -} -.tsd-page-toolbar .tsd-toolbar-contents { - display: flex; - justify-content: space-between; - height: 2.5rem; - margin: 0 auto; -} -.tsd-page-toolbar .table-cell { - position: relative; - white-space: nowrap; - line-height: 40px; -} -.tsd-page-toolbar .table-cell:first-child { - width: 100%; -} -.tsd-page-toolbar .tsd-toolbar-icon { - box-sizing: border-box; - line-height: 0; - padding: 12px 0; -} - -.tsd-widget { - display: inline-block; - overflow: hidden; - opacity: 0.8; - height: 40px; - transition: - opacity 0.1s, - background-color 0.2s; - vertical-align: bottom; - cursor: pointer; -} -.tsd-widget:hover { - opacity: 0.9; -} -.tsd-widget.active { - opacity: 1; - background-color: var(--color-accent); -} -.tsd-widget.no-caption { - width: 40px; -} -.tsd-widget.no-caption:before { - margin: 0; -} - -.tsd-widget.options, -.tsd-widget.menu { - display: none; -} -input[type="checkbox"] + .tsd-widget:before { - background-position: -120px 0; -} -input[type="checkbox"]:checked + .tsd-widget:before { - background-position: -160px 0; -} - -img { - max-width: 100%; -} - -.tsd-anchor-icon { - display: inline-flex; - align-items: center; - margin-left: 0.5rem; - vertical-align: middle; - color: var(--color-text); -} - -.tsd-anchor-icon svg { - width: 1em; - height: 1em; - visibility: hidden; -} - -.tsd-anchor-link:hover > .tsd-anchor-icon svg { - visibility: visible; -} - -.deprecated { - text-decoration: line-through !important; -} - -.warning { - padding: 1rem; - color: var(--color-warning-text); - background: var(--color-background-warning); -} - -.tsd-kind-project { - color: var(--color-ts-project); -} -.tsd-kind-module { - color: var(--color-ts-module); -} -.tsd-kind-namespace { - color: var(--color-ts-namespace); -} -.tsd-kind-enum { - color: var(--color-ts-enum); -} -.tsd-kind-enum-member { - color: var(--color-ts-enum-member); -} -.tsd-kind-variable { - color: var(--color-ts-variable); -} -.tsd-kind-function { - color: var(--color-ts-function); -} -.tsd-kind-class { - color: var(--color-ts-class); -} -.tsd-kind-interface { - color: var(--color-ts-interface); -} -.tsd-kind-constructor { - color: var(--color-ts-constructor); -} -.tsd-kind-property { - color: var(--color-ts-property); -} -.tsd-kind-method { - color: var(--color-ts-method); -} -.tsd-kind-call-signature { - color: var(--color-ts-call-signature); -} -.tsd-kind-index-signature { - color: var(--color-ts-index-signature); -} -.tsd-kind-constructor-signature { - color: var(--color-ts-constructor-signature); -} -.tsd-kind-parameter { - color: var(--color-ts-parameter); -} -.tsd-kind-type-literal { - color: var(--color-ts-type-literal); -} -.tsd-kind-type-parameter { - color: var(--color-ts-type-parameter); -} -.tsd-kind-accessor { - color: var(--color-ts-accessor); -} -.tsd-kind-get-signature { - color: var(--color-ts-get-signature); -} -.tsd-kind-set-signature { - color: var(--color-ts-set-signature); -} -.tsd-kind-type-alias { - color: var(--color-ts-type-alias); -} - -/* if we have a kind icon, don't color the text by kind */ -.tsd-kind-icon ~ span { - color: var(--color-text); -} - -* { - scrollbar-width: thin; - scrollbar-color: var(--color-accent) var(--color-icon-background); -} - -*::-webkit-scrollbar { - width: 0.75rem; -} - -*::-webkit-scrollbar-track { - background: var(--color-icon-background); -} - -*::-webkit-scrollbar-thumb { - background-color: var(--color-accent); - border-radius: 999rem; - border: 0.25rem solid var(--color-icon-background); -} - -/* mobile */ -@media (max-width: 769px) { - .tsd-widget.options, - .tsd-widget.menu { - display: inline-block; - } - - .container-main { - display: flex; - } - html .col-content { - float: none; - max-width: 100%; - width: 100%; - } - html .col-sidebar { - position: fixed !important; - overflow-y: auto; - -webkit-overflow-scrolling: touch; - z-index: 1024; - top: 0 !important; - bottom: 0 !important; - left: auto !important; - right: 0 !important; - padding: 1.5rem 1.5rem 0 0; - width: 75vw; - visibility: hidden; - background-color: var(--color-background); - transform: translate(100%, 0); - } - html .col-sidebar > *:last-child { - padding-bottom: 20px; - } - html .overlay { - content: ""; - display: block; - position: fixed; - z-index: 1023; - top: 0; - left: 0; - right: 0; - bottom: 0; - background-color: rgba(0, 0, 0, 0.75); - visibility: hidden; - } - - .to-has-menu .overlay { - animation: fade-in 0.4s; - } - - .to-has-menu .col-sidebar { - animation: pop-in-from-right 0.4s; - } - - .from-has-menu .overlay { - animation: fade-out 0.4s; - } - - .from-has-menu .col-sidebar { - animation: pop-out-to-right 0.4s; - } - - .has-menu body { - overflow: hidden; - } - .has-menu .overlay { - visibility: visible; - } - .has-menu .col-sidebar { - visibility: visible; - transform: translate(0, 0); - display: flex; - flex-direction: column; - gap: 1.5rem; - max-height: 100vh; - padding: 1rem 2rem; - } - .has-menu .tsd-navigation { - max-height: 100%; - } - #tsd-toolbar-links { - display: none; - } - .tsd-navigation .tsd-nav-link { - display: flex; - } -} - -/* one sidebar */ -@media (min-width: 770px) { - .container-main { - display: grid; - grid-template-columns: minmax(0, 1fr) minmax(0, 2fr); - grid-template-areas: "sidebar content"; - margin: 2rem auto; - } - - .col-sidebar { - grid-area: sidebar; - } - .col-content { - grid-area: content; - padding: 0 1rem; - } -} -@media (min-width: 770px) and (max-width: 1399px) { - .col-sidebar { - max-height: calc(100vh - 2rem - 42px); - overflow: auto; - position: sticky; - top: 42px; - padding-top: 1rem; - } - .site-menu { - margin-top: 1rem; - } -} - -/* two sidebars */ -@media (min-width: 1200px) { - .container-main { - grid-template-columns: minmax(0, 1fr) minmax(0, 2.5fr) minmax(0, 20rem); - grid-template-areas: "sidebar content toc"; - } - - .col-sidebar { - display: contents; - } - - .page-menu { - grid-area: toc; - padding-left: 1rem; - } - .site-menu { - grid-area: sidebar; - } - - .site-menu { - margin-top: 1rem 0; - } - - .page-menu, - .site-menu { - max-height: calc(100vh - 2rem - 42px); - overflow: auto; - position: sticky; - top: 42px; - } -} diff --git a/docs/v2.0/classes/p2p_media_loader_core.Core.html b/docs/v2.0/classes/p2p_media_loader_core.Core.html deleted file mode 100644 index f338901f..00000000 --- a/docs/v2.0/classes/p2p_media_loader_core.Core.html +++ /dev/null @@ -1,253 +0,0 @@ -Core | P2P Media Loader Documentation

Class Core<TStream>

Core class for managing media streams loading via P2P.

-

Type Parameters

Constructors

constructor -

Properties

DEFAULT_COMMON_CORE_CONFIG -DEFAULT_STREAM_CONFIG -

Methods

getConfig -applyDynamicConfig -addEventListener -removeEventListener -setManifestResponseUrl -hasSegment -getStream -addStreamIfNoneExists -updateStream -loadSegment -abortSegmentLoading -updatePlayback -setActiveLevelBitrate -setIsLive -isSegmentLoadable -destroy -

Constructors

constructor

  • new Core<TStream>(config?): Core<TStream>

  • Constructs a new Core instance with optional initial configuration.

    -

    Type Parameters

    Parameters

    • Optionalconfig: Partial<CoreConfig>

      Optional partial configuration to override default settings.

      -

    Returns Core<TStream>

    Example

    // Create a Core instance with custom configuration for HTTP and P2P downloads.
    const core = new Core({
      simultaneousHttpDownloads: 5,
      simultaneousP2PDownloads: 5,
      httpErrorRetries: 5,
      p2pErrorRetries: 5
    });
-
    - -

    Example

    // Create a Core instance using the default configuration.
    const core = new Core();
-
    - -

Properties

Static ReadonlyDEFAULT_COMMON_CORE_CONFIG

DEFAULT_COMMON_CORE_CONFIG: CommonCoreConfig = ...

Default configuration for common core settings.

-

Static ReadonlyDEFAULT_STREAM_CONFIG

DEFAULT_STREAM_CONFIG: StreamConfig = ...

Default configuration for stream settings.

-

Methods

getConfig

applyDynamicConfig

  • applyDynamicConfig(dynamicConfig): void

  • Applies a set of dynamic configuration updates to the core, merging with the existing configuration.

    -

    Parameters

    Returns void

    Example

    // Example of dynamically updating the download time windows and timeout settings.
    const dynamicConfig = {
      httpDownloadTimeWindowMs: 60,  // Set HTTP download time window to 60 seconds
      p2pDownloadTimeWindowMs: 60,   // Set P2P download time window to 60 seconds
      httpNotReceivingBytesTimeoutMs: 1500,  // Set HTTP timeout to 1500 milliseconds
      p2pNotReceivingBytesTimeoutMs: 1500    // Set P2P timeout to 1500 milliseconds
    };
    core.applyDynamicConfig(dynamicConfig);
-
    - -

addEventListener

  • addEventListener<K>(eventName, listener): void

  • Adds an event listener for the specified event type on the core event target.

    -

    Type Parameters

    Parameters

    • eventName: K

      The name of the event to listen for.

      -
    • listener: CoreEventMap[K]

      The callback function to invoke when the event is fired.

      -

    Returns void

removeEventListener

  • removeEventListener<K>(eventName, listener): void

  • Removes an event listener for the specified event type on the core event target.

    -

    Type Parameters

    Parameters

    • eventName: K

      The name of the event to listen for.

      -
    • listener: CoreEventMap[K]

      The callback function to be removed.

      -

    Returns void

setManifestResponseUrl

  • setManifestResponseUrl(url): void

  • Sets the response URL for the manifest, stripping any query parameters.

    -

    Parameters

    • url: string

      The full URL to the manifest response.

      -

    Returns void

hasSegment

  • hasSegment(segmentRuntimeId): boolean

  • Checks if a segment is already stored within the core.

    -

    Parameters

    • segmentRuntimeId: string

      The runtime identifier of the segment to check.

      -

    Returns boolean

    true if the segment is present, otherwise false.

    -

getStream

  • getStream(streamRuntimeId): undefined | StreamWithSegments<TStream>

  • Retrieves a specific stream by its runtime identifier, if it exists.

    -

    Parameters

    • streamRuntimeId: string

      The runtime identifier of the stream to retrieve.

      -

    Returns undefined | StreamWithSegments<TStream>

    The stream with its segments, or undefined if not found.

    -

addStreamIfNoneExists

  • addStreamIfNoneExists(stream): void

  • Ensures a stream exists in the map; adds it if it does not.

    -

    Parameters

    • stream: TStream

      The stream to potentially add to the map.

      -

    Returns void

updateStream

  • updateStream(streamRuntimeId, addSegments?, removeSegmentIds?): void

  • Updates the segments associated with a specific stream.

    -

    Parameters

    • streamRuntimeId: string

      The runtime identifier of the stream to update.

      -
    • OptionaladdSegments: Iterable<Segment>

      Optional segments to add to the stream.

      -
    • OptionalremoveSegmentIds: Iterable<string>

      Optional segment IDs to remove from the stream.

      -

    Returns void

loadSegment

  • loadSegment(segmentRuntimeId, callbacks): Promise<void>

  • Loads a segment given its runtime identifier and invokes the provided callbacks during the process. -Initializes segment storage if it has not been initialized yet.

    -

    Parameters

    • segmentRuntimeId: string

      The runtime identifier of the segment to load.

      -
    • callbacks: EngineCallbacks

      The callbacks to be invoked during segment loading.

      -

    Returns Promise<void>

    Throws

      -
    • Throws if the manifest response URL is not defined.
      • -
    -

abortSegmentLoading

  • abortSegmentLoading(segmentRuntimeId): void

  • Aborts the loading of a segment specified by its runtime identifier.

    -

    Parameters

    • segmentRuntimeId: string

      The runtime identifier of the segment whose loading is to be aborted.

      -

    Returns void

updatePlayback

  • updatePlayback(position, rate): void

  • Updates the playback parameters while play head moves, specifically position and playback rate, for stream loaders.

    -

    Parameters

    • position: number

      The new position in the stream, in seconds.

      -
    • rate: number

      The new playback rate.

      -

    Returns void

setActiveLevelBitrate

  • setActiveLevelBitrate(bitrate): void

  • Sets the active level bitrate, used for adjusting quality levels in adaptive streaming. -Notifies the stream loaders if a change occurs.

    -

    Parameters

    • bitrate: number

      The new bitrate to set as active.

      -

    Returns void

setIsLive

  • setIsLive(isLive): void

  • Updates the 'isLive' status of the stream

    -

    Parameters

    • isLive: boolean

      Boolean indicating whether the stream is live.

      -

    Returns void

isSegmentLoadable

  • isSegmentLoadable(segmentRuntimeId): boolean

  • Identify if a segment is loadable by the P2P core based on the segment's stream type and configuration.

    -

    Parameters

    • segmentRuntimeId: string

      Segment runtime identifier to check.

      -

    Returns boolean

    true if the segment is loadable by the P2P core, otherwise false.

    -

destroy

  • destroy(): void

  • Cleans up resources used by the Core instance, including destroying any active stream loaders -and clearing stored segments.

    -

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/v2.0/classes/p2p_media_loader_core.CoreRequestError.html b/docs/v2.0/classes/p2p_media_loader_core.CoreRequestError.html deleted file mode 100644 index c2dba0c0..00000000 --- a/docs/v2.0/classes/p2p_media_loader_core.CoreRequestError.html +++ /dev/null @@ -1,180 +0,0 @@ -CoreRequestError | P2P Media Loader Documentation

Class CoreRequestError

Custom error class for errors that occur during core network requests.

-

Hierarchy

  • Error
    • CoreRequestError

Constructors

constructor -

Properties

type -

Constructors

constructor

  • new CoreRequestError(type): CoreRequestError

  • Constructs a new CoreRequestError.

    -

    Parameters

    • type: "failed" | "aborted"

      The type of the error, either 'failed' or 'aborted'.

      -

    Returns CoreRequestError

Properties

Readonlytype

type: "failed" | "aborted"

The type of the error, either 'failed' or 'aborted'.

-

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/docs/v2.0/classes/p2p_media_loader_core.RequestError.html b/docs/v2.0/classes/p2p_media_loader_core.RequestError.html deleted file mode 100644 index cf1383c6..00000000 --- a/docs/v2.0/classes/p2p_media_loader_core.RequestError.html +++ /dev/null @@ -1,184 +0,0 @@ -RequestError | P2P Media Loader Documentation

Class RequestError<T>

Represents an error that can occur during the request process, with a timestamp for when the error occurred.

-

Type Parameters

Hierarchy

  • Error
    • RequestError

Constructors

constructor -

Properties

timestamp -type -

Constructors

constructor

Properties

Readonlytimestamp

timestamp: number

Error timestamp.

-

Readonlytype

type: T

The specific error type.

-

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/docs/v2.0/classes/p2p_media_loader_hlsjs.HlsJsP2PEngine.html b/docs/v2.0/classes/p2p_media_loader_hlsjs.HlsJsP2PEngine.html deleted file mode 100644 index 4d39a839..00000000 --- a/docs/v2.0/classes/p2p_media_loader_hlsjs.HlsJsP2PEngine.html +++ /dev/null @@ -1,228 +0,0 @@ -HlsJsP2PEngine | P2P Media Loader Documentation

Class HlsJsP2PEngine

Represents a P2P (peer-to-peer) engine for HLS (HTTP Live Streaming) to enhance media streaming efficiency. -This class integrates P2P technologies into HLS.js, enabling the distribution of media segments via a peer network -alongside traditional HTTP fetching. It reduces server bandwidth costs and improves scalability by sharing the load -across multiple clients.

-

The engine manages core functionalities such as segment fetching, segment management, peer connection management, -and event handling related to the P2P and HLS processes.

-

Example

// Creating an instance of HlsJsP2PEngine with custom configuration
const hlsP2PEngine = new HlsJsP2PEngine({
  core: {
    highDemandTimeWindow: 30, // 30 seconds
    simultaneousHttpDownloads: 3,
    webRtcMaxMessageSize: 64 * 1024, // 64 KB
    p2pNotReceivingBytesTimeoutMs: 10000, // 10 seconds
    p2pInactiveLoaderDestroyTimeoutMs: 15000, // 15 seconds
    httpNotReceivingBytesTimeoutMs: 8000, // 8 seconds
    httpErrorRetries: 2,
    p2pErrorRetries: 2,
    announceTrackers: ["wss://personal.tracker.com"],
    rtcConfig: {
      iceServers: [{ urls: "stun:personal.stun.com" }]
    },
    swarmId: "example-swarm-id"
  }
});
-
- -

Constructors

constructor -

Methods

injectMixin -addEventListener -removeEventListener -getConfigForHlsJs -getConfig -applyDynamicConfig -bindHls -destroy -

Constructors

constructor

Methods

StaticinjectMixin

  • injectMixin(hls): (new (config?: Partial<HlsConfig> & {
        p2p?: Partial<Omit<HlsJsP2PEngineConfig, "core">> & {
            core?: Partial<CoreConfig>;
        } & {
            onHlsJsCreated?: ((hls: HlsWithP2PInstance<typeof Hls>) => void);
        };
    }) => HlsWithP2PInstance<Hls>)

  • Enhances a given Hls.js class by injecting additional P2P (peer-to-peer) functionalities.

    -

    Parameters

    • hls: typeof Hls

    Returns (new (config?: Partial<HlsConfig> & {
        p2p?: Partial<Omit<HlsJsP2PEngineConfig, "core">> & {
            core?: Partial<CoreConfig>;
        } & {
            onHlsJsCreated?: ((hls: HlsWithP2PInstance<typeof Hls>) => void);
        };
    }) => HlsWithP2PInstance<Hls>)

      -
    • The enhanced Hls.js class with P2P functionalities.
      • -
    -

    Example

    const HlsWithP2P = HlsJsP2PEngine.injectMixin(Hls);

    const hls = new HlsWithP2P({
      // Hls.js configuration
      startLevel: 0, // Example of Hls.js config parameter
      p2p: {
        core: {
          // P2P core configuration
        },
        onHlsJsCreated(hls) {
          // Do something with the Hls.js instance
        },
      },
    });
-
    - -

addEventListener

  • addEventListener<K>(eventName, listener): void

  • Adds an event listener for the specified event.

    -

    Type Parameters

    Parameters

    • eventName: K

      The name of the event to listen for.

      -
    • listener: CoreEventMap[K]

      The callback function to be invoked when the event is triggered.

      -

    Returns void

    Example

    // Listening for a segment being successfully loaded
    p2pEngine.addEventListener('onSegmentLoaded', (details) => {
      console.log('Segment Loaded:', details);
    });
-
    - -

    Example

    // Handling segment load errors
    p2pEngine.addEventListener('onSegmentError', (errorDetails) => {
      console.error('Error loading segment:', errorDetails);
    });
-
    - -

    Example

    // Tracking data downloaded from peers
    p2pEngine.addEventListener('onChunkDownloaded', (bytesLength, downloadSource, peerId) => {
      console.log(`Downloaded ${bytesLength} bytes from ${downloadSource} ${peerId ? 'from peer ' + peerId : 'from server'}`);
    });
-
    - -

removeEventListener

  • removeEventListener<K>(eventName, listener): void

  • Removes an event listener for the specified event.

    -

    Type Parameters

    Parameters

    • eventName: K

      The name of the event.

      -
    • listener: CoreEventMap[K]

      The callback function that was previously added.

      -

    Returns void

getConfigForHlsJs

  • getConfigForHlsJs<F, P>(): {
        fLoader: F;
        pLoader: P;
    }

  • provides the Hls.js P2P specific configuration for Hls.js loaders.

    -

    Type Parameters

    • F = unknown
    • P = unknown

    Returns {
        fLoader: F;
        pLoader: P;
    }

    An object with fragment loader (fLoader) and playlist loader (pLoader).

    -
    • fLoader: F
    • pLoader: P

getConfig

applyDynamicConfig

  • applyDynamicConfig(dynamicConfig): void

  • Applies dynamic configuration updates to the P2P engine.

    -

    Parameters

    Returns void

    Example

    // Assuming `hlsP2PEngine` is an instance of HlsJsP2PEngine

    const newDynamicConfig = {
      core: {
        // Increase the number of cached segments to 1000
        cachedSegmentsCount: 1000,
        // 50 minutes of segments will be downloaded further through HTTP connections if P2P fails
        httpDownloadTimeWindow: 3000,
        // 100 minutes of segments will be downloaded further through P2P connections
        p2pDownloadTimeWindow: 6000,
    };

    hlsP2PEngine.applyDynamicConfig(newDynamicConfig);
-
    - -

bindHls

  • bindHls<T>(hls): void

  • Sets the HLS instance for handling media.

    -

    Type Parameters

    • T = unknown

    Parameters

    • hls: T | (() => T)

      The HLS instance or a function that returns an HLS instance.

      -

    Returns void

destroy

  • destroy(): void

  • Clean up and release all resources. Unregister all event handlers.

    -

    Returns void

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/docs/v2.0/classes/p2p_media_loader_shaka.ShakaP2PEngine.html b/docs/v2.0/classes/p2p_media_loader_shaka.ShakaP2PEngine.html deleted file mode 100644 index 262cfce3..00000000 --- a/docs/v2.0/classes/p2p_media_loader_shaka.ShakaP2PEngine.html +++ /dev/null @@ -1,225 +0,0 @@ -ShakaP2PEngine | P2P Media Loader Documentation

Class ShakaP2PEngine

Represents a P2P (peer-to-peer) engine for HLS (HTTP Live Streaming) to enhance media streaming efficiency. -This class integrates P2P technologies into Shaka Player, enabling the distribution of media segments via a peer network -alongside traditional HTTP fetching. It reduces server bandwidth costs and improves scalability by sharing the load -across multiple clients.

-

The engine manages core functionalities such as segment fetching, segment management, peer connection management, -and event handling related to the P2P and HLS processes.

-

Example

// Initializing the ShakaP2PEngine with custom configuration
const shakaP2PEngine = new ShakaP2PEngine({
  core: {
    highDemandTimeWindow: 30, // 30 seconds
    simultaneousHttpDownloads: 3,
    webRtcMaxMessageSize: 64 * 1024, // 64 KB
    p2pNotReceivingBytesTimeoutMs: 10000, // 10 seconds
    p2pInactiveLoaderDestroyTimeoutMs: 15000, // 15 seconds
    httpNotReceivingBytesTimeoutMs: 8000, // 8 seconds
    httpErrorRetries: 2,
    p2pErrorRetries: 2,
    announceTrackers: ["wss://personal.tracker.com"],
    rtcConfig: {
      iceServers: [{ urls: "stun:personal.stun.com" }]
    },
    swarmId: "example-swarm-id"
  }
});
-
- -

Constructors

constructor -

Methods

bindShakaPlayer -applyDynamicConfig -getConfig -addEventListener -removeEventListener -destroy -registerPlugins -unregisterPlugins -

Constructors

constructor

  • new ShakaP2PEngine(config?, shaka?): ShakaP2PEngine

  • Constructs an instance of ShakaP2PEngine.

    -

    Parameters

    • Optionalconfig: PartialShakaEngineConfig

      Optional configuration for customizing the P2P engine's behavior.

      -
    • shaka: typeof shaka = window.shaka

      The Shaka Player library instance.

      -

    Returns ShakaP2PEngine

Methods

bindShakaPlayer

  • bindShakaPlayer(player): void

  • Configures and initializes the Shaka Player instance with predefined settings for optimal P2P performance.

    -

    Parameters

    • player: Player

      The Shaka Player instance to configure.

      -

    Returns void

applyDynamicConfig

  • applyDynamicConfig(dynamicConfig): void

  • Applies dynamic configuration updates to the P2P engine.

    -

    Parameters

    Returns void

    Example

    // Assuming `shakaP2PEngine` is an instance of ShakaP2PEngine

    const newDynamicConfig = {
      core: {
        // Increase the number of cached segments to 1000
        cachedSegmentsCount: 1000,
        // 50 minutes of segments will be downloaded further through HTTP connections if P2P fails
        httpDownloadTimeWindow: 3000,
        // 100 minutes of segments will be downloaded further through P2P connections
        p2pDownloadTimeWindow: 6000,
    };

    shakaP2PEngine.applyDynamicConfig(newDynamicConfig);
-
    - -

getConfig

addEventListener

  • addEventListener<K>(eventName, listener): void

  • Adds an event listener for the specified event.

    -

    Type Parameters

    Parameters

    • eventName: K

      The name of the event to listen for.

      -
    • listener: CoreEventMap[K]

      The callback function to be invoked when the event is triggered.

      -

    Returns void

    Example

    // Listening for a segment being successfully loaded
    shakaP2PEngine.addEventListener('onSegmentLoaded', (details) => {
      console.log('Segment Loaded:', details);
    });
-
    - -

    Example

    // Handling segment load errors
    shakaP2PEngine.addEventListener('onSegmentError', (errorDetails) => {
      console.error('Error loading segment:', errorDetails);
    });
-
    - -

    Example

    // Tracking data downloaded from peers
    shakaP2PEngine.addEventListener('onChunkDownloaded', (bytesLength, downloadSource, peerId) => {
      console.log(`Downloaded ${bytesLength} bytes from ${downloadSource} ${peerId ? 'from peer ' + peerId : 'from server'}`);
    });
-
    - -

removeEventListener

  • removeEventListener<K>(eventName, listener): void

  • Removes an event listener for the specified event.

    -

    Type Parameters

    Parameters

    • eventName: K

      The name of the event.

      -
    • listener: CoreEventMap[K]

      The callback function that was previously added.

      -

    Returns void

destroy

  • destroy(): void

  • Clean up and release all resources. Unregister all event handlers.

    -

    Returns void

StaticregisterPlugins

  • registerPlugins(shaka?): void

  • Registers plugins related to P2P functionality into the Shaka Player. -Plugins must be registered before initializing the player to ensure proper integration.

    -

    Parameters

    • shaka: typeof shaka = window.shaka

      The Shaka Player library. Defaults to the global Shaka Player instance if not provided.

      -

    Returns void

StaticunregisterPlugins

  • unregisterPlugins(shaka?): void

  • Unregister plugins related to P2P functionality from the Shaka Player.

    -

    Parameters

    • shaka: typeof shaka = window.shaka

      The Shaka Player library. Defaults to the global Shaka Player instance if not provided.

      -

    Returns void

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/docs/v2.0/index.html b/docs/v2.0/index.html deleted file mode 100644 index 2e473646..00000000 --- a/docs/v2.0/index.html +++ /dev/null @@ -1,280 +0,0 @@ -P2P Media Loader Documentation

P2P Media Loader Documentation

-

P2P Media Loader is an open-source JavaScript library that leverages modern web browser features, such as HTML5 video and WebRTC, to enable media delivery over peer-to-peer (P2P) networks. It integrates smoothly with many popular HTML5 video players and works entirely without browser plugins or add-ons. Experience it in action with the demo.

-

P2P Media Loader can be bundled in your project as an npm package or used through a CDN. Below are examples of both methods.

-

Using P2P Media Loader with npm

To include P2P Media Loader in your project using npm, follow these steps:

-
    -
  1. -

    Install the package via npm:

    -
      -
    • -

      For HLS.js integration:

      -
      npm install p2p-media-loader-hlsjs
-
      - -
      • -
    • -

      For Shaka Player integration:

      -
      npm install p2p-media-loader-shaka
-
      - -
      • -
    -
    2. -
  2. -

    Provide Node.js polyfills

    -

    To ensure the P2P Media Loader works correctly in a browser environment, you must provide Node.js polyfills required by bittorrent-tracker dependency.

    -
      -
    • -

      Vite configuration example:

      -
      // vite.config.ts
      import { defineConfig } from "vite";
      import { nodePolyfills } from "vite-plugin-node-polyfills";

      export default defineConfig({
        plugins: [nodePolyfills()],
      });
-
      - -
      • -
    • -

      Webpack configuration example:

      -
      // webpack.config.mjs
      import NodePolyfillPlugin from "node-polyfill-webpack-plugin";

      export default {
        plugins: [new NodePolyfillPlugin({ additionalAliases: ["process"] })],
      };
-
      - -
      • -
    -
    3. -
  3. -

    Import and use it in your project:

    -
      -
    • -

      HLS.js integration:

      -
      import Hls from "hls.js";
      import { HlsJsP2PEngine } from "p2p-media-loader-hlsjs";

      const HlsWithP2P = HlsJsP2PEngine.injectMixin(Hls);
-
      - -
      • -
    • -

      Shaka Player integration:

      -
      import shaka from "shaka-player/dist/shaka-player.ui";
      import { ShakaP2PEngine } from "p2p-media-loader-shaka";

      ShakaP2PEngine.registerPlugins(shaka);
-
      - -
      • -
    -
    4. -
-

For more examples with npm packages, you may check our React demo

-

Using P2P Media Loader with CDN via JavaScript Modules

P2P Media Loader supports many players that use Hls.js as media engine. Lets pick Vidstack player for extended hlsjs example:

-

Integrating P2P with Vidstack and Hls.js

<!doctype html>
<html>
  <head>
    <!-- Include Hls.js library from CDN -->
    <script src="https://cdn.jsdelivr.net/npm/hls.js@~1/dist/hls.min.js"></script>

    <!-- Import map for P2P Media Loader modules -->
    <script type="importmap">
      {
        "imports": {
          "p2p-media-loader-core": "https://cdn.jsdelivr.net/npm/p2p-media-loader-core@^1/dist/p2p-media-loader-core.es.min.js",
          "p2p-media-loader-hlsjs": "https://cdn.jsdelivr.net/npm/p2p-media-loader-hlsjs@^1/dist/p2p-media-loader-hlsjs.es.min.js"
        }
      }
    </script>

    <!-- Include Vidstack player stylesheets -->
    <link rel="stylesheet" href="https://cdn.vidstack.io/player/theme.css" />
    <link rel="stylesheet" href="https://cdn.vidstack.io/player/video.css" />

    <!-- Include Vidstack player library from CDN -->
    <script src="https://cdn.vidstack.io/player" type="module"></script>

    <!-- Module script to initialize Vidstack player with P2P Media Loader -->
    <script type="module">
      import { HlsJsP2PEngine } from "p2p-media-loader-hlsjs";

      const player = document.querySelector("media-player");
      // Inject P2P capabilities into Hls.js
      const HlsWithP2P = HlsJsP2PEngine.injectMixin(window.Hls);

      player.addEventListener("provider-change", (event) => {
        const provider = event.detail;

        // Check if the provider is HLS
        if (provider?.type === "hls") {
          provider.library = HlsWithP2P;

          provider.config = {
            p2p: {
              core: {
                swarmId: "Optional custom swarm ID for stream",
                // other P2P engine config parameters go here
              },
              onHlsJsCreated: (hls) => {
                hls.p2pEngine.addEventListener("onPeerConnect", (params) => {
                  console.log("Peer connected:", params.peerId);
                });
                // Subscribe to P2P engine and Hls.js events here
              },
            },
          };
        }
      });
    </script>
  </head>

  <body>
    <div style="width: 800px">
      <!-- Vidstack media player with HLS stream -->
      <media-player src="streamUrl">
        <media-provider></media-provider>
        <media-video-layout></media-video-layout>
      </media-player>
    </div>
  </body>
</html>
-
- -

Integrating P2P with raw Hls.js player

<script type="module">
  import { HlsJsP2PEngine } from "p2p-media-loader-hlsjs";

  const videoElement = document.querySelector("#video");

  const HlsWithP2P = HlsJsP2PEngine.injectMixin(window.Hls);

  const hls = new HlsWithP2P({
    p2p: {
      core: {
        swarmId: "Optional custom swarm ID for stream",
        // Other P2P engine config parameters go here
      },
      onHlsJsCreated(hls) {
        hls.p2pEngine.addEventListener("onPeerConnect", (params) => {
          console.log("Peer connected:", params.peerId);
        });
        // Subscribe to P2P engine and Hls.js events here
      },
    },
  });

  hls.attachMedia(videoElement);
  hls.loadSource(streamUrl);
</script>
-
- -

Integrating P2P with PlayerJS and Hls.js

<script type="module">
  import { HlsJsP2PEngine } from "p2p-media-loader-hlsjs";

  window.Hls = HlsJsP2PEngine.injectMixin(window.Hls);

  const player = new Playerjs({
    id: "player",
    hlsconfig: {
      p2p: {
        core: {
          swarmId: "Optional custom swarm ID for stream",
          // Other P2P engine config parameters go here
        },
        onHlsJsCreated: (hls) => {
          // Subscribe to P2P engine and Hls.js events here
          hls.p2pEngine.addEventListener("onPeerConnect", (details) => {
            console.log(`Connected to peer ${details.peerId})`);
          });
        },
      },
    },
  });
</script>
-
- -

Integrating P2P with DPlayer and Hls.js

<script type="module">
  import { HlsJsP2PEngine } from "p2p-media-loader-hlsjs";

  const videoContainer = document.querySelector("#player");

  const player = new DPlayer({
    container: videoContainer,
    video: {
      url: "",
      type: "customHls",
      customType: {
        customHls: (video) => {
          const HlsWithP2P = HlsJsP2PEngine.injectMixin(window.Hls);

          const hls = new HlsWithP2P({
            p2p: {
              core: {
                swarmId: "Optional custom swarm ID for stream",
                // Other P2P engine config parameters go here
              },
            },
          });

          hls.attachMedia(video);
          hls.loadSource(streamUrl);
        },
      },
    },
  });

  player.play();
</script>
-
- -

Integrating P2P with Clappr and Hls.js

<script type="module">
  import { HlsJsP2PEngine } from "p2p-media-loader-hlsjs";

  const engine = new HlsJsP2PEngine({
    core: {
      swarmId: "Optional custom swarm ID for stream",
      // Other P2P engine config parameters go here
    },
  });

  const player = new Clappr.Player({
    source: streamUrl,
    plugins: [LevelSelector], // https://cdn.jsdelivr.net/gh/clappr/clappr-level-selector-plugin@~0/dist/level-selector.min.js
    height: "100%",
    width: "100%",
    parentId: `#player`,
    playback: {
      hlsjsConfig: {
        ...engine.getConfigForHlsJs(),
      },
    },
  });

  engine.bindHls(() => clapprPlayer.core.getCurrentPlayback()?._hls);
</script>
-
- -

Integrating P2P with MediaElement and Hls.js

<script type="module">
  import { HlsJsP2PEngine } from "p2p-media-loader-hlsjs";

  const videoElement = document.querySelector("#video");

  window.Hls = HlsJsP2PEngine.injectMixin(window.Hls);

  const player = new MediaElementPlayer(videoElement.id, {
    videoHeight: "100%",
    hls: {
      p2p: {
        core: {
          swarmId: "Optional custom swarm ID for stream",
          // Other P2P engine config parameters go here
        },
        onHlsJsCreated: (hls) => {
          // Subscribe to P2P engine and Hls.js events here
        },
      },
    },
  });

  player.setSrc(streamUrl);
  player.load();
</script>
-
- -

Integrating P2P with Plyr and Hls.js

<script type="module">
  import { HlsJsP2PEngine } from "p2p-media-loader-hlsjs";

  const videoElement = document.querySelector("#video");

  const HlsWithP2P = HlsJsP2PEngine.injectMixin(window.Hls);

  const hls = new HlsWithP2P({
    p2p: {
      core: {
        swarmId: "Optional custom swarm ID for stream",
        // Other P2P engine config parameters go here
      },
      onHlsJsCreated(hls) {
        // Subscribe to P2P engine and Hls.js events here
      },
    },
  });

  hls.on(Hls.Events.MANIFEST_PARSED, () => {
    const levels = hls.levels;

    const quality = {
      default: levels[levels.length - 1].height,
      options: levels.map((level) => level.height),
      forced: true,
      onChange: (newQuality) => {
        levels.forEach((level, levelIndex) => {
          if (level.height === newQuality) {
            hls.currentLevel = levelIndex;
          }
        });
      },
    };

    player = new Plyr(videoElement, {
      quality,
      autoplay: true,
      muted: true,
    });
  });

  hls.attachMedia(videoElement);
  hls.loadSource(streamUrl);
</script>
-
- -

Integrating P2P with OpenPlayerJS and Hls.js

<script type="module">
  import { HlsJsP2PEngine } from "p2p-media-loader-hlsjs";

  const videoElement = document.querySelector("#video");
  const HlsWithP2P = HlsJsP2PEngine.injectMixin(window.Hls);

  const player = new OpenPlayerJS(videoElement, {
    hls: {
      p2p: {
        core: {
          swarmId: "Optional custom swarm ID for stream",
          // Other P2P engine config parameters go here
        },
        onHlsJsCreated: (hls) => {
          // Subscribe to P2P engine and Hls.js events here
        },
      },
    },
    controls: {
      layers: {
        left: ["play", "time", "volume"],
        right: ["settings", "fullscreen", "levels"],
        middle: ["progress"],
      },
    },
  });

  player.src = [
    {
      src: streamUrl,
      type: "application/x-mpegURL",
    },
  ];

  player.init();
</script>
-
- -

Integrating P2P with Shaka Player

Shaka player is used for an extended example:

-
<!doctype html>
<html>
  <head>
    <!-- Link to Shaka Player's CSS for controls -->
    <link
      rel="stylesheet"
      type="text/css"
      href="https://unpkg.com/shaka-player/dist/controls.css"
    />

    <!-- Link to Shaka Player's compiled UI script -->
    <script src="https://unpkg.com/shaka-player/dist/shaka-player.ui.js"></script>

    <!-- Import map for P2P Media Loader modules -->
    <script type="importmap">
      {
        "imports": {
          "p2p-media-loader-core": "https://cdn.jsdelivr.net/npm/p2p-media-loader-core@^1/dist/p2p-media-loader-core.es.min.js",
          "p2p-media-loader-shaka": "https://cdn.jsdelivr.net/npm/p2p-media-loader-shaka@^1/dist/p2p-media-loader-shaka.es.min.js"
        }
      }
    </script>

    <!-- Module script to initialize Shaka Player with P2P Media Loader -->
    <script type="module">
      import { ShakaP2PEngine } from "p2p-media-loader-shaka";

      // Register P2P Media Loader plugins with Shaka
      ShakaP2PEngine.registerPlugins();

      async function init() {
        // Get the video element by its ID
        const video = document.getElementById("video");

        // Get Shaka UI controls and player
        const ui = video["ui"];
        const controls = ui.getControls();
        const player = controls.getPlayer();

        // Initialize P2P Media Loader with custom config
        const shakaP2PEngine = new ShakaP2PEngine({
          core: {
            swarmId: "Optional custom swarm ID for stream",
            // Other P2P engine config parameters go here
          },
        });

        //Subscribe to P2P engine events here
        shakaP2PEngine.addEventListener("onPeerConnect", (params) => {
          console.log("Peer connected:", params.peerId);
        });

        // Configure and initialize Shaka Player with P2P Media Loader
        shakaP2PEngine.bindShakaPlayer(player);

        // Load the stream URL into the player
        player.load(streamUrl);
      }

      // Add event listener for Shaka UI loaded event to trigger initialization
      document.addEventListener("shaka-ui-loaded", init);
    </script>
  </head>

  <body>
    <div data-shaka-player-container style="max-width:40em">
      <!-- Video element with Shaka Player UI -->
      <video
        autoplay
        data-shaka-player
        id="video"
        style="width:100%;height:100%"
      ></video>
    </div>
  </body>
</html>
-
- -

Integrating P2P with Clappr and Shaka Player

<script type="module">
  import { ShakaP2PEngine } from "p2p-media-loader-shaka";

  const container = document.getElementById("container");

  ShakaP2PEngine.registerPlugins();

  const shakaP2PEngine = new ShakaP2PEngine({
    core: {
      swarmId: "Optional custom swarm ID for stream",
      // Other P2P Media Loader Core options
    },
  });

  const player = new Clappr.Player({
    parentId: `#${container.id}`,
    source: streamUrl,
    plugins: [window.DashShakaPlayback, window.LevelSelector],
    shakaOnBeforeLoad: (shakaPlayerInstance) => {
      subscribeToUiEvents({
        engine: shakaP2PEngine,
        onPeerConnect,
        onPeerDisconnect,
        onChunkDownloaded,
        onChunkUploaded,
      });

      shakaP2PEngine.bindShakaPlayer(shakaPlayerInstance);
    },
  });
</script>
-
- -

Integrating P2P with DPlayer and Shaka Player

<script type="module">
  import { ShakaP2PEngine } from "p2p-media-loader-shaka";

  const container = document.getElementById("container");

  ShakaP2PEngine.registerPlugins();

  const shakaP2PEngine = new ShakaP2PEngine({
    core: {
      swarmId: "Optional custom swarm ID for stream",
      // Other P2P Media Loader Core options
    },
  });

  const player = new DPlayer({
    container,
    video: {
      url: "",
      type: "customHlsOrDash",
      customType: {
        customHlsOrDash: (video) => {
          const shakaPlayer = new shaka.Player();
          void shakaPlayer.attach(video);

          shakaP2PEngine.bindShakaPlayer(shakaPlayer);
          void shakaPlayer.load(streamUrl);
        },
      },
    },
  });
</script>
-
- -

Integrating P2P with Plyr and Shaka Player

<script type="module">
  import { ShakaP2PEngine } from "p2p-media-loader-shaka";

  ShakaP2PEngine.registerPlugins();

  const videoElement = document.getElementById("video");

  const initPlayer = () => {
    const shakaP2PEngine = new ShakaP2PEngine({
      core: {
        swarmId: "Optional custom swarm ID for stream",
        // Other P2P Media Loader Core options
      },
    });
    const shakaPlayer = new shaka.Player();

    shakaPlayer.attach(videoElement);

    shakaP2PEngine.bindShakaPlayer(shakaPlayer);

    shakaPlayer.load(streamUrl);

    const plyrPlayer = new Plyr(videoElement);
  };

  initPlayer();
</script>
-
- -

Settings

Member Visibility

On This Page

Using P2P Media Loader with npmUsing P2P Media Loader with CDN via JavaScript Modules
diff --git a/docs/v2.0/interfaces/p2p_media_loader_core.SegmentStorage.html b/docs/v2.0/interfaces/p2p_media_loader_core.SegmentStorage.html deleted file mode 100644 index 42e37991..00000000 --- a/docs/v2.0/interfaces/p2p_media_loader_core.SegmentStorage.html +++ /dev/null @@ -1,224 +0,0 @@ -SegmentStorage | P2P Media Loader Documentation

Interface SegmentStorage

Segments storage interface

-
interface SegmentStorage {
    initialize(coreConfig: CommonCoreConfig, mainStreamConfig: StreamConfig, secondaryStreamConfig: StreamConfig): Promise<void>;
    onPlaybackUpdated(position: number, rate: number): void;
    onSegmentRequested(swarmId: string, streamId: string, segmentId: number, startTime: number, endTime: number, streamType: StreamType, isLiveStream: boolean): void;
    storeSegment(swarmId: string, streamId: string, segmentId: number, data: ArrayBuffer, startTime: number, endTime: number, streamType: StreamType, isLiveStream: boolean): Promise<void>;
    getSegmentData(swarmId: string, streamId: string, segmentId: number): Promise<undefined | ArrayBuffer>;
    getUsage(): {
        totalCapacity: number;
        usedCapacity: number;
    };
    hasSegment(swarmId: string, streamId: string, segmentId: number): boolean;
    getStoredSegmentIds(swarmId: string, streamId: string): number[];
    setSegmentChangeCallback(callback: ((streamId: string) => void)): void;
    destroy(): void;
}

Methods

initialize -onPlaybackUpdated -onSegmentRequested -storeSegment -getSegmentData -getUsage -hasSegment -getStoredSegmentIds -setSegmentChangeCallback -destroy -

Methods

initialize

  • initialize(coreConfig, mainStreamConfig, secondaryStreamConfig): Promise<void>

  • Initializes storage

    -

    Parameters

    Returns Promise<void>

onPlaybackUpdated

  • onPlaybackUpdated(position, rate): void

  • Provides playback position from player

    -

    Parameters

    • position: number

      Playback position

      -
    • rate: number

      Playback rate

      -

    Returns void

onSegmentRequested

  • onSegmentRequested(swarmId, streamId, segmentId, startTime, endTime, streamType, isLiveStream): void

  • Provides segment request information from player

    -

    Parameters

    • swarmId: string

      Swarm identifier

      -
    • streamId: string

      Stream identifier

      -
    • segmentId: number

      Segment identifier

      -
    • startTime: number

      Segment start time

      -
    • endTime: number

      Segment end time

      -
    • streamType: StreamType

      Stream type

      -
    • isLiveStream: boolean

      Is live stream

      -

    Returns void

storeSegment

  • storeSegment(swarmId, streamId, segmentId, data, startTime, endTime, streamType, isLiveStream): Promise<void>

  • Stores segment data

    -

    Parameters

    • swarmId: string

      Swarm identifier

      -
    • streamId: string

      Stream identifier

      -
    • segmentId: number

      Segment identifier

      -
    • data: ArrayBuffer

      Segment data

      -
    • startTime: number

      Segment start time

      -
    • endTime: number

      Segment end time

      -
    • streamType: StreamType

      Stream type

      -
    • isLiveStream: boolean

      Is live stream

      -

    Returns Promise<void>

getSegmentData

  • getSegmentData(swarmId, streamId, segmentId): Promise<undefined | ArrayBuffer>

  • Returns segment data

    -

    Parameters

    • swarmId: string

      Swarm identifier

      -
    • streamId: string

      Stream identifier

      -
    • segmentId: number

      Segment identifier

      -

    Returns Promise<undefined | ArrayBuffer>

getUsage

  • getUsage(): {
        totalCapacity: number;
        usedCapacity: number;
    }

  • Returns used memory information in the storage

    -

    Returns {
        totalCapacity: number;
        usedCapacity: number;
    }

    • totalCapacity: number
    • usedCapacity: number

hasSegment

  • hasSegment(swarmId, streamId, segmentId): boolean

  • Returns true if segment is in storage

    -

    Parameters

    • swarmId: string

      Swarm identifier

      -
    • streamId: string

      Stream identifier

      -
    • segmentId: number

      Segment identifier

      -

    Returns boolean

getStoredSegmentIds

  • getStoredSegmentIds(swarmId, streamId): number[]

  • Returns segment IDs of a stream that are stored in the storage

    -

    Parameters

    • swarmId: string

      Swarm identifier

      -
    • streamId: string

      Stream identifier

      -

    Returns number[]

setSegmentChangeCallback

  • setSegmentChangeCallback(callback): void

  • Sets segment change callback function

    -

    Parameters

    • callback: ((streamId: string) => void)

      Callback function that has to be called when segments appear or disappear in the storage

      -
        • (streamId): void

        • Parameters

          • streamId: string

          Returns void

    Returns void

destroy

Settings

Member Visibility

On This Page

Methods
diff --git a/docs/v2.0/modules/p2p_media_loader_core.html b/docs/v2.0/modules/p2p_media_loader_core.html deleted file mode 100644 index 8d41e119..00000000 --- a/docs/v2.0/modules/p2p_media_loader_core.html +++ /dev/null @@ -1,206 +0,0 @@ -p2p-media-loader-core | P2P Media Loader Documentation

Module p2p-media-loader-core

Index

Classes

Core -RequestError -CoreRequestError -

Interfaces

SegmentStorage -

Type Aliases

StreamType -ByteRange -Segment -SegmentWithStream -StreamWithSegments -Stream -DefinedCoreConfig -DynamicStreamProperties -DynamicCoreConfig -CommonCoreConfig -CoreConfig -StreamConfig -DownloadSource -SegmentStartDetails -SegmentErrorDetails -SegmentAbortDetails -SegmentLoadDetails -PeerDetails -PeerErrorDetails -TrackerErrorDetails -TrackerWarningDetails -CoreEventMap -RequestAbortErrorType -HttpRequestErrorType -PeerRequestErrorType -RequestErrorType -SegmentResponse -EngineCallbacks -

Settings

Member Visibility
diff --git a/docs/v2.0/modules/p2p_media_loader_hlsjs.html b/docs/v2.0/modules/p2p_media_loader_hlsjs.html deleted file mode 100644 index c3bf57fd..00000000 --- a/docs/v2.0/modules/p2p_media_loader_hlsjs.html +++ /dev/null @@ -1,180 +0,0 @@ -p2p-media-loader-hlsjs | P2P Media Loader Documentation

Module p2p-media-loader-hlsjs

Index

Classes

HlsJsP2PEngine -

Type Aliases

HlsJsP2PEngineConfig -PartialHlsJsP2PEngineConfig -DynamicHlsJsP2PEngineConfig -HlsWithP2PInstance -HlsWithP2PConfig -

Settings

Member Visibility
diff --git a/docs/v2.0/modules/p2p_media_loader_shaka.html b/docs/v2.0/modules/p2p_media_loader_shaka.html deleted file mode 100644 index 5f88b529..00000000 --- a/docs/v2.0/modules/p2p_media_loader_shaka.html +++ /dev/null @@ -1,178 +0,0 @@ -p2p-media-loader-shaka | P2P Media Loader Documentation

Module p2p-media-loader-shaka

Index

Classes

ShakaP2PEngine -

Type Aliases

DynamicShakaP2PEngineConfig -ShakaP2PEngineConfig -PartialShakaEngineConfig -

Settings

Member Visibility
diff --git a/docs/v2.0/types/p2p_media_loader_core.ByteRange.html b/docs/v2.0/types/p2p_media_loader_core.ByteRange.html deleted file mode 100644 index 02ed94b7..00000000 --- a/docs/v2.0/types/p2p_media_loader_core.ByteRange.html +++ /dev/null @@ -1,177 +0,0 @@ -ByteRange | P2P Media Loader Documentation

Type Alias ByteRange

ByteRange: {
    start: number;
    end: number;
}

Represents a range of bytes, used for specifying a segment of data to download.

-

Type declaration

  • start: number

    The starting byte index of the range.

    -
  • end: number

    The ending byte index of the range.

    -

Settings

Member Visibility
diff --git a/docs/v2.0/types/p2p_media_loader_core.CommonCoreConfig.html b/docs/v2.0/types/p2p_media_loader_core.CommonCoreConfig.html deleted file mode 100644 index a35b32c8..00000000 --- a/docs/v2.0/types/p2p_media_loader_core.CommonCoreConfig.html +++ /dev/null @@ -1,194 +0,0 @@ -CommonCoreConfig | P2P Media Loader Documentation

Type Alias CommonCoreConfig

CommonCoreConfig: {
    segmentMemoryStorageLimit: number | undefined;
    customSegmentStorageFactory?: ((isLive: boolean) => SegmentStorage);
}

Represents the configuration for the Core functionality that is common to all streams.

-

Type declaration

  • segmentMemoryStorageLimit: number | undefined

    Defines the memory storage limit for media segments, in MiB.

    -

    Default

    segmentMemoryStorageLimit: undefined
-
    - -
      -
    • When undefined, the default limit is determined based on the device type and browser: -
        -
      • Desktop: 4000 MiB
        • -
      • Android: 2000 MiB
        • -
      • iOS: 1000 MiB
        • -
      • Android WebView: 1000 MiB
        • -
      • iOS WebView: 1000 MiB
        • -
      -
      • -
    -
  • OptionalcustomSegmentStorageFactory?: ((isLive: boolean) => SegmentStorage)

    Optional custom storage factory for the segments storage.

    -

    Default

    customSegmentStorageFactory: undefined
-
    - -

Settings

Member Visibility
diff --git a/docs/v2.0/types/p2p_media_loader_core.CoreConfig.html b/docs/v2.0/types/p2p_media_loader_core.CoreConfig.html deleted file mode 100644 index 93ebd7f0..00000000 --- a/docs/v2.0/types/p2p_media_loader_core.CoreConfig.html +++ /dev/null @@ -1,184 +0,0 @@ -CoreConfig | P2P Media Loader Documentation

Type Alias CoreConfig

CoreConfig: Partial<StreamConfig> & Partial<CommonCoreConfig> & {
    mainStream?: Partial<StreamConfig>;
    secondaryStream?: Partial<StreamConfig>;
}

Represents a set of configuration parameters that can be used to override or extend the -default configuration settings for a specific stream (main or secondary).

-

Type declaration

  • OptionalmainStream?: Partial<StreamConfig>

    Optional configuration for the main stream.

    -
  • OptionalsecondaryStream?: Partial<StreamConfig>

    Optional configuration for the secondary stream.

    -

Example: Configuration for basic video stream

const config: CoreConfig = {
 highDemandTimeWindow: 15,
 httpDownloadTimeWindow: 3000,
 p2pDownloadTimeWindow: 6000,
 swarmId: "custom swarm ID for video stream",
 cashedSegmentsCount: 1000,
}
-
- -

Example: Configuration for advanced video stream

const config: CoreConfig = {
 // Configuration for both streams
 highDemandTimeWindow: 20,
 httpDownloadTimeWindow: 3000,
 p2pDownloadTimeWindow: 6000,
 mainStream: {
  // Optional configuration for the main stream
  swarmId: "custom swarm ID for video stream",
 },
 secondaryStream: {
  // Optional configuration for the secondary stream
  swarmId: "custom swarm ID for audio stream",
 },
-
- -

Settings

Member Visibility
diff --git a/docs/v2.0/types/p2p_media_loader_core.CoreEventMap.html b/docs/v2.0/types/p2p_media_loader_core.CoreEventMap.html deleted file mode 100644 index e45c01c2..00000000 --- a/docs/v2.0/types/p2p_media_loader_core.CoreEventMap.html +++ /dev/null @@ -1,201 +0,0 @@ -CoreEventMap | P2P Media Loader Documentation

Type Alias CoreEventMap

CoreEventMap: {
    onSegmentLoaded: ((params: SegmentLoadDetails) => void);
    onSegmentError: ((params: SegmentErrorDetails) => void);
    onSegmentAbort: ((params: SegmentAbortDetails) => void);
    onSegmentStart: ((params: SegmentStartDetails) => void);
    onPeerConnect: ((params: PeerDetails) => void);
    onPeerClose: ((params: PeerDetails) => void);
    onPeerError: ((params: PeerErrorDetails) => void);
    onChunkDownloaded: ((bytesLength: number, downloadSource: DownloadSource, peerId?: string) => void);
    onChunkUploaded: ((bytesLength: number, peerId: string) => void);
    onTrackerError: ((params: TrackerErrorDetails) => void);
    onTrackerWarning: ((params: TrackerWarningDetails) => void);
}

The CoreEventMap defines a comprehensive suite of event handlers crucial for monitoring and controlling the lifecycle -of segment downloading and uploading processes.

-

Type declaration

  • onSegmentLoaded: ((params: SegmentLoadDetails) => void)

    Invoked when a segment is fully downloaded and available for use.

    -
      • (params): void

      • Parameters

        Returns void

  • onSegmentError: ((params: SegmentErrorDetails) => void)

    Triggered when an error occurs during the download of a segment.

    -
      • (params): void

      • Parameters

        Returns void

  • onSegmentAbort: ((params: SegmentAbortDetails) => void)

    Called if the download of a segment is aborted before completion.

    -
      • (params): void

      • Parameters

        Returns void

  • onSegmentStart: ((params: SegmentStartDetails) => void)

    Fired at the beginning of a segment download process.

    -
      • (params): void

      • Parameters

        Returns void

  • onPeerConnect: ((params: PeerDetails) => void)

    Occurs when a new peer-to-peer connection is established.

    -
      • (params): void

      • Parameters

        • params: PeerDetails

          Contains details about the peer that the event is about.

          -

        Returns void

  • onPeerClose: ((params: PeerDetails) => void)

    Triggered when an existing peer-to-peer connection is closed.

    -
      • (params): void

      • Parameters

        • params: PeerDetails

          Contains details about the peer that the event is about.

          -

        Returns void

  • onPeerError: ((params: PeerErrorDetails) => void)

    Triggered when an error occurs during a peer-to-peer connection.

    -
      • (params): void

      • Parameters

        • params: PeerErrorDetails

          Contains details about the error and the peer that the event is about.

          -

        Returns void

  • onChunkDownloaded: ((bytesLength: number, downloadSource: DownloadSource, peerId?: string) => void)

    Invoked after a chunk of data from a segment has been successfully downloaded.

    -
      • (bytesLength, downloadSource, peerId?): void

      • Parameters

        • bytesLength: number

          The size of the downloaded chunk in bytes.

          -
        • downloadSource: DownloadSource

          The source of the download.

          -
        • OptionalpeerId: string

          The peer ID of the peer that the event is about, if applicable.

          -

        Returns void

  • onChunkUploaded: ((bytesLength: number, peerId: string) => void)

    Called when a chunk of data has been successfully uploaded to a peer.

    -
      • (bytesLength, peerId): void

      • Parameters

        • bytesLength: number

          The length of the segment in bytes.

          -
        • peerId: string

          The peer ID, if the segment was downloaded from a peer

          -

        Returns void

  • onTrackerError: ((params: TrackerErrorDetails) => void)

    Called when an error occurs during the tracker request process.

    -
      • (params): void

      • Parameters

        Returns void

  • onTrackerWarning: ((params: TrackerWarningDetails) => void)

    Called when a warning occurs during the tracker request process.

    -
      • (params): void

      • Parameters

        Returns void

Settings

Member Visibility
diff --git a/docs/v2.0/types/p2p_media_loader_core.DefinedCoreConfig.html b/docs/v2.0/types/p2p_media_loader_core.DefinedCoreConfig.html deleted file mode 100644 index 15911019..00000000 --- a/docs/v2.0/types/p2p_media_loader_core.DefinedCoreConfig.html +++ /dev/null @@ -1,177 +0,0 @@ -DefinedCoreConfig | P2P Media Loader Documentation

Type Alias DefinedCoreConfig

DefinedCoreConfig: CommonCoreConfig & {
    mainStream: StreamConfig;
    secondaryStream: StreamConfig;
}

Represents a defined Core configuration with specific settings for the main and secondary streams.

-

Type declaration

  • mainStream: StreamConfig

    Configuration for the main stream.

    -
  • secondaryStream: StreamConfig

    Configuration for the secondary stream.

    -

Settings

Member Visibility
diff --git a/docs/v2.0/types/p2p_media_loader_core.DownloadSource.html b/docs/v2.0/types/p2p_media_loader_core.DownloadSource.html deleted file mode 100644 index 8d8c6fcf..00000000 --- a/docs/v2.0/types/p2p_media_loader_core.DownloadSource.html +++ /dev/null @@ -1,177 +0,0 @@ -DownloadSource | P2P Media Loader Documentation

Type Alias DownloadSource

DownloadSource: "http" | "p2p"

Specifies the source of a download within a media streaming context.

-

"http" - Indicates that the segment was downloaded using the HTTP protocol.

-

"p2p"- Indicates that the segment was downloaded through a peer-to-peer network.

-

Settings

Member Visibility
diff --git a/docs/v2.0/types/p2p_media_loader_core.DynamicCoreConfig.html b/docs/v2.0/types/p2p_media_loader_core.DynamicCoreConfig.html deleted file mode 100644 index d702afed..00000000 --- a/docs/v2.0/types/p2p_media_loader_core.DynamicCoreConfig.html +++ /dev/null @@ -1,180 +0,0 @@ -DynamicCoreConfig | P2P Media Loader Documentation

Type Alias DynamicCoreConfig

DynamicCoreConfig: Partial<Pick<CoreConfig, DynamicStreamProperties>> & Partial<CommonCoreConfig> & {
    mainStream?: Partial<Pick<StreamConfig, DynamicStreamProperties>>;
    secondaryStream?: Partial<Pick<StreamConfig, DynamicStreamProperties>>;
}

Represents a dynamically modifiable configuration, allowing updates to selected CoreConfig properties at runtime.

-

Type declaration

Example

const dynamicConfig: DynamicCoreConfig = {
  core: {
    cachedSegmentsCount: 200,
  },
  mainStream: {
    swarmId: "custom swarm ID for video stream",
    p2pDownloadTimeWindow: 6000,
  },
  secondaryStream: {
    swarmId: "custom swarm ID for audio stream",
    p2pDownloadTimeWindow: 3000,
  }
};
-
- -

Settings

Member Visibility
diff --git a/docs/v2.0/types/p2p_media_loader_core.DynamicStreamProperties.html b/docs/v2.0/types/p2p_media_loader_core.DynamicStreamProperties.html deleted file mode 100644 index 26da2651..00000000 --- a/docs/v2.0/types/p2p_media_loader_core.DynamicStreamProperties.html +++ /dev/null @@ -1,175 +0,0 @@ -DynamicStreamProperties | P2P Media Loader Documentation

Type Alias DynamicStreamProperties

DynamicStreamProperties:
    | "highDemandTimeWindow"
    | "httpDownloadTimeWindow"
    | "p2pDownloadTimeWindow"
    | "simultaneousHttpDownloads"
    | "simultaneousP2PDownloads"
    | "webRtcMaxMessageSize"
    | "p2pNotReceivingBytesTimeoutMs"
    | "p2pInactiveLoaderDestroyTimeoutMs"
    | "httpNotReceivingBytesTimeoutMs"
    | "httpErrorRetries"
    | "p2pErrorRetries"
    | "validateP2PSegment"
    | "httpRequestSetup"
    | "isP2PDisabled"

Represents a set of properties that can be dynamically modified at runtime.

-

Settings

Member Visibility
diff --git a/docs/v2.0/types/p2p_media_loader_core.EngineCallbacks.html b/docs/v2.0/types/p2p_media_loader_core.EngineCallbacks.html deleted file mode 100644 index bd080ecd..00000000 --- a/docs/v2.0/types/p2p_media_loader_core.EngineCallbacks.html +++ /dev/null @@ -1,179 +0,0 @@ -EngineCallbacks | P2P Media Loader Documentation

Type Alias EngineCallbacks

EngineCallbacks: {
    onSuccess: ((response: SegmentResponse) => void);
    onError: ((reason: CoreRequestError) => void);
}

Callbacks for handling the success or failure of an engine operation.

-

Type declaration

  • onSuccess: ((response: SegmentResponse) => void)

    Called when the operation is successful.

    -
      • (response): void

      • Parameters

        Returns void

  • onError: ((reason: CoreRequestError) => void)

    Called when the operation encounters an error.

    -
      • (reason): void

      • Parameters

        Returns void

Settings

Member Visibility
diff --git a/docs/v2.0/types/p2p_media_loader_core.HttpRequestErrorType.html b/docs/v2.0/types/p2p_media_loader_core.HttpRequestErrorType.html deleted file mode 100644 index 4cd0701c..00000000 --- a/docs/v2.0/types/p2p_media_loader_core.HttpRequestErrorType.html +++ /dev/null @@ -1,175 +0,0 @@ -HttpRequestErrorType | P2P Media Loader Documentation

Type Alias HttpRequestErrorType

HttpRequestErrorType: "http-error" | "http-bytes-mismatch" | "http-unexpected-status-code"

Defines the types of errors specific to HTTP requests.

-

Settings

Member Visibility
diff --git a/docs/v2.0/types/p2p_media_loader_core.PeerDetails.html b/docs/v2.0/types/p2p_media_loader_core.PeerDetails.html deleted file mode 100644 index 9cf44c7a..00000000 --- a/docs/v2.0/types/p2p_media_loader_core.PeerDetails.html +++ /dev/null @@ -1,177 +0,0 @@ -PeerDetails | P2P Media Loader Documentation

Type Alias PeerDetails

PeerDetails: {
    peerId: string;
    streamType: StreamType;
}

Represents the details of a peer in a peer-to-peer network.

-

Type declaration

  • peerId: string

    The unique identifier for a peer in the network.

    -
  • streamType: StreamType

    The type of stream that the peer is connected to.

    -

Settings

Member Visibility
diff --git a/docs/v2.0/types/p2p_media_loader_core.PeerErrorDetails.html b/docs/v2.0/types/p2p_media_loader_core.PeerErrorDetails.html deleted file mode 100644 index 97a909fb..00000000 --- a/docs/v2.0/types/p2p_media_loader_core.PeerErrorDetails.html +++ /dev/null @@ -1,178 +0,0 @@ -PeerErrorDetails | P2P Media Loader Documentation

Type Alias PeerErrorDetails

PeerErrorDetails: {
    peerId: string;
    streamType: StreamType;
    error: Error;
}

Represents the details of a peer error event.

-

Type declaration

  • peerId: string

    The unique identifier for a peer in the network.

    -
  • streamType: StreamType

    The type of stream that the peer is connected to.

    -
  • error: Error

    The error that occurred during the peer-to-peer connection.

    -

Settings

Member Visibility
diff --git a/docs/v2.0/types/p2p_media_loader_core.PeerRequestErrorType.html b/docs/v2.0/types/p2p_media_loader_core.PeerRequestErrorType.html deleted file mode 100644 index 13d95fba..00000000 --- a/docs/v2.0/types/p2p_media_loader_core.PeerRequestErrorType.html +++ /dev/null @@ -1,175 +0,0 @@ -PeerRequestErrorType | P2P Media Loader Documentation

Type Alias PeerRequestErrorType

PeerRequestErrorType:
    | "peer-response-bytes-length-mismatch"
    | "peer-protocol-violation"
    | "peer-segment-absent"
    | "peer-closed"
    | "p2p-segment-validation-failed"

Defines the types of errors specific to peer-to-peer requests.

-

Settings

Member Visibility
diff --git a/docs/v2.0/types/p2p_media_loader_core.RequestAbortErrorType.html b/docs/v2.0/types/p2p_media_loader_core.RequestAbortErrorType.html deleted file mode 100644 index 9446b35d..00000000 --- a/docs/v2.0/types/p2p_media_loader_core.RequestAbortErrorType.html +++ /dev/null @@ -1,175 +0,0 @@ -RequestAbortErrorType | P2P Media Loader Documentation

Type Alias RequestAbortErrorType

RequestAbortErrorType: "abort" | "bytes-receiving-timeout"

Defines the types of errors that can occur during a request abortion process.

-

Settings

Member Visibility
diff --git a/docs/v2.0/types/p2p_media_loader_core.RequestErrorType.html b/docs/v2.0/types/p2p_media_loader_core.RequestErrorType.html deleted file mode 100644 index 8805ed70..00000000 --- a/docs/v2.0/types/p2p_media_loader_core.RequestErrorType.html +++ /dev/null @@ -1,175 +0,0 @@ -RequestErrorType | P2P Media Loader Documentation

Type Alias RequestErrorType

RequestErrorType: RequestAbortErrorType | PeerRequestErrorType | HttpRequestErrorType

Enumerates all possible request error types, including HTTP and peer-related errors.

-

Settings

Member Visibility
diff --git a/docs/v2.0/types/p2p_media_loader_core.Segment.html b/docs/v2.0/types/p2p_media_loader_core.Segment.html deleted file mode 100644 index 4f34d170..00000000 --- a/docs/v2.0/types/p2p_media_loader_core.Segment.html +++ /dev/null @@ -1,181 +0,0 @@ -Segment | P2P Media Loader Documentation

Type Alias Segment

Segment: {
    runtimeId: string;
    externalId: number;
    url: string;
    byteRange?: ByteRange;
    startTime: number;
    endTime: number;
}

Describes a media segment with its unique identifiers, location, and timing information.

-

Type declaration

  • ReadonlyruntimeId: string

    A runtime identifier for the segment that includes URL and byte range from its manifest.

    -
  • ReadonlyexternalId: number

    An unique identifier of the segment in its stream used for P2P communications: sequence number for HLS or playtime for MPEG-DASH.

    -
  • Readonlyurl: string

    The URL from which the segment can be downloaded.

    -
  • Optional ReadonlybyteRange?: ByteRange

    An optional property specifying the range of bytes that represent the segment.

    -
  • ReadonlystartTime: number

    The start time of the segment in seconds, relative to the beginning of the stream.

    -
  • ReadonlyendTime: number

    The end time of the segment in seconds, relative to the beginning of the stream.

    -

Settings

Member Visibility
diff --git a/docs/v2.0/types/p2p_media_loader_core.SegmentAbortDetails.html b/docs/v2.0/types/p2p_media_loader_core.SegmentAbortDetails.html deleted file mode 100644 index ed01ad99..00000000 --- a/docs/v2.0/types/p2p_media_loader_core.SegmentAbortDetails.html +++ /dev/null @@ -1,179 +0,0 @@ -SegmentAbortDetails | P2P Media Loader Documentation

Type Alias SegmentAbortDetails

SegmentAbortDetails: {
    segment: Segment;
    downloadSource: DownloadSource | undefined;
    peerId: string | undefined;
    streamType: StreamType;
}

Represents details about a segment abort event.

-

Type declaration

  • segment: Segment

    The segment that the event is about.

    -
  • downloadSource: DownloadSource | undefined

    The source of the download.

    -
  • peerId: string | undefined

    The peer ID, if the segment was downloaded from a peer.

    -
  • streamType: StreamType

    The type of stream that the segment is associated with.

    -

Settings

Member Visibility
diff --git a/docs/v2.0/types/p2p_media_loader_core.SegmentErrorDetails.html b/docs/v2.0/types/p2p_media_loader_core.SegmentErrorDetails.html deleted file mode 100644 index 68c0b5ad..00000000 --- a/docs/v2.0/types/p2p_media_loader_core.SegmentErrorDetails.html +++ /dev/null @@ -1,180 +0,0 @@ -SegmentErrorDetails | P2P Media Loader Documentation

Type Alias SegmentErrorDetails

SegmentErrorDetails: {
    error: RequestError;
    segment: Segment;
    downloadSource: DownloadSource;
    peerId: string | undefined;
    streamType: StreamType;
}

Represents details about a segment error event.

-

Type declaration

  • error: RequestError

    The error that occurred during the segment download.

    -
  • segment: Segment

    The segment that the event is about.

    -
  • downloadSource: DownloadSource

    The source of the download.

    -
  • peerId: string | undefined

    The peer ID, if the segment was downloaded from a peer.

    -
  • streamType: StreamType

    The type of stream that the segment is associated with.

    -

Settings

Member Visibility
diff --git a/docs/v2.0/types/p2p_media_loader_core.SegmentLoadDetails.html b/docs/v2.0/types/p2p_media_loader_core.SegmentLoadDetails.html deleted file mode 100644 index ec7a24e9..00000000 --- a/docs/v2.0/types/p2p_media_loader_core.SegmentLoadDetails.html +++ /dev/null @@ -1,180 +0,0 @@ -SegmentLoadDetails | P2P Media Loader Documentation

Type Alias SegmentLoadDetails

SegmentLoadDetails: {
    segmentUrl: string;
    bytesLength: number;
    downloadSource: DownloadSource;
    peerId: string | undefined;
    streamType: StreamType;
}

Represents the details about a loaded segment.

-

Type declaration

  • segmentUrl: string

    The URL of the loaded segment

    -
  • bytesLength: number

    The length of the segment in bytes.

    -
  • downloadSource: DownloadSource

    The source of the download.

    -
  • peerId: string | undefined

    The peer ID, if the segment was downloaded from a peer.

    -
  • streamType: StreamType

    The segment that the event is about.

    -

Settings

Member Visibility
diff --git a/docs/v2.0/types/p2p_media_loader_core.SegmentResponse.html b/docs/v2.0/types/p2p_media_loader_core.SegmentResponse.html deleted file mode 100644 index 084702e4..00000000 --- a/docs/v2.0/types/p2p_media_loader_core.SegmentResponse.html +++ /dev/null @@ -1,177 +0,0 @@ -SegmentResponse | P2P Media Loader Documentation

Type Alias SegmentResponse

SegmentResponse: {
    data: ArrayBuffer;
    bandwidth: number;
}

Represents the response from a segment request, including the data and measured bandwidth.

-

Type declaration

  • data: ArrayBuffer

    Segment data as an ArrayBuffer.

    -
  • bandwidth: number

    Measured bandwidth for the segment download, in bytes per second.

    -

Settings

Member Visibility
diff --git a/docs/v2.0/types/p2p_media_loader_core.SegmentStartDetails.html b/docs/v2.0/types/p2p_media_loader_core.SegmentStartDetails.html deleted file mode 100644 index 3b6d2a34..00000000 --- a/docs/v2.0/types/p2p_media_loader_core.SegmentStartDetails.html +++ /dev/null @@ -1,178 +0,0 @@ -SegmentStartDetails | P2P Media Loader Documentation

Type Alias SegmentStartDetails

SegmentStartDetails: {
    segment: Segment;
    downloadSource: DownloadSource;
    peerId: string | undefined;
}

Represents details about a segment event.

-

Type declaration

  • segment: Segment

    The segment that the event is about.

    -
  • downloadSource: DownloadSource

    The origin of the segment download.

    -
  • peerId: string | undefined

    The peer ID, if the segment is downloaded from a peer.

    -

Settings

Member Visibility
diff --git a/docs/v2.0/types/p2p_media_loader_core.SegmentWithStream.html b/docs/v2.0/types/p2p_media_loader_core.SegmentWithStream.html deleted file mode 100644 index 9be3f964..00000000 --- a/docs/v2.0/types/p2p_media_loader_core.SegmentWithStream.html +++ /dev/null @@ -1,175 +0,0 @@ -SegmentWithStream | P2P Media Loader Documentation

Type Alias SegmentWithStream<TStream>

SegmentWithStream<TStream>: Segment & {
    stream: StreamWithSegments<TStream>;
}

Extends a Segment with a reference to its associated stream.

-

Type Parameters

Settings

Member Visibility
diff --git a/docs/v2.0/types/p2p_media_loader_core.Stream.html b/docs/v2.0/types/p2p_media_loader_core.Stream.html deleted file mode 100644 index 607d2652..00000000 --- a/docs/v2.0/types/p2p_media_loader_core.Stream.html +++ /dev/null @@ -1,178 +0,0 @@ -Stream | P2P Media Loader Documentation

Type Alias Stream

Stream: {
    runtimeId: string;
    type: StreamType;
    index: number;
}

Represents a media stream with various defining characteristics.

-

Type declaration

  • ReadonlyruntimeId: string

    Runtime identifier of the stream from an engine.

    -
  • Readonlytype: StreamType

    Stream type.

    -
  • Readonlyindex: number

    Stream index in the manifest.

    -

Settings

Member Visibility
diff --git a/docs/v2.0/types/p2p_media_loader_core.StreamConfig.html b/docs/v2.0/types/p2p_media_loader_core.StreamConfig.html deleted file mode 100644 index 0a87b0fe..00000000 --- a/docs/v2.0/types/p2p_media_loader_core.StreamConfig.html +++ /dev/null @@ -1,270 +0,0 @@ -StreamConfig | P2P Media Loader Documentation

Type Alias StreamConfig

StreamConfig: {
    isP2PDisabled: boolean;
    highDemandTimeWindow: number;
    httpDownloadTimeWindow: number;
    p2pDownloadTimeWindow: number;
    simultaneousHttpDownloads: number;
    simultaneousP2PDownloads: number;
    webRtcMaxMessageSize: number;
    p2pNotReceivingBytesTimeoutMs: number;
    p2pInactiveLoaderDestroyTimeoutMs: number;
    httpNotReceivingBytesTimeoutMs: number;
    httpErrorRetries: number;
    p2pErrorRetries: number;
    announceTrackers: string[];
    rtcConfig: RTCConfiguration;
    trackerClientVersionPrefix: string;
    swarmId?: string;
    validateP2PSegment?: ((url: string, byteRange?: ByteRange) => Promise<boolean>);
    httpRequestSetup?: ((segmentUrl: string, segmentByteRange: ByteRange | undefined, requestAbortSignal: AbortSignal, requestByteRange: {
        start: number;
        end?: number;
    } | undefined) => Promise<Request | undefined | null>);
}

Configuration options for the Core functionality, including network and processing parameters.

-

Type declaration

  • isP2PDisabled: boolean

    Indicates whether Peer-to-Peer (P2P) functionality is disabled for the stream. -If set to true, P2P functionality is disabled for the stream.

    -

    Default

    isP2PDisabled: false
-
    - -
  • highDemandTimeWindow: number

    Defines the duration of the time window, in seconds, during which segments are pre-loaded to ensure smooth playback. -This window helps prioritize the fetching of media segments that are imminent to playback.

    -

    Default

    highDemandTimeWindow: 15
-
    - -
  • httpDownloadTimeWindow: number

    Defines the time window, in seconds, for HTTP segment downloads. This property specifies the duration -over which media segments are pre-fetched using HTTP requests.

    -

    For a better P2P ratio, it is recommended to set this httpDownloadTimeWindow to be lower than p2pDownloadTimeWindow.

    -

    NOTE: This setting only takes effect if there is at least one peer connection and the connected peer -does not have the requested segments available to share via P2P.

    -

    Default

    httpDownloadTimeWindow: 3000
-
    - -
  • p2pDownloadTimeWindow: number

    Defines the time window, in seconds, dedicated to pre-fetching media segments via Peer-to-Peer (P2P) downloads. -This duration determines how much content is downloaded in advance using P2P connections to ensure smooth playback and reduce reliance on HTTP downloads.

    -

    For a better P2P ratio, it is recommended to set this time window to be greater than httpDownloadTimeWindow to maximize P2P usage.

    -

    Default

    p2pDownloadTimeWindow: 6000
-
    - -
  • simultaneousHttpDownloads: number

    Maximum number of simultaneous HTTP downloads allowed.

    -

    Default

    simultaneousHttpDownloads: 2
-
    - -
  • simultaneousP2PDownloads: number

    Maximum number of simultaneous P2P downloads allowed.

    -

    Default

    simultaneousP2PDownloads: 3
-
    - -
  • webRtcMaxMessageSize: number

    Maximum message size for WebRTC communications, in bytes.

    -

    Default

    webRtcMaxMessageSize: 64 * 1024 - 1
-
    - -
  • p2pNotReceivingBytesTimeoutMs: number

    Timeout for not receiving bytes from P2P, in milliseconds.

    -

    Default

    p2pNotReceivingBytesTimeoutMs: 2000
-
    - -
  • p2pInactiveLoaderDestroyTimeoutMs: number

    Timeout for destroying the P2P loader if inactive, in milliseconds.

    -

    Default

    p2pInactiveLoaderDestroyTimeoutMs: 30 * 1000
-
    - -
  • httpNotReceivingBytesTimeoutMs: number

    Timeout for not receiving bytes from HTTP downloads, in milliseconds.

    -

    Default

    httpNotReceivingBytesTimeoutMs: 3000
-
    - -
  • httpErrorRetries: number

    Number of retries allowed after an HTTP error.

    -

    Default

    httpErrorRetries: 3
-
    - -
  • p2pErrorRetries: number

    Number of retries allowed after a P2P error.

    -

    Default

    p2pErrorRetries: 3
-
    - -
  • announceTrackers: string[]

    List of URLs to the WebTorrent trackers used for announcing and discovering peers (i.e. WebRTC signaling).

    -

    WARNING: In the Safari browser, only the first tracker will be used. Safari has issues with multiple trackers, -leading to problems with sending SDP messages for WebRTC signaling.

    -

    Default

    The default trackers used are:

    -
    [
      "wss://tracker.novage.com.ua",
      "wss://tracker.webtorrent.dev",
      "wss://tracker.openwebtorrent.com",
    ]
-
    - -
  • rtcConfig: RTCConfiguration

    Configuration for the RTC layer, used in WebRTC communication. -This configuration specifies the STUN/TURN servers used by WebRTC to establish connections through NATs and firewalls.

    -

    See

    https://developer.mozilla.org/en-US/docs/Web/API/RTCConfiguration

    -

    Default

    {
      "rtcConfig": {
        "iceServers": [
          { "urls": "stun:stun.l.google.com:19302" },
          { "urls": "stun:global.stun.twilio.com:3478" }
        ]
      }
    }
-
    - -
  • trackerClientVersionPrefix: string

    Prefix to use for the WebTorrent client version in tracker communications. -If undefined, the default version prefix is used, which is calculated based on the package version.

    -

    Default

    trackerClientVersionPrefix: undefined
-
    - -
  • OptionalswarmId?: string

    Optional unique identifier for the swarm, used to isolate peer pools by media stream. -If undefined, the URL of the manifest is used as the swarm ID.

    -

    Default

    swarmId: undefined
-
    - -
  • OptionalvalidateP2PSegment?: ((url: string, byteRange?: ByteRange) => Promise<boolean>)

    Optional function to validate a P2P segment before fully integrating it into the playback buffer.

    -

    Default

    validateP2PSegment: undefined
-
    - -
      • (url, byteRange?): Promise<boolean>

      • Parameters

        • url: string

          URL of the segment to validate.

          -
        • OptionalbyteRange: ByteRange

          Optional byte range of the segment.

          -

        Returns Promise<boolean>

        A promise that resolves with a boolean indicating if the segment is valid.

        -
  • OptionalhttpRequestSetup?: ((segmentUrl: string, segmentByteRange: ByteRange | undefined, requestAbortSignal: AbortSignal, requestByteRange: {
        start: number;
        end?: number;
    } | undefined) => Promise<Request | undefined | null>)

    Optional function to customize the setup of HTTP requests for segment downloads.

    -

    Default

    httpRequestSetup: undefined
-
    - -
      • (segmentUrl, segmentByteRange, requestAbortSignal, requestByteRange): Promise<Request | undefined | null>

      • Parameters

        • segmentUrl: string

          URL of the segment.

          -
        • segmentByteRange: ByteRange | undefined

          The range of bytes requested for the segment.

          -
        • requestAbortSignal: AbortSignal

          An abort signal to cancel the request if needed.

          -
        • requestByteRange: {
              start: number;
              end?: number;
          } | undefined

          Additional byte range for partial requests, if required.

          -

        Returns Promise<Request | undefined | null>

        A promise that resolves with the configured request, or undefined if no customization should be made.

        -

Settings

Member Visibility
diff --git a/docs/v2.0/types/p2p_media_loader_core.StreamType.html b/docs/v2.0/types/p2p_media_loader_core.StreamType.html deleted file mode 100644 index 40418f0d..00000000 --- a/docs/v2.0/types/p2p_media_loader_core.StreamType.html +++ /dev/null @@ -1,175 +0,0 @@ -StreamType | P2P Media Loader Documentation

Type Alias StreamType

StreamType: "main" | "secondary"

Represents the types of streams available, either primary (main) or secondary.

-

Settings

Member Visibility
diff --git a/docs/v2.0/types/p2p_media_loader_core.StreamWithSegments.html b/docs/v2.0/types/p2p_media_loader_core.StreamWithSegments.html deleted file mode 100644 index aec32ad4..00000000 --- a/docs/v2.0/types/p2p_media_loader_core.StreamWithSegments.html +++ /dev/null @@ -1,176 +0,0 @@ -StreamWithSegments | P2P Media Loader Documentation

Type Alias StreamWithSegments<TStream>

StreamWithSegments<TStream>: TStream & {
    segments: Map<string, SegmentWithStream<TStream>>;
}

Represents a stream that includes multiple segments, each associated with the stream.

-

Type Parameters

  • TStream extends Stream = Stream

    Type of the underlying stream data structure.

    -

Settings

Member Visibility
diff --git a/docs/v2.0/types/p2p_media_loader_core.TrackerErrorDetails.html b/docs/v2.0/types/p2p_media_loader_core.TrackerErrorDetails.html deleted file mode 100644 index 2d792312..00000000 --- a/docs/v2.0/types/p2p_media_loader_core.TrackerErrorDetails.html +++ /dev/null @@ -1,177 +0,0 @@ -TrackerErrorDetails | P2P Media Loader Documentation

Type Alias TrackerErrorDetails

TrackerErrorDetails: {
    streamType: StreamType;
    error: unknown;
}

Represents the details of a tracker error event.

-

Type declaration

  • streamType: StreamType

    The type of stream that the tracker is for.

    -
  • error: unknown

    The error that occurred during the tracker request.

    -

Settings

Member Visibility
diff --git a/docs/v2.0/types/p2p_media_loader_core.TrackerWarningDetails.html b/docs/v2.0/types/p2p_media_loader_core.TrackerWarningDetails.html deleted file mode 100644 index a996c273..00000000 --- a/docs/v2.0/types/p2p_media_loader_core.TrackerWarningDetails.html +++ /dev/null @@ -1,176 +0,0 @@ -TrackerWarningDetails | P2P Media Loader Documentation

Type Alias TrackerWarningDetails

TrackerWarningDetails: {
    streamType: StreamType;
    warning: unknown;
}

Type declaration

  • streamType: StreamType

    The type of stream that the tracker is for.

    -
  • warning: unknown

    The warning that occurred during the tracker request.

    -

Settings

Member Visibility
diff --git a/docs/v2.0/types/p2p_media_loader_hlsjs.DynamicHlsJsP2PEngineConfig.html b/docs/v2.0/types/p2p_media_loader_hlsjs.DynamicHlsJsP2PEngineConfig.html deleted file mode 100644 index 93679bf6..00000000 --- a/docs/v2.0/types/p2p_media_loader_hlsjs.DynamicHlsJsP2PEngineConfig.html +++ /dev/null @@ -1,176 +0,0 @@ -DynamicHlsJsP2PEngineConfig | P2P Media Loader Documentation

Type Alias DynamicHlsJsP2PEngineConfig

DynamicHlsJsP2PEngineConfig: {
    core?: DynamicCoreConfig;
}

Type for specifying dynamic configuration options that can be changed at runtime for the P2P engine's core.

-

Type declaration

Settings

Member Visibility
diff --git a/docs/v2.0/types/p2p_media_loader_hlsjs.HlsJsP2PEngineConfig.html b/docs/v2.0/types/p2p_media_loader_hlsjs.HlsJsP2PEngineConfig.html deleted file mode 100644 index 7608299d..00000000 --- a/docs/v2.0/types/p2p_media_loader_hlsjs.HlsJsP2PEngineConfig.html +++ /dev/null @@ -1,176 +0,0 @@ -HlsJsP2PEngineConfig | P2P Media Loader Documentation

Type Alias HlsJsP2PEngineConfig

HlsJsP2PEngineConfig: {
    core: DefinedCoreConfig;
}

Represents the complete configuration for HlsJsP2PEngine.

-

Type declaration

Settings

Member Visibility
diff --git a/docs/v2.0/types/p2p_media_loader_hlsjs.HlsWithP2PConfig.html b/docs/v2.0/types/p2p_media_loader_hlsjs.HlsWithP2PConfig.html deleted file mode 100644 index 69449e36..00000000 --- a/docs/v2.0/types/p2p_media_loader_hlsjs.HlsWithP2PConfig.html +++ /dev/null @@ -1,176 +0,0 @@ -HlsWithP2PConfig | P2P Media Loader Documentation

Type Alias HlsWithP2PConfig<HlsType>

HlsWithP2PConfig<HlsType>: ConstructorParameters<HlsType>[0] & {
    p2p?: PartialHlsJsP2PEngineConfig & {
        onHlsJsCreated?: ((hls: HlsWithP2PInstance<HlsType>) => void);
    };
}

Configuration type for HLS instances that includes P2P settings, augmenting standard HLS configuration with P2P capabilities.

-

Type Parameters

  • HlsType extends (abstract new () => unknown)

    A constructor type that produces an HLS instance.

    -

Settings

Member Visibility
diff --git a/docs/v2.0/types/p2p_media_loader_hlsjs.HlsWithP2PInstance.html b/docs/v2.0/types/p2p_media_loader_hlsjs.HlsWithP2PInstance.html deleted file mode 100644 index 327f0bd8..00000000 --- a/docs/v2.0/types/p2p_media_loader_hlsjs.HlsWithP2PInstance.html +++ /dev/null @@ -1,177 +0,0 @@ -HlsWithP2PInstance | P2P Media Loader Documentation

Type Alias HlsWithP2PInstance<HlsType>

HlsWithP2PInstance<HlsType>: HlsType & {
    p2pEngine: HlsJsP2PEngine;
}

Extends a generic HLS type to include the P2P engine, integrating P2P capabilities directly into the HLS instance.

-

Type Parameters

  • HlsType

    The base HLS type that is being extended.

    -

Type declaration

Settings

Member Visibility
diff --git a/docs/v2.0/types/p2p_media_loader_hlsjs.PartialHlsJsP2PEngineConfig.html b/docs/v2.0/types/p2p_media_loader_hlsjs.PartialHlsJsP2PEngineConfig.html deleted file mode 100644 index 1d1781b2..00000000 --- a/docs/v2.0/types/p2p_media_loader_hlsjs.PartialHlsJsP2PEngineConfig.html +++ /dev/null @@ -1,176 +0,0 @@ -PartialHlsJsP2PEngineConfig | P2P Media Loader Documentation

Type Alias PartialHlsJsP2PEngineConfig

PartialHlsJsP2PEngineConfig: Partial<Omit<HlsJsP2PEngineConfig, "core">> & {
    core?: Partial<CoreConfig>;
}

Allows for partial configuration of HlsJsP2PEngine, useful for providing overrides or partial updates.

-

Type declaration

  • Optionalcore?: Partial<CoreConfig>

    Partial core config

    -

Settings

Member Visibility
diff --git a/docs/v2.0/types/p2p_media_loader_shaka.DynamicShakaP2PEngineConfig.html b/docs/v2.0/types/p2p_media_loader_shaka.DynamicShakaP2PEngineConfig.html deleted file mode 100644 index a664a836..00000000 --- a/docs/v2.0/types/p2p_media_loader_shaka.DynamicShakaP2PEngineConfig.html +++ /dev/null @@ -1,176 +0,0 @@ -DynamicShakaP2PEngineConfig | P2P Media Loader Documentation

Type Alias DynamicShakaP2PEngineConfig

DynamicShakaP2PEngineConfig: {
    core?: DynamicCoreConfig;
}

Type for specifying dynamic configuration options that can be changed at runtime for the P2P engine's core.

-

Type declaration

Settings

Member Visibility
diff --git a/docs/v2.0/types/p2p_media_loader_shaka.PartialShakaEngineConfig.html b/docs/v2.0/types/p2p_media_loader_shaka.PartialShakaEngineConfig.html deleted file mode 100644 index 4fb13128..00000000 --- a/docs/v2.0/types/p2p_media_loader_shaka.PartialShakaEngineConfig.html +++ /dev/null @@ -1,176 +0,0 @@ -PartialShakaEngineConfig | P2P Media Loader Documentation

Type Alias PartialShakaEngineConfig

PartialShakaEngineConfig: Partial<Omit<ShakaP2PEngineConfig, "core">> & {
    core?: Partial<CoreConfig>;
}

Allows for partial configuration settings for the Shaka P2P Engine.

-

Type declaration

  • Optionalcore?: Partial<CoreConfig>

    Partial core config

    -

Settings

Member Visibility
diff --git a/docs/v2.0/types/p2p_media_loader_shaka.ShakaP2PEngineConfig.html b/docs/v2.0/types/p2p_media_loader_shaka.ShakaP2PEngineConfig.html deleted file mode 100644 index 06b4f3d4..00000000 --- a/docs/v2.0/types/p2p_media_loader_shaka.ShakaP2PEngineConfig.html +++ /dev/null @@ -1,176 +0,0 @@ -ShakaP2PEngineConfig | P2P Media Loader Documentation

Type Alias ShakaP2PEngineConfig

ShakaP2PEngineConfig: {
    core: DefinedCoreConfig;
}

Represents the complete configuration for ShakaP2PEngine.

-

Type declaration

Settings

Member Visibility