diff --git a/docs/assets/highlight.css b/docs/assets/highlight.css index b93b386..6b28338 100644 --- a/docs/assets/highlight.css +++ b/docs/assets/highlight.css @@ -1,25 +1,25 @@ :root { - --light-hl-0: #000000; - --dark-hl-0: #D4D4D4; - --light-hl-1: #0000FF; - --dark-hl-1: #569CD6; - --light-hl-2: #267F99; - --dark-hl-2: #4EC9B0; - --light-hl-3: #795E26; - --dark-hl-3: #DCDCAA; - --light-hl-4: #008000; - --dark-hl-4: #6A9955; - --light-hl-5: #001080; - --dark-hl-5: #9CDCFE; - --light-hl-6: #AF00DB; - --dark-hl-6: #C586C0; - --light-hl-7: #A31515; - --dark-hl-7: #CE9178; + --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: #0000FF; + --dark-hl-3: #569CD6; + --light-hl-4: #267F99; + --dark-hl-4: #4EC9B0; + --light-hl-5: #008000; + --dark-hl-5: #6A9955; + --light-hl-6: #001080; + --dark-hl-6: #9CDCFE; + --light-hl-7: #AF00DB; + --dark-hl-7: #C586C0; --light-hl-8: #0070C1; --dark-hl-8: #4FC1FF; --light-hl-9: #800000; --dark-hl-9: #808080; - --light-hl-10: #FF0000; + --light-hl-10: #E50000; --dark-hl-10: #9CDCFE; --light-hl-11: #000000FF; --dark-hl-11: #D4D4D4; diff --git a/docs/assets/main.js b/docs/assets/main.js index abd0485..d6f1388 100644 --- a/docs/assets/main.js +++ b/docs/assets/main.js @@ -1,54 +1,59 @@ "use strict"; -"use strict";(()=>{var Qe=Object.create;var ae=Object.defineProperty;var Pe=Object.getOwnPropertyDescriptor;var Ce=Object.getOwnPropertyNames;var Oe=Object.getPrototypeOf,Re=Object.prototype.hasOwnProperty;var _e=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Me=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Ce(e))!Re.call(t,i)&&i!==n&&ae(t,i,{get:()=>e[i],enumerable:!(r=Pe(e,i))||r.enumerable});return t};var De=(t,e,n)=>(n=t!=null?Qe(Oe(t)):{},Me(e||!t||!t.__esModule?ae(n,"default",{value:t,enumerable:!0}):n,t));var de=_e((ce,he)=>{(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 h=t.utils.clone(n)||{};h.position=[a,l],h.index=s.length,s.push(new t.Token(r.slice(a,o),h))}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(ou?h+=2:a==u&&(n+=r[l+1]*i[h+1],l+=2,h+=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 u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}if(s.str.length==0&&(u.final=!0),i.push({node:u,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 l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}s.str.length==1&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var h=s.str.charAt(0),m=s.str.charAt(1),v;m in s.node.edges?v=s.node.edges[m]:(v=new t.TokenSet,s.node.edges[m]=v),s.str.length==1&&(v.final=!0),i.push({node:v,editsRemaining:s.editsRemaining-1,str:h+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),u=0;u1?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 ce=="object"?he.exports=n():e.lunr=n()}(this,function(){return t})})()});var le=[];function j(t,e){le.push({selector:e,constructor:t})}var Y=class{constructor(){this.createComponents(document.body)}createComponents(e){le.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r}),r.dataset.hasInstance=String(!0))})})}};var k=class{constructor(e){this.el=e.el}};var J=class{constructor(){this.listeners={}}addEventListener(e,n){e in this.listeners||(this.listeners[e]=[]),this.listeners[e].push(n)}removeEventListener(e,n){if(!(e in this.listeners))return;let r=this.listeners[e];for(let i=0,s=r.length;i{let n=Date.now();return(...r)=>{n+e-Date.now()<0&&(t(...r),n=Date.now())}};var re=class extends J{constructor(){super();this.scrollTop=0;this.lastY=0;this.width=0;this.height=0;this.showToolbar=!0;this.toolbar=document.querySelector(".tsd-page-toolbar"),this.navigation=document.querySelector(".col-menu"),window.addEventListener("scroll",ne(()=>this.onScroll(),10)),window.addEventListener("resize",ne(()=>this.onResize(),10)),this.searchInput=document.querySelector("#tsd-search input"),this.searchInput&&this.searchInput.addEventListener("focus",()=>{this.hideShowToolbar()}),this.onResize(),this.onScroll()}triggerResize(){let n=new CustomEvent("resize",{detail:{width:this.width,height:this.height}});this.dispatchEvent(n)}onResize(){this.width=window.innerWidth||0,this.height=window.innerHeight||0;let n=new CustomEvent("resize",{detail:{width:this.width,height:this.height}});this.dispatchEvent(n)}onScroll(){this.scrollTop=window.scrollY||0;let n=new CustomEvent("scroll",{detail:{scrollTop:this.scrollTop}});this.dispatchEvent(n),this.hideShowToolbar()}hideShowToolbar(){let n=this.showToolbar;this.showToolbar=this.lastY>=this.scrollTop||this.scrollTop<=0||!!this.searchInput&&this.searchInput===document.activeElement,n!==this.showToolbar&&(this.toolbar.classList.toggle("tsd-page-toolbar--hide"),this.navigation?.classList.toggle("col-menu--hide")),this.lastY=this.scrollTop}},R=re;R.instance=new re;var X=class extends k{constructor(n){super(n);this.anchors=[];this.index=-1;R.instance.addEventListener("resize",()=>this.onResize()),R.instance.addEventListener("scroll",r=>this.onScroll(r)),this.createAnchors()}createAnchors(){let n=window.location.href;n.indexOf("#")!=-1&&(n=n.substring(0,n.indexOf("#"))),this.el.querySelectorAll("a").forEach(r=>{let i=r.href;if(i.indexOf("#")==-1||i.substring(0,n.length)!=n)return;let s=i.substring(i.indexOf("#")+1),o=document.querySelector("a.tsd-anchor[name="+s+"]"),a=r.parentNode;!o||!a||this.anchors.push({link:a,anchor:o,position:0})}),this.onResize()}onResize(){let n;for(let i=0,s=this.anchors.length;ii.position-s.position);let r=new CustomEvent("scroll",{detail:{scrollTop:R.instance.scrollTop}});this.onScroll(r)}onScroll(n){let r=n.detail.scrollTop+5,i=this.anchors,s=i.length-1,o=this.index;for(;o>-1&&i[o].position>r;)o-=1;for(;o-1&&this.anchors[this.index].link.classList.remove("focus"),this.index=o,this.index>-1&&this.anchors[this.index].link.classList.add("focus"))}};var ue=(t,e=100)=>{let n;return(...r)=>{clearTimeout(n),n=setTimeout(()=>t(r),e)}};var me=De(de());function ve(){let t=document.getElementById("tsd-search");if(!t)return;let e=document.getElementById("search-script");t.classList.add("loading"),e&&(e.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),e.addEventListener("load",()=>{t.classList.remove("loading"),t.classList.add("ready")}),window.searchData&&t.classList.remove("loading"));let n=document.querySelector("#tsd-search input"),r=document.querySelector("#tsd-search .results");if(!n||!r)throw new Error("The input field or the result list wrapper was not found");let i=!1;r.addEventListener("mousedown",()=>i=!0),r.addEventListener("mouseup",()=>{i=!1,t.classList.remove("has-focus")}),n.addEventListener("focus",()=>t.classList.add("has-focus")),n.addEventListener("blur",()=>{i||(i=!1,t.classList.remove("has-focus"))});let s={base:t.dataset.base+"/"};Fe(t,r,n,s)}function Fe(t,e,n,r){n.addEventListener("input",ue(()=>{Ae(t,e,n,r)},200));let i=!1;n.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Ve(e,n):s.key=="Escape"?n.blur():s.key=="ArrowUp"?fe(e,-1):s.key==="ArrowDown"?fe(e,1):i=!1}),n.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!n.matches(":focus")&&s.key==="/"&&(n.focus(),s.preventDefault())})}function He(t,e){t.index||window.searchData&&(e.classList.remove("loading"),e.classList.add("ready"),t.data=window.searchData,t.index=me.Index.load(window.searchData.index))}function Ae(t,e,n,r){if(He(r,t),!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s=i?r.index.search(`*${i}*`):[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o${pe(u.parent,i)}.${l}`);let h=document.createElement("li");h.classList.value=u.classes??"";let m=document.createElement("a");m.href=r.base+u.url,m.innerHTML=l,h.append(m),e.appendChild(h)}}function fe(t,e){let n=t.querySelector(".current");if(!n)n=t.querySelector(e==1?"li:first-child":"li:last-child"),n&&n.classList.add("current");else{let r=n;if(e===1)do r=r.nextElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);else do r=r.previousElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);r&&(n.classList.remove("current"),r.classList.add("current"))}}function Ve(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),e.blur()}}function pe(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(ie(t.substring(s,o)),`${ie(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(ie(t.substring(s))),i.join("")}var Ne={"&":"&","<":"<",">":">","'":"'",'"':"""};function ie(t){return t.replace(/[&<>"'"]/g,e=>Ne[e])}var F="mousedown",ye="mousemove",B="mouseup",Z={x:0,y:0},ge=!1,se=!1,je=!1,H=!1,xe=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(xe?"is-mobile":"not-mobile");xe&&"ontouchstart"in document.documentElement&&(je=!0,F="touchstart",ye="touchmove",B="touchend");document.addEventListener(F,t=>{se=!0,H=!1;let e=F=="touchstart"?t.targetTouches[0]:t;Z.y=e.pageY||0,Z.x=e.pageX||0});document.addEventListener(ye,t=>{if(!!se&&!H){let e=F=="touchstart"?t.targetTouches[0]:t,n=Z.x-(e.pageX||0),r=Z.y-(e.pageY||0);H=Math.sqrt(n*n+r*r)>10}});document.addEventListener(B,()=>{se=!1});document.addEventListener("click",t=>{ge&&(t.preventDefault(),t.stopImmediatePropagation(),ge=!1)});var K=class extends k{constructor(n){super(n);this.className=this.el.dataset.toggle||"",this.el.addEventListener(B,r=>this.onPointerUp(r)),this.el.addEventListener("click",r=>r.preventDefault()),document.addEventListener(F,r=>this.onDocumentPointerDown(r)),document.addEventListener(B,r=>this.onDocumentPointerUp(r))}setActive(n){if(this.active==n)return;this.active=n,document.documentElement.classList.toggle("has-"+this.className,n),this.el.classList.toggle("active",n);let r=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(r),setTimeout(()=>document.documentElement.classList.remove(r),500)}onPointerUp(n){H||(this.setActive(!0),n.preventDefault())}onDocumentPointerDown(n){if(this.active){if(n.target.closest(".col-menu, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(n){if(!H&&this.active&&n.target.closest(".col-menu")){let r=n.target.closest("a");if(r){let i=window.location.href;i.indexOf("#")!=-1&&(i=i.substring(0,i.indexOf("#"))),r.href.substring(0,i.length)==i&&setTimeout(()=>this.setActive(!1),250)}}}};var oe;try{oe=localStorage}catch{oe={getItem(){return null},setItem(){}}}var Q=oe;var Le=document.head.appendChild(document.createElement("style"));Le.dataset.for="filters";var ee=class extends k{constructor(n){super(n);this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),Le.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } -`}fromLocalStorage(){let n=Q.getItem(this.key);return n?n==="true":this.el.checked}setLocalStorage(n){Q.setItem(this.key,n.toString()),this.value=n,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),document.querySelectorAll(".tsd-index-section").forEach(n=>{n.style.display="block";let r=Array.from(n.querySelectorAll(".tsd-index-link")).every(i=>i.offsetParent==null);n.style.display=r?"none":"block"})}};var te=class extends k{constructor(n){super(n);this.calculateHeights(),this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.textContent.replace(/\s+/g,"-").toLowerCase()}`,this.setLocalStorage(this.fromLocalStorage(),!0),this.summary.addEventListener("click",r=>this.toggleVisibility(r)),this.icon.style.transform=this.getIconRotation()}getIconRotation(n=this.el.open){return`rotate(${n?0:-90}deg)`}calculateHeights(){let n=this.el.open,{position:r,left:i}=this.el.style;this.el.style.position="fixed",this.el.style.left="-9999px",this.el.open=!0,this.expandedHeight=this.el.offsetHeight+"px",this.el.open=!1,this.collapsedHeight=this.el.offsetHeight+"px",this.el.open=n,this.el.style.height=n?this.expandedHeight:this.collapsedHeight,this.el.style.position=r,this.el.style.left=i}toggleVisibility(n){n.preventDefault(),this.el.style.overflow="hidden",this.el.open?this.collapse():this.expand()}expand(n=!0){this.el.open=!0,this.animate(this.collapsedHeight,this.expandedHeight,{opening:!0,duration:n?300:0})}collapse(n=!0){this.animate(this.expandedHeight,this.collapsedHeight,{opening:!1,duration:n?300:0})}animate(n,r,{opening:i,duration:s=300}){if(this.animation)return;let o={duration:s,easing:"ease"};this.animation=this.el.animate({height:[n,r]},o),this.icon.animate({transform:[this.icon.style.transform||this.getIconRotation(!i),this.getIconRotation(i)]},o).addEventListener("finish",()=>{this.icon.style.transform=this.getIconRotation(i)}),this.animation.addEventListener("finish",()=>this.animationEnd(i))}animationEnd(n){this.el.open=n,this.animation=void 0,this.el.style.height="auto",this.el.style.overflow="visible",this.setLocalStorage(n)}fromLocalStorage(){let n=Q.getItem(this.key);return n?n==="true":this.el.open}setLocalStorage(n,r=!1){this.fromLocalStorage()===n&&!r||(Q.setItem(this.key,n.toString()),this.el.open=n,this.handleValueChange(r))}handleValueChange(n=!1){this.fromLocalStorage()===this.el.open&&!n||(this.fromLocalStorage()?this.expand(!1):this.collapse(!1))}};function be(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,Ee(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),Ee(t.value)})}function Ee(t){document.documentElement.dataset.theme=t}ve();j(X,".menu-highlight");j(K,"a[data-toggle]");j(te,".tsd-index-accordion");j(ee,".tsd-filter-item input[type=checkbox]");var Se=document.getElementById("theme");Se&&be(Se);var Be=new Y;Object.defineProperty(window,"app",{value:Be});})(); -/*! - * lunr.Builder - * Copyright (C) 2020 Oliver Nightingale - */ -/*! - * lunr.Index - * Copyright (C) 2020 Oliver Nightingale - */ -/*! - * lunr.Pipeline - * Copyright (C) 2020 Oliver Nightingale - */ -/*! - * lunr.Set - * Copyright (C) 2020 Oliver Nightingale - */ -/*! - * lunr.TokenSet - * 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.tokenizer - * Copyright (C) 2020 Oliver Nightingale - */ -/*! - * lunr.trimmer - * Copyright (C) 2020 Oliver Nightingale - */ -/*! - * lunr.utils - * Copyright (C) 2020 Oliver Nightingale - */ -/** - * 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 - */ +"use strict";(()=>{var Ce=Object.create;var ne=Object.defineProperty;var Pe=Object.getOwnPropertyDescriptor;var Oe=Object.getOwnPropertyNames;var _e=Object.getPrototypeOf,Re=Object.prototype.hasOwnProperty;var Me=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Fe=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Oe(e))!Re.call(t,i)&&i!==n&&ne(t,i,{get:()=>e[i],enumerable:!(r=Pe(e,i))||r.enumerable});return t};var De=(t,e,n)=>(n=t!=null?Ce(_e(t)):{},Fe(e||!t||!t.__esModule?ne(n,"default",{value:t,enumerable:!0}):n,t));var ae=Me((se,oe)=>{(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),y=s.str.charAt(1),p;y in s.node.edges?p=s.node.edges[y]:(p=new t.TokenSet,s.node.edges[y]=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 se=="object"?oe.exports=n():e.lunr=n()}(this,function(){return t})})()});var re=[];function G(t,e){re.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){re.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&&(console.log("Show page"),document.body.style.removeProperty("display"),this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}scrollToHash(){if(location.hash){console.log("Scorlling");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&&!e.checkVisibility()){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").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&&n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let r=document.createElement("p");r.classList.add("warning"),r.textContent="This member is normally hidden due to your filter settings.",n.prepend(r)}}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="Copied!",e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent="Copy"},100)},1e3)})})}};var ie=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var de=De(ae());async function le(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=de.Index.load(i.index),e.classList.remove("loading"),e.classList.add("ready")}function he(){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",()=>{le(e,t)}),le(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");let s=!1;i.addEventListener("mousedown",()=>s=!0),i.addEventListener("mouseup",()=>{s=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{s||(s=!1,t.classList.remove("has-focus"))}),Ae(t,i,r,e)}function Ae(t,e,n,r){n.addEventListener("input",ie(()=>{Ve(t,e,n,r)},200));let i=!1;n.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Ne(e,n):s.key=="Escape"?n.blur():s.key=="ArrowUp"?ue(e,-1):s.key==="ArrowDown"?ue(e,1):i=!1}),n.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!n.matches(":focus")&&s.key==="/"&&(n.focus(),s.preventDefault())})}function Ve(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=ce(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=` + ${ce(l.parent,i)}.${d}`);let y=document.createElement("li");y.classList.value=l.classes??"";let p=document.createElement("a");p.href=r.base+l.url,p.innerHTML=u+d,y.append(p),e.appendChild(y)}}function ue(t,e){let n=t.querySelector(".current");if(!n)n=t.querySelector(e==1?"li:first-child":"li:last-child"),n&&n.classList.add("current");else{let r=n;if(e===1)do r=r.nextElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);else do r=r.previousElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);r&&(n.classList.remove("current"),r.classList.add("current"))}}function Ne(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),e.blur()}}function ce(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(K(t.substring(s,o)),`${K(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(K(t.substring(s))),i.join("")}var He={"&":"&","<":"<",">":">","'":"'",'"':"""};function K(t){return t.replace(/[&<>"'"]/g,e=>He[e])}var I=class{constructor(e){this.el=e.el,this.app=e.app}};var F="mousedown",fe="mousemove",H="mouseup",J={x:0,y:0},pe=!1,ee=!1,Be=!1,D=!1,me=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(me?"is-mobile":"not-mobile");me&&"ontouchstart"in document.documentElement&&(Be=!0,F="touchstart",fe="touchmove",H="touchend");document.addEventListener(F,t=>{ee=!0,D=!1;let e=F=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(fe,t=>{if(ee&&!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(H,()=>{ee=!1});document.addEventListener("click",t=>{pe&&(t.preventDefault(),t.stopImmediatePropagation(),pe=!1)});var X=class extends I{constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener(H,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(F,n=>this.onDocumentPointerDown(n)),document.addEventListener(H,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 te;try{te=localStorage}catch{te={getItem(){return null},setItem(){}}}var Q=te;var ye=document.head.appendChild(document.createElement("style"));ye.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()),ye.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 ge(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,ve(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),ve(t.value)})}function ve(t){document.documentElement.dataset.theme=t}var Le;function be(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",xe),xe())}async function xe(){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();Le=t.dataset.base+"/",t.innerHTML="";for(let s of i)we(s,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function we(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-index-accordion`:"tsd-index-accordion",s.dataset.key=i.join("$");let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.innerHTML='',Ee(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)we(u,l,i)}else Ee(t,r,t.class)}function Ee(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));r.href=Le+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-index-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var Se=document.getElementById("tsd-theme");Se&&ge(Se);var je=new U;Object.defineProperty(window,"app",{value:je});he();be();})(); +/*! 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/assets/search.js b/docs/assets/search.js index 7d987d6..4f61c9d 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1 @@ -window.searchData = JSON.parse("{\"kinds\":{\"32\":\"Variable\",\"64\":\"Function\",\"128\":\"Class\",\"256\":\"Interface\",\"512\":\"Constructor\",\"1024\":\"Property\",\"2048\":\"Method\",\"65536\":\"Type literal\",\"4194304\":\"Type alias\"},\"rows\":[{\"kind\":64,\"name\":\"registerGlobals\",\"url\":\"functions/registerGlobals.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":128,\"name\":\"AudioSession\",\"url\":\"classes/AudioSession.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":2048,\"name\":\"configureAudio\",\"url\":\"classes/AudioSession.html#configureAudio\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"AudioSession\"},{\"kind\":2048,\"name\":\"startAudioSession\",\"url\":\"classes/AudioSession.html#startAudioSession\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"AudioSession\"},{\"kind\":2048,\"name\":\"stopAudioSession\",\"url\":\"classes/AudioSession.html#stopAudioSession\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"AudioSession\"},{\"kind\":2048,\"name\":\"getAudioOutputs\",\"url\":\"classes/AudioSession.html#getAudioOutputs\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"AudioSession\"},{\"kind\":2048,\"name\":\"selectAudioOutput\",\"url\":\"classes/AudioSession.html#selectAudioOutput\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"AudioSession\"},{\"kind\":2048,\"name\":\"showAudioRoutePicker\",\"url\":\"classes/AudioSession.html#showAudioRoutePicker\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"AudioSession\"},{\"kind\":2048,\"name\":\"setAppleAudioConfiguration\",\"url\":\"classes/AudioSession.html#setAppleAudioConfiguration\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"AudioSession\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/AudioSession.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"AudioSession\"},{\"kind\":4194304,\"name\":\"AudioConfiguration\",\"url\":\"types/AudioConfiguration.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/AudioConfiguration.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"AudioConfiguration\"},{\"kind\":1024,\"name\":\"android\",\"url\":\"types/AudioConfiguration.html#__type.android\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"AudioConfiguration.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/AudioConfiguration.html#__type.__type-1\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"parent\":\"AudioConfiguration.__type\"},{\"kind\":1024,\"name\":\"preferredOutputList\",\"url\":\"types/AudioConfiguration.html#__type.__type-1.preferredOutputList\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"AudioConfiguration.__type.__type\"},{\"kind\":1024,\"name\":\"audioTypeOptions\",\"url\":\"types/AudioConfiguration.html#__type.__type-1.audioTypeOptions\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"AudioConfiguration.__type.__type\"},{\"kind\":1024,\"name\":\"ios\",\"url\":\"types/AudioConfiguration.html#__type.ios\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"AudioConfiguration.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/AudioConfiguration.html#__type.__type-2\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-literal\",\"parent\":\"AudioConfiguration.__type\"},{\"kind\":1024,\"name\":\"defaultOutput\",\"url\":\"types/AudioConfiguration.html#__type.__type-2.defaultOutput\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"AudioConfiguration.__type.__type\"},{\"kind\":4194304,\"name\":\"AndroidAudioTypeOptions\",\"url\":\"types/AndroidAudioTypeOptions.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/AndroidAudioTypeOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"AndroidAudioTypeOptions\"},{\"kind\":1024,\"name\":\"manageAudioFocus\",\"url\":\"types/AndroidAudioTypeOptions.html#__type.manageAudioFocus\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"AndroidAudioTypeOptions.__type\"},{\"kind\":1024,\"name\":\"audioMode\",\"url\":\"types/AndroidAudioTypeOptions.html#__type.audioMode\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"AndroidAudioTypeOptions.__type\"},{\"kind\":1024,\"name\":\"audioFocusMode\",\"url\":\"types/AndroidAudioTypeOptions.html#__type.audioFocusMode\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"AndroidAudioTypeOptions.__type\"},{\"kind\":1024,\"name\":\"audioAttributesUsageType\",\"url\":\"types/AndroidAudioTypeOptions.html#__type.audioAttributesUsageType\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"AndroidAudioTypeOptions.__type\"},{\"kind\":1024,\"name\":\"audioAttributesContentType\",\"url\":\"types/AndroidAudioTypeOptions.html#__type.audioAttributesContentType\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"AndroidAudioTypeOptions.__type\"},{\"kind\":1024,\"name\":\"audioStreamType\",\"url\":\"types/AndroidAudioTypeOptions.html#__type.audioStreamType\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"AndroidAudioTypeOptions.__type\"},{\"kind\":1024,\"name\":\"forceHandleAudioRouting\",\"url\":\"types/AndroidAudioTypeOptions.html#__type.forceHandleAudioRouting\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"AndroidAudioTypeOptions.__type\"},{\"kind\":32,\"name\":\"AndroidAudioTypePresets\",\"url\":\"variables/AndroidAudioTypePresets.html\",\"classes\":\"tsd-kind-variable\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"variables/AndroidAudioTypePresets.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-variable\",\"parent\":\"AndroidAudioTypePresets\"},{\"kind\":1024,\"name\":\"communication\",\"url\":\"variables/AndroidAudioTypePresets.html#__type.communication\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"AndroidAudioTypePresets.__type\"},{\"kind\":1024,\"name\":\"media\",\"url\":\"variables/AndroidAudioTypePresets.html#__type.media\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"AndroidAudioTypePresets.__type\"},{\"kind\":4194304,\"name\":\"AppleAudioCategory\",\"url\":\"types/AppleAudioCategory.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":4194304,\"name\":\"AppleAudioCategoryOption\",\"url\":\"types/AppleAudioCategoryOption.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":4194304,\"name\":\"AppleAudioConfiguration\",\"url\":\"types/AppleAudioConfiguration.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/AppleAudioConfiguration.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"AppleAudioConfiguration\"},{\"kind\":1024,\"name\":\"audioCategory\",\"url\":\"types/AppleAudioConfiguration.html#__type.audioCategory\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"AppleAudioConfiguration.__type\"},{\"kind\":1024,\"name\":\"audioCategoryOptions\",\"url\":\"types/AppleAudioConfiguration.html#__type.audioCategoryOptions\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"AppleAudioConfiguration.__type\"},{\"kind\":1024,\"name\":\"audioMode\",\"url\":\"types/AppleAudioConfiguration.html#__type.audioMode\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"AppleAudioConfiguration.__type\"},{\"kind\":4194304,\"name\":\"AppleAudioMode\",\"url\":\"types/AppleAudioMode.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":4194304,\"name\":\"AudioTrackState\",\"url\":\"types/AudioTrackState.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":64,\"name\":\"getDefaultAppleAudioConfigurationForMode\",\"url\":\"functions/getDefaultAppleAudioConfigurationForMode.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":4194304,\"name\":\"LogLevel\",\"url\":\"types/LogLevel.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":4194304,\"name\":\"SetLogLevelOptions\",\"url\":\"types/SetLogLevelOptions.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/SetLogLevelOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"SetLogLevelOptions\"},{\"kind\":1024,\"name\":\"liveKitClientLogLevel\",\"url\":\"types/SetLogLevelOptions.html#__type.liveKitClientLogLevel\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"SetLogLevelOptions.__type\"},{\"kind\":64,\"name\":\"LiveKitRoom\",\"url\":\"functions/LiveKitRoom.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":256,\"name\":\"LiveKitRoomProps\",\"url\":\"interfaces/LiveKitRoomProps.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"serverUrl\",\"url\":\"interfaces/LiveKitRoomProps.html#serverUrl\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"LiveKitRoomProps\"},{\"kind\":1024,\"name\":\"token\",\"url\":\"interfaces/LiveKitRoomProps.html#token\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"LiveKitRoomProps\"},{\"kind\":1024,\"name\":\"audio\",\"url\":\"interfaces/LiveKitRoomProps.html#audio\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"LiveKitRoomProps\"},{\"kind\":1024,\"name\":\"video\",\"url\":\"interfaces/LiveKitRoomProps.html#video\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"LiveKitRoomProps\"},{\"kind\":1024,\"name\":\"screen\",\"url\":\"interfaces/LiveKitRoomProps.html#screen\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"LiveKitRoomProps\"},{\"kind\":1024,\"name\":\"connect\",\"url\":\"interfaces/LiveKitRoomProps.html#connect\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"LiveKitRoomProps\"},{\"kind\":1024,\"name\":\"options\",\"url\":\"interfaces/LiveKitRoomProps.html#options\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"LiveKitRoomProps\"},{\"kind\":1024,\"name\":\"connectOptions\",\"url\":\"interfaces/LiveKitRoomProps.html#connectOptions\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"LiveKitRoomProps\"},{\"kind\":1024,\"name\":\"onConnected\",\"url\":\"interfaces/LiveKitRoomProps.html#onConnected\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"LiveKitRoomProps\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/LiveKitRoomProps.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-interface\",\"parent\":\"LiveKitRoomProps\"},{\"kind\":1024,\"name\":\"onDisconnected\",\"url\":\"interfaces/LiveKitRoomProps.html#onDisconnected\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"LiveKitRoomProps\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/LiveKitRoomProps.html#__type-2\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-interface\",\"parent\":\"LiveKitRoomProps\"},{\"kind\":1024,\"name\":\"onError\",\"url\":\"interfaces/LiveKitRoomProps.html#onError\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"LiveKitRoomProps\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/LiveKitRoomProps.html#__type-6\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-interface\",\"parent\":\"LiveKitRoomProps\"},{\"kind\":1024,\"name\":\"onMediaDeviceFailure\",\"url\":\"interfaces/LiveKitRoomProps.html#onMediaDeviceFailure\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"LiveKitRoomProps\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/LiveKitRoomProps.html#__type-8\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-interface\",\"parent\":\"LiveKitRoomProps\"},{\"kind\":1024,\"name\":\"onEncryptionError\",\"url\":\"interfaces/LiveKitRoomProps.html#onEncryptionError\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"LiveKitRoomProps\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/LiveKitRoomProps.html#__type-4\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-interface\",\"parent\":\"LiveKitRoomProps\"},{\"kind\":1024,\"name\":\"room\",\"url\":\"interfaces/LiveKitRoomProps.html#room\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"LiveKitRoomProps\"},{\"kind\":1024,\"name\":\"simulateParticipants\",\"url\":\"interfaces/LiveKitRoomProps.html#simulateParticipants\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"LiveKitRoomProps\"},{\"kind\":1024,\"name\":\"featureFlags\",\"url\":\"interfaces/LiveKitRoomProps.html#featureFlags\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"LiveKitRoomProps\"},{\"kind\":4194304,\"name\":\"VideoTrackProps\",\"url\":\"types/VideoTrackProps.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/VideoTrackProps.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"VideoTrackProps\"},{\"kind\":1024,\"name\":\"trackRef\",\"url\":\"types/VideoTrackProps.html#__type.trackRef\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"VideoTrackProps.__type\"},{\"kind\":1024,\"name\":\"style\",\"url\":\"types/VideoTrackProps.html#__type.style\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"VideoTrackProps.__type\"},{\"kind\":1024,\"name\":\"objectFit\",\"url\":\"types/VideoTrackProps.html#__type.objectFit\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"VideoTrackProps.__type\"},{\"kind\":1024,\"name\":\"mirror\",\"url\":\"types/VideoTrackProps.html#__type.mirror\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"VideoTrackProps.__type\"},{\"kind\":1024,\"name\":\"zOrder\",\"url\":\"types/VideoTrackProps.html#__type.zOrder\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"VideoTrackProps.__type\"},{\"kind\":64,\"name\":\"VideoTrack\",\"url\":\"functions/VideoTrack.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":4194304,\"name\":\"Props\",\"url\":\"types/Props.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/Props.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"Props\"},{\"kind\":1024,\"name\":\"videoTrack\",\"url\":\"types/Props.html#__type.videoTrack\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Props.__type\"},{\"kind\":1024,\"name\":\"style\",\"url\":\"types/Props.html#__type.style\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Props.__type\"},{\"kind\":1024,\"name\":\"objectFit\",\"url\":\"types/Props.html#__type.objectFit\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Props.__type\"},{\"kind\":1024,\"name\":\"mirror\",\"url\":\"types/Props.html#__type.mirror\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Props.__type\"},{\"kind\":1024,\"name\":\"zOrder\",\"url\":\"types/Props.html#__type.zOrder\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Props.__type\"},{\"kind\":64,\"name\":\"VideoView\",\"url\":\"functions/VideoView.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":64,\"name\":\"useParticipant\",\"url\":\"functions/useParticipant.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":256,\"name\":\"ParticipantState\",\"url\":\"interfaces/ParticipantState.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"isSpeaking\",\"url\":\"interfaces/ParticipantState.html#isSpeaking\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"ParticipantState\"},{\"kind\":1024,\"name\":\"connectionQuality\",\"url\":\"interfaces/ParticipantState.html#connectionQuality\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"ParticipantState\"},{\"kind\":1024,\"name\":\"isLocal\",\"url\":\"interfaces/ParticipantState.html#isLocal\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"ParticipantState\"},{\"kind\":1024,\"name\":\"metadata\",\"url\":\"interfaces/ParticipantState.html#metadata\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"ParticipantState\"},{\"kind\":1024,\"name\":\"publications\",\"url\":\"interfaces/ParticipantState.html#publications\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"ParticipantState\"},{\"kind\":1024,\"name\":\"subscribedTracks\",\"url\":\"interfaces/ParticipantState.html#subscribedTracks\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"ParticipantState\"},{\"kind\":1024,\"name\":\"cameraPublication\",\"url\":\"interfaces/ParticipantState.html#cameraPublication\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"ParticipantState\"},{\"kind\":1024,\"name\":\"microphonePublication\",\"url\":\"interfaces/ParticipantState.html#microphonePublication\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"ParticipantState\"},{\"kind\":1024,\"name\":\"screenSharePublication\",\"url\":\"interfaces/ParticipantState.html#screenSharePublication\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"ParticipantState\"},{\"kind\":64,\"name\":\"useRoom\",\"url\":\"functions/useRoom.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":64,\"name\":\"sortParticipants\",\"url\":\"functions/sortParticipants.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":256,\"name\":\"RoomState\",\"url\":\"interfaces/RoomState.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"room\",\"url\":\"interfaces/RoomState.html#room\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"RoomState\"},{\"kind\":1024,\"name\":\"participants\",\"url\":\"interfaces/RoomState.html#participants\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"RoomState\"},{\"kind\":1024,\"name\":\"audioTracks\",\"url\":\"interfaces/RoomState.html#audioTracks\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"RoomState\"},{\"kind\":1024,\"name\":\"error\",\"url\":\"interfaces/RoomState.html#error\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"RoomState\"},{\"kind\":256,\"name\":\"RoomOptions\",\"url\":\"interfaces/RoomOptions.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"sortParticipants\",\"url\":\"interfaces/RoomOptions.html#sortParticipants\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"RoomOptions\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/RoomOptions.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-interface\",\"parent\":\"RoomOptions\"},{\"kind\":64,\"name\":\"setLogLevel\",\"url\":\"functions/setLogLevel.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":32,\"name\":\"log\",\"url\":\"variables/log.html\",\"classes\":\"tsd-kind-variable\"},{\"kind\":64,\"name\":\"useIOSAudioManagement\",\"url\":\"functions/useIOSAudioManagement.html\",\"classes\":\"tsd-kind-function\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"comment\"],\"fieldVectors\":[[\"name/0\",[0,42.95]],[\"comment/0\",[]],[\"name/1\",[1,42.95]],[\"comment/1\",[]],[\"name/2\",[2,42.95]],[\"comment/2\",[]],[\"name/3\",[3,42.95]],[\"comment/3\",[]],[\"name/4\",[4,42.95]],[\"comment/4\",[]],[\"name/5\",[5,42.95]],[\"comment/5\",[]],[\"name/6\",[6,42.95]],[\"comment/6\",[]],[\"name/7\",[7,42.95]],[\"comment/7\",[]],[\"name/8\",[8,42.95]],[\"comment/8\",[]],[\"name/9\",[9,42.95]],[\"comment/9\",[]],[\"name/10\",[10,42.95]],[\"comment/10\",[]],[\"name/11\",[11,19.596]],[\"comment/11\",[]],[\"name/12\",[12,42.95]],[\"comment/12\",[]],[\"name/13\",[11,19.596]],[\"comment/13\",[]],[\"name/14\",[13,42.95]],[\"comment/14\",[]],[\"name/15\",[14,42.95]],[\"comment/15\",[]],[\"name/16\",[15,42.95]],[\"comment/16\",[]],[\"name/17\",[11,19.596]],[\"comment/17\",[]],[\"name/18\",[16,42.95]],[\"comment/18\",[]],[\"name/19\",[17,42.95]],[\"comment/19\",[]],[\"name/20\",[11,19.596]],[\"comment/20\",[]],[\"name/21\",[18,42.95]],[\"comment/21\",[]],[\"name/22\",[19,37.842]],[\"comment/22\",[]],[\"name/23\",[20,42.95]],[\"comment/23\",[]],[\"name/24\",[21,42.95]],[\"comment/24\",[]],[\"name/25\",[22,42.95]],[\"comment/25\",[]],[\"name/26\",[23,42.95]],[\"comment/26\",[]],[\"name/27\",[24,42.95]],[\"comment/27\",[]],[\"name/28\",[25,42.95]],[\"comment/28\",[]],[\"name/29\",[11,19.596]],[\"comment/29\",[]],[\"name/30\",[26,42.95]],[\"comment/30\",[]],[\"name/31\",[27,42.95]],[\"comment/31\",[]],[\"name/32\",[28,42.95]],[\"comment/32\",[]],[\"name/33\",[29,42.95]],[\"comment/33\",[]],[\"name/34\",[30,42.95]],[\"comment/34\",[]],[\"name/35\",[11,19.596]],[\"comment/35\",[]],[\"name/36\",[31,42.95]],[\"comment/36\",[]],[\"name/37\",[32,42.95]],[\"comment/37\",[]],[\"name/38\",[19,37.842]],[\"comment/38\",[]],[\"name/39\",[33,42.95]],[\"comment/39\",[]],[\"name/40\",[34,42.95]],[\"comment/40\",[]],[\"name/41\",[35,42.95]],[\"comment/41\",[]],[\"name/42\",[36,42.95]],[\"comment/42\",[]],[\"name/43\",[37,42.95]],[\"comment/43\",[]],[\"name/44\",[11,19.596]],[\"comment/44\",[]],[\"name/45\",[38,42.95]],[\"comment/45\",[]],[\"name/46\",[39,42.95]],[\"comment/46\",[]],[\"name/47\",[40,42.95]],[\"comment/47\",[]],[\"name/48\",[41,42.95]],[\"comment/48\",[]],[\"name/49\",[42,42.95]],[\"comment/49\",[]],[\"name/50\",[43,42.95]],[\"comment/50\",[]],[\"name/51\",[44,42.95]],[\"comment/51\",[]],[\"name/52\",[45,42.95]],[\"comment/52\",[]],[\"name/53\",[46,42.95]],[\"comment/53\",[]],[\"name/54\",[47,42.95]],[\"comment/54\",[]],[\"name/55\",[48,42.95]],[\"comment/55\",[]],[\"name/56\",[49,42.95]],[\"comment/56\",[]],[\"name/57\",[11,19.596]],[\"comment/57\",[]],[\"name/58\",[50,42.95]],[\"comment/58\",[]],[\"name/59\",[11,19.596]],[\"comment/59\",[]],[\"name/60\",[51,42.95]],[\"comment/60\",[]],[\"name/61\",[11,19.596]],[\"comment/61\",[]],[\"name/62\",[52,42.95]],[\"comment/62\",[]],[\"name/63\",[11,19.596]],[\"comment/63\",[]],[\"name/64\",[53,42.95]],[\"comment/64\",[]],[\"name/65\",[11,19.596]],[\"comment/65\",[]],[\"name/66\",[54,37.842]],[\"comment/66\",[]],[\"name/67\",[55,42.95]],[\"comment/67\",[]],[\"name/68\",[56,42.95]],[\"comment/68\",[]],[\"name/69\",[57,42.95]],[\"comment/69\",[]],[\"name/70\",[11,19.596]],[\"comment/70\",[]],[\"name/71\",[58,42.95]],[\"comment/71\",[]],[\"name/72\",[59,37.842]],[\"comment/72\",[]],[\"name/73\",[60,37.842]],[\"comment/73\",[]],[\"name/74\",[61,37.842]],[\"comment/74\",[]],[\"name/75\",[62,37.842]],[\"comment/75\",[]],[\"name/76\",[63,37.842]],[\"comment/76\",[]],[\"name/77\",[64,42.95]],[\"comment/77\",[]],[\"name/78\",[11,19.596]],[\"comment/78\",[]],[\"name/79\",[63,37.842]],[\"comment/79\",[]],[\"name/80\",[59,37.842]],[\"comment/80\",[]],[\"name/81\",[60,37.842]],[\"comment/81\",[]],[\"name/82\",[61,37.842]],[\"comment/82\",[]],[\"name/83\",[62,37.842]],[\"comment/83\",[]],[\"name/84\",[65,42.95]],[\"comment/84\",[]],[\"name/85\",[66,42.95]],[\"comment/85\",[]],[\"name/86\",[67,42.95]],[\"comment/86\",[]],[\"name/87\",[68,42.95]],[\"comment/87\",[]],[\"name/88\",[69,42.95]],[\"comment/88\",[]],[\"name/89\",[70,42.95]],[\"comment/89\",[]],[\"name/90\",[71,42.95]],[\"comment/90\",[]],[\"name/91\",[72,42.95]],[\"comment/91\",[]],[\"name/92\",[73,42.95]],[\"comment/92\",[]],[\"name/93\",[74,42.95]],[\"comment/93\",[]],[\"name/94\",[75,42.95]],[\"comment/94\",[]],[\"name/95\",[76,42.95]],[\"comment/95\",[]],[\"name/96\",[77,42.95]],[\"comment/96\",[]],[\"name/97\",[78,37.842]],[\"comment/97\",[]],[\"name/98\",[79,42.95]],[\"comment/98\",[]],[\"name/99\",[54,37.842]],[\"comment/99\",[]],[\"name/100\",[80,42.95]],[\"comment/100\",[]],[\"name/101\",[81,42.95]],[\"comment/101\",[]],[\"name/102\",[82,42.95]],[\"comment/102\",[]],[\"name/103\",[83,42.95]],[\"comment/103\",[]],[\"name/104\",[78,37.842]],[\"comment/104\",[]],[\"name/105\",[11,19.596]],[\"comment/105\",[]],[\"name/106\",[84,42.95]],[\"comment/106\",[]],[\"name/107\",[85,42.95]],[\"comment/107\",[]],[\"name/108\",[86,42.95]],[\"comment/108\",[]]],\"invertedIndex\":[[\"__type\",{\"_index\":11,\"name\":{\"11\":{},\"13\":{},\"17\":{},\"20\":{},\"29\":{},\"35\":{},\"44\":{},\"57\":{},\"59\":{},\"61\":{},\"63\":{},\"65\":{},\"70\":{},\"78\":{},\"105\":{}},\"comment\":{}}],[\"android\",{\"_index\":12,\"name\":{\"12\":{}},\"comment\":{}}],[\"androidaudiotypeoptions\",{\"_index\":17,\"name\":{\"19\":{}},\"comment\":{}}],[\"androidaudiotypepresets\",{\"_index\":25,\"name\":{\"28\":{}},\"comment\":{}}],[\"appleaudiocategory\",{\"_index\":28,\"name\":{\"32\":{}},\"comment\":{}}],[\"appleaudiocategoryoption\",{\"_index\":29,\"name\":{\"33\":{}},\"comment\":{}}],[\"appleaudioconfiguration\",{\"_index\":30,\"name\":{\"34\":{}},\"comment\":{}}],[\"appleaudiomode\",{\"_index\":33,\"name\":{\"39\":{}},\"comment\":{}}],[\"audio\",{\"_index\":43,\"name\":{\"50\":{}},\"comment\":{}}],[\"audioattributescontenttype\",{\"_index\":22,\"name\":{\"25\":{}},\"comment\":{}}],[\"audioattributesusagetype\",{\"_index\":21,\"name\":{\"24\":{}},\"comment\":{}}],[\"audiocategory\",{\"_index\":31,\"name\":{\"36\":{}},\"comment\":{}}],[\"audiocategoryoptions\",{\"_index\":32,\"name\":{\"37\":{}},\"comment\":{}}],[\"audioconfiguration\",{\"_index\":10,\"name\":{\"10\":{}},\"comment\":{}}],[\"audiofocusmode\",{\"_index\":20,\"name\":{\"23\":{}},\"comment\":{}}],[\"audiomode\",{\"_index\":19,\"name\":{\"22\":{},\"38\":{}},\"comment\":{}}],[\"audiosession\",{\"_index\":1,\"name\":{\"1\":{}},\"comment\":{}}],[\"audiostreamtype\",{\"_index\":23,\"name\":{\"26\":{}},\"comment\":{}}],[\"audiotracks\",{\"_index\":81,\"name\":{\"101\":{}},\"comment\":{}}],[\"audiotrackstate\",{\"_index\":34,\"name\":{\"40\":{}},\"comment\":{}}],[\"audiotypeoptions\",{\"_index\":14,\"name\":{\"15\":{}},\"comment\":{}}],[\"camerapublication\",{\"_index\":74,\"name\":{\"93\":{}},\"comment\":{}}],[\"communication\",{\"_index\":26,\"name\":{\"30\":{}},\"comment\":{}}],[\"configureaudio\",{\"_index\":2,\"name\":{\"2\":{}},\"comment\":{}}],[\"connect\",{\"_index\":46,\"name\":{\"53\":{}},\"comment\":{}}],[\"connectionquality\",{\"_index\":69,\"name\":{\"88\":{}},\"comment\":{}}],[\"connectoptions\",{\"_index\":48,\"name\":{\"55\":{}},\"comment\":{}}],[\"constructor\",{\"_index\":9,\"name\":{\"9\":{}},\"comment\":{}}],[\"defaultoutput\",{\"_index\":16,\"name\":{\"18\":{}},\"comment\":{}}],[\"error\",{\"_index\":82,\"name\":{\"102\":{}},\"comment\":{}}],[\"featureflags\",{\"_index\":56,\"name\":{\"68\":{}},\"comment\":{}}],[\"forcehandleaudiorouting\",{\"_index\":24,\"name\":{\"27\":{}},\"comment\":{}}],[\"getaudiooutputs\",{\"_index\":5,\"name\":{\"5\":{}},\"comment\":{}}],[\"getdefaultappleaudioconfigurationformode\",{\"_index\":35,\"name\":{\"41\":{}},\"comment\":{}}],[\"ios\",{\"_index\":15,\"name\":{\"16\":{}},\"comment\":{}}],[\"islocal\",{\"_index\":70,\"name\":{\"89\":{}},\"comment\":{}}],[\"isspeaking\",{\"_index\":68,\"name\":{\"87\":{}},\"comment\":{}}],[\"livekitclientloglevel\",{\"_index\":38,\"name\":{\"45\":{}},\"comment\":{}}],[\"livekitroom\",{\"_index\":39,\"name\":{\"46\":{}},\"comment\":{}}],[\"livekitroomprops\",{\"_index\":40,\"name\":{\"47\":{}},\"comment\":{}}],[\"log\",{\"_index\":85,\"name\":{\"107\":{}},\"comment\":{}}],[\"loglevel\",{\"_index\":36,\"name\":{\"42\":{}},\"comment\":{}}],[\"manageaudiofocus\",{\"_index\":18,\"name\":{\"21\":{}},\"comment\":{}}],[\"media\",{\"_index\":27,\"name\":{\"31\":{}},\"comment\":{}}],[\"metadata\",{\"_index\":71,\"name\":{\"90\":{}},\"comment\":{}}],[\"microphonepublication\",{\"_index\":75,\"name\":{\"94\":{}},\"comment\":{}}],[\"mirror\",{\"_index\":61,\"name\":{\"74\":{},\"82\":{}},\"comment\":{}}],[\"objectfit\",{\"_index\":60,\"name\":{\"73\":{},\"81\":{}},\"comment\":{}}],[\"onconnected\",{\"_index\":49,\"name\":{\"56\":{}},\"comment\":{}}],[\"ondisconnected\",{\"_index\":50,\"name\":{\"58\":{}},\"comment\":{}}],[\"onencryptionerror\",{\"_index\":53,\"name\":{\"64\":{}},\"comment\":{}}],[\"onerror\",{\"_index\":51,\"name\":{\"60\":{}},\"comment\":{}}],[\"onmediadevicefailure\",{\"_index\":52,\"name\":{\"62\":{}},\"comment\":{}}],[\"options\",{\"_index\":47,\"name\":{\"54\":{}},\"comment\":{}}],[\"participants\",{\"_index\":80,\"name\":{\"100\":{}},\"comment\":{}}],[\"participantstate\",{\"_index\":67,\"name\":{\"86\":{}},\"comment\":{}}],[\"preferredoutputlist\",{\"_index\":13,\"name\":{\"14\":{}},\"comment\":{}}],[\"props\",{\"_index\":64,\"name\":{\"77\":{}},\"comment\":{}}],[\"publications\",{\"_index\":72,\"name\":{\"91\":{}},\"comment\":{}}],[\"registerglobals\",{\"_index\":0,\"name\":{\"0\":{}},\"comment\":{}}],[\"room\",{\"_index\":54,\"name\":{\"66\":{},\"99\":{}},\"comment\":{}}],[\"roomoptions\",{\"_index\":83,\"name\":{\"103\":{}},\"comment\":{}}],[\"roomstate\",{\"_index\":79,\"name\":{\"98\":{}},\"comment\":{}}],[\"screen\",{\"_index\":45,\"name\":{\"52\":{}},\"comment\":{}}],[\"screensharepublication\",{\"_index\":76,\"name\":{\"95\":{}},\"comment\":{}}],[\"selectaudiooutput\",{\"_index\":6,\"name\":{\"6\":{}},\"comment\":{}}],[\"serverurl\",{\"_index\":41,\"name\":{\"48\":{}},\"comment\":{}}],[\"setappleaudioconfiguration\",{\"_index\":8,\"name\":{\"8\":{}},\"comment\":{}}],[\"setloglevel\",{\"_index\":84,\"name\":{\"106\":{}},\"comment\":{}}],[\"setlogleveloptions\",{\"_index\":37,\"name\":{\"43\":{}},\"comment\":{}}],[\"showaudioroutepicker\",{\"_index\":7,\"name\":{\"7\":{}},\"comment\":{}}],[\"simulateparticipants\",{\"_index\":55,\"name\":{\"67\":{}},\"comment\":{}}],[\"sortparticipants\",{\"_index\":78,\"name\":{\"97\":{},\"104\":{}},\"comment\":{}}],[\"startaudiosession\",{\"_index\":3,\"name\":{\"3\":{}},\"comment\":{}}],[\"stopaudiosession\",{\"_index\":4,\"name\":{\"4\":{}},\"comment\":{}}],[\"style\",{\"_index\":59,\"name\":{\"72\":{},\"80\":{}},\"comment\":{}}],[\"subscribedtracks\",{\"_index\":73,\"name\":{\"92\":{}},\"comment\":{}}],[\"token\",{\"_index\":42,\"name\":{\"49\":{}},\"comment\":{}}],[\"trackref\",{\"_index\":58,\"name\":{\"71\":{}},\"comment\":{}}],[\"useiosaudiomanagement\",{\"_index\":86,\"name\":{\"108\":{}},\"comment\":{}}],[\"useparticipant\",{\"_index\":66,\"name\":{\"85\":{}},\"comment\":{}}],[\"useroom\",{\"_index\":77,\"name\":{\"96\":{}},\"comment\":{}}],[\"video\",{\"_index\":44,\"name\":{\"51\":{}},\"comment\":{}}],[\"videotrack\",{\"_index\":63,\"name\":{\"76\":{},\"79\":{}},\"comment\":{}}],[\"videotrackprops\",{\"_index\":57,\"name\":{\"69\":{}},\"comment\":{}}],[\"videoview\",{\"_index\":65,\"name\":{\"84\":{}},\"comment\":{}}],[\"zorder\",{\"_index\":62,\"name\":{\"75\":{},\"83\":{}},\"comment\":{}}]],\"pipeline\":[]}}"); \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAE8VcWZObSBL+L/hVI3MUV7857PXuxHrC3ukZvygcDhqVZNYItIB61tPh/75RBYhMyOQQPd6nDlt5fJVfZtYBxZNR5H+Uxt3uyfiaZHvjzhMbI4tO0rgzCnlMykoWf0/zhygtjY1xKVLjzjhcsrhK8qx82ZPYfqlOqbEx4jQqS1kad4bxfdMatuzgavnVZZ/k97Iskzy7mm20XsIfRy3apuhMxnl2SI6XQmr1aaMvBgrAx8Y4R4XMqj5UxndZRUW1bEwvKJ01CPLzYgADldv9H2U9lveX6nypyhnuhxorRi9TGUNzc4ZP6KxA8CX/Q8v9ml8q+SGJv8piDghabU0kqlfnc1rn9Osmw6NqZkaMKS/C5Fo2LMyyKi5xlc+JCJZe5NTpfL7K9kWe7LXgb9/O8kMhSwnS8jEqkughVQhoydG+47mu4119ff5cfTvLhaZfXLWYITIDAO3UtAWI8el0yZIYM70IyrZvYxGwbTMeBt9J7pPoRlyt7ko8YF47yuqNPESXlEv3t3nxS76XxIQ3V3Vi3gp9y7XxbEgXqxpEUyZI4Pb8HLU4mZZDpAzjUc3LIrfbTmmue4LntYNvUTSmf7KWw7kOhAnOuZAHWRRyX88875KyWgdxS1u8EfZEMUdtrb0/66JYCZ0w99fgTvKFUGuF/2cqJnnbyX6yb4iLGgATjH3dxXrLpcWgtn07N0AcBm7QIHtNnkk8Wmp1qxwxu3Qab4Fz02SURcd6Unmbx5clA7zOlkMTi6DNqX00N86HBnWfHZMe7Bpg0MCzo3tVVUXycKlk+XsZHeVvN2XZdsTUX4j4dZ5VMqueBzM29uyo76tCRqc1UJGF58R3yItY/iPK9s2qUe34kux4A07e0kq8g7bbLXGjSh7z4lsf7UBg2bp3oF5Dm/RSi93qa2yhTUutnkJGzE5OIQzwsTKYpotfnvX0F4GaU6KYw8EUtxTi5KLxdqTUbDIX3vhEMhcTn8Sj2G7bgP5WRPHX+yqqyDVq9+siy+/y4zv5KNOeyfa/F9m6l1WrRyfPUGBt4TIWp2qWQMokWpo8yn8m1es0kVnFBGscxJYzMRfa6FHJu9r4r3l+Ik5DwK/jTLoeZfFDkZ87DpOsksUhiiWyq2XGnyvAeJayeJTF70U62+wLqELHbACZcV7lX2U233Ervs5phB53TDptxdc5fUz2coHTVnyd0zIu5JL4XuXXuY3zLJNxNd9vp7DOcd5rcpOO84m5cOGI+0127sCnpuTZ489e1wblfkEMkNJiAKNzwhLn24kpYmAAAmcD8iYp41ti0tP74WGB/qcPtIjYoAGw4flbUYCHTDNwtQo/PCDacRsJb0kkashsCH5RT0veyMcklm+jJL0Ui2CR2j88OEMUbaSCJZEiBsNnThYX33TfWp5DA9Ufn00YQhstsSivesNgQlXAleAktEZ65byfnC5pVMkPUVElcXKOsmrBpMRor4N0kFF1KeTbNDougNLTWgyhvyH6qJZVemOGV9L1tqH369qtEGVuah/UB8itm5XEr/Iw3+MWqMxyPbHfL6tv6YIBb1v55/CdP/xbxtXbpP8UZsw/1HkODKcEdb1pAFeF5/D+5/tiL5d4vyrc6B1scDtZYn/b/bjooIKqxmepwfmVN717w2Nm7G+R6IirG+praVWtqaVbKujmullcLTfXyOLKmFkPHxP5B1cO6rfxPO6MXUo47RIWscDsMySggw8swRTcl5l/hpSU92cZfYUPZ6bsvkA6TOz7oMd330me/esSpUn1bT4KSnUdmKR8l8cReZrGBaJVWOf4JKtoH1XRfM9AY53r8+UhbV6DIxd3tPue1joI5eWhjIvkQe51710Ag9BcmY7RSRbRh250C9KRUF2ZFUlc5OcveSZvAsSpryRLnzPef4mK21Cx+oth4dbLHNo3v8zt4WVeVOTOq7PYF5ndxxUOtoFff5zfubnNKTY1vivtMHHtYWIb2nN2nrPvnHQaXZ/BzfGJpW90KbmDkJ4zObq2odz0U2DkoBn8vOAhEJeyI4ZfEEr8iIZP9eYe4Uz6nTo4hgYGmOkKlsMni6B4u19HIwzerk/zbmXUvcud5scF68Kf39/Xz6r1+2onyS0Ph3KUk08bI8n28r/G3ZPxKAt9MeDOsLfONjQ2xiGR6V7dcar9b/Tr8srjp+a3j1LdN1AStchL09jszI2wt6H76dNm1yro/9f/oaUsY7OzCCkLSdnGZmcTUjaScozNziGkHCQljM1OEFICSbnGZucSUi6S8ozNziOkPCTlG5udT0j5SCowNruAkAqQVGhsdiEhFeKoqiBbVPStXvh1/K2NFW7d0MOSmAJLxdqiSLAwC5YKt0XxYGEiLBVxi6LCwlxYKugWxYaF6bA8fjSYEkvF3qKoszArVsCbxMxYigKL4tnC5NiaHIpqG5Nja3Iotu1eedgsSBuTYysKbCoxbEyOrSiwqcq0MTm2y/vG7NiKApssY0yOrSiwnY3jbwNhY0nMjq0osKkUsjE5tqLAplLIxuQ4igKbSgwHk+MoCmyKbgeT4+jmRdHt9NqX5oai28HcOIoBhyLRwdw4igCHItHB1Dh84TiYG0cR4FAkOpgaRxHgkO0YU+OELNsO5kYoBhyyd2NuhGLAodgWmBuhGHAotgXmRui5hWJb9GYXwUZSYHKEJofKC4HJEYoBh8oLgbkRigFB5YXA3AjFgKDyQmBuhCJAUGwLTI2rCBAU2y6mxlUECIpDF1PjKgIEOQVjalxFgKA4dDE1rp75KQ7d3tyv4i8oZlzMjKviLyhmXMyM67NZ4WJqXEWAS3HoYmrckDeJufEUAy7Ftoe58fjFgIfJ8RQFLpUXHibHc3iTmB1PceBSGeRhdjx+wvF6qzNFgiuozuJhfjxFgkslm4fp8TQ95JIP0+MpDlwq2TzMjm+yw/ExPb7iwKXS0sfs+JqdkBq3j+nxFQeeSUpienxFgmeRkpgfX5Hg2aQk5sfXy2ey8/u9FbRiwaO6ho/58fnlmo8J8kPeOWYoMNlwBpihwGLDGWCKApsNZ4ApChw2nAGmKNAUUUkcYIYCzRCVxAEmKNAEUUkcYH4CzQ+5e+ltchQJHtUxA0xPoDjwqT4YYHZCRYFPdbcQkxMqBnyqZ4WYm1AR4FOdKMTUhCr+PpWVIWYmVPH3KWZCzEyo4u9TzISYmVDF36eYCTEzod58BlT6hJiaUBHgk3vL3hY0ZNtq2N+GKgoCeh/a24iaioSAPAoweztRU9EQkFtRs7cXNRURAbkZNXu7UVOwkap/g7L8HFT/BmUVIQG5zTV7m1JTMRKQG12zty019XEBuYE1a7r0ec6jLCq5/7k+19ntrodqT8bn5rDHstojpSfDsoy7p+8bw/Kav0H917abv27912l+F6L+6/rN37D+6zV2PKf52+j5ZvO3satidff0/Xt3mqT+pQZzvcUOgHoAqD+upw9v1Uivr/N2dmwwYFvMtHNuP34B8JgAj8nZURdKtJX4eh8IQAk7E44z20Te3PDqDDkAi8OOqTOEr28BOyA2DsvN1c5J36AB6qJTF2xI6rfnOy3hdFruqFZ0vQMZ13cg+8lsgxxxZpq6qCugA0MuSJJwzBDFa3fO+2Q4bKoOKUX55YCwOMGoEY5OC4zCYulUJg7q5m6fThvQaY8iGGgC7HbTHJzRMJbtB5QAegB+VFVfNx0w6IPwjepXzUOeTjeArs0ZyvXzN8AdCLwY16eblBWAAHKJXD8bPsPnnZ0FH5AXcr0lxt+rAf5BBls2q918/WtQ0kB7RLm+4QEaAahel4fcvp/xn/b9jM6CBxpqwGVsY4GIugBRd7l6QV9X6nSBZy7Rm+885M13HkC4QPu2uYE3zwhBlkKOTC7OzQuzh/qF2U7bBcH2uFDpa9Jf9DVpzXHRXpMG2EHMHA7EUVZaP28/VAZwgJDz2k3omCnskBf9DmSB9Le4GVF/nAToAA5trmqTMq1fzgGlBugLOPKTsry+3QQSFkQv4GYKdTvxa1LF+nZimh/T+jEkaDfAiuCi2FipH9wDXTBo4U3rnusXM0HRgNELdgg5GnYAJyZzRGk4VJC2gku3+gMe3cSG8hX2Jm68zfeyQGqACc3iKrR7ewrkBphKQq6Rd+/UcM0cxCvksrl9QxJkF3DuN2v1gAta/TbnIUGdyQPk+s1qPuBKI8/ABSmQICDDXC7iebZH96tAgwAQXK5R5Zm83r0YNEoXkOdx0aP0QPg8jrs808my13dkDu2FH2AE5JvHxp6Yi8D6xeVA4xdjQH2hvQkHHWr3VzAecB9wpF2/mFX39VR/MQsUDbBhcX1x0E880Ll9rjXgNwVBoYBoh1yetl9cPbbfZO30Qdy4qPUbqAvwes3GOORGq5QJsgPYXkyuvyjlAVE+XHhw5dFe4wXpBeddLi1rtVK9Vcc1JtCOQ27mqT8TChYAiG4QPVZf3S5XL7bAAYDiFOy4JbdkQNEHqc4bomajAK4yTB7/VZna54EqERz16iOn1xWYPDcfOQU8gJrhTDSXuLie4YKM8FgjeVFxBnwQx7DZ9KmTM8aS+nYvt/WDW19WPz9z6vAYglXX9yTA8EEd+c15V8D1gO4N4eHm0QfgQ66ymu8WAMigcQmue2hnhbqxBXCDqPtcx7uUMsnLeqsOXhYDiQwP10yuCi4lzB5UxUA/4PrApZT95umDxA25+mk+fQCCBQh2uTFrraq+dgOAAnb8plv7XLw7E4NZygXAvVH9R30RBCAAdRZw6flnXt9BAWogQfzmPDUgi+PTxjgnZ5kmmTTudp++f/8fYhe6raBcAAA="; \ No newline at end of file diff --git a/docs/assets/style.css b/docs/assets/style.css index 958d2c2..778b949 100644 --- a/docs/assets/style.css +++ b/docs/assets/style.css @@ -2,38 +2,80 @@ /* 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: #707070; - --light-color-link: #4da6ff; - --light-color-ts: #db1373; - --light-color-ts-interface: #139d2c; - --light-color-ts-enum: #9c891a; - --light-color-ts-class: #2484e5; + --light-color-text-aside: #6e6e6e; + --light-color-link: #1f70c2; + + --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-namespace: #b111c9; - --light-color-ts-private: #707070; - --light-color-ts-variable: #4d68ff; + --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-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-ts: #ff6492; - --dark-color-ts-interface: #6cff87; + + --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-class: #61b0ff; - --dark-color-ts-function: #9772ff; - --dark-color-ts-namespace: #e14dff; - --dark-color-ts-private: #e2e2e2; - --dark-color-ts-variable: #4d68ff; + --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-external-icon: url("data:image/svg+xml;utf8,"); --dark-color-scheme: dark; } @@ -42,19 +84,39 @@ :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-ts: var(--light-color-ts); - --color-ts-interface: var(--light-color-ts-interface); - --color-ts-enum: var(--light-color-ts-enum); - --color-ts-class: var(--light-color-ts-class); - --color-ts-function: var(--light-color-ts-function); + + --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-private: var(--light-color-ts-private); + --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); + --external-icon: var(--light-external-icon); --color-scheme: var(--light-color-scheme); } @@ -64,19 +126,39 @@ :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-ts: var(--dark-color-ts); - --color-ts-interface: var(--dark-color-ts-interface); - --color-ts-enum: var(--dark-color-ts-enum); - --color-ts-class: var(--dark-color-ts-class); - --color-ts-function: var(--dark-color-ts-function); + + --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-private: var(--dark-color-ts-private); + --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); + --external-icon: var(--dark-external-icon); --color-scheme: var(--dark-color-scheme); } @@ -93,19 +175,39 @@ body { :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-ts: var(--light-color-ts); - --color-ts-interface: var(--light-color-ts-interface); - --color-ts-enum: var(--light-color-ts-enum); - --color-ts-class: var(--light-color-ts-class); - --color-ts-function: var(--light-color-ts-function); + + --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-private: var(--light-color-ts-private); + --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); + --external-icon: var(--light-external-icon); --color-scheme: var(--light-color-scheme); } @@ -113,23 +215,48 @@ body { :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-ts: var(--dark-color-ts); - --color-ts-interface: var(--dark-color-ts-interface); - --color-ts-enum: var(--dark-color-ts-enum); - --color-ts-class: var(--dark-color-ts-class); - --color-ts-function: var(--dark-color-ts-function); + + --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-private: var(--dark-color-ts-private); + --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); + --external-icon: var(--dark-external-icon); --color-scheme: var(--dark-color-scheme); } +.always-visible, +.always-visible .tsd-signatures { + display: inherit !important; +} + h1, h2, h3, @@ -139,6 +266,16 @@ h6 { line-height: 1.2; } +h1 > a:not(.link), +h2 > a:not(.link), +h3 > a:not(.link), +h4 > a:not(.link), +h5 > a:not(.link), +h6 > a:not(.link) { + text-decoration: none; + color: var(--color-text); +} + h1 { font-size: 1.875rem; margin: 0.67rem 0; @@ -173,12 +310,6 @@ h6 { text-transform: uppercase; } -pre { - white-space: pre; - white-space: pre-wrap; - word-wrap: break-word; -} - dl, menu, ol, @@ -191,61 +322,25 @@ dd { } .container { - max-width: 1600px; + max-width: 1700px; padding: 0 2rem; } -@media (min-width: 640px) { - .container { - padding: 0 4rem; - } -} -@media (min-width: 1200px) { - .container { - padding: 0 8rem; - } -} -@media (min-width: 1600px) { - .container { - padding: 0 12rem; - } -} - /* Footer */ -.tsd-generator { +footer { border-top: 1px solid var(--color-accent); padding-top: 1rem; padding-bottom: 1rem; max-height: 3.5rem; } - -.tsd-generator > p { - margin-top: 0; - margin-bottom: 0; - padding: 0 1rem; +.tsd-generator { + margin: 0 1em; } .container-main { - display: flex; - justify-content: space-between; - position: relative; margin: 0 auto; -} - -.col-4, -.col-8 { - box-sizing: border-box; - float: left; - padding: 2rem 1rem; -} - -.col-4 { - flex: 0 0 25%; -} -.col-8 { - flex: 1 0; - flex-wrap: wrap; - padding-left: 0; + /* toolbar, footer, margin */ + min-height: calc(100vh - 41px - 56px - 4rem); } @keyframes fade-in { @@ -288,22 +383,6 @@ dd { opacity: 0; } } -@keyframes shift-to-left { - from { - transform: translate(0, 0); - } - to { - transform: translate(-25%, 0); - } -} -@keyframes unshift-to-left { - from { - transform: translate(-25%, 0); - } - to { - transform: translate(0, 0); - } -} @keyframes pop-in-from-right { from { transform: translate(100%, 0); @@ -323,7 +402,8 @@ dd { } body { background: var(--color-background); - font-family: "Segoe UI", sans-serif; + 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); } @@ -352,13 +432,29 @@ pre { } pre { + position: relative; + white-space: pre; + white-space: pre-wrap; + word-wrap: break-word; padding: 10px; - border: 0.1em solid var(--color-accent); + 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; @@ -374,13 +470,12 @@ blockquote { padding: 0 0 0 20px; margin: 0; } -.tsd-typography h4, .tsd-typography .tsd-index-panel h3, .tsd-index-panel .tsd-typography h3, +.tsd-typography h4, .tsd-typography h5, .tsd-typography h6 { font-size: 1em; - margin: 0; } .tsd-typography h5, .tsd-typography h6 { @@ -391,91 +486,18 @@ blockquote { .tsd-typography ol { margin: 1em 0; } - -@media (max-width: 1024px) { - html .col-content { - float: none; - max-width: 100%; - width: 100%; - padding-top: 3rem; - } - html .col-menu { - 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; - max-width: 25rem; - visibility: hidden; - background-color: var(--color-background); - transform: translate(100%, 0); - } - html .col-menu > *: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 :is(header, footer, .col-content) { - animation: shift-to-left 0.4s; - } - - .to-has-menu .col-menu { - animation: pop-in-from-right 0.4s; - } - - .from-has-menu .overlay { - animation: fade-out 0.4s; - } - - .from-has-menu :is(header, footer, .col-content) { - animation: unshift-to-left 0.4s; - } - - .from-has-menu .col-menu { - animation: pop-out-to-right 0.4s; - } - - .has-menu body { - overflow: hidden; - } - .has-menu .overlay { - visibility: visible; - } - .has-menu :is(header, footer, .col-content) { - transform: translate(-25%, 0); - } - .has-menu .col-menu { - visibility: visible; - transform: translate(0, 0); - display: grid; - align-items: center; - grid-template-rows: auto 1fr; - grid-gap: 1.5rem; - max-height: 100vh; - padding: 1rem 2rem; - } - .has-menu .tsd-navigation { - max-height: 100%; - } +.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 { @@ -625,6 +647,28 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { 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; } @@ -656,43 +700,6 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { -o-page-break-inside: avoid; page-break-inside: avoid; } -.tsd-index-panel a, -.tsd-index-panel a.tsd-parent-kind-module { - color: var(--color-ts); -} -.tsd-index-panel a.tsd-parent-kind-interface { - color: var(--color-ts-interface); -} -.tsd-index-panel a.tsd-parent-kind-enum { - color: var(--color-ts-enum); -} -.tsd-index-panel a.tsd-parent-kind-class { - color: var(--color-ts-class); -} -.tsd-index-panel a.tsd-kind-module { - color: var(--color-ts-namespace); -} -.tsd-index-panel a.tsd-kind-interface { - color: var(--color-ts-interface); -} -.tsd-index-panel a.tsd-kind-enum { - color: var(--color-ts-enum); -} -.tsd-index-panel a.tsd-kind-class { - color: var(--color-ts-class); -} -.tsd-index-panel a.tsd-kind-function { - color: var(--color-ts-function); -} -.tsd-index-panel a.tsd-kind-namespace { - color: var(--color-ts-namespace); -} -.tsd-index-panel a.tsd-kind-variable { - color: var(--color-ts-variable); -} -.tsd-index-panel a.tsd-is-private { - color: var(--color-ts-private); -} .tsd-flag { display: inline-block; @@ -707,7 +714,7 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { } .tsd-anchor { - position: absolute; + position: relative; top: -100px; } @@ -721,146 +728,108 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { margin-bottom: 0; border-bottom: none; } -.tsd-member [data-tsd-kind] { - color: var(--color-ts); -} -.tsd-member [data-tsd-kind="Interface"] { - color: var(--color-ts-interface); -} -.tsd-member [data-tsd-kind="Enum"] { - color: var(--color-ts-enum); -} -.tsd-member [data-tsd-kind="Class"] { - color: var(--color-ts-class); + +.tsd-navigation.settings { + margin: 1rem 0; } -.tsd-member [data-tsd-kind="Private"] { - color: var(--color-ts-private); +.tsd-navigation > a, +.tsd-navigation .tsd-accordion-summary { + width: calc(100% - 0.25rem); + display: flex; + align-items: center; } - -.tsd-navigation a { - display: block; - margin: 0.4rem 0; - border-left: 2px solid transparent; +.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; - transition: border-left-color 0.1s; + box-sizing: border-box; +} +.tsd-navigation a.current, +.tsd-page-navigation a.current { + background: var(--color-active-menu-item); } -.tsd-navigation a:hover { +.tsd-navigation a:hover, +.tsd-page-navigation a:hover { text-decoration: underline; } -.tsd-navigation ul { - margin: 0; +.tsd-navigation ul, +.tsd-page-navigation ul { + margin-top: 0; + margin-bottom: 0; padding: 0; list-style: none; } -.tsd-navigation li { +.tsd-navigation li, +.tsd-page-navigation li { padding: 0; + max-width: 100%; } - -.tsd-navigation.primary .tsd-accordion-details > ul { - margin-top: 0.75rem; -} -.tsd-navigation.primary a { - padding: 0.75rem 0.5rem; - margin: 0; +.tsd-nested-navigation { + margin-left: 3rem; } -.tsd-navigation.primary ul li a { - margin-left: 0.5rem; +.tsd-nested-navigation > li > details { + margin-left: -1.5rem; } -.tsd-navigation.primary ul li li a { +.tsd-small-nested-navigation { margin-left: 1.5rem; } -.tsd-navigation.primary ul li li li a { - margin-left: 2.5rem; -} -.tsd-navigation.primary ul li li li li a { - margin-left: 3.5rem; -} -.tsd-navigation.primary ul li li li li li a { - margin-left: 4.5rem; -} -.tsd-navigation.primary ul li li li li li li a { - margin-left: 5.5rem; -} -.tsd-navigation.primary li.current > a { - border-left: 0.15rem var(--color-text) solid; -} -.tsd-navigation.primary li.selected > a { - font-weight: bold; - border-left: 0.2rem var(--color-text) solid; -} -.tsd-navigation.primary ul li a:hover { - border-left: 0.2rem var(--color-text-aside) solid; -} -.tsd-navigation.primary li.globals + li > span, -.tsd-navigation.primary li.globals + li > a { - padding-top: 20px; +.tsd-small-nested-navigation > li > details { + margin-left: -1.5rem; } -.tsd-navigation.secondary.tsd-navigation--toolbar-hide { - max-height: calc(100vh - 1rem); - top: 0.5rem; -} -.tsd-navigation.secondary > ul { - display: inline; - padding-right: 0.5rem; - transition: opacity 0.2s; -} -.tsd-navigation.secondary ul li a { - padding-left: 0; -} -.tsd-navigation.secondary ul li li a { - padding-left: 1.1rem; -} -.tsd-navigation.secondary ul li li li a { - padding-left: 2.2rem; +.tsd-page-navigation ul { + padding-left: 1.75rem; } -.tsd-navigation.secondary ul li li li li a { - padding-left: 3.3rem; -} -.tsd-navigation.secondary ul li li li li li a { - padding-left: 4.4rem; + +#tsd-sidebar-links a { + margin-top: 0; + margin-bottom: 0.5rem; + line-height: 1.25rem; } -.tsd-navigation.secondary ul li li li li li li a { - padding-left: 5.5rem; +#tsd-sidebar-links a:last-of-type { + margin-bottom: 0; } a.tsd-index-link { - margin: 0.25rem 0; + 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 > h1, -.tsd-accordion-summary > h2, -.tsd-accordion-summary > h3, -.tsd-accordion-summary > h4, -.tsd-accordion-summary > h5 { - display: inline-flex; - align-items: center; - vertical-align: middle; - margin-bottom: 0; +.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 { user-select: none; -moz-user-select: none; -webkit-user-select: none; -ms-user-select: none; -} -.tsd-accordion-summary { - display: block; + 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-summary::-webkit-details-marker { - display: none; -} -.tsd-index-accordion .tsd-accordion-summary svg { - margin-right: 0.25rem; +.tsd-index-accordion .tsd-accordion-summary > svg { + margin-left: 0.25rem; } .tsd-index-content > :not(:first-child) { margin-top: 0.75rem; @@ -885,34 +854,6 @@ a.tsd-index-link { margin-right: 0.8rem; } -@media (min-width: 1024px) { - .col-content { - margin: 2rem auto; - } - - .menu-sticky-wrap { - position: sticky; - height: calc(100vh - 2rem); - top: 4rem; - right: 0; - padding: 0 1.5rem; - padding-top: 1rem; - margin-top: 3rem; - transition: 0.3s ease-in-out; - transition-property: top, padding-top, padding, height; - overflow-y: auto; - } - .col-menu { - border-left: 1px solid var(--color-accent); - } - .col-menu--hide { - top: 1rem; - } - .col-menu .tsd-navigation:not(:last-child) { - padding-bottom: 1.75rem; - } -} - .tsd-panel { margin-bottom: 2.5rem; } @@ -978,7 +919,8 @@ a.tsd-index-link { right: -40px; } #tsd-search .field input, -#tsd-search .title { +#tsd-search .title, +#tsd-toolbar-links a { transition: opacity 0.2s; } #tsd-search .results { @@ -992,8 +934,9 @@ a.tsd-index-link { box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); } #tsd-search .results li { - padding: 0 10px; background-color: var(--color-background); + line-height: initial; + padding: 4px; } #tsd-search .results li:nth-child(even) { background-color: var(--color-background-secondary); @@ -1001,12 +944,15 @@ a.tsd-index-link { #tsd-search .results li.state { display: none; } -#tsd-search .results li.current, -#tsd-search .results li:hover { +#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: block; + display: flex; + align-items: center; + padding: 0.25rem; + box-sizing: border-box; } #tsd-search .results a:before { top: 10px; @@ -1022,7 +968,8 @@ a.tsd-index-link { top: 0; opacity: 1; } -#tsd-search.has-focus .title { +#tsd-search.has-focus .title, +#tsd-search.has-focus #tsd-toolbar-links a { z-index: 0; opacity: 0; } @@ -1036,6 +983,22 @@ a.tsd-index-link { 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; @@ -1045,6 +1008,11 @@ a.tsd-index-link { 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; @@ -1100,7 +1068,7 @@ ul.tsd-type-parameter-list h5 { } .tsd-page-toolbar { - position: fixed; + position: sticky; z-index: 1; top: 0; left: 0; @@ -1134,9 +1102,10 @@ ul.tsd-type-parameter-list h5 { .tsd-page-toolbar .table-cell:first-child { width: 100%; } - -.tsd-page-toolbar--hide { - transform: translateY(-100%); +.tsd-page-toolbar .tsd-toolbar-icon { + box-sizing: border-box; + line-height: 0; + padding: 12px 0; } .tsd-widget { @@ -1144,7 +1113,9 @@ ul.tsd-type-parameter-list h5 { overflow: hidden; opacity: 0.8; height: 40px; - transition: opacity 0.1s, background-color 0.2s; + transition: + opacity 0.1s, + background-color 0.2s; vertical-align: bottom; cursor: pointer; } @@ -1166,12 +1137,6 @@ ul.tsd-type-parameter-list h5 { .tsd-widget.menu { display: none; } -@media (max-width: 1024px) { - .tsd-widget.options, - .tsd-widget.menu { - display: inline-block; - } -} input[type="checkbox"] + .tsd-widget:before { background-position: -120px 0; } @@ -1202,7 +1167,85 @@ img { } .deprecated { - text-decoration: line-through; + 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); } * { @@ -1223,3 +1266,147 @@ img { 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%; + } +} + +/* 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/assets/widgets.png b/docs/assets/widgets.png deleted file mode 100644 index c738053..0000000 Binary files a/docs/assets/widgets.png and /dev/null differ diff --git a/docs/assets/widgets@2x.png b/docs/assets/widgets@2x.png deleted file mode 100644 index 4bbbd57..0000000 Binary files a/docs/assets/widgets@2x.png and /dev/null differ diff --git a/docs/classes/AudioSession.html b/docs/classes/AudioSession.html index 0eb701f..2184b6d 100644 --- a/docs/classes/AudioSession.html +++ b/docs/classes/AudioSession.html @@ -1,77 +1,16 @@ -AudioSession | @livekit/react-native
-
- -
-
-
-
- -

Class AudioSession

-
-

Hierarchy

-
    -
  • AudioSession
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Methods

-
configureAudio -getAudioOutputs -selectAudioOutput -setAppleAudioConfiguration -showAudioRoutePicker -startAudioSession -stopAudioSession -
-
-

Constructors

-
-

constructor

-
-
-

Methods

-
-

Static configureAudio

-

Static startAudioSession

Static stopAudioSession

Settings

Member Visibility

Theme

On This Page

constructorconfigureAudiogetAudioOutputsselectAudioOutputsetAppleAudioConfigurationshowAudioRoutePickerstartAudioSessionstopAudioSession
\ No newline at end of file diff --git a/docs/functions/LiveKitRoom.html b/docs/functions/LiveKitRoom.html index db02803..e618925 100644 --- a/docs/functions/LiveKitRoom.html +++ b/docs/functions/LiveKitRoom.html @@ -1,126 +1,6 @@ -LiveKitRoom | @livekit/react-native
-
- -
-
-
-
- -

Function LiveKitRoom

-
-

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/VideoTrack.html b/docs/functions/VideoTrack.html index 7c326fc..31023ca 100644 --- a/docs/functions/VideoTrack.html +++ b/docs/functions/VideoTrack.html @@ -1,119 +1 @@ -VideoTrack | @livekit/react-native
-
- -
-
-
-
- -

Function VideoTrack

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +VideoTrack | LiveKit React Native Client SDK - v2.3.0

Function VideoTrack

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/VideoView.html b/docs/functions/VideoView.html index dd227e6..87be7ae 100644 --- a/docs/functions/VideoView.html +++ b/docs/functions/VideoView.html @@ -1,122 +1,2 @@ -VideoView | @livekit/react-native
-
- -
-
-
-
- -

Function VideoView

-
-
    - -
  • -
    -

    Deprecated

    use VideoTrack and VideoTrackProps instead.

    -
    -
    -

    Parameters

    -
      -
    • -
      __namedParameters: Props
    -

    Returns Element

-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +VideoView | LiveKit React Native Client SDK - v2.3.0

Function VideoView

  • VideoView(__namedParameters): Element

  • Parameters

    Returns Element

    Deprecated

    use VideoTrack and VideoTrackProps instead.

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/getDefaultAppleAudioConfigurationForMode.html b/docs/functions/getDefaultAppleAudioConfigurationForMode.html index 2703116..6bb6f3d 100644 --- a/docs/functions/getDefaultAppleAudioConfigurationForMode.html +++ b/docs/functions/getDefaultAppleAudioConfigurationForMode.html @@ -1,121 +1 @@ -getDefaultAppleAudioConfigurationForMode | @livekit/react-native
-
- -
-
-
-
- -

Function getDefaultAppleAudioConfigurationForMode

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +getDefaultAppleAudioConfigurationForMode | LiveKit React Native Client SDK - v2.3.0

Function getDefaultAppleAudioConfigurationForMode

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/isTrackReference.html b/docs/functions/isTrackReference.html deleted file mode 100644 index 55f7918..0000000 --- a/docs/functions/isTrackReference.html +++ /dev/null @@ -1,119 +0,0 @@ -isTrackReference | @livekit/react-native
-
- -
-
-
-
- -

Function isTrackReference

-
-
    - -
  • Internal -
    -

    Parameters

    -
      -
    • -
      trackReference: unknown
    -

    Returns trackReference is TrackReference

-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/functions/registerGlobals.html b/docs/functions/registerGlobals.html index ab6faf9..88dc2ec 100644 --- a/docs/functions/registerGlobals.html +++ b/docs/functions/registerGlobals.html @@ -1,117 +1,3 @@ -registerGlobals | @livekit/react-native
-
- -
-
-
-
- -

Function registerGlobals

-
-

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/setLogLevel.html b/docs/functions/setLogLevel.html index 11f3968..c11fc23 100644 --- a/docs/functions/setLogLevel.html +++ b/docs/functions/setLogLevel.html @@ -1,124 +1,3 @@ -setLogLevel | @livekit/react-native
-
- -
-
-
-
- -

Function setLogLevel

-
-

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/sortParticipants.html b/docs/functions/sortParticipants.html index b2bbbd4..b1e3437 100644 --- a/docs/functions/sortParticipants.html +++ b/docs/functions/sortParticipants.html @@ -1,23 +1,4 @@ -sortParticipants | @livekit/react-native
-
- -
-
-
-
- -

Function sortParticipants

-
-
    - -
  • -

    Default sort for participants, it'll order participants by:

    +sortParticipants | LiveKit React Native Client SDK - v2.3.0

    Function sortParticipants

    • sortParticipants(participants, localParticipant?): void

    • Default sort for participants, it'll order participants by:

      1. dominant speaker (speaker with the loudest audio level)
      2. local participant
        3. @@ -25,106 +6,4 @@

        Function sortParticipants

    • participants with video on
    • by joinedAt
      • -
    -
    -

    Parameters

    -
      -
    • -
      participants: default[]
      • -
    • -
      Optional localParticipant: default
    -

    Returns void

-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Parameters

  • participants: default[]
  • Optional localParticipant: default

Returns void

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/useChat.html b/docs/functions/useChat.html deleted file mode 100644 index 17f0aeb..0000000 --- a/docs/functions/useChat.html +++ /dev/null @@ -1,134 +0,0 @@ -useChat | @livekit/react-native
-
- -
-
-
-
- -

Function useChat

-
-
    - -
  • -

    The useChat hook provides chat functionality for a LiveKit room. -It returns a simple send function to send chat messages and an array of chatMessages to hold received messages. -It also returns a update function that allows you to implement message-edit functionality.

    - -

    Remarks

    It is possible to pass configurations for custom message encoding and decoding and non-default topics on which to send the messages.

    -
    -
    -

    Parameters

    -
      -
    • -
      Optional options: ChatOptions
    -

    Returns { chatMessages: ReceivedChatMessage[]; isSending: boolean; send: ((message: string) => Promise<ChatMessage>) | undefined; update: ((message: string, messageId: string) => Promise<ChatMessage>) | undefined }

    -
      -
    • -
      chatMessages: ReceivedChatMessage[]
      • -
    • -
      isSending: boolean
      • -
    • -
      send: ((message: string) => Promise<ChatMessage>) | undefined
      • -
    • -
      update: ((message: string, messageId: string) => Promise<ChatMessage>) | undefined
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/functions/useConnectionState.html b/docs/functions/useConnectionState.html deleted file mode 100644 index 0000c07..0000000 --- a/docs/functions/useConnectionState.html +++ /dev/null @@ -1,124 +0,0 @@ -useConnectionState | @livekit/react-native
-
- -
-
-
-
- -

Function useConnectionState

-
-
    - -
  • -

    The useConnectionState hook allows you to simply implement your own ConnectionState component.

    - -

    Example

    const connectionState = useConnectionState(room);
-
    -
    -
    -

    Parameters

    -
      -
    • -
      Optional room: Room
    -

    Returns ConnectionState

-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/functions/useDataChannel.html b/docs/functions/useDataChannel.html deleted file mode 100644 index d064767..0000000 --- a/docs/functions/useDataChannel.html +++ /dev/null @@ -1,177 +0,0 @@ -useDataChannel | @livekit/react-native
-
- -
-
-
-
- -

Function useDataChannel

-
-
    - -
  • -

    The useDataChannel hook returns the ability to send and receive messages. -By optionally passing a topic, you can narrow down which messages are returned in the messages array.

    - -

    Remarks

    There is only one data channel. Passing a topic does not open a new data channel. -It is only used to filter out messages with no or a different topic.

    - -

    Example

    // Send messages to all participants via the 'chat' topic.
    const { message, send } = useDataChannel('chat');
-
    -
    -
    -

    Type Parameters

    -
    -

    Type Parameters

    -
      -
    • -

      T extends string

    -
    -

    Parameters

    -
    -

    Returns UseDataChannelReturnType<T>

    • - -
  • -

    The useDataChannel hook returns the ability to send and receive messages.

    - -

    Remarks

    There is only one data channel. Passing a topic does not open a new data channel. -It is only used to filter out messages with no or a different topic.

    - -

    Example

    // Send messages to all participants
    const { message, send } = useDataChannel(callback);
-
    -
    -
    -

    Parameters

    -
    -

    Returns UseDataChannelReturnType

-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/functions/useEnsureTrackRef.html b/docs/functions/useEnsureTrackRef.html deleted file mode 100644 index 81618e7..0000000 --- a/docs/functions/useEnsureTrackRef.html +++ /dev/null @@ -1,122 +0,0 @@ -useEnsureTrackRef | @livekit/react-native
-
- -
-
-
-
- -

Function useEnsureTrackRef

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/functions/useIOSAudioManagement.html b/docs/functions/useIOSAudioManagement.html index f6f6954..bb14195 100644 --- a/docs/functions/useIOSAudioManagement.html +++ b/docs/functions/useIOSAudioManagement.html @@ -1,141 +1,4 @@ -useIOSAudioManagement | @livekit/react-native
-
- -
-
-
-
- -

Function useIOSAudioManagement

-
-

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/useIsEncrypted.html b/docs/functions/useIsEncrypted.html deleted file mode 100644 index 20cffc1..0000000 --- a/docs/functions/useIsEncrypted.html +++ /dev/null @@ -1,119 +0,0 @@ -useIsEncrypted | @livekit/react-native
-
- -
-
-
-
- -

Function useIsEncrypted

-
-
    - -
  • Alpha -
    -

    Parameters

    -
      -
    • -
      Optional participant: default
    -

    Returns boolean

-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/functions/useIsMuted.html b/docs/functions/useIsMuted.html deleted file mode 100644 index fbe552a..0000000 --- a/docs/functions/useIsMuted.html +++ /dev/null @@ -1,125 +0,0 @@ -useIsMuted | @livekit/react-native
-
- -
-
-
-
- -

Function useIsMuted

-
-
    - -
  • -

    The useIsMuted hook is used to implement the TrackMutedIndicator or your custom implementation of it. -It returns a boolean that indicates if the track is muted or not.

    - -

    Example

    const isMuted = useIsMuted(track);
-
    -
    -
    -

    Parameters

    -
    -

    Returns boolean

-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/functions/useIsSpeaking.html b/docs/functions/useIsSpeaking.html deleted file mode 100644 index c23e930..0000000 --- a/docs/functions/useIsSpeaking.html +++ /dev/null @@ -1,124 +0,0 @@ -useIsSpeaking | @livekit/react-native
-
- -
-
-
-
- -

Function useIsSpeaking

-
-
    - -
  • -

    The useIsSpeaking hook returns a boolean that indicates if the participant is speaking or not.

    - -

    Example

    const isSpeaking = useIsSpeaking(participant);
-
    -
    -
    -

    Parameters

    -
      -
    • -
      Optional participant: default
    -

    Returns boolean

-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/functions/useLiveKitRoom.html b/docs/functions/useLiveKitRoom.html deleted file mode 100644 index ddb23b2..0000000 --- a/docs/functions/useLiveKitRoom.html +++ /dev/null @@ -1,137 +0,0 @@ -useLiveKitRoom | @livekit/react-native
-
- -
-
-
-
- -

Function useLiveKitRoom

-
-
    - -
  • -

    The useLiveKitRoom hook is used to implement the LiveKitRoom or your custom implementation of it. -It returns a Room instance and HTML props that should be applied to the root element of the component.

    - -

    Example

    const { room, htmlProps } = useLiveKitRoom();
    return <div {...htmlProps}>...</div>;
-
    -
    -
    -

    Type Parameters

    -
    -

    Type Parameters

    -
      -
    • -

      T extends HTMLElement

    -
    -

    Parameters

    -
      -
    • -
      props: LiveKitRoomProps
    -

    Returns { htmlProps: HTMLAttributes<T>; room: Room | undefined }

    -
      -
    • -
      htmlProps: HTMLAttributes<T>
      • -
    • -
      room: Room | undefined
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/functions/useLocalParticipant.html b/docs/functions/useLocalParticipant.html deleted file mode 100644 index 38a6a42..0000000 --- a/docs/functions/useLocalParticipant.html +++ /dev/null @@ -1,142 +0,0 @@ -useLocalParticipant | @livekit/react-native
-
- -
-
-
-
- -

Function useLocalParticipant

-
-
    - -
  • -

    The useLocalParticipant hook returns the local participant and the associated state -around the participant.

    - -

    Example

    const { localParticipant } = useLocalParticipant();
-
    -
    -
    -

    Parameters

    -
    -

    Returns { cameraTrack: TrackPublication | undefined; isCameraEnabled: boolean; isMicrophoneEnabled: boolean; isScreenShareEnabled: boolean; lastCameraError: Error | undefined; lastMicrophoneError: Error | undefined; localParticipant: LocalParticipant; microphoneTrack: TrackPublication | undefined }

    -
      -
    • -
      cameraTrack: TrackPublication | undefined
      • -
    • -
      isCameraEnabled: boolean
      • -
    • -
      isMicrophoneEnabled: boolean
      • -
    • -
      isScreenShareEnabled: boolean
      • -
    • -
      lastCameraError: Error | undefined
      • -
    • -
      lastMicrophoneError: Error | undefined
      • -
    • -
      localParticipant: LocalParticipant
      • -
    • -
      microphoneTrack: TrackPublication | undefined
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/functions/useLocalParticipantPermissions.html b/docs/functions/useLocalParticipantPermissions.html deleted file mode 100644 index 4d79e50..0000000 --- a/docs/functions/useLocalParticipantPermissions.html +++ /dev/null @@ -1,119 +0,0 @@ -useLocalParticipantPermissions | @livekit/react-native
-
- -
-
-
-
- -

Function useLocalParticipantPermissions

-
-
    - -
  • -

    The useLocalParticipantPermissions hook returns the local participant's permissions.

    - -

    Example

    const { canPublish, canPublishData } = useLocalParticipantPermissions();
-
    -
    -

    Returns ParticipantPermission | undefined

-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/functions/useParticipant.html b/docs/functions/useParticipant.html index e478f6e..6a768bb 100644 --- a/docs/functions/useParticipant.html +++ b/docs/functions/useParticipant.html @@ -1,122 +1,2 @@ -useParticipant | @livekit/react-native
-
- -
-
-
-
- -

Function useParticipant

-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +useParticipant | LiveKit React Native Client SDK - v2.3.0

Function useParticipant

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/useParticipantContext.html b/docs/functions/useParticipantContext.html deleted file mode 100644 index 9aea982..0000000 --- a/docs/functions/useParticipantContext.html +++ /dev/null @@ -1,117 +0,0 @@ -useParticipantContext | @livekit/react-native
-
- -
-
-
-
- -

Function useParticipantContext

-
-
    - -
  • -

    Ensures that a participant is provided via context. -If not inside a ParticipantContext, an error is thrown.

    -
    -

    Returns Participant

-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/functions/useParticipantInfo.html b/docs/functions/useParticipantInfo.html deleted file mode 100644 index 0140483..0000000 --- a/docs/functions/useParticipantInfo.html +++ /dev/null @@ -1,126 +0,0 @@ -useParticipantInfo | @livekit/react-native
-
- -
-
-
-
- -

Function useParticipantInfo

-
-
    - -
  • -
    -

    Parameters

    -
    -

    Returns { identity: string; metadata: string | undefined; name: string | undefined }

    -
      -
    • -
      identity: string
      • -
    • -
      metadata: string | undefined
      • -
    • -
      name: string | undefined
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/functions/useParticipantTracks.html b/docs/functions/useParticipantTracks.html deleted file mode 100644 index c7c9286..0000000 --- a/docs/functions/useParticipantTracks.html +++ /dev/null @@ -1,124 +0,0 @@ -useParticipantTracks | @livekit/react-native
-
- -
-
-
-
- -

Function useParticipantTracks

-
-
    - -
  • -

    useParticipantTracks is a custom React that allows you to get tracks of a specific participant only, by specifiying the participant's identity. -If the participant identity is not passed the hook will try to get the participant from a participant context.

    -
    -
    -

    Parameters

    -
      -
    • -
      sources: Source[]
      • -
    • -
      Optional participantIdentity: string
    -

    Returns TrackReference[]

-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/functions/useParticipants.html b/docs/functions/useParticipants.html deleted file mode 100644 index a9000a3..0000000 --- a/docs/functions/useParticipants.html +++ /dev/null @@ -1,126 +0,0 @@ -useParticipants | @livekit/react-native
-
- -
-
-
-
- -

Function useParticipants

-
-
    - -
  • -

    The useParticipants hook returns all participants (local and remote) of the current room.

    - -

    Remarks

    To optimize performance, you can use the updateOnlyOn property to decide on what RoomEvents the hook updates.

    - -

    Example

    const participants = useParticipants();
    <ParticipantLoop participants={participants}>
     <ParticipantName />
    </ParticipantLoop>
-
    -
    -
    -

    Parameters

    -
    -

    Returns (RemoteParticipant | LocalParticipant)[]

-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/functions/useRemoteParticipant.html b/docs/functions/useRemoteParticipant.html deleted file mode 100644 index 7dfe134..0000000 --- a/docs/functions/useRemoteParticipant.html +++ /dev/null @@ -1,128 +0,0 @@ -useRemoteParticipant | @livekit/react-native
-
- -
-
-
-
- -

Function useRemoteParticipant

-
-
    - -
  • -

    The useRemoteParticipant hook returns the RemoteParticipant with the given identity.

    - -

    Remarks

    To optimize performance, you can use the updateOnlyOn property to decide on what ParticipantEvents the hook updates.

    - -

    Example

    const participant = useRemoteParticipant('Russ');
-
    -
    -
    -

    Parameters

    -
    -

    Returns RemoteParticipant | undefined

-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/functions/useRemoteParticipants.html b/docs/functions/useRemoteParticipants.html deleted file mode 100644 index f879e2f..0000000 --- a/docs/functions/useRemoteParticipants.html +++ /dev/null @@ -1,126 +0,0 @@ -useRemoteParticipants | @livekit/react-native
-
- -
-
-
-
- -

Function useRemoteParticipants

-
-
    - -
  • -

    The useRemoteParticipants hook returns all remote participants (without the local) of the current room.

    - -

    Remarks

    To optimize performance, you can use the updateOnlyOn property to decide on what RoomEvents the hook updates.

    - -

    Example

    const participants = useRemoteParticipants();
    <ParticipantLoop participants={participants}>
     <ParticipantName />
    </ParticipantLoop>
-
    -
    -
    -

    Parameters

    -
    -

    Returns RemoteParticipant[]

-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/functions/useRoom.html b/docs/functions/useRoom.html index f7e892b..4c8860b 100644 --- a/docs/functions/useRoom.html +++ b/docs/functions/useRoom.html @@ -1,124 +1,2 @@ -useRoom | @livekit/react-native
-
- -
-
-
-
- -

Function useRoom

-
-
    - -
  • -
    -

    Deprecated

    wrap your components in a component instead and use more granular hooks to track state you're interested in

    -
    -
    -

    Parameters

    -
    -

    Returns RoomState

-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +useRoom | LiveKit React Native Client SDK - v2.3.0

Function useRoom

  • useRoom(room, options?): RoomState

  • Parameters

    Returns RoomState

    Deprecated

    wrap your components in a component instead and use more granular hooks to track state you're interested in

    +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/functions/useRoomContext.html b/docs/functions/useRoomContext.html deleted file mode 100644 index 332ba64..0000000 --- a/docs/functions/useRoomContext.html +++ /dev/null @@ -1,117 +0,0 @@ -useRoomContext | @livekit/react-native
-
- -
-
-
-
- -

Function useRoomContext

-
-
    - -
  • -

    Ensures that a room is provided via context. -If no room is provided, an error is thrown.

    -
    -

    Returns Room

-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/functions/useRoomInfo.html b/docs/functions/useRoomInfo.html deleted file mode 100644 index 8e87e6d..0000000 --- a/docs/functions/useRoomInfo.html +++ /dev/null @@ -1,124 +0,0 @@ -useRoomInfo | @livekit/react-native
-
- -
-
-
-
- -

Function useRoomInfo

-
-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      Optional options: UseRoomInfoOptions
    -

    Returns { metadata: string | undefined; name: string }

    -
      -
    • -
      metadata: string | undefined
      • -
    • -
      name: string
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/functions/useSortedParticipants.html b/docs/functions/useSortedParticipants.html deleted file mode 100644 index 86e80c7..0000000 --- a/docs/functions/useSortedParticipants.html +++ /dev/null @@ -1,121 +0,0 @@ -useSortedParticipants | @livekit/react-native
-
- -
-
-
-
- -

Function useSortedParticipants

-
-
    - -
  • -

    The useSortedParticipants hook returns the participants sorted by importance.

    -
    -
    -

    Parameters

    -
      -
    • -
      participants: default[]
    -

    Returns Participant[]

-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/functions/useSpeakingParticipants.html b/docs/functions/useSpeakingParticipants.html deleted file mode 100644 index 02f894f..0000000 --- a/docs/functions/useSpeakingParticipants.html +++ /dev/null @@ -1,119 +0,0 @@ -useSpeakingParticipants | @livekit/react-native
-
- -
-
-
-
- -

Function useSpeakingParticipants

-
-
    - -
  • -

    The useSpeakingParticipants hook returns the only the active speakers of all participants.

    - -

    Example

    const activeSpeakers = useSpeakingParticipants();
-
    -
    -

    Returns Participant[]

-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/functions/useTrackMutedIndicator.html b/docs/functions/useTrackMutedIndicator.html deleted file mode 100644 index c51c5e7..0000000 --- a/docs/functions/useTrackMutedIndicator.html +++ /dev/null @@ -1,125 +0,0 @@ -useTrackMutedIndicator | @livekit/react-native
-
- -
-
-
-
- -

Function useTrackMutedIndicator

-
-
    - -
  • -

    The useTrackMutedIndicator hook is used to implement the TrackMutedIndicator component -and returns the muted state of the given track.

    - -

    Example

    const { isMuted } = useTrackMutedIndicator(trackRef);
-
    -
    -
    -

    Parameters

    -
    -

    Returns TrackMutedIndicatorReturnType

-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/functions/useTrackRefContext.html b/docs/functions/useTrackRefContext.html deleted file mode 100644 index fee0276..0000000 --- a/docs/functions/useTrackRefContext.html +++ /dev/null @@ -1,117 +0,0 @@ -useTrackRefContext | @livekit/react-native
-
- -
-
-
-
- -

Function useTrackRefContext

-
-
    - -
  • -

    Ensures that a track reference is provided via context. -If not inside a TrackRefContext, an error is thrown.

    -
    -

    Returns TrackReferenceOrPlaceholder

-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/functions/useTracks.html b/docs/functions/useTracks.html deleted file mode 100644 index f6cf6eb..0000000 --- a/docs/functions/useTracks.html +++ /dev/null @@ -1,137 +0,0 @@ -useTracks | @livekit/react-native
-
- -
-
-
-
- -

Function useTracks

-
-
    - -
  • -

    The useTracks hook returns an array of TrackReference or TrackReferenceOrPlaceholder depending on the provided sources property. -If only subscribed tracks are desired, set the onlySubscribed property to true.

    - -

    Example

    // Return all camera track publications.
    const trackReferences: TrackReference[] = useTracks([Track.Source.Camera])
-
    - -

    Example

    // Return all subscribed camera tracks as well as placeholders for
    // participants without a camera subscription.
    const trackReferencesWithPlaceholders: TrackReferenceOrPlaceholder[] = useTracks([{source: Track.Source.Camera, withPlaceholder: true}])
-
    -
    -
    -

    Type Parameters

    -
    -

    Type Parameters

    -
      -
    • -

      T extends SourcesArray = Source[]

    -
    -

    Parameters

    -
    -

    Returns UseTracksHookReturnType<T>

-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/functions/useVisualStableUpdate.html b/docs/functions/useVisualStableUpdate.html deleted file mode 100644 index d215244..0000000 --- a/docs/functions/useVisualStableUpdate.html +++ /dev/null @@ -1,137 +0,0 @@ -useVisualStableUpdate | @livekit/react-native
-
- -
-
-
-
- -

Function useVisualStableUpdate

-
-
    - -
  • -

    The useVisualStableUpdate hook is used to prevent visually jarring jumps and shifts of elements -in an array. The algorithm only starts to update when there are more items than visually fit -on a page. If this is the case, it will make sure that speaking participants move to the first -page and are always visible.

    - -

    Remarks

    Updating the array can occur because attendees leave or join a room, or because they mute/unmute -or start speaking. -The hook is used for the GridLayout and CarouselLayout components.

    - -

    Example

    const trackRefs = useTracks();
    const updatedTrackRefs = useVisualStableUpdate(trackRefs, itemPerPage);
-
    -
    -
    -

    Parameters

    -
    -

    Returns TrackReferenceOrPlaceholder[]

-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/index.html b/docs/index.html index b9c1e7c..23fbd69 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,16 +1,4 @@ -@livekit/react-native
-
- -
-
-
-
-

@livekit/react-native

-
+LiveKit React Native Client SDK - v2.3.0

LiveKit React Native Client SDK - v2.3.0

@@ -20,11 +8,7 @@

@livekit/react-native

- - -

livekit-react-native

- - +

livekit-react-native

Use this SDK to add real-time video, audio and data features to your React Native app. By connecting to a self- or cloud-hosted LiveKit server, you can quickly build applications like interactive live streaming or video calls with just a few lines of code.

@@ -33,22 +17,10 @@

livekit-react-native

This is v2 of the React-Native SDK. When migrating from v1.x to v2.x you might encounter a small set of breaking changes. Read the migration guide for a detailed overview of what has changed.

- - -

Installation

- - - -

NPM

- -
npm install @livekit/react-native @livekit/react-native-webrtc
-
- - -

Yarn

- -
yarn add @livekit/react-native @livekit/react-native-webrtc
-
+

Installation

NPM

npm install @livekit/react-native @livekit/react-native-webrtc
+
+

Yarn

yarn add @livekit/react-native @livekit/react-native-webrtc
+

This library depends on @livekit/react-native-webrtc, which has additional installation instructions found here:

Once the @livekit/react-native-webrtc dependency is installed, one last step is needed to finish the installation:

- - -

Android

- -

In your MainApplication.java file:

- - -

Java

- -
import com.livekit.reactnative.LiveKitReactNative;
import com.livekit.reactnative.audio.AudioType;

public class MainApplication extends Application implements ReactApplication {

  @Override
  public void onCreate() {
    // Place this above any other RN related initialization
    // When AudioType is omitted, it'll default to CommunicationAudioType.
    // Use MediaAudioType if user is only consuming audio, and not publishing.
    LiveKitReactNative.setup(this, new AudioType.CommunicationAudioType());

    //...
  }
}
-
+

Android

In your MainApplication.java file:

+

Java

import com.livekit.reactnative.LiveKitReactNative;
import com.livekit.reactnative.audio.AudioType;

public class MainApplication extends Application implements ReactApplication {

  @Override
  public void onCreate() {
    // Place this above any other RN related initialization
    // When AudioType is omitted, it'll default to CommunicationAudioType.
    // Use MediaAudioType if user is only consuming audio, and not publishing.
    LiveKitReactNative.setup(this, new AudioType.CommunicationAudioType());

    //...
  }
}
+

Or in your MainApplication.kt if you are using RN 0.73+

- - -

Kotlin

- -
import com.livekit.reactnative.LiveKitReactNative
import com.livekit.reactnative.audio.AudioType

class MainApplication : Application, ReactApplication() {
  override fun onCreate() {
    // Place this above any other RN related initialization
    // When AudioType is omitted, it'll default to CommunicationAudioType.
    // Use MediaAudioType if user is only consuming audio, and not publishing.
    LiveKitReactNative.setup(this, AudioType.CommunicationAudioType())

    //...
  }
}
-
+

Kotlin

import com.livekit.reactnative.LiveKitReactNative
import com.livekit.reactnative.audio.AudioType

class MainApplication : Application, ReactApplication() {
  override fun onCreate() {
    // Place this above any other RN related initialization
    // When AudioType is omitted, it'll default to CommunicationAudioType.
    // Use MediaAudioType if user is only consuming audio, and not publishing.
    LiveKitReactNative.setup(this, AudioType.CommunicationAudioType())

    //...
  }
}
+
- - -

iOS

- -

In your AppDelegate.m file:

-
#import "LivekitReactNative.h"

@implementation AppDelegate

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
  // Place this above any other RN related initialization
  [LivekitReactNative setup];

  //...
}
-
- - -

