README

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

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

PHP Version Required: 7.1

Install view composer:

composer require bennetgallein/ts3ab-api

Get started

1. Make a connection:

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

1. Authenticate

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

Read more about Authentication in the official Wiki.

1. 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"

1. Execute commands.

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

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, <userid>);

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.