{"id":16073316,"url":"https://github.com/svenpaulsen/node-ts3sdk-client","last_synced_at":"2025-03-17T17:30:35.204Z","repository":{"id":21238300,"uuid":"70084419","full_name":"svenpaulsen/node-ts3sdk-client","owner":"svenpaulsen","description":"TeamSpeak 3 SDK Client Addon for Node.js","archived":false,"fork":false,"pushed_at":"2022-12-27T14:46:20.000Z","size":19180,"stargazers_count":29,"open_issues_count":6,"forks_count":3,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-04-15T07:39:56.002Z","etag":null,"topics":["c-plus-plus","node-gyp","node-module","nodejs","teamspeak3","teamspeak3-client","teamspeak3-sdk"],"latest_commit_sha":null,"homepage":"","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/svenpaulsen.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-10-05T17:47:45.000Z","updated_at":"2023-07-03T12:25:07.000Z","dependencies_parsed_at":"2023-01-12T03:45:21.047Z","dependency_job_id":null,"html_url":"https://github.com/svenpaulsen/node-ts3sdk-client","commit_stats":{"total_commits":106,"total_committers":4,"mean_commits":26.5,"dds":0.1132075471698113,"last_synced_commit":"fea02e389c5a14e3f56beee69ce09a9406804847"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/svenpaulsen%2Fnode-ts3sdk-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/svenpaulsen%2Fnode-ts3sdk-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/svenpaulsen%2Fnode-ts3sdk-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/svenpaulsen%2Fnode-ts3sdk-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/svenpaulsen","download_url":"https://codeload.github.com/svenpaulsen/node-ts3sdk-client/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243871904,"owners_count":20361380,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["c-plus-plus","node-gyp","node-module","nodejs","teamspeak3","teamspeak3-client","teamspeak3-sdk"],"created_at":"2024-10-09T08:06:18.175Z","updated_at":"2025-03-17T17:30:33.087Z","avatar_url":"https://github.com/svenpaulsen.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"# TeamSpeak 3 SDK Client Addon for Node.js\n\n[![Build Status](https://travis-ci.org/svenpaulsen/node-ts3sdk-client.svg?branch=master)](https://travis-ci.org/svenpaulsen/node-ts3sdk-client)\n\nThis native Node.js addon is a wrapper for the TeamSpeak 3 SDK and allows JavaScript implementations of third-party clients using the TeamSpeak 3 ClientLib.\n\n## Prerequisites\n\nThe following prerequisites are necessary prior to using the addon:\n\n- [TeamSpeak 3 SDK](https://www.teamspeak.com)\n- [Node.js](https://www.nodejs.org)\n- [Native Addon Build Tool for Node.js](https://www.npmjs.com/package/node-gyp)\n- [Visual C++ Build Tools](https://www.npmjs.com/package/windows-build-tools) (Windows only)\n\n## Installing\n\nAll dependencies can be installed via `npm`:\n\n```sh\nnpm install\n```\n\nThis will also build build the module for your current platform. If you want to build the addon manually, issue the following commands in the root directory after cloning the repository:\n\n```sh\n$ node-gyp configure\n$ node-gyp build\n```\n\n## Testing\n\nIncluded is a minimal console client to connect to a local TeamSpeak 3 SDK Server.\n\n```sh\n$ cd node-ts3sdk-client\n$ node examples/client_minimal.js\n```\n\n## Usage\n\nPlease refer to the official TeamSpeak 3 SDK [documentation](https://github.com/svenpaulsen/node-ts3sdk-client/blob/master/doc/client.pdf) for a list of functions and events available.\n\n### Basics\n\nAfter loading the addon, most TeamSpeak 3 ClientLib features are available in JavaScript. For the sake of convenience the `ts3client_` prefix has been removed from function names and some arguments are optional.\n\n```javascript\nconst ts3client = require('node-ts3sdk-client');\n\nts3client.initClientLib(ts3client.LogTypes.CONSOLE, logPath, soundBackendPath);\n\nvar schID = ts3client.spawnNewServerConnectionHandler();\nvar ident = ts3client.createIdentity();\n\nts3client.startConnection(schID, ident, '127.0.0.1', 9987, 'JohnDoe');\n```\n\n### Callbacks\n\nTo register a callback to an event triggered by the TeamSpeak 3 ClientLib, use the `on` method:\n\n```javascript\nts3client.on('onConnectStatusChangeEvent', function(schID, status, errno)\n{\n  // your code\n});\n\nts3client.on('onTalkStatusChangeEvent', function(schID, status, isWhisper, clientID)\n{\n  // your code\n});\n\nts3client.on('onClientMoveEvent', function(schID, clientID, oldChannelID, newChannelID, visibility, moveMessage)\n{\n  // your code\n});\n```\n\n### Error Handling\n\nWhen an error occurs, the addon will throw exceptions:\n\n```javascript\ntry\n{\n  ts3client.openCaptureDevice(schID, undefined, 'some_invalid_capture_device');\n}\ncatch(err)\n{\n  var errno = ts3client.getLastError();\n\n  console.log('ERROR ' + errno + ': ' + err.message);\n}\n```\n\n## Known Issues\n\nI am aware that some features of the SDK are not implemented and I am working to update these. Please visit the project on [GitHub](https://github.com/svenpaulsen/node-ts3sdk-client) to view outstanding issues.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsvenpaulsen%2Fnode-ts3sdk-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsvenpaulsen%2Fnode-ts3sdk-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsvenpaulsen%2Fnode-ts3sdk-client/lists"}