Expo

- -

LiveKit is available on Expo through development builds. You can find our Expo plugin and setup instructions here.

- - -

Example app

- -

You can try our standalone example app here.

- - -

Usage

- -

In your index.js file, setup the LiveKit SDK by calling registerGlobals(). +

iOS

In your AppDelegate.m file:

+
#import "LivekitReactNative.h"

@implementation AppDelegate

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
  // Place this above any other RN related initialization
  [LivekitReactNative setup];

  //...
}
+
+

Expo

LiveKit is available on Expo through development builds. You can find our Expo plugin and setup instructions here.

+

Example app

You can try our standalone example app here.

+

Usage

In your index.js file, setup the LiveKit SDK by calling registerGlobals(). This sets up the required WebRTC libraries for use in Javascript, and is needed for LiveKit to work.

-
import { registerGlobals } from '@livekit/react-native';

// ...

registerGlobals();
-
+
import { registerGlobals } from '@livekit/react-native';

// ...

registerGlobals();
+

In your app, wrap your component in a LiveKitRoom component, which manages a Room object and allows you to use our hooks to create your own real-time video/audio app.

-
import * as React from 'react';
import {
  StyleSheet,
  View,
  FlatList,
  ListRenderItem,
} from 'react-native';
import { useEffect } from 'react';
import {
  AudioSession,
  LiveKitRoom,
  useTracks,
  TrackReferenceOrPlaceholder,
  VideoTrack,
  isTrackReference,
  registerGlobals,
} from '@livekit/react-native';
import { Track } from 'livekit-client';

