Repository files navigation

A front end API wrapper written in JavaScript for TeamSpeak 5's remote apps WebSocket feature

• ts5-remote-apps-wrapper
• Table of contents
• Setting up ts5-remote-apps-wrapper
• Usage
  • Basic information
  • Connecting without API key
  • Connecting with existing API key
  • Basic connection example
• Config
  • How to pass options
  • Available options
• Events
  • API
    • List of events
  • TeamSpeak
    • Show captured events
    • List of commonly used events
• Methods
• TeamSpeak client
  • Permission prompt

1. Download the latest version of the bundled library filehere.
2. Import script in your front end

<scripttype="text/javascript"src="ts5-remote-apps-wrapper.min.js"></script>

3. You can now access the API wrapper by instantiating it's class as follows

newTSRemoteAppWrapper.TSApiWrapper();

When connecting to the TeamSpeak client API, an API key is used to identify the application that is trying to access the API. The API key is generated upon the first connection (given an empty API key is passed in the config on the first connection) after the user has accepted thepermission prompt in the TeamSpeak client settings.

It is best to store the API key for future connections as this prevents the user from having to accept thepermission prompt again in the future.

NOTE: The example below stores the generated API key in a variable. In most cases you'll probably want to store it somewhere more persistant, like a cookie.

// Variable used to store the API keyvarapiKey="";varapi=newTSRemoteAppWrapper.TSApiWrapper();// Once API is connected store generated API key for future connectionsapi.on('apiReady',(data)=>{apiKey=data.payload.apiKey;});// Show errors in consoleapi.on('apiError',(data)=>{console.log(data.exception.message);});

NOTE: You can only use API keys generated by the API as described under "Basic information".
Using custom or self generated API keys will result in an authentication error.

varapiKey="a89e9a63-170e-459d-985a-b83d616910cb";varapi=newTSRemoteAppWrapper.TSApiWrapper({api:{key:apiKey}});

For a basic connection example using cookies to store the API key seeexample/index.html;

Custom config values can be passed during instantiation of theTSApiWrapper object:

varcustomConfig={api:{key:apiKey,},app:{identifier:'test-app',name:'Test app',description:'Test app for TS API'}}varapi=TSRemoteAppWrapper.TSApiWrapper(customConfig);

You can attach event handlers to any event using theon() function:

api.on(eventName,callback);

API events are events that are specific to the API connection. These events are generated by the API wrapper.
Examples are: Failure to connect to API, closing of API connection etc.

TeamSpeak events are events generated on the TeamSpeak client and forwarded to the API.
Examples would be: moving channels, connecting to a new server etc.

An easy way to figure out and track events that are being captured by the API Wrapper is to enable theapi.tsEventDebugoption when instantiating the API wrapper:

varapi=TSRemoteAppWrapper.TSApiWrapper({api:{tsEventDebug:true}});

Once the API is connected successfully, every event that is triggered in the TeamSpeak client and it's corresponding data is logged to the console:

NOTE: TeamSpeak events are generated dynamically according to the TeamSpeak client API messages.
The list below is by no means complete and subject to change depending on TeamSpeak client updates.

Upon initializing the API connection to the TeamSpeak client, the user receives a permission prompt that needs to be confirmed for the API to work.
The prompt can be found either in TeamSpeak's notification tray:



or under the "Remote Apps" settings: