${e}
`:""}var ct=["button","checkbox","file","hidden","image","radio","range","reset","submit"];function ut(){let t=document.activeElement;return t?t.isContentEditable||t.tagName==="TEXTAREA"||t.tagName==="SEARCH"?!0:t.tagName==="INPUT"&&!ct.includes(t.type):!1}var D="mousedown",Me="mousemove",$="mouseup",ne={x:0,y:0},Qe=!1,ce=!1,dt=!1,F=!1,Oe=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(Oe?"is-mobile":"not-mobile");Oe&&"ontouchstart"in document.documentElement&&(dt=!0,D="touchstart",Me="touchmove",$="touchend");document.addEventListener(D,t=>{ce=!0,F=!1;let e=D=="touchstart"?t.targetTouches[0]:t;ne.y=e.pageY||0,ne.x=e.pageX||0});document.addEventListener(Me,t=>{if(ce&&!F){let e=D=="touchstart"?t.targetTouches[0]:t,n=ne.x-(e.pageX||0),r=ne.y-(e.pageY||0);F=Math.sqrt(n*n+r*r)>10}});document.addEventListener($,()=>{ce=!1});document.addEventListener("click",t=>{Qe&&(t.preventDefault(),t.stopImmediatePropagation(),Qe=!1)});var re=class extends I{active;className;constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener($,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(D,n=>this.onDocumentPointerDown(n)),document.addEventListener($,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){F||(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(!F&&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 ue=new Map,de=class{open;accordions=[];key;constructor(e,n){this.key=e,this.open=n}add(e){this.accordions.push(e),e.open=this.open,e.addEventListener("toggle",()=>{this.toggle(e.open)})}toggle(e){for(let n of this.accordions)n.open=e;S.setItem(this.key,e.toString())}},ie=class extends I{constructor(e){super(e);let n=this.el.querySelector("summary"),r=n.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)});let i=`tsd-accordion-${n.dataset.key??n.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`,s;if(ue.has(i))s=ue.get(i);else{let o=S.getItem(i),a=o?o==="true":this.el.open;s=new de(i,a),ue.set(i,s)}s.add(this.el)}};function He(t){let e=S.getItem("tsd-theme")||"os";t.value=e,Ae(e),t.addEventListener("change",()=>{S.setItem("tsd-theme",t.value),Ae(t.value)})}function Ae(t){document.documentElement.dataset.theme=t}var se;function Ne(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",Re),Re())}async function Re(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let e=await R(window.navigationData);se=document.documentElement.dataset.base,se.endsWith("/")||(se+="/"),t.innerHTML="";for(let n of e)Be(n,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function Be(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-accordion`:"tsd-accordion";let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.dataset.key=i.join("$"),o.innerHTML='',De(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let c=a.appendChild(document.createElement("ul"));c.className="tsd-nested-navigation";for(let l of t.children)Be(l,c,i)}else De(t,r,t.class)}function De(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));if(r.href=se+t.path,n&&(r.className=n),location.pathname===r.pathname&&!r.href.includes("#")&&(r.classList.add("current"),r.ariaCurrent="page"),t.kind){let i=window.translations[`kind_${t.kind}`].replaceAll('"',""");r.innerHTML=``}r.appendChild(Fe(t.text,document.createElement("span")))}else{let r=e.appendChild(document.createElement("span")),i=window.translations.folder.replaceAll('"',""");r.innerHTML=``,r.appendChild(Fe(t.text,document.createElement("span")))}}function Fe(t,e){let n=t.split(/(?<=[^A-Z])(?=[A-Z])|(?<=[A-Z])(?=[A-Z][a-z])|(?<=[_-])(?=[^_-])/);for(let r=0;rFunction createClient
tap-sdk-js
Hierarchy Summary
tap-sdk-js
Zako Tap SDK js
This is the javascript sdk package required to create a javascript tap server responsible for the audio of zako, a discord audio bot.
Quickstart Example
First, you need to download tap-sdk-js on your project.
npm install tap-sdk-js
+Then, you can use the sdk. +Here is some example.
+import { createClient } from "tap-sdk-js";
const client = createClient({
name: "your zako tap server name",
token: "your zako tap server token",
zakoEndpoint: "zako endpoint (default is https://api.zako.ac)",
});
client.events.on("ready", () => {
console.log("ready");
});
client.events.on("request", (handle) => {
const { data, parameters } = handle;
// data is the actual data to handle.
// to respond the stream
handle.respond(/* stream here */);
// call this on error
handle.respondError("error message");
});
client.events.on("connectionError", (e) => {
console.error(e);
});
client.events.on("error", (e) => {
console.error(e);
});
client.connect();
+Client Description
1. Create Client and Connect
You can create tap server client by call createClient function in tap-sdk-js package.
You should put the client data written as ZakoTapConfig type inside the argument of createClient.
You can then connect to the tab server using client.connect().
import { createClient } from "zako-sdk-js"
const client = createClient({
name: "your zako tap server name",
token: "your zako tap server token",
zakoEndpoint: "zako endpoint (option)"
backoffBaseMs: "loop waiting time (option)";
});
client.connect();
+2. Client Event
Using the client created above, you can use client.on to perform a specific function when the EventEmitter's event is called.
+client.events.on("event name", function)
+The types of events are specified in TapEvents among the types in the zakotap package.
+Tap Events
-
+
ready: This event is called when the zako tap server successfully connects to thezako tap hub.
+request: This event is called when anaudio requestis received from thezako tap hub.
+connectionError: This event is called when an connection error occurs within the zakotap package.
+error: This event is called when an error occurs within the zakotap package.
+
3. Send Audio
You can send your audio stream by using handle.respond() function.
handle.respond("your audio stream");
+You can get audio request handle from request event parameter. If you don't send an audio stream, your tap server will be considered offline and you may be disconnected.
Work Flow
sequenceDiagram
+ participant TapServer
+ participant TapHub
+
+ TapServer->>TapHub: WS TapHello
+ TapHub-->>TapServer: WS TapResponse
+ Note right of TapServer: Waiting for audio request
+ TapHub-->>TapServer: WS AudioRequest
+ TapServer->>TapHub: POST AudioStream
+Related Documents
+Authors
-
+
- @ridanit-ruma (Discord:
ruma0607)
+
Interface ZakoTapOptions
Represents client options of ZakoTapClient.
+interface ZakoTapOptions {
backoffBaseMs?: number;
name: string;
token: string;
zakoEndpoint?: string;
}
backoffBaseMs?: number;
name: string;
token: string;
zakoEndpoint?: string;
}
Index
Properties
Properties
Optionalbackoff
backoffBaseMs?: number
Milliseconds of backoff retry.
+If the connection errored, the client retries after backoffBaseMs * 2^(Number of consecutive failures) milliseconds.
name
name: string
The name of the tap.
+token
token: string
Assigned API key of the tap.
+Optionalzako
zakoEndpoint?: string
Zako TapHub API endpoint. (optional)
+tap-sdk-js
Interfaces
Type Aliases
Functions
Type Alias AudioRequestHandle
Represents handle with audio request information and respond function.
+type AudioRequestHandle = {
data: string;
parameters: Record<string, string>;
respond: AudioResponseFunction;
respondError: AudioResponseErrorFunction;
}
data: string;
parameters: Record<string, string>;
respond: AudioResponseFunction;
respondError: AudioResponseErrorFunction;
}
Index
Properties
Type Alias TapEvents
Represents all events of Tap Client.
+type TapEvents = {
connectionError: (e: Error) => any;
error: (e: Error) => any;
ready: () => any;
request: (handle: AudioRequestHandle) => any;
}
connectionError: (e: Error) => any;
error: (e: Error) => any;
ready: () => any;
request: (handle: AudioRequestHandle) => any;
}
Index
Properties
Type Alias ZakoTapClientHandle
Represents a handle to the Zako Tap client.
+This object provides methods and event handling capabilities +for interacting with the Zako Tap system.
+
Creates a ZakoTap client handle.
+