const wsURL = "wss://example.com"
const token = "your-token-here"

export default function App() {
  // Start the audio session first.
  useEffect(() => {
    let start = async () => {
      await AudioSession.startAudioSession();
    };

    start();
    return () => {
      AudioSession.stopAudioSession();
    };
  }, []);

  return (
    <LiveKitRoom
      serverUrl={wsURL}
      token={token}
      connect={true}
      options={{
        // Use screen pixel density to handle screens with differing densities.
        adaptiveStream: { pixelDensity: 'screen' },
      }}
      audio={true}
      video={true}
    >
      <RoomView />
    </LiveKitRoom>
  );
};

const RoomView = () => {
  // Get all camera tracks.
  // The useTracks hook grabs the tracks from LiveKitRoom component
  // providing the context for the Room object.
  const tracks = useTracks([Track.Source.Camera]);

  const renderTrack: ListRenderItem<TrackReferenceOrPlaceholder> = ({item}) => {
    // Render using the VideoTrack component.
    if(isTrackReference(item)) {
      return (<VideoTrack trackRef={item} style={styles.participantView} />)
    } else {
      return (<View style={styles.participantView} />)
    }
  };

  return (
    <View style={styles.container}>
      <FlatList
        data={tracks}
        renderItem={renderTrack}
      />
    </View>
  );
};

