PHPackages                             bennetgallein/ts3ab-api - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. bennetgallein/ts3ab-api

ActiveLibrary[API Development](/categories/api)

bennetgallein/ts3ab-api
=======================

OOP API Wrapper for the TS3AudioBot WebAPI

v1.3(6y ago)31.3k2LGPL-3.0PHPPHP >=7.1

Since Sep 3Pushed 6y ago3 watchersCompare

[ Source](https://github.com/bennetgallein/TS3AB-API)[ Packagist](https://packagist.org/packages/bennetgallein/ts3ab-api)[ RSS](/packages/bennetgallein-ts3ab-api/feed)WikiDiscussions master Synced 2d ago

READMEChangelog (8)DependenciesVersions (8)Used By (0)

TS3AB-API
=========

[](#ts3ab-api)

OOP API Wrapper for the TS3AudioBot WebAPI

This Wrapper is meant to make work with the TS3AudioBot WebAPI over PHP easier. It provides (in the future) all functions that the bot supports.

**Warning:** This is based on the development branch! Do not use funtions that are only available there or you'll encounter some bad errors!

Intention
---------

[](#intention)

This is more of a sideproject than a dedicated one, since I needed an easier way to communicate between a PHP-Backend with the Bot's API.

Installation
------------

[](#installation)

PHP Version Required: 7.1

Install view composer:

```
composer require bennetgallein/ts3ab-api

```

Get started
-----------

[](#get-started)

1. Make a connection:

```
$bot = new \TS3AB\Ts3AudioBot("192.168.1.104", "3306");
```

2. Authenticate

```
$bot->basicAuth("j+W41OpXcHv8In9vt/Q2x+UmUPs=:ts3ab:X38WCfV3srBQBYUYZVkMnpxyBPWlMxZs");
```

Read more about Authentication in the official Wiki.

3. Select the correct bot. Since TS3AB allows multi-instances to run at the same time, you need to choose the context you want to work with.

```
var_dump($bot->getCommandExecutor()->list()); // lists all active bots
$bot->getCommandExecutor()->use(0); // tells the API to use bot "0"
```

4. Execute commands.

```
var_dump($bot->getCommandExecutor()->play("https://www.youtube.com/watch?v=xxxx"));
```

### History

[](#history)

```
$history = $bot->getCommandExecutor()->history();
```

Adds the song with to the queue

```
$history->add(0);
```

Cleans up the history file for better startup performance.

```
$history->clean();
```

Cleans up the history file for better startup performance. Also checks for all links in the history which cannot be opened anymore.

```
$history->cleanRemovedefective();
```

Removes the entry with from the history.

```
$history->delete(0);
```

Gets the last songs from the user with the given ".

```
$history->historyFrom(10, );
```

Displays all saved informations about the song with (also can be last|next)

```
$history->historyID(0);
```

Gets the last played songs.

```
$history->last(10);
```

Plays the last song again

```
$history->playLast();
```

Playes the song with

```
$history->play(2);
```

Sets the name of the song with to

```
$history->rename(0, "new title");
```

Gets all songs played until . Any of those desciptors: (hour|today|yesterday|week)

```
$history->till("today");
```

Gets all songs which title contains

```
$history->filterTitle("filter");
```

Atm the return value of all funtions is the pure answer from the TS3AB API, which may change in the future.

###  Health Score

32

—

LowBetter than 72% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity22

Limited adoption so far

Community13

Small or concentrated contributor base

Maturity62

Established project with proven stability

 Bus Factor1

Top contributor holds 94.6% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~73 days

Recently: every ~49 days

Total

7

Last Release

2371d ago

Major Versions

v0.9.0 → v1.02018-11-13

### Community

Maintainers

![](https://www.gravatar.com/avatar/d1fe6824fa3ef29f0284a7dddd5233ee261e0e1e41a575e6d867e34428b70386?d=identicon)[BennetPHP](/maintainers/BennetPHP)

---

Top Contributors

[![bennetgallein](https://avatars.githubusercontent.com/u/15325891?v=4)](https://github.com/bennetgallein "bennetgallein (35 commits)")[![FlareNetwork](https://avatars.githubusercontent.com/u/24608271?v=4)](https://github.com/FlareNetwork "FlareNetwork (1 commits)")[![Wruczek](https://avatars.githubusercontent.com/u/7156344?v=4)](https://github.com/Wruczek "Wruczek (1 commits)")

### Embed Badge

![Health badge](/badges/bennetgallein-ts3ab-api/health.svg)

```
[![Health](https://phpackages.com/badges/bennetgallein-ts3ab-api/health.svg)](https://phpackages.com/packages/bennetgallein-ts3ab-api)
```

###  Alternatives

[stripe/stripe-php

Stripe PHP Library

4.0k143.3M480](/packages/stripe-stripe-php)[twilio/sdk

A PHP wrapper for Twilio's API

1.6k92.9M272](/packages/twilio-sdk)[knplabs/github-api

GitHub API v3 client

2.2k15.8M187](/packages/knplabs-github-api)[facebook/php-business-sdk

PHP SDK for Facebook Business

90121.9M34](/packages/facebook-php-business-sdk)[meilisearch/meilisearch-php

PHP wrapper for the Meilisearch API

73813.7M114](/packages/meilisearch-meilisearch-php)[google/gax

Google API Core for PHP

263103.1M454](/packages/google-gax)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)