const styles = StyleSheet.create({
  container: {
    flex: 1,
    alignItems: 'stretch',
    justifyContent: 'center',
  },
  participantView: {
    height: 300,
  },
});
-
+
import * as React from 'react';
import {
  StyleSheet,
  View,
  FlatList,
  ListRenderItem,
} from 'react-native';
import { useEffect } from 'react';
import {
  AudioSession,
  LiveKitRoom,
  useTracks,
  TrackReferenceOrPlaceholder,
  VideoTrack,
  isTrackReference,
  registerGlobals,
} from '@livekit/react-native';
import { Track } from 'livekit-client';

const wsURL = "wss://example.com"
const token = "your-token-here"

export default function App() {
  // Start the audio session first.
  useEffect(() => {
    let start = async () => {
      await AudioSession.startAudioSession();
    };

    start();
    return () => {
      AudioSession.stopAudioSession();
    };
  }, []);

  return (
    <LiveKitRoom
      serverUrl={wsURL}
      token={token}
      connect={true}
      options={{
        // Use screen pixel density to handle screens with differing densities.
        adaptiveStream: { pixelDensity: 'screen' },
      }}
      audio={true}
      video={true}
    >
      <RoomView />
    </LiveKitRoom>
  );
};

const RoomView = () => {
  // Get all camera tracks.
  // The useTracks hook grabs the tracks from LiveKitRoom component
  // providing the context for the Room object.
  const tracks = useTracks([Track.Source.Camera]);

  const renderTrack: ListRenderItem<TrackReferenceOrPlaceholder> = ({item}) => {
    // Render using the VideoTrack component.
    if(isTrackReference(item)) {
      return (<VideoTrack trackRef={item} style={styles.participantView} />)
    } else {
      return (<View style={styles.participantView} />)
    }
  };

  return (
    <View style={styles.container}>
      <FlatList
        data={tracks}
        renderItem={renderTrack}
      />
    </View>
  );
};

const styles = StyleSheet.create({
  container: {
    flex: 1,
    alignItems: 'stretch',
    justifyContent: 'center',
  },
  participantView: {
    height: 300,
  },
});
+

API documentation is located here.

Additional documentation for the LiveKit SDK can be found at https://docs.livekit.io/

- - -

Audio sessions

- -

As seen in the above example, we've introduced a class AudioSession that helps +

Audio sessions

As seen in the above example, we've introduced a class AudioSession that helps to manage the audio session on native platforms. This class wraps either AudioManager on Android, or AVAudioSession on iOS.

You can customize the configuration of the audio session with configureAudio.

- - -

Android

- - - -

Media playback

- -

By default, the audio session is set up for bidirectional communication. In this mode, the audio framework exhibits the following behaviors:

+

Android

Media playback

By default, the audio session is set up for bidirectional communication. In this mode, the audio framework exhibits the following behaviors:

  • The volume cannot be reduced to 0.
  • Echo cancellation is available and is enabled by default.
  • A microphone indicator can be displayed, depending on the platform.

If you're leveraging LiveKit primarily for media playback, you have the option to reconfigure the audio session to better suit media playback. Here's how:

-
useEffect(() => {
  let connect = async () => {
    // configure audio session prior to starting it.
    await AudioSession.configureAudio({
      android: {
        // currently supports .media and .communication presets
        audioTypeOptions: AndroidAudioTypePresets.media,
      },
    });
    await AudioSession.startAudioSession();
    await room.connect(url, token, {});
  };
  connect();
  return () => {
    room.disconnect();
    AudioSession.stopAudioSession();
  };
}, [url, token, room]);
-
- - -

Customizing audio session

- -

Instead of using our presets, you can further customize the audio session to suit your specific needs.

-
await AudioSession.configureAudio({
  android: {
    preferredOutputList: ['earpiece'],
    // See [AudioManager](https://developer.android.com/reference/android/media/AudioManager)
    // for details on audio and focus modes.
    audioTypeOptions: {
      manageAudioFocus: true,
      audioMode: 'normal',
      audioFocusMode: 'gain',
      audioStreamType: 'music',
      audioAttributesUsageType: 'media',
      audioAttributesContentType: 'unknown',
    },
  },
});
await AudioSession.startAudioSession();
-
- - -

iOS

- -

For iOS, the most appropriate audio configuration may change over time when local/remote +

useEffect(() => {
  let connect = async () => {
    // configure audio session prior to starting it.
    await AudioSession.configureAudio({
      android: {
        // currently supports .media and .communication presets
        audioTypeOptions: AndroidAudioTypePresets.media,
      },
    });
    await AudioSession.startAudioSession();
    await room.connect(url, token, {});
  };
  connect();
  return () => {
    room.disconnect();
    AudioSession.stopAudioSession();
  };
}, [url, token, room]);
+
+

Customizing audio session

Instead of using our presets, you can further customize the audio session to suit your specific needs.

+
await AudioSession.configureAudio({
  android: {
    preferredOutputList: ['earpiece'],
    // See [AudioManager](https://developer.android.com/reference/android/media/AudioManager)
    // for details on audio and focus modes.
    audioTypeOptions: {
      manageAudioFocus: true,
      audioMode: 'normal',
      audioFocusMode: 'gain',
      audioStreamType: 'music',
      audioAttributesUsageType: 'media',
      audioAttributesContentType: 'unknown',
    },
  },
});
await AudioSession.startAudioSession();
+
+

iOS

For iOS, the most appropriate audio configuration may change over time when local/remote audio tracks publish and unpublish from the room. To adapt to this, the useIOSAudioManagement hook is advised over just configuring the audio session once for the entire audio session.

- - -

Screenshare

- -

Enabling screenshare requires extra installation steps:

- - -

Android

- -

Android screenshare requires a foreground service with type mediaProjection to be present.

-

The example app uses @voximplant/react-native-foreground-service for this. -Ensure that the service is labelled a mediaProjection service like so:

-
<service android:name="com.voximplant.foregroundservice.VIForegroundService" android:foregroundServiceType="mediaProjection" />
-
+

Screenshare

Enabling screenshare requires extra installation steps:

+

Android

Android screenshare requires a foreground service with type mediaProjection to be present.

+

The example app uses @supersami/rn-foreground-service for this.

+

Add the following permissions to your AndroidManifest.xml file:

+
<uses-permission android:name="android.permission.FOREGROUND_SERVICE" />
<uses-permission android:name="android.permission.FOREGROUND_SERVICE_MEDIA_PROJECTION" />
+
+

Declare the the service and ensure it's labelled a mediaProjection service like so:

+
<service android:name="com.supersami.foregroundservice.ForegroundService" android:foregroundServiceType="mediaProjection" />
<service android:name="com.supersami.foregroundservice.ForegroundServiceTask" />
+

Once setup, start the foreground service prior to using screenshare.

- - -

iOS

- -

iOS screenshare requires adding a Broadcast Extension to your iOS project. Follow the integration instructions here:

+

iOS

iOS screenshare requires adding a Broadcast Extension to your iOS project. Follow the integration instructions here:

https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-ios-sdk/#screen-sharing-integration

It involves copying the files found in this sample project to your iOS project, and registering a Broadcast Extension in Xcode.

@@ -172,138 +87,26 @@

iOS

Due to background app processing limitations, screen recording may be interrupted if the app is restricted in the background. Registering with CallKit allows the app to continue processing for the duration of the call.

Once setup, iOS screenshare can be initiated like so:

-
const screenCaptureRef = React.useRef(null);
const screenCapturePickerView = Platform.OS === 'ios' && (
  <ScreenCapturePickerView ref={screenCaptureRef} />
);
const startBroadcast = async () => {
  if (Platform.OS === 'ios') {
    const reactTag = findNodeHandle(screenCaptureRef.current);
    await NativeModules.ScreenCapturePickerViewManager.show(reactTag);
    room.localParticipant.setScreenShareEnabled(true);
  } else {
    room.localParticipant.setScreenShareEnabled(true);
  }
};

return (
  <View style={styles.container}>
    /*...*/ // Make sure the ScreenCapturePickerView exists in the view tree.
    {screenCapturePickerView}
  </View>
);
-
- - -

Note

- -

You will not be able to publish camera or microphone tracks on iOS Simulator.

- - -

Troubleshooting

- - - -

Cannot read properties of undefined (reading 'split')

- -

This error could happen if you are using yarn and have incompatible versions of dependencies with livekit-client.

+
const screenCaptureRef = React.useRef(null);
const screenCapturePickerView = Platform.OS === 'ios' && (
  <ScreenCapturePickerView ref={screenCaptureRef} />
);
const startBroadcast = async () => {
  if (Platform.OS === 'ios') {
    const reactTag = findNodeHandle(screenCaptureRef.current);
    await NativeModules.ScreenCapturePickerViewManager.show(reactTag);
    room.localParticipant.setScreenShareEnabled(true);
  } else {
    room.localParticipant.setScreenShareEnabled(true);
  }
};

return (
  <View style={styles.container}>
    /*...*/ // Make sure the ScreenCapturePickerView exists in the view tree.
    {screenCapturePickerView}
  </View>
);
+
+

Note

You will not be able to publish camera or microphone tracks on iOS Simulator.

+

Troubleshooting

Cannot read properties of undefined (reading 'split')

This error could happen if you are using yarn and have incompatible versions of dependencies with livekit-client.

To fix this, you can either:

  • use another package manager, like npm
  • use yarn-deduplicate to deduplicate dependencies
- - -

Contributing

- -

See the contributing guide to learn how to contribute to the repository and the development workflow.

- - -

License

- -

Apache License 2.0

+

Contributing

See the contributing guide to learn how to contribute to the repository and the development workflow.

+

License

Apache License 2.0


- - + +
LiveKit Ecosystem
Real-time SDKsReact Components · JavaScript · iOS/macOS · Android · Flutter · React Native · Rust · Python · Unity (web) · Unity (beta)
Server APIsNode.js · Golang · Ruby · Java/Kotlin · Python · Rust · PHP (community)
Real-time SDKsReact Components · Browser · iOS/macOS · Android · Flutter · React Native · Rust · Node.js · Python · Unity (web) · Unity (beta)
Server APIsNode.js · Golang · Ruby · Java/Kotlin · Python · Rust · PHP (community)
Agents FrameworksPython · Playground
ServicesLivekit server · Egress · Ingress · SIP
ResourcesDocs · Example apps · Cloud · Self-hosting · CLI
-

-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

livekit-react-native
\ No newline at end of file diff --git a/docs/interfaces/LiveKitRoomProps.html b/docs/interfaces/LiveKitRoomProps.html index b7d07d5..994d7fa 100644 --- a/docs/interfaces/LiveKitRoomProps.html +++ b/docs/interfaces/LiveKitRoomProps.html @@ -1,272 +1,44 @@ -LiveKitRoomProps | @livekit/react-native
-
- -
-
-
-
- -

Interface LiveKitRoomProps

-
-

Hierarchy

-
    -
  • LiveKitRoomProps
-
-
-
- -
-
-

Properties

-
audio? -connect? -connectOptions? -featureFlags? -onConnected? -onDisconnected? -onEncryptionError? -onError? -onMediaDeviceFailure? -options? -room? -screen? -serverUrl -simulateParticipants? -token -video? -
-
-

Properties

-
-

Optional audio

-
audio?: boolean | AudioCaptureOptions
-

Publish audio immediately after connecting to your LiveKit room.

- -

Default Value

false

- -

See

https://docs.livekit.io/client-sdk-js/interfaces/AudioCaptureOptions.html

-
-
-

Optional connect

-
connect?: boolean
-

If set to true a connection to LiveKit room is initiated.

- -

Default Value

false

-
-
-

Optional connectOptions

-
connectOptions?: RoomConnectOptions
-

Define options how to connect to the LiveKit server.

- -

See

https://docs.livekit.io/client-sdk-js/interfaces/RoomConnectOptions.html

-
-
-

Optional Experimental featureFlags

-
featureFlags?: FeatureFlags
-
-

Optional onConnected

-
onConnected?: (() => void)
-
-

Type declaration

-
    -
  • -
      -
    • (): void
      • -
    • -

      Returns void

-
-

Optional onDisconnected

-
onDisconnected?: (() => void)
-
-

Type declaration

-
    -
  • -
      -
    • (): void
      • -
    • -

      Returns void

-
-

Optional onEncryptionError

-
onEncryptionError?: ((error: Error) => void)
-
-

Type declaration

-
    -
  • -
      -
    • (error: Error): void
      • -
    • -
      -

      Parameters

      -
        -
      • -
        error: Error
      -

      Returns void

-
-

Optional onError

-
onError?: ((error: Error) => void)
-
-

Type declaration

-
    -
  • -
      -
    • (error: Error): void
      • -
    • -
      -

      Parameters

      -
        -
      • -
        error: Error
      -

      Returns void

-
-

Optional onMediaDeviceFailure

-
onMediaDeviceFailure?: ((failure?: MediaDeviceFailure) => void)
-
-

Type declaration

-
    -
  • -
      -
    • (failure?: MediaDeviceFailure): void
      • -
    • -
      -

      Parameters

      -
        -
      • -
        Optional failure: MediaDeviceFailure
      -

      Returns void

-
-

Optional options

-
options?: RoomOptions
-

Options for when creating a new room. +LiveKitRoomProps | LiveKit React Native Client SDK - v2.3.0

Interface LiveKitRoomProps

interface LiveKitRoomProps {
    audio?: boolean | AudioCaptureOptions;
    connect?: boolean;
    connectOptions?: RoomConnectOptions;
    featureFlags?: FeatureFlags;
    onConnected?: (() => void);
    onDisconnected?: (() => void);
    onEncryptionError?: ((error) => void);
    onError?: ((error) => void);
    onMediaDeviceFailure?: ((failure?) => void);
    options?: RoomOptions;
    room?: Room;
    screen?: boolean | ScreenShareCaptureOptions;
    serverUrl: undefined | string;
    simulateParticipants?: number;
    token: undefined | string;
    video?: boolean | VideoCaptureOptions;
}

Properties

audio? +connect? +connectOptions? +featureFlags? +onConnected? +onDisconnected? +onEncryptionError? +onError? +onMediaDeviceFailure? +options? +room? +screen? +serverUrl +simulateParticipants? +token +video? +

Properties

Optional audio

audio?: boolean | AudioCaptureOptions

Publish audio immediately after connecting to your LiveKit room.

+

Default Value

false

+

See

https://docs.livekit.io/client-sdk-js/interfaces/AudioCaptureOptions.html

+

Optional connect

connect?: boolean

If set to true a connection to LiveKit room is initiated.

+

Default Value

false

+

Optional connectOptions

connectOptions?: RoomConnectOptions

Define options how to connect to the LiveKit server.

+

See

https://docs.livekit.io/client-sdk-js/interfaces/RoomConnectOptions.html

+

Optional Experimental featureFlags

featureFlags?: FeatureFlags

Optional onConnected

onConnected?: (() => void)

Type declaration

    • (): void

    • Returns void

Optional onDisconnected

onDisconnected?: (() => void)

Type declaration

    • (): void

    • Returns void

Optional onEncryptionError

onEncryptionError?: ((error) => void)

Type declaration

    • (error): void

    • Parameters

      • error: Error

      Returns void

Optional onError

onError?: ((error) => void)

Type declaration

    • (error): void

    • Parameters

      • error: Error

      Returns void

Optional onMediaDeviceFailure

onMediaDeviceFailure?: ((failure?) => void)

Type declaration

    • (failure?): void

    • Parameters

      • Optional failure: MediaDeviceFailure

      Returns void

Optional options

options?: RoomOptions

Options for when creating a new room. When you pass your own room instance to this component, these options have no effect. Instead, set the options directly in the room instance.

- -

See

https://docs.livekit.io/client-sdk-js/interfaces/RoomOptions.html

-
-
-

Optional room

-
room?: Room
-

Optional room instance. +

See

https://docs.livekit.io/client-sdk-js/interfaces/RoomOptions.html

+

Optional room

room?: Room

Optional room instance. By passing your own room instance you overwrite the options parameter, make sure to set the options directly on the room instance itself.

-
-
-

Optional screen

-
screen?: boolean | ScreenShareCaptureOptions
-

Publish screen share immediately after connecting to your LiveKit room.

- -

Default Value

false

- -

See

https://docs.livekit.io/client-sdk-js/interfaces/ScreenShareCaptureOptions.html

-
-
-

serverUrl

-
serverUrl: undefined | string
-

URL to the LiveKit server. +

Optional screen

screen?: boolean | ScreenShareCaptureOptions

Publish screen share immediately after connecting to your LiveKit room.

+

Default Value

false

+

See

https://docs.livekit.io/client-sdk-js/interfaces/ScreenShareCaptureOptions.html

+

serverUrl

serverUrl: undefined | string

URL to the LiveKit server. For example: wss://<domain>.livekit.cloud To simplify the implementation, undefined is also accepted as an intermediate value, but only with a valid string url can the connection be established.

-
-
-

Optional simulateParticipants

-
simulateParticipants?: number
-
-

token

-
token: undefined | string
-

A user specific access token for a client to authenticate to the room. +

Optional simulateParticipants

simulateParticipants?: number

token

token: undefined | string

A user specific access token for a client to authenticate to the room. This token is necessary to establish a connection to the room. To simplify the implementation, undefined is also accepted as an intermediate value, but only with a valid string token can the connection be established.

- -

See

https://docs.livekit.io/cloud/project-management/keys-and-tokens/#generating-access-tokens

-
-
-

Optional video

-
video?: boolean | VideoCaptureOptions
-

Publish video immediately after connecting to your LiveKit room.

- -

Default Value

false

- -

See

https://docs.livekit.io/client-sdk-js/interfaces/VideoCaptureOptions.html

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +

See

https://docs.livekit.io/cloud/project-management/keys-and-tokens/#generating-access-tokens

+

Optional video

video?: boolean | VideoCaptureOptions

Publish video immediately after connecting to your LiveKit room.

+

Default Value

false

+

See

https://docs.livekit.io/client-sdk-js/interfaces/VideoCaptureOptions.html

+

Settings

Member Visibility

Theme

On This Page

audioconnectconnectOptionsfeatureFlagsonConnectedonDisconnectedonEncryptionErroronErroronMediaDeviceFailureoptionsroomscreenserverUrlsimulateParticipantstokenvideo
\ No newline at end of file diff --git a/docs/interfaces/ParticipantState.html b/docs/interfaces/ParticipantState.html index 2c1c5e8..2bfabf2 100644 --- a/docs/interfaces/ParticipantState.html +++ b/docs/interfaces/ParticipantState.html @@ -1,126 +1,11 @@ -ParticipantState | @livekit/react-native
-
- -
-
-
-
- -

Interface ParticipantState

-
-
-

Deprecated

use useRemoteParticipant or useLocalParticipant instead

-
-
-

Hierarchy

-
    -
  • ParticipantState
-
-
-
- -
-
-

Properties

-
cameraPublication? -connectionQuality -isLocal -isSpeaking -metadata? -microphonePublication? -publications -screenSharePublication? -subscribedTracks -
-
-

Properties

-
-

Optional cameraPublication

-
cameraPublication?: TrackPublication
-
-

connectionQuality

-
connectionQuality: ConnectionQuality
-
-

isLocal

-
isLocal: boolean
-
-

isSpeaking

-
isSpeaking: boolean
-
-

Optional metadata

-
metadata?: string
-
-

Optional microphonePublication

-
microphonePublication?: TrackPublication
-
-

publications

-
publications: TrackPublication[]
-
-

Optional screenSharePublication

-
screenSharePublication?: TrackPublication
-
-

subscribedTracks

-
subscribedTracks: TrackPublication[]
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +ParticipantState | LiveKit React Native Client SDK - v2.3.0

Interface ParticipantState

Deprecated

use useRemoteParticipant or useLocalParticipant instead

+
interface ParticipantState {
    cameraPublication?: TrackPublication;
    connectionQuality: ConnectionQuality;
    isLocal: boolean;
    isSpeaking: boolean;
    metadata?: string;
    microphonePublication?: TrackPublication;
    publications: TrackPublication[];
    screenSharePublication?: TrackPublication;
    subscribedTracks: TrackPublication[];
}

Properties

cameraPublication? +connectionQuality +isLocal +isSpeaking +metadata? +microphonePublication? +publications +screenSharePublication? +subscribedTracks +

Properties

Optional cameraPublication

cameraPublication?: TrackPublication

connectionQuality

connectionQuality: ConnectionQuality

isLocal

isLocal: boolean

isSpeaking

isSpeaking: boolean

Optional metadata

metadata?: string

Optional microphonePublication

microphonePublication?: TrackPublication

publications

publications: TrackPublication[]

Optional screenSharePublication

screenSharePublication?: TrackPublication

subscribedTracks

subscribedTracks: TrackPublication[]

Settings

Member Visibility

Theme

On This Page

cameraPublicationconnectionQualityisLocalisSpeakingmetadatamicrophonePublicationpublicationsscreenSharePublicationsubscribedTracks
\ No newline at end of file diff --git a/docs/interfaces/ReceivedDataMessage.html b/docs/interfaces/ReceivedDataMessage.html deleted file mode 100644 index 77681f4..0000000 --- a/docs/interfaces/ReceivedDataMessage.html +++ /dev/null @@ -1,91 +0,0 @@ -ReceivedDataMessage | @livekit/react-native
-
- -
-
-
-
- -

Interface ReceivedDataMessage<T>

-
-

Type Parameters

-
    -
  • -

    T extends string | undefined = string

-
-

Hierarchy

-
    -
  • BaseDataMessage<T> -
    -

    Hierarchy

    -
      -
    • ReceivedDataMessage
-
-
-
- -
-
-

Properties

-
from? -payload -topic? -
-
-

Properties

-
-

Optional from

-
from?: default
-
-

payload

-
payload: Uint8Array
-
-

Optional topic

-
topic?: T
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/RoomOptions.html b/docs/interfaces/RoomOptions.html index 2360c3b..03bf21d 100644 --- a/docs/interfaces/RoomOptions.html +++ b/docs/interfaces/RoomOptions.html @@ -1,79 +1,2 @@ -RoomOptions | @livekit/react-native
-
- -
-
-
-
- -

Interface RoomOptions

-
-

Hierarchy

-
    -
  • RoomOptions
-
-
-
- -
-
-

Properties

-
sortParticipants? -
-
-

Properties

-
-

Optional sortParticipants

-
sortParticipants?: ((participants: default[]) => void)
-
-

Type declaration

-
    -
  • -
      -
    • (participants: default[]): void
      • -
    • -
      -

      Parameters

      -
        -
      • -
        participants: default[]
      -

      Returns void

-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +RoomOptions | LiveKit React Native Client SDK - v2.3.0

Interface RoomOptions

interface RoomOptions {
    sortParticipants?: ((participants) => void);
}

Properties

sortParticipants? +

Properties

Optional sortParticipants

sortParticipants?: ((participants) => void)

Type declaration

    • (participants): void

    • Parameters

      • participants: default[]

      Returns void

Settings

Member Visibility

Theme

On This Page

sortParticipants
\ No newline at end of file diff --git a/docs/interfaces/RoomState.html b/docs/interfaces/RoomState.html index 6c51575..69b633d 100644 --- a/docs/interfaces/RoomState.html +++ b/docs/interfaces/RoomState.html @@ -1,87 +1,5 @@ -RoomState | @livekit/react-native
-
- -
-
-
-
- -

Interface RoomState

-
-

Hierarchy

-
    -
  • RoomState
-
-
-
- -
-
-

Properties

-
audioTracks -error? -participants -room? -
-
-

Properties

-
-

audioTracks

-
audioTracks: AudioTrack[]
-
-

Optional error

-
error?: Error
-
-

participants

-
participants: default[]
-
-

Optional room

-
room?: Room
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +RoomState | LiveKit React Native Client SDK - v2.3.0

Interface RoomState

interface RoomState {
    audioTracks: AudioTrack[];
    error?: Error;
    participants: default[];
    room?: Room;
}

Properties

audioTracks +error? +participants +room? +

Properties

audioTracks

audioTracks: AudioTrack[]

Optional error

error?: Error

participants

participants: default[]

Optional room

room?: Room

Settings

Member Visibility

Theme

On This Page

audioTrackserrorparticipantsroom
\ No newline at end of file diff --git a/docs/interfaces/UseLocalParticipantOptions.html b/docs/interfaces/UseLocalParticipantOptions.html deleted file mode 100644 index c19aa91..0000000 --- a/docs/interfaces/UseLocalParticipantOptions.html +++ /dev/null @@ -1,68 +0,0 @@ -UseLocalParticipantOptions | @livekit/react-native
-
- -
-
-
-
- -

Interface UseLocalParticipantOptions

-
-

Hierarchy

-
    -
  • UseLocalParticipantOptions
-
-
-
- -
-
-

Properties

-
room? -
-
-

Properties

-
-

Optional room

-
room?: Room
-

The room to use. If not provided, the hook will use the room from the context.

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/UseParticipantInfoOptions.html b/docs/interfaces/UseParticipantInfoOptions.html deleted file mode 100644 index 9676fda..0000000 --- a/docs/interfaces/UseParticipantInfoOptions.html +++ /dev/null @@ -1,73 +0,0 @@ -UseParticipantInfoOptions | @livekit/react-native
-
- -
-
-
-
- -

Interface UseParticipantInfoOptions

-
-

The useParticipantInfo hook returns the identity, name, and metadata of a given participant. -It requires a Participant object passed as property or via the ParticipantContext.

- -

Example

const { identity, name, metadata } = useParticipantInfo({ participant });
-
-
-
-

Hierarchy

-
    -
  • UseParticipantInfoOptions
-
-
-
- -
-
-

Properties

-
participant? -
-
-

Properties

-
-

Optional participant

-
participant?: default
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/UseParticipantsOptions.html b/docs/interfaces/UseParticipantsOptions.html deleted file mode 100644 index 1f72826..0000000 --- a/docs/interfaces/UseParticipantsOptions.html +++ /dev/null @@ -1,79 +0,0 @@ -UseParticipantsOptions | @livekit/react-native
-
- -
-
-
-
- -

Interface UseParticipantsOptions

-
-

Hierarchy

-
    -
  • UseParticipantsOptions
-
-
-
- -
-
-

Properties

-
room? -updateOnlyOn? -
-
-

Properties

-
-

Optional room

-
room?: Room
-

The room to use. If not provided, the hook will use the room from the context.

-
-
-

Optional updateOnlyOn

-
updateOnlyOn?: RoomEvent[]
-

To optimize performance, you can use the updateOnlyOn property to decide on what RoomEvents the hook updates. -By default it updates on all relevant RoomEvents to keep the returned participants array up to date. -The minimal set of non-overwriteable RoomEvents is: [RoomEvent.ParticipantConnected, RoomEvent.ParticipantDisconnected, RoomEvent.ConnectionStateChanged]

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/UseRemoteParticipantOptions.html b/docs/interfaces/UseRemoteParticipantOptions.html deleted file mode 100644 index 7876792..0000000 --- a/docs/interfaces/UseRemoteParticipantOptions.html +++ /dev/null @@ -1,69 +0,0 @@ -UseRemoteParticipantOptions | @livekit/react-native
-
- -
-
-
-
- -

Interface UseRemoteParticipantOptions

-
-

Hierarchy

-
    -
  • UseRemoteParticipantOptions
-
-
-
- -
-
-

Properties

-
updateOnlyOn? -
-
-

Properties

-
-

Optional updateOnlyOn

-
updateOnlyOn?: ParticipantEvent[]
-

To optimize performance, you can use the updateOnlyOn property to decide on what ParticipantEvents the hook updates. -By default it updates on all relevant ParticipantEvents to keep the returned participant up to date.

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/UseRemoteParticipantsOptions.html b/docs/interfaces/UseRemoteParticipantsOptions.html deleted file mode 100644 index 1ee2e2b..0000000 --- a/docs/interfaces/UseRemoteParticipantsOptions.html +++ /dev/null @@ -1,79 +0,0 @@ -UseRemoteParticipantsOptions | @livekit/react-native
-
- -
-
-
-
- -

Interface UseRemoteParticipantsOptions

-
-

Hierarchy

-
    -
  • UseRemoteParticipantsOptions
-
-
-
- -
-
-

Properties

-
room? -updateOnlyOn? -
-
-

Properties

-
-

Optional room

-
room?: Room
-

The room to use. If not provided, the hook will use the room from the context.

-
-
-

Optional updateOnlyOn

-
updateOnlyOn?: RoomEvent[]
-

To optimize performance, you can use the updateOnlyOn property to decide on what RoomEvents the hook updates. -By default it updates on all relevant RoomEvents to keep the returned participants array up to date. -The minimal set of non-overwriteable RoomEvents is: [RoomEvent.ParticipantConnected, RoomEvent.ParticipantDisconnected, RoomEvent.ConnectionStateChanged]

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/interfaces/UseVisualStableUpdateOptions.html b/docs/interfaces/UseVisualStableUpdateOptions.html deleted file mode 100644 index 0e29a72..0000000 --- a/docs/interfaces/UseVisualStableUpdateOptions.html +++ /dev/null @@ -1,81 +0,0 @@ -UseVisualStableUpdateOptions | @livekit/react-native
-
- -
-
-
-
- -

Interface UseVisualStableUpdateOptions

-
-

Hierarchy

-
    -
  • UseVisualStableUpdateOptions
-
-
-
- -
-
-

Properties

-
customSortFunction? -
-
-

Properties

-
-

Optional customSortFunction

-
customSortFunction?: ((trackReferences: TrackReferenceOrPlaceholder[]) => TrackReferenceOrPlaceholder[])
-
-

Type declaration

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/docs/modules.html b/docs/modules.html index e90bcc4..7c8906d 100644 --- a/docs/modules.html +++ b/docs/modules.html @@ -1,188 +1,29 @@ -@livekit/react-native
-
- -
-
-
-
-

@livekit/react-native

-
-
-

Index

-
-

Classes

-
AudioSession -
-
-

Interfaces

-
LiveKitRoomProps -ParticipantState -ReceivedDataMessage -RoomOptions -RoomState -UseLocalParticipantOptions -UseParticipantInfoOptions -UseParticipantsOptions -UseRemoteParticipantOptions -UseRemoteParticipantsOptions -UseVisualStableUpdateOptions -
-
-

Type Aliases

-
AndroidAudioTypeOptions -AppleAudioCategory -AppleAudioCategoryOption -AppleAudioConfiguration -AppleAudioMode -AudioConfiguration -AudioTrackState -LogLevel -Props -SetLogLevelOptions -TrackReference -TrackReferenceOrPlaceholder -UseTracksOptions -VideoTrackProps -
-
-

Variables

-
AndroidAudioTypePresets -ParticipantContext -RoomContext -TrackRefContext -log -
-
-

Functions

-
LiveKitRoom -VideoTrack -VideoView -getDefaultAppleAudioConfigurationForMode -isTrackReference -registerGlobals -setLogLevel -sortParticipants -useChat -useConnectionState -useDataChannel -useEnsureTrackRef -useIOSAudioManagement -useIsEncrypted -useIsMuted -useIsSpeaking -useLiveKitRoom -useLocalParticipant -useLocalParticipantPermissions -useParticipant -useParticipantContext -useParticipantInfo -useParticipantTracks -useParticipants -useRemoteParticipant -useRemoteParticipants -useRoom -useRoomContext -useRoomInfo -useSortedParticipants -useSpeakingParticipants -useTrackMutedIndicator -useTrackRefContext -useTracks -useVisualStableUpdate -
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +LiveKit React Native Client SDK - v2.3.0

LiveKit React Native Client SDK - v2.3.0

Index

Classes

AudioSession +

Interfaces

LiveKitRoomProps +ParticipantState +RoomOptions +RoomState +

Type Aliases

AndroidAudioTypeOptions +AppleAudioCategory +AppleAudioCategoryOption +AppleAudioConfiguration +AppleAudioMode +AudioConfiguration +AudioTrackState +LogLevel +Props +SetLogLevelOptions +VideoTrackProps +

Variables

AndroidAudioTypePresets +log +

Functions

LiveKitRoom +VideoTrack +VideoView +getDefaultAppleAudioConfigurationForMode +registerGlobals +setLogLevel +sortParticipants +useIOSAudioManagement +useParticipant +useRoom +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/AndroidAudioTypeOptions.html b/docs/types/AndroidAudioTypeOptions.html index 0948978..fb5a5a2 100644 --- a/docs/types/AndroidAudioTypeOptions.html +++ b/docs/types/AndroidAudioTypeOptions.html @@ -1,155 +1,22 @@ -AndroidAudioTypeOptions | @livekit/react-native
-
- -
-
-
-
- -

Type alias AndroidAudioTypeOptions

-
AndroidAudioTypeOptions: { audioAttributesContentType?: "movie" | "music" | "sonification" | "speech" | "unknown"; audioAttributesUsageType?: "alarm" | "assistanceAccessibility" | "assistanceNavigationGuidance" | "assistanceSonification" | "assistant" | "game" | "media" | "notification" | "notificationEvent" | "notificationRingtone" | "unknown" | "voiceCommunication" | "voiceCommunicationSignalling"; audioFocusMode?: "gain" | "gainTransient" | "gainTransientExclusive" | "gainTransientMayDuck"; audioMode?: "normal" | "callScreening" | "inCall" | "inCommunication" | "ringtone"; audioStreamType?: "accessibility" | "alarm" | "dtmf" | "music" | "notification" | "ring" | "system" | "voiceCall"; forceHandleAudioRouting?: boolean; manageAudioFocus?: boolean }
-
-

Type declaration

-

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/AppleAudioCategory.html b/docs/types/AppleAudioCategory.html index d671d91..e893db0 100644 --- a/docs/types/AppleAudioCategory.html +++ b/docs/types/AppleAudioCategory.html @@ -1,110 +1 @@ -AppleAudioCategory | @livekit/react-native
-
- -
-
-
-
- -

Type alias AppleAudioCategory

-
AppleAudioCategory: "soloAmbient" | "playback" | "record" | "playAndRecord" | "multiRoute"
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +AppleAudioCategory | LiveKit React Native Client SDK - v2.3.0

Type alias AppleAudioCategory

AppleAudioCategory: "soloAmbient" | "playback" | "record" | "playAndRecord" | "multiRoute"

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/AppleAudioCategoryOption.html b/docs/types/AppleAudioCategoryOption.html index 62a7082..82e3481 100644 --- a/docs/types/AppleAudioCategoryOption.html +++ b/docs/types/AppleAudioCategoryOption.html @@ -1,110 +1 @@ -AppleAudioCategoryOption | @livekit/react-native
-
- -
-
-
-
- -

Type alias AppleAudioCategoryOption

-
AppleAudioCategoryOption: "mixWithOthers" | "duckOthers" | "interruptSpokenAudioAndMixWithOthers" | "allowBluetooth" | "allowBluetoothA2DP" | "allowAirPlay" | "defaultToSpeaker"
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +AppleAudioCategoryOption | LiveKit React Native Client SDK - v2.3.0

Type alias AppleAudioCategoryOption

AppleAudioCategoryOption: "mixWithOthers" | "duckOthers" | "interruptSpokenAudioAndMixWithOthers" | "allowBluetooth" | "allowBluetoothA2DP" | "allowAirPlay" | "defaultToSpeaker"

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/AppleAudioConfiguration.html b/docs/types/AppleAudioConfiguration.html index c7064ad..7287a85 100644 --- a/docs/types/AppleAudioConfiguration.html +++ b/docs/types/AppleAudioConfiguration.html @@ -1,119 +1 @@ -AppleAudioConfiguration | @livekit/react-native
-
- -
-
-
-
- -

Type alias AppleAudioConfiguration

-
AppleAudioConfiguration: { audioCategory?: AppleAudioCategory; audioCategoryOptions?: AppleAudioCategoryOption[]; audioMode?: AppleAudioMode }
-
-

Type declaration

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +AppleAudioConfiguration | LiveKit React Native Client SDK - v2.3.0

Type alias AppleAudioConfiguration

AppleAudioConfiguration: {
    audioCategory?: AppleAudioCategory;
    audioCategoryOptions?: AppleAudioCategoryOption[];
    audioMode?: AppleAudioMode;
}

Type declaration

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/AppleAudioMode.html b/docs/types/AppleAudioMode.html index 35b32ab..8df2ecb 100644 --- a/docs/types/AppleAudioMode.html +++ b/docs/types/AppleAudioMode.html @@ -1,110 +1 @@ -AppleAudioMode | @livekit/react-native
-
- -
-
-
-
- -

Type alias AppleAudioMode

-
AppleAudioMode: "default" | "gameChat" | "measurement" | "moviePlayback" | "spokenAudio" | "videoChat" | "videoRecording" | "voiceChat" | "voicePrompt"
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +AppleAudioMode | LiveKit React Native Client SDK - v2.3.0

Type alias AppleAudioMode

AppleAudioMode: "default" | "gameChat" | "measurement" | "moviePlayback" | "spokenAudio" | "videoChat" | "videoRecording" | "voiceChat" | "voicePrompt"

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/AudioConfiguration.html b/docs/types/AudioConfiguration.html index 9330fef..4408446 100644 --- a/docs/types/AudioConfiguration.html +++ b/docs/types/AudioConfiguration.html @@ -1,25 +1,9 @@ -AudioConfiguration | @livekit/react-native
-
- -
-
-
-
- -

Type alias AudioConfiguration

-
AudioConfiguration: { android?: { audioTypeOptions: AndroidAudioTypeOptions; preferredOutputList?: ("speaker" | "earpiece" | "headset" | "bluetooth")[] }; ios?: { defaultOutput?: "speaker" | "earpiece" } }
-

Configuration for the underlying AudioSession.

+AudioConfiguration | LiveKit React Native Client SDK - v2.3.0

Type alias AudioConfiguration

AudioConfiguration: {
    android?: {
        audioTypeOptions: AndroidAudioTypeOptions;
        preferredOutputList?: ("speaker" | "earpiece" | "headset" | "bluetooth")[];
    };
    ios?: {
        defaultOutput?: "speaker" | "earpiece";
    };
}

Configuration for the underlying AudioSession.

Android specific options:

  • preferredOutputList - The preferred order in which to automatically select an audio output. -This is ignored when an output is manually selected with selectAudioOutput.

    +This is ignored when an output is manually selected with AudioSession.selectAudioOutput.

    By default, the order is set to:

    1. `"bluetooth"
      2. @@ -28,9 +12,9 @@

      Type alias AudioConfiguration

  • "earpiece"
    • -

  • audioTypeOptions - An AndroidAudioTypeOptions object which provides the +

  • audioTypeOptions - An AndroidAudioTypeOptions object which provides the audio options to use on Android.

    -

    See AndroidAudioTypePresets for pre-configured values.

    +

    See AndroidAudioTypePresets for pre-configured values.

    • @@ -40,113 +24,4 @@

    Type alias AudioConfiguration

    By default, this is set to "speaker"

    -
    -
    -

    Type declaration

    -
      -
    • -
      Optional android?: { audioTypeOptions: AndroidAudioTypeOptions; preferredOutputList?: ("speaker" | "earpiece" | "headset" | "bluetooth")[] }
      -
        -
      • -
        audioTypeOptions: AndroidAudioTypeOptions
        • -
      • -
        Optional preferredOutputList?: ("speaker" | "earpiece" | "headset" | "bluetooth")[]
      • -
    • -
      Optional ios?: { defaultOutput?: "speaker" | "earpiece" }
      -
        -
      • -
        Optional defaultOutput?: "speaker" | "earpiece"
    -
    -
    -
    -

    Settings

     -
    -
    -

    Member Visibility

    -
      -
      • -
      • -
      • -
    -
    -

    Theme

    - -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Type declaration

    • Optional android?: {
          audioTypeOptions: AndroidAudioTypeOptions;
          preferredOutputList?: ("speaker" | "earpiece" | "headset" | "bluetooth")[];
      }
      • audioTypeOptions: AndroidAudioTypeOptions
      • Optional preferredOutputList?: ("speaker" | "earpiece" | "headset" | "bluetooth")[]
    • Optional ios?: {
          defaultOutput?: "speaker" | "earpiece";
      }
      • Optional defaultOutput?: "speaker" | "earpiece"

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/AudioTrackState.html b/docs/types/AudioTrackState.html index 9df8318..0f48b15 100644 --- a/docs/types/AudioTrackState.html +++ b/docs/types/AudioTrackState.html @@ -1,110 +1 @@ -AudioTrackState | @livekit/react-native
    -
    - -
    -
    -
    -
    - -

    Type alias AudioTrackState

    -
    AudioTrackState: "none" | "remoteOnly" | "localOnly" | "localAndRemote"
    -
    -
    -
    -

    Settings

     -
    -
    -

    Member Visibility

    -
      -
      • -
      • -
      • -
    -
    -

    Theme

    - -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +AudioTrackState | LiveKit React Native Client SDK - v2.3.0

    Type alias AudioTrackState

    AudioTrackState: "none" | "remoteOnly" | "localOnly" | "localAndRemote"

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/LogLevel.html b/docs/types/LogLevel.html index 436768a..5e078b1 100644 --- a/docs/types/LogLevel.html +++ b/docs/types/LogLevel.html @@ -1,110 +1 @@ -LogLevel | @livekit/react-native
    -
    - -
    -
    -
    -
    - -

    Type alias LogLevel

    -
    LogLevel: Parameters<typeof setClientSdkLogLevel>[0]
    -
    -
    -
    -

    Settings

     -
    -
    -

    Member Visibility

    -
      -
      • -
      • -
      • -
    -
    -

    Theme

    - -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +LogLevel | LiveKit React Native Client SDK - v2.3.0

    Type alias LogLevel

    LogLevel: Parameters<typeof setClientSdkLogLevel>[0]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/Props.html b/docs/types/Props.html index 3209250..0406a9e 100644 --- a/docs/types/Props.html +++ b/docs/types/Props.html @@ -1,126 +1,2 @@ -Props | @livekit/react-native
    -
    - -
    -
    -
    -
    - -

    Type alias Props

    -
    Props: { mirror?: boolean; objectFit?: "cover" | "contain"; style?: ViewStyle; videoTrack?: VideoTrack; zOrder?: number }
    -
    -

    Deprecated

    use VideoTrack and VideoTrackProps instead.

    -
    -
    -

    Type declaration

    -
      -
    • -
      Optional mirror?: boolean
      • -
    • -
      Optional objectFit?: "cover" | "contain"
      • -
    • -
      Optional style?: ViewStyle
      • -
    • -
      Optional videoTrack?: VideoTrack
      • -
    • -
      Optional zOrder?: number
    -
    -
    -
    -

    Settings

     -
    -
    -

    Member Visibility

    -
      -
      • -
      • -
      • -
    -
    -

    Theme

    - -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +Props | LiveKit React Native Client SDK - v2.3.0

    Type alias Props

    Props: {
        mirror?: boolean;
        objectFit?: "cover" | "contain";
        style?: ViewStyle;
        videoTrack?: VideoTrack;
        zOrder?: number;
    }

    Type declaration

    • Optional mirror?: boolean
    • Optional objectFit?: "cover" | "contain"
    • Optional style?: ViewStyle
    • Optional videoTrack?: VideoTrack
    • Optional zOrder?: number

    Deprecated

    use VideoTrack and VideoTrackProps instead.

    +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/SetLogLevelOptions.html b/docs/types/SetLogLevelOptions.html index 95c4c70..84ef4b1 100644 --- a/docs/types/SetLogLevelOptions.html +++ b/docs/types/SetLogLevelOptions.html @@ -1,115 +1 @@ -SetLogLevelOptions | @livekit/react-native
    -
    - -
    -
    -
    -
    - -

    Type alias SetLogLevelOptions

    -
    SetLogLevelOptions: { liveKitClientLogLevel?: LogLevel }
    -
    -

    Type declaration

    -
      -
    • -
      Optional liveKitClientLogLevel?: LogLevel
    -
    -
    -
    -

    Settings

     -
    -
    -

    Member Visibility

    -
      -
      • -
      • -
      • -
    -
    -

    Theme

    - -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +SetLogLevelOptions | LiveKit React Native Client SDK - v2.3.0

    Type alias SetLogLevelOptions

    SetLogLevelOptions: {
        liveKitClientLogLevel?: LogLevel;
    }

    Type declaration

    • Optional liveKitClientLogLevel?: LogLevel

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/TrackReference.html b/docs/types/TrackReference.html deleted file mode 100644 index 5c37d01..0000000 --- a/docs/types/TrackReference.html +++ /dev/null @@ -1,119 +0,0 @@ -TrackReference | @livekit/react-native
    -
    - -
    -
    -
    -
    - -

    Type alias TrackReference

    -
    TrackReference: { participant: Participant; publication: TrackPublication; source: Track.Source }
    -
    -

    Type declaration

    -
      -
    • -
      participant: Participant
      • -
    • -
      publication: TrackPublication
      • -
    • -
      source: Track.Source
    -
    -
    -
    -

    Settings

     -
    -
    -

    Member Visibility

    -
      -
      • -
      • -
      • -
    -
    -

    Theme

    - -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file diff --git a/docs/types/TrackReferenceOrPlaceholder.html b/docs/types/TrackReferenceOrPlaceholder.html deleted file mode 100644 index 478c679..0000000 --- a/docs/types/TrackReferenceOrPlaceholder.html +++ /dev/null @@ -1,110 +0,0 @@ -TrackReferenceOrPlaceholder | @livekit/react-native
    -
    - -
    -
    -
    -
    - -

    Type alias TrackReferenceOrPlaceholder

    -
    TrackReferenceOrPlaceholder: TrackReference | TrackReferencePlaceholder
    -
    -
    -
    -

    Settings

     -
    -
    -

    Member Visibility

    -
      -
      • -
      • -
      • -
    -
    -

    Theme

    - -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file diff --git a/docs/types/UseTracksOptions.html b/docs/types/UseTracksOptions.html deleted file mode 100644 index bccacf1..0000000 --- a/docs/types/UseTracksOptions.html +++ /dev/null @@ -1,119 +0,0 @@ -UseTracksOptions | @livekit/react-native
    -
    - -
    -
    -
    -
    - -

    Type alias UseTracksOptions

    -
    UseTracksOptions: { onlySubscribed?: boolean; room?: Room; updateOnlyOn?: RoomEvent[] }
    -
    -

    Type declaration

    -
      -
    • -
      Optional onlySubscribed?: boolean
      • -
    • -
      Optional room?: Room
      • -
    • -
      Optional updateOnlyOn?: RoomEvent[]
    -
    -
    -
    -

    Settings

     -
    -
    -

    Member Visibility

    -
      -
      • -
      • -
      • -
    -
    -

    Theme

    - -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file diff --git a/docs/types/VideoTrackProps.html b/docs/types/VideoTrackProps.html index 19fa8cf..a370dd0 100644 --- a/docs/types/VideoTrackProps.html +++ b/docs/types/VideoTrackProps.html @@ -1,123 +1 @@ -VideoTrackProps | @livekit/react-native
    -
    - -
    -
    -
    -
    - -

    Type alias VideoTrackProps

    -
    VideoTrackProps: { mirror?: boolean; objectFit?: "cover" | "contain"; style?: ViewStyle; trackRef: TrackReference | undefined; zOrder?: number }
    -
    -

    Type declaration

    -
      -
    • -
      Optional mirror?: boolean
      • -
    • -
      Optional objectFit?: "cover" | "contain"
      • -
    • -
      Optional style?: ViewStyle
      • -
    • -
      trackRef: TrackReference | undefined
      • -
    • -
      Optional zOrder?: number
    -
    -
    -
    -

    Settings

     -
    -
    -

    Member Visibility

    -
      -
      • -
      • -
      • -
    -
    -

    Theme

    - -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +VideoTrackProps | LiveKit React Native Client SDK - v2.3.0

    Type alias VideoTrackProps

    VideoTrackProps: {
        mirror?: boolean;
        objectFit?: "cover" | "contain";
        style?: ViewStyle;
        trackRef: TrackReference | undefined;
        zOrder?: number;
    }

    Type declaration

    • Optional mirror?: boolean
    • Optional objectFit?: "cover" | "contain"
    • Optional style?: ViewStyle
    • trackRef: TrackReference | undefined
    • Optional zOrder?: number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/variables/AndroidAudioTypePresets.html b/docs/variables/AndroidAudioTypePresets.html index da41990..9c45520 100644 --- a/docs/variables/AndroidAudioTypePresets.html +++ b/docs/variables/AndroidAudioTypePresets.html @@ -1,121 +1,3 @@ -AndroidAudioTypePresets | @livekit/react-native
    -
    - -
    -
    -
    -
    - -

    Variable AndroidAudioTypePresetsConst

    -
    AndroidAudioTypePresets: { communication: AndroidAudioTypeOptions; media: AndroidAudioTypeOptions } = ...
    -
    -

    Type declaration

    -
    -
    -
    -
    -

    Settings

     -
    -
    -

    Member Visibility

    -
      -
      • -
      • -
      • -
    -
    -

    Theme

    - -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +AndroidAudioTypePresets | LiveKit React Native Client SDK - v2.3.0

    Variable AndroidAudioTypePresetsConst

    AndroidAudioTypePresets: {
        communication: AndroidAudioTypeOptions;
        media: AndroidAudioTypeOptions;
    } = ...

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/variables/ParticipantContext.html b/docs/variables/ParticipantContext.html deleted file mode 100644 index 34d712e..0000000 --- a/docs/variables/ParticipantContext.html +++ /dev/null @@ -1,110 +0,0 @@ -ParticipantContext | @livekit/react-native
    -
    - -
    -
    -
    -
    - -

    Variable ParticipantContextConst

    -
    ParticipantContext: React.Context<Participant | undefined>
    -
    -
    -
    -

    Settings

     -
    -
    -

    Member Visibility

    -
      -
      • -
      • -
      • -
    -
    -

    Theme

    - -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file diff --git a/docs/variables/RoomContext.html b/docs/variables/RoomContext.html deleted file mode 100644 index 2d3cd88..0000000 --- a/docs/variables/RoomContext.html +++ /dev/null @@ -1,110 +0,0 @@ -RoomContext | @livekit/react-native
    -
    - -
    -
    -
    -
    - -

    Variable RoomContextConst

    -
    RoomContext: React.Context<Room | undefined>
    -
    -
    -
    -

    Settings

     -
    -
    -

    Member Visibility

    -
      -
      • -
      • -
      • -
    -
    -

    Theme

    - -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file diff --git a/docs/variables/TrackRefContext.html b/docs/variables/TrackRefContext.html deleted file mode 100644 index a4b6026..0000000 --- a/docs/variables/TrackRefContext.html +++ /dev/null @@ -1,112 +0,0 @@ -TrackRefContext | @livekit/react-native
    -
    - -
    -
    -
    -
    - -

    Variable TrackRefContextConst

    -
    TrackRefContext: React.Context<TrackReferenceOrPlaceholder | undefined>
    -

    This context provides a TrackReferenceOrPlaceholder to all child components.

    -
    -
    -
    -
    -

    Settings

     -
    -
    -

    Member Visibility

    -
      -
      • -
      • -
      • -
    -
    -

    Theme

    - -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file diff --git a/docs/variables/log.html b/docs/variables/log.html index 25d8332..1bd821d 100644 --- a/docs/variables/log.html +++ b/docs/variables/log.html @@ -1,110 +1 @@ -log | @livekit/react-native
    -
    - -
    -
    -
    -
    - -

    Variable logConst

    -
    log: Logger = ...
    -
    -
    -
    -

    Settings

     -
    -
    -

    Member Visibility

    -
      -
      • -
      • -
      • -
    -
    -

    Theme

    - -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +log | LiveKit React Native Client SDK - v2.3.0

    Variable logConst

    log: Logger = ...

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/example/ios/Podfile.lock b/example/ios/Podfile.lock index aacce26..fcdd122 100644 --- a/example/ios/Podfile.lock +++ b/example/ios/Podfile.lock @@ -7,7 +7,7 @@ PODS: - hermes-engine (0.74.2): - hermes-engine/Pre-built (= 0.74.2) - hermes-engine/Pre-built (0.74.2) - - livekit-react-native (2.2.0): + - livekit-react-native (2.3.0): - livekit-react-native-webrtc - React-Core - livekit-react-native-webrtc (125.0.0): @@ -1401,7 +1401,7 @@ SPEC CHECKSUMS: fmt: 4c2741a687cc09f0634a2e2c72a838b99f1ff120 glog: fdfdfe5479092de0c4bdbebedd9056951f092c4f hermes-engine: 01d3e052018c2a13937aca1860fbedbccd4a41b7 - livekit-react-native: 86571071c5daaf2b925396119a0de57c1ed9126c + livekit-react-native: 7ce460b953e7400d3039c60a67c161d7622feeb0 livekit-react-native-webrtc: 480dba8e56c3e1cc6c8574dcb8686db2578891cb RCT-Folly: 02617c592a293bd6d418e0a88ff4ee1f88329b47 RCTDeprecation: b03c35057846b685b3ccadc9bfe43e349989cdb2 diff --git a/package.json b/package.json index 5a336b7..828acc3 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@livekit/react-native", - "version": "2.2.0", + "version": "2.3.0", "description": "LiveKit for React Native", "main": "lib/commonjs/index", "module": "lib/module/index",