TeamTalk.py

https://teamtalkpy.readthedocs.io/en/latest/
Admin
TeamTalk.py is a Python library providing a simple interface to connect to and interact with...
Tokens:17,516
Snippets:201
Trust Score:9.6
Update:5 months ago
Show doc for...
Tokens:
Raw
### Quick Start: TeamTalk Bot Example

Source: https://teamtalkpy.readthedocs.io/en/latest/index.html

A basic example demonstrating how to create a TeamTalk bot, register event listeners for 'ready' and 'message' events, add a server, and start the bot.

```python
import teamtalk

# Create a new TeamTalk bot
bot = teamtalk.Bot()

# listen to some events
@bot.event
def on_ready():
    print("Bot is ready!")

@bot.event
def on_message(message):
    print(f"Received message: {message}")

# then add our servers
bot.add_server("localhost", 10333, 10333, "serveradmin", "password")

# and finally, connect to the servers and start listening for events
bot.run()
```

--------------------------------

### Install teamtalk.py from source

Source: https://teamtalkpy.readthedocs.io/en/latest/index.html

Clone the repository, build the package, and install it locally. Use this method if you need to contribute to the library or use a development version.

```bash
git clone https://github.com/JessicaTegner/teamtalk.py.git
cd teamtalk.py
uv build
pip install dist/teamtalk_py-*.tar.gz
```

--------------------------------

### Install teamtalk.py using pip

Source: https://teamtalkpy.readthedocs.io/en/latest/index.html

Install the library using pip. This is the recommended method for most users.

```bash
pip install teamtalk.py
```

--------------------------------

### Run the Bot

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Start the bot and connect to all added servers. This is a blocking call that handles all events.

```python
bot.run()

```

--------------------------------

### How to use events

Source: https://teamtalkpy.readthedocs.io/en/latest/events.html

Demonstrates how to use the `teamtalk.bot.event()` decorator to listen to events. The example shows how to print a message object to the console when a message is received.

```APIDOC
## How do I use these events?

The events are listed in the following tables. Each event has a name, a list of arguments that are passed to the event handler and a description of what the event is.
To listen to an event, you must use the `teamtalk.bot.event()` decorator.
example:
```python
@bot.event
def on_message(message):
    print(message)
```

The above code will print the message object to the console whenever a message is sent. The message object is passed to the event handler as an argument.
```

--------------------------------

### Get and Update Server Properties

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Demonstrates how to retrieve current server properties and then update them. Ensure you have the necessary permissions to modify server properties.

```python
>>> server = teamtalk server
>>> properties = server.get_properties()
>>> properties.max_users
1000
>>> properties.max_users = 500
>>> server.update_properties(properties)
>>> properties = server.get_properties()
>>> properties.max_users
500
```

--------------------------------

### Get Users in Channel

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Retrieves a list of all users currently present in a channel. Returns a list of User instances.

```python
channel.get_users() -> List[User]
```

--------------------------------

### Get Files in Channel

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Retrieves a list of all files available in a channel. Returns a list of RemoteFile instances.

```python
channel.get_files() -> List[RemoteFile]
```

--------------------------------

### Listen to Bot Events with @bot.event

Source: https://teamtalkpy.readthedocs.io/en/latest/events.html

Use the `teamtalk.bot.event()` decorator to register an event handler. This example shows how to print incoming messages to the console.

```python
import teamtalk

bot = teamtalk.Bot("your_token")

@bot.event
def on_message(message):
    print(message)
```

--------------------------------

### Get Input Volume

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Retrieves the current input gain level, scaled so that the SDK default is 100.

```APIDOC
## get_input_volume()

### Description
Gets the current input gain level (100=SDK default).
Retrieves the raw SDK gain and scales it so the SDK default gain level (SOUND_GAIN_DEFAULT) corresponds to 100.

### Returns
* **int** - The volume level where 100 is the SDK default gain. Values above 100 represent gain higher than the SDK default. Returns 0 if the SDK call fails.
```

--------------------------------

### Initialize Streamer for Channel

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Get a Streamer instance for a specific TeamTalk channel. Allows configuration of sample rate, channels, and block size.

```python
streamer = teamtalk.Streamer.get_streamer_for_channel(message.channel, sample_rate=48000, channels=2)

```

--------------------------------

### get_path_from_channel

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Gets the string path representation of a channel.

```APIDOC
## get_path_from_channel

### Description
Gets the path of a channel.

### Parameters
* **channel** (Channel | int) - The channel to get the path of.

### Returns
* **str** - The path of the channel.

### Return Type
str

### Raises
* **TypeError** - If the channel is not of type teamtalk.Channel or int.
* **ValueError** - If the channel is not found.
```

--------------------------------

### Get Sound Devices

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Retrieves a list of available TeamTalk sound devices, indicating the default input device.

```APIDOC
## get_sound_devices()

### Description
Gets the list of available TeamTalk sound devices, marking the default input.

### Returns
* **List[SoundDevice]** - A list of SoundDevice objects representing the available devices. Returns an empty list if the SDK call fails.
```

--------------------------------

### Streamer Class

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Methods for managing audio streaming, including searching, starting, stopping, and controlling volume.

```APIDOC
## Streamer

### Description
Handles audio streaming functionalities.

### Methods

#### `Streamer.get_streamer_for_channel()`

##### Description
Gets a streamer instance for a specific channel.

#### `Streamer.__init__()`

##### Description
Initializes the Streamer.

#### `Streamer.search_and_stream()`

##### Description
Searches for and streams audio.

#### `Streamer.stop()`

##### Description
Stops the current audio stream.

#### `Streamer.stream()`

##### Description
Starts streaming audio.

#### `Streamer.volume`

##### Description
Gets or sets the stream volume.

#### `Streamer.mute_left`

##### Description
Gets or sets the mute state for the left audio channel.

#### `Streamer.mute_right`

##### Description
Gets or sets the mute state for the right audio channel.

#### `Streamer.feed()`

##### Description
Feeds audio data to the stream.
```

--------------------------------

### TeamTalkInstance.get_server_statistics

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Gets the statistics from the server. This method allows you to retrieve detailed statistics about the TeamTalk server instance.

```APIDOC
## get_server_statistics()

### Description
Gets the statistics from the server.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Method
Not applicable (this is a method call, not an HTTP endpoint)

### Endpoint
Not applicable (this is a method call, not an HTTP endpoint)

### Parameters
- **timeout** (int) - Optional - The time to wait before assuming that getting the servers statistics failed.

### Raises
- **TimeoutError**: If the server statistics are not received within the given time.

### Returns
- **teamtalk.statistics**: The teamtalk.statistics object representing the servers statistics.
```

--------------------------------

### Stream Audio to TeamTalk Channel

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Use the Streamer class to stream audio files or URLs to a TeamTalk channel. Ensure ffmpeg is installed for non-wav files and yt-dlp for URLs.

```python
>>> import teamtalk
>>> # asuming we have a bot in the variable bot
>>> @bot.event
>>> async def on_message(message):
>>>     if message.content.lower() == "play":
>>>         streamer = teamtalk.Streamer.get_streamer_for_channel(message.channel)
>>>         streamer.stream("path/to/file.wav")
>>> # or for an url
>>> streamer.stream("https://www.example.com/youtube/or/other/stream")

```

--------------------------------

### Server Initialization

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Initializes a Server instance with a TeamTalkInstance and server information.

```APIDOC
## Server Initialization

### Description
Initializes a Server instance.

### Parameters
* **teamtalk_instance** (teamtalk.TeamTalkInstance) - An instance of teamtalk.TeamTalkInstance.
* **server_info** - The server information.
```

--------------------------------

### Initialize TeamTalkServerInfo

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Create a TeamTalkServerInfo object to hold connection details for a TeamTalk server. All required parameters like host, ports, and username must be provided.

```python
server_info = TeamTalkServerInfo(
    host='example.com',
    tcp_port=1234,
    udp_port=5678,
    username='myuser',
    password='mypassword'
)

```

--------------------------------

### Set Input Device

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Sets and initializes the input device for the instance, accepting a device ID or 'default'.

```APIDOC
## set_input_device(_device_id_or_name_)

### Description
Sets and initializes the input device for this instance.
Accepts a specific device ID (int) or the string “default” to use the system default input device. Updates the stored current input device ID on success.

### Parameters
* **device_id_or_name** (_int | str_) - The ID (int) of the device or the string “default”.

### Returns
* **bool** - True on success, False on initialization failure or if default not found.

### Raises
* **ValueError** - If the input is not a valid integer or “default”.
```

--------------------------------

### TeamTalkInstance Initialization

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Initializes a TeamTalkInstance for a specific server.

```APIDOC
## __init__ TeamTalkInstance(_bot_, _server_info_)

### Description
Initializes a teamtalk.TeamTalkInstance instance.

### Parameters
* **bot** (_teamtalk.Bot_) - The teamtalk.Bot instance.
* **server_info** (_TeamTalkServerInfo_) - The server info for the server we wish to connect to.
```

--------------------------------

### Initialize RemoteFile Instance

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Initializes a RemoteFile instance. This is typically handled internally by the TeamTalk library.

```python
__init__(_teamtalk_instance_ , _payload_)

```

--------------------------------

### Initialize TeamTalkBot

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Initialize a TeamTalkBot object. Optionally, provide a custom client name.

```python
bot = TeamTalkBot(client_name='MyBot')

```

--------------------------------

### Stream Audio from Data Stream

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Stream audio from a live data source, like a microphone, by initializing the Streamer with specific sample rates and channels, then feeding data in 16-bit PCM format.

```python
>>> import teamtalk
>>> # asuming we have a bot in the variable bot
>>> @bot.event
>>> async def on_message(message):
>>>     if message.content.lower() == "play":
>>>         streamer = teamtalk.Streamer.get_streamer_for_channel(message.channel, sample_rate=48000, channels=2)
>>>         # we could get the data from any source, so let's assume it's coming from a live microphone.
>>>         data_stream = # connect to microphone
>>>         while True:
>>>             # get the data from the stream
>>>             data = data_stream.read(streamer.block_size*16) # we are reading 16 chunks at a time to combat buffering
>>>             if data == 0:
>>>                 break
>>>             # add the data to the streamer
>>>             streamer.feed(data)
>>>         # close the connection to our microphone

```

--------------------------------

### Get Current Input Device ID

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Retrieves the ID of the currently active input device for this instance, based on the last set value.

```APIDOC
## get_current_input_device_id()

### Description
Gets the ID of the currently active input device for this instance.
Note
This returns the ID that was stored when the input device was last initialized or set for this instance using set_input_device. It does not query the SDK directly for the current device.

### Returns
* **int | None** - The ID of the current input device, or -1 if not set or unknown.
```

--------------------------------

### Construct TeamTalkServerInfo from Dictionary

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Create a TeamTalkServerInfo object from a dictionary. This is useful for loading server configurations from external sources.

```python
server_info = TeamTalkServerInfo.from_dict(server_data)

```

--------------------------------

### create_channel

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Creates a new channel with specified properties.

```APIDOC
## create_channel

### Description
Creates a channel.

### Parameters
* **name** (str) - The name of the channel to create.
* **parent_channel** (Channel | int) - The parent channel of the channel.
* **topic** (str, optional) - The topic of the channel. Defaults to ''.
* **password** (str, optional) - The password of the channel. Leave empty for no password.
* **channel_type** (ChannelType, optional) - The type of the channel. Defaults to CHANNEL_DEFAULT.

### Raises
* **PermissionError** - If the bot does not have permission to create channels.
* **ValueError** - If the channel could not be created.

### Returns
* **bool** - True if the channel was created, False otherwise.

### Return Type
bool
```

--------------------------------

### Initialize UserAccount Object

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Initializes a UserAccount object. This class is not meant to be instantiated directly; use TeamTalkBot.list_user_accounts() instead.

```python
UserAccount(_teamtalk_instance_ , _account : UserAccount_) -> None
```

--------------------------------

### Connect to Server

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Establishes a connection to the TeamTalk server. This method blocks until the connection is successful or fails.

```APIDOC
## connect()

### Description
Connects to the server. This doesn’t return until the connection is successful or fails.

### Returns
* **bool** - True if the connection was successful, False otherwise.
```

--------------------------------

### Upload File to Channel

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Uploads a file from the local filesystem to a channel. Provide the local path to the file as an argument.

```python
channel.upload_file(_filepath_)
```

--------------------------------

### TeamTalkInstance Class (Low Level)

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Low-level methods for direct interaction with the TeamTalk instance, including connection, authentication, and core functionalities.

```APIDOC
## TeamTalkInstance

### Description
Provides low-level access to TeamTalk functionalities.

### Methods

#### `TeamTalkInstance.__init__()`

##### Description
Initializes the TeamTalkInstance.

#### `TeamTalkInstance.connect()`

##### Description
Connects to a TeamTalk server.

#### `TeamTalkInstance.login()`

##### Description
Logs into the TeamTalk server.

#### `TeamTalkInstance.logout()`

##### Description
Logs out from the TeamTalk server.

#### `TeamTalkInstance.disconnect()`

##### Description
Disconnects from the TeamTalk server.

#### `TeamTalkInstance.change_nickname()`

##### Description
Changes the client's nickname.

#### `TeamTalkInstance.change_status()`

##### Description
Changes the client's status (e.g., online, away).

#### `TeamTalkInstance.get_sound_devices()`

##### Description
Retrieves available sound input devices.

#### `TeamTalkInstance.get_current_input_device_id()`

##### Description
Gets the ID of the current audio input device.

#### `TeamTalkInstance.set_input_device()`

##### Description
Sets the audio input device.

#### `TeamTalkInstance.enable_voice_transmission()`

##### Description
Enables or disables voice transmission.

#### `TeamTalkInstance.get_input_volume()`

##### Description
Gets the current input volume level.

#### `TeamTalkInstance.set_input_volume()`

##### Description
Sets the input volume level.

#### `TeamTalkInstance.has_permission()`

##### Description
Checks if the client has a specific permission.

#### `TeamTalkInstance.is_admin()`

##### Description
Checks if the client is an administrator.

#### `TeamTalkInstance.is_user_admin()`

##### Description
Checks if a specific user is an administrator.

#### `TeamTalkInstance.subscribe()`

##### Description
Subscribes to various events.

#### `TeamTalkInstance.unsubscribe()`

##### Description
Unsubscribes from events.

#### `TeamTalkInstance.is_subscribed()`

##### Description
Checks if the client is subscribed to an event.

#### `TeamTalkInstance.join_root_channel()`

##### Description
Joins the root channel of the server.

#### `TeamTalkInstance.join_channel_by_id()`

##### Description
Joins a channel using its ID.

#### `TeamTalkInstance.join_channel()`

##### Description
Joins a channel by its name or path.

#### `TeamTalkInstance.leave_channel()`

##### Description
Leaves the current channel.

#### `TeamTalkInstance.get_channel()`

##### Description
Retrieves channel information.

#### `TeamTalkInstance.get_path_from_channel()`

##### Description
Gets the path of a channel.

#### `TeamTalkInstance.get_channel_from_path()`

##### Description
Gets a channel object from its path.

#### `TeamTalkInstance.create_channel()`

##### Description
Creates a new channel.

#### `TeamTalkInstance.delete_channel()`

##### Description
Deletes a channel.

#### `TeamTalkInstance.make_channel_operator()`

##### Description
Grants operator status in a channel.

#### `TeamTalkInstance.remove_channel_operator()`

##### Description
Revokes operator status in a channel.

#### `TeamTalkInstance.get_user()`

##### Description
Retrieves user information.

#### `TeamTalkInstance.create_user_account()`

##### Description
Creates a new user account.

#### `TeamTalkInstance.delete_user_account()`

##### Description
Deletes a user account.

#### `TeamTalkInstance.list_user_accounts()`

##### Description
Lists all user accounts on the server.

#### `TeamTalkInstance.upload_file()`

##### Description
Uploads a file to a channel.

#### `TeamTalkInstance.download_file()`

##### Description
Downloads a file from a channel.

#### `TeamTalkInstance.download_file_by_id()`

##### Description
Downloads a file by its ID.

#### `TeamTalkInstance.delete_file_by_id()`

##### Description
Deletes a file by its ID.

#### `TeamTalkInstance.get_channel_files()`

##### Description
Retrieves a list of files in a channel.

#### `TeamTalkInstance.move_user()`

##### Description
Moves a user to a different channel.
```

--------------------------------

### Channel.upload_file()

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Uploads a file from the local filesystem to the channel.

```APIDOC
## Channel.upload_file(filepath)

### Description
Upload a file to the channel.

### Method
Upload File

### Endpoint
Not applicable (method call)

### Parameters
- **filepath** (str) - Required - The local path to the file to upload.
```

--------------------------------

### join_channel

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Joins a specified channel on the server, optionally with a password.

```APIDOC
## join_channel

### Description
Joins the specified channel.

### Parameters
* **channel** (Channel | str | int) - The channel to join.
* **password** (str, optional) - The password for the channel, if required. Defaults to ''

### Returns
True if the channel was joined successfully, False otherwise.
```

--------------------------------

### create_user_account

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Creates a new user account on the TeamTalk server.

```APIDOC
## create_user_account

### Description
Creates a user account on the server.

### Parameters
* **username** (str) - The username of the user account.
* **password** (str) - The password of the user account.
* **usertype** (UserType) - The type of the user account.

### Returns
* **UserAccount** - The created user account.

### Return Type
TeamTalkUserAccount
```

--------------------------------

### Channel.move()

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Moves a specified user to this channel.

```APIDOC
## Channel.move(user)

### Description
Move a user to this channel.

### Method
Move User

### Endpoint
Not applicable (method call)

### Parameters
- **user** (User | int) - Required - The user to move.
```

--------------------------------

### _list_user_accounts

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Lists all user accounts on the server. Requires admin privileges.

```APIDOC
## _list_user_accounts

### Description
Lists all user accounts on the server.

### Returns
- **List[UserAccount]** - A list of all user accounts.

### Raises
- **PermissionError** - If the bot is not an admin.
- **ValueError** - If an unknown error occurred.
```

--------------------------------

### TeamTalkServerInfo Class

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Holds the necessary information to connect and log in to a TeamTalk server.

```APIDOC
## class TeamTalkServerInfo

Holds the required information to connect and login to a TeamTalk server.

### Methods

*   **__init__(host: str, tcp_port: int, udp_port: int, username: str, password: str = '', encrypted: bool = False, nickname: str = '', join_channel_id: int = -1, join_channel_password: str = '')**
    Initialize a TeamTalkServerInfo object.
    Parameters:
        host (str): The host of the TeamTalk server.
        tcp_port (int): The TCP port of the TeamTalk server.
        udp_port (int): The UDP port of the TeamTalk server.
        username (str): The username to login with.
        password (str): The password to login with. Defaults to "" (no password).
        encrypted (bool): Whether or not to use encryption. Defaults to False.
        nickname (str): The nickname to use. Defaults to “teamtalk.py Bot”.
        join_channel_id (int): The channel ID to join. Defaults to -1 (don’t join a channel on login). Set to 0 to join the root channel, or a positive integer to join a specific channel.
        join_channel_password (str): The password to join the channel with. Defaults to "" (no password).

*   **classmethod from_dict(data: dict)**
    Construct a TeamTalkServerInfo object from a dictionary.
    Parameters:
        data (dict): The dictionary to construct the object from.
    Returns:
        Self: The constructed object.

*   **to_dict() -> dict**
    Convert this object to a dictionary.
    Returns:
        dict: The dictionary representation of this object.
```

--------------------------------

### Channel.get_files()

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Retrieves a list of all files that have been uploaded to the channel.

```APIDOC
## Channel.get_files()

### Description
Get a list of files in the channel.

### Method
Get Files

### Endpoint
Not applicable (method call)

### Returns
- **List[RemoteFile]**: A list of teamtalk.RemoteFile instances in the channel.
```

--------------------------------

### Subscribe to Channel Subscription

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Subscribes to a given subscription for all users within this channel.

```python
channel.subscribe(_subscription_)
```

--------------------------------

### Server, Channel & File Events

Source: https://teamtalkpy.readthedocs.io/en/latest/events.html

Events related to server updates, channel creation/deletion/updates, and file uploads/deletions.

```APIDOC
## Server, Channel & File Events

Server, Channel & File Events

on_channel_new | teamtalk.Channel | Called when a new channel (teamtalk.Channel) is created.
on_channel_update | teamtalk.Channel | Called when a teamtalk.Channel has been updated.
on_channel_delete | teamtalk.Channel | Called when a teamtalk.Channel has been deleted from the server.
on_server_update | teamtalk.Server | Called when a teamtalk.Server has updated its settings.
on_server_statistics | teamtalk.Statistics | Called when a TeamTalk server sends it’s statistics.
on_file_new | teamtalk.RemoteFile | Called when a file has been uploaded to a channel.
on_file_delete | teamtalk.RemoteFile | Called when a file has been deleted from a channel.
on_muxed_audio | teamtalk.MuxedAudioBlock | called when a muxed audio block is recieved, this is used to get audio from all users in the channel at once.
on_user_audio | teamtalk.AudioBlock | called when an audio block is recieved from a user, this is the audio for an individual user, not the hole server.
```

--------------------------------

### Set Input Volume

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Sets the input gain level, where 100 represents the SDK default.

```APIDOC
## set_input_volume(_volume_)

### Description
Sets the input gain level (100=SDK default).
Scales the input volume (where 100 is the SDK default gain) to the SDK’s raw gain range [0, 32000] and applies it, clamping the value.

### Parameters
* **volume** (_int_) - The desired volume level, where 100 corresponds to the SDK default gain.

### Returns
* **bool** - True on success, False otherwise.

### Raises
* **ValueError** - If volume is negative.
```

--------------------------------

### Server Class

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Methods for interacting with a TeamTalk server, including sending messages, managing users, and retrieving information.

```APIDOC
## Server

### Description
Represents a connection to a TeamTalk server.

### Methods

#### `Server.send_message()`

##### Description
Sends a message to the server.

#### `Server.ping()`

##### Description
Pings the server to check connectivity.

#### `Server.get_users()`

##### Description
Retrieves a list of users on the server.

#### `Server.get_channels()`

##### Description
Retrieves a list of channels on the server.

#### `Server.get_channel()`

##### Description
Retrieves a specific channel by its ID or name.

#### `Server.get_user()`

##### Description
Retrieves a specific user by their ID or name.

#### `Server.join_channel()`

##### Description
Joins a specified channel.

#### `Server.get_statistics()`

##### Description
Retrieves server statistics.

#### `Server.move_user()`

##### Description
Moves a user to a different channel.

#### `Server.kick()`

##### Description
Kicks a user from the server.

#### `Server.ban()`

##### Description
Bans a user from the server.

#### `Server.unban()`

##### Description
Unbans a user from the server.

#### `Server.subscribe()`

##### Description
Subscribes to server events.

#### `Server.unsubscribe()`

##### Description
Unsubscribes from server events.

#### `Server.get_properties()`

##### Description
Retrieves server properties.

#### `Server.update_properties()`

##### Description
Updates server properties.
```

--------------------------------

### Is Admin

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Determines if the bot has administrator privileges.

```APIDOC
## is_admin()

### Description
Checks if the bot is an admin.

### Returns
* **bool** - True if the bot is an admin, False otherwise.
```

--------------------------------

### Channel.subscribe()

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Subscribes to a specific subscription for all users within this channel.

```APIDOC
## Channel.subscribe(subscription)

### Description
Subscribe to a subscription for all users in this channel.

### Method
Subscribe

### Endpoint
Not applicable (method call)

### Parameters
- **subscription** - Required - The subscription to subscribe to.
```

--------------------------------

### User Class

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Methods for interacting with a specific user, including sending messages, moving, kicking, and banning.

```APIDOC
## User

### Description
Represents a user on a TeamTalk server.

### Methods

#### `User.__init__()`

##### Description
Initializes a User object.

#### `User.is_me()`

##### Description
Checks if the user is the current client.

#### `User.send_message()`

##### Description
Sends a direct message to the user.

#### `User.move()`

##### Description
Moves the user to a different channel.

#### `User.kick()`

##### Description
Kicks the user from the server.

#### `User.ban()`

##### Description
Bans the user from the server.

#### `User.subscribe()`

##### Description
Subscribes to user-specific events.

#### `User.unsubscribe()`

##### Description
Unsubscribes from user-specific events.

#### `User.is_subscribed()`

##### Description
Checks if the user is subscribed to events.
```

--------------------------------

### RemoteFile Class

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Represents a file on a TeamTalk server. This class should not be instantiated directly by the user.

```APIDOC
## _class _teamtalk.tt_file.RemoteFile
    
Represents a file on a TeamTalk server. Should not be instantiated directly. 

__init__(_teamtalk_instance_ , _payload_)
    
Initializes the RemoteFile instance. 

Parameters:    
  * **teamtalk_instance** – The teamtalk.TeamTalkInstance instance.
  * **payload** – An instance of sdk.RemoteFile.
```

--------------------------------

### get_users

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Retrieves a list of all users currently on the server.

```APIDOC
## get_users

### Description
Gets a list of users on the server.

### Returns
A list of teamtalk.User instances representing the users on the server.
```

--------------------------------

### get_properties

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Retrieves the current properties of the server.

```APIDOC
## get_properties

### Description
Gets the properties of the server.

### Returns
A teamtalk.ServerProperties instance representing the properties of the server.
```

--------------------------------

### TeamTalkInstance.get_server_statistics()

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Retrieves statistics for the TeamTalk server.

```APIDOC
## get_server_statistics()

### Description
Fetches current statistics for the TeamTalk server, such as the number of connected users.

### Method
`get_server_statistics() -> dict`

### Returns
A dictionary containing server statistics. The exact keys and values depend on the server implementation.
```

--------------------------------

### download_file

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Downloads a remote file from a channel to a local path. Requires download permissions.

```APIDOC
## download_file

### Description
Downloads a remote file from a channel.

### Parameters
#### Path Parameters
- **channel_id** (int) - Required - The ID of the channel to download the file from.
- **remote_file_name** (str) - Required - The name of the remote file to download.
- **local_file_path** (str) - Required - The path to save the file to.

### Raises
- **PermissionError** - If the bot does not have permission to download files.
- **ValueError** - If the channel ID is less than 0.
```

--------------------------------

### get_channels

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Retrieves a list of all channels available on the server.

```APIDOC
## get_channels

### Description
Gets a list of channels on the server.

### Returns
A list of teamtalk.Channel instances representing the channels on the server.
```

--------------------------------

### Login to Server

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Logs into the TeamTalk server. This method blocks until the login is successful or fails.

```APIDOC
## login(_join_channel_on_login_ = True_)

### Description
Logs in to the server. This doesn’t return until the login is successful or fails.

### Parameters
* **join_channel_on_login** (_bool_) - Whether to join the channel on login or not.

### Returns
* **bool** - True if the login was successful, False otherwise.
```

--------------------------------

### Channel.get_users()

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Retrieves a list of all users currently present in the channel.

```APIDOC
## Channel.get_users()

### Description
Get a list of users in the channel.

### Method
Get Users

### Endpoint
Not applicable (method call)

### Returns
- **List[User]**: A list of teamtalk.User instances in the channel.
```

--------------------------------

### kick_user

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Kicks a user from a channel or the entire server. Requires kick permissions.

```APIDOC
## kick_user

### Description
Kicks a user from a channel or the server.

### Parameters
#### Path Parameters
- **user** (User | int) - Required - The user to kick.
- **channel** (Channel | int) - Required - The channel to kick the user from. If 0, the user will be kicked from the server.

### Raises
- **PermissionError** - If the bot does not have permission to kick users.
- **TypeError** - If the user or channel is not a subclass of User or Channel.
- **ValueError** - If the user or channel is not found.
```

--------------------------------

### subscribe

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Subscribes to a specified subscription for all users on the server.

```APIDOC
## subscribe

### Description
Subscribes to the specified subscription for all users on the server.

### Parameters
* **subscription** - The subscription to subscribe to.
```

--------------------------------

### Channel Class

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Methods for interacting with a specific channel, including sending messages, managing files, and user operations.

```APIDOC
## Channel

### Description
Represents a channel within a TeamTalk server.

### Methods

#### `Channel.__init__()`

##### Description
Initializes a Channel object.

#### `Channel.update()`

##### Description
Updates the channel's properties.

#### `Channel.send_message()`

##### Description
Sends a message to the channel.

#### `Channel.upload_file()`

##### Description
Uploads a file to the channel.

#### `Channel.get_users()`

##### Description
Retrieves a list of users in the channel.

#### `Channel.get_files()`

##### Description
Retrieves a list of files in the channel.

#### `Channel.move()`

##### Description
Moves the channel.

#### `Channel.kick()`

##### Description
Kicks a user from the channel.

#### `Channel.ban()`

##### Description
Bans a user from the channel.

#### `Channel.subscribe()`

##### Description
Subscribes to channel events.

#### `Channel.unsubscribe()`

##### Description
Unsubscribes from channel events.
```

--------------------------------

### join_root_channel

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Joins the root channel of the TeamTalk server.

```APIDOC
## join_root_channel

### Description
Joins the root channel.

### Endpoint
join_root_channel()
```

--------------------------------

### TeamTalkInstance.kick_user()

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Kicks a user from the TeamTalk server.

```APIDOC
## kick_user()

### Description
Kicks a specified user from the TeamTalk server.

### Method
`kick_user(user_id: int)`

### Parameters
#### Path Parameters
- **user_id** (int) - Required - The ID of the user to kick.
```

--------------------------------

### join_channel

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Joins a specified channel object.

```APIDOC
## join_channel

### Description
Joins a channel.

### Parameters
* **channel** (Channel) - The channel to join.
```

--------------------------------

### upload_file

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Uploads a local file to a specified channel. Requires upload permissions.

```APIDOC
## upload_file

### Description
Uploads a local file to a channel.

### Parameters
#### Path Parameters
- **channel_id** (int) - Required - The ID of the channel to upload the file to.
- **filepath** (str) - Required - The path to the local file to upload.

### Raises
- **PermissionError** - If the bot does not have permission to upload files.
- **ValueError** - If the channel ID is less than 0.
- **FileNotFoundError** - If the local file does not exist.
```

--------------------------------

### ping

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Pings the server to check its availability.

```APIDOC
## ping

### Description
Pings the server.

### Returns
True if the ping is successful, False otherwise.
```

--------------------------------

### join_channel_by_id

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Joins a specific channel using its ID and an optional password.

```APIDOC
## join_channel_by_id

### Description
Joins a channel by its ID.

### Parameters
* **id** (int) - The ID of the channel to join.
* **password** (str, optional) - The password of the channel. Defaults to ''.
```

--------------------------------

### Subscribe to User

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Subscribes to a specific subscription for a given user.

```APIDOC
## subscribe(_user_, _subscription_)

### Description
Subscribes to a subscription.

### Parameters
* **user** (_User_) - The user to subscribe to.
* **subscription** (_Subscription_) - The subscription to subscribe to.
```

--------------------------------

### kick

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Kicks a specified user from the current channel.

```APIDOC
## kick

### Description
Kicks the specified user from the specified channel.

### Parameters
* **user** (User | int) - The user to kick.

### Raises
**PermissionError** – If the user is not an admin.
```

--------------------------------

### User Account Types

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Defines the type of a user account, determining their permissions.

```python
UserType.DEFAULT

```

```python
UserType.ADMIN

```

--------------------------------

### Add Server to Bot

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Add a TeamTalk server to the bot. The server information can be provided as a TeamTalkServerInfo object or a dictionary.

```python
await bot.add_server(server_info)

```

--------------------------------

### Feed Data to Streamer

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Manually feed audio data (bytes) to the streamer. This is useful for streaming from custom data sources.

```python
streamer.feed(data)

```

--------------------------------

### Initialize BannedUserAccount Object

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Represents a banned user account. This class is not meant to be instantiated directly; use TeamTalkBot.list_banned_users() instead.

```python
BannedUserAccount()
```

--------------------------------

### Move User to Channel

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Moves a specified user to the current channel. The user can be identified by their User object or ID.

```python
channel.move(_user : User | int_)
```

--------------------------------

### User Class Methods

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Methods available for the User class to interact with TeamTalk server functionalities.

```APIDOC
## User Class

### `__init__(_teamtalk_instance_, _user_)`

Initializes the User instance.

**Parameters:**
- `teamtalk_instance` (TeamTalk.TeamTalkInstance): An instance of TeamTalk5.
- `user` (str | int | User): Either a username (string), user ID (integer), or a User instance.

**Raises:**
- `TypeError`: If the user argument is not of the expected type.

### `is_me() → bool`

Checks if this user is the bot itself.

**Returns:**
- `bool`: True if this user is the bot itself, False otherwise.

### `send_message(_content_, _**kwargs_) → int`

Sends a text message to this user.

**Parameters:**
- `content` (str): The content of the message.
- `**kwargs`: Keyword arguments. See `teamtalk.TeamTalkInstance.send_message` for more information.

**Returns:**
- `int`: The ID of the message if successful, or a negative value if unsuccessful.

### `move(_channel_) → bool`

Moves this user to the specified channel.

**Parameters:**
- `channel`: The channel to move this user to.

**Returns:**
- `bool`: True if the user was moved successfully, False otherwise.

### `kick(_from_server_) → None`

Kicks this user from the server.

**Parameters:**
- `from_server` (bool): If True, the user will be kicked from the server. If False, the user will be kicked from the channel.

### `ban(_from_server_) → None`

Bans this user from the server.

**Parameters:**
- `from_server` (bool): If True, the user will be banned from the server. If False, the user will be banned from the channel.

### `subscribe(_subscription_) → None`

Subscribes to the specified subscription.

**Parameters:**
- `subscription`: The subscription to subscribe to.

### `unsubscribe(_subscription_) → None`

Unsubscribes from the specified subscription.

**Parameters:**
- `subscription`: The subscription to unsubscribe from.

### `is_subscribed(_subscription_) → bool`

Checks if this user is subscribed to the specified subscription.

**Parameters:**
- `subscription`: The subscription to check.

**Returns:**
- `bool`: True if the bot is subscribed to the specified subscription from this user, False otherwise.
```

--------------------------------

### Check Permission

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Checks if the bot possesses a specific permission.

```APIDOC
## has_permission(_permission_)

### Description
Checks if the bot has a permission.
If the user is an admin, they have all permissions.

### Parameters
* **permission** (_Permission_) - The permission to check for.

### Returns
* **bool** - True if the bot has the permission, False otherwise.
```

--------------------------------

### send_message

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Sends a message to all users on the server using a broadcast message.

```APIDOC
## send_message

### Description
Sends a message to all users on the server, using a broadcast message.

### Parameters
* **content** (str) - The content of the message.
* ****kwargs** - Keyword arguments. See teamtalk.TeamTalkInstance.send_message for more information.

### Returns
The result of the doTextMessage call.

### Raises
**PermissionError** – If the user is not an admin.
```

--------------------------------

### User Events

Source: https://teamtalkpy.readthedocs.io/en/latest/events.html

Events related to user actions such as login, logout, updates, joining, and leaving channels.

```APIDOC
## User Events

User Events

on_user_audio | teamtalk.AudioBlock | Called when a user transmits audio.
on_user_login | teamtalk.user | Called when a user logs in to a server that the bot is on
on_user_logout | teamtalk.User | Called when a user logs out from a server that the bot is on
on_user_update | teamtalk.User | Called when a user gets updated
on_user_join | teamtalk.User, teamtalk.Channel | Called when a teamtalk.User joins a teamtalk.Channel
on_user_left | teamtalk.User, teamtalk.Channel | Called when a teamtalk.User leaves a teamtalk.Channel
```

--------------------------------

### get_user

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Retrieves a specific user on the server by their ID.

```APIDOC
## get_user

### Description
Gets the user with the specified ID.

### Parameters
* **user_id** - The ID of the user.

### Returns
The teamtalk.User instance representing the user with the specified ID.
```

--------------------------------

### Convert TeamTalkServerInfo to Dictionary

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Convert a TeamTalkServerInfo object into a dictionary representation. This can be used for serialization or saving configurations.

```python
server_data = server_info.to_dict()

```

--------------------------------

### Channel.kick()

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Removes a specified user from this channel.

```APIDOC
## Channel.kick(user)

### Description
Kick a user from this channel.

### Method
Kick User

### Endpoint
Not applicable (method call)

### Parameters
- **user** (User | int) - Required - The user to kick.
```

--------------------------------

### download_file_by_id

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Downloads a remote file from a channel using its ID. Requires download permissions.

```APIDOC
## download_file_by_id

### Description
Downloads a remote file from a channel by its ID.

### Parameters
#### Path Parameters
- **channel_id** (int) - Required - The ID of the channel to download the file from.
- **file_id** (int) - Required - The ID of the file to download.
- **filepath** (str) - Required - The path to save the file to.

### Raises
- **PermissionError** - If the bot does not have permission to download files.
```

--------------------------------

### move_user

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Moves a specified user to a different channel. Requires move permissions.

```APIDOC
## move_user

### Description
Moves a user to a channel.

### Parameters
#### Path Parameters
- **user** (User | int) - Required - The user to move.
- **channel** (Channel | int) - Required - The channel to move the user to.

### Raises
- **PermissionError** - If the bot does not have permission to move users.
- **TypeError** - If the user or channel is not a subclass of User or Channel.
```

--------------------------------

### Unsubscribe from Channel Subscription

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Unsubscribes from a given subscription for all users within this channel.

```python
channel.unsubscribe(_subscription_)
```

--------------------------------

### User Status Modes

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Represents the online status of a user. Used with the change_status method.

```python
UserStatusMode.ONLINE

```

```python
UserStatusMode.AWAY

```

```python
UserStatusMode.QUESTION

```

--------------------------------

### get_user

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Retrieves a user object by their ID.

```APIDOC
## get_user

### Description
Gets a user by its ID.

### Parameters
* **user_id** (int) - The ID of the user to get.

### Returns
* **User** - The user object.

### Return Type
TeamTalkUser
```

--------------------------------

### Channel.send_message()

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Sends a message to the specified channel. Additional keyword arguments can be passed for more advanced message options.

```APIDOC
## Channel.send_message(content, **kwargs)

### Description
Send a message to the channel.

### Method
Send Message

### Endpoint
Not applicable (method call)

### Parameters
- **content** (str) - Required - The message to send.
- ****kwargs** - Optional - Keyword arguments. See teamtalk.TeamTalkInstance.send_message for more information.

### Raises
- **PermissionError**: If the bot is not in the channel and is not an admin.
```

--------------------------------

### Update Channel Information

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Use this method to update the name of a channel. Ensure the bot has the necessary permissions before attempting an update.

```python
>>> channel = teamtalk.get_channel(1)
>>> channel.name = "New Channel Name"
>>> channel.update()

```

--------------------------------

### get_channel

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Retrieves a specific channel on the server by its ID.

```APIDOC
## get_channel

### Description
Gets the channel with the specified ID.

### Parameters
* **channel_id** - The ID of the channel.

### Returns
The teamtalk.Channel instance representing the channel with the specified ID.
```

--------------------------------

### Enable Voice Transmission

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Enables or disables voice transmission for the instance.

```APIDOC
## enable_voice_transmission(_enabled_)

### Description
Enables or disables voice transmission state for this instance.

### Parameters
* **enabled** (_bool_) - True to enable voice transmission, False to disable it.

### Returns
* **bool** - True if the SDK call was successful, False otherwise.
```

--------------------------------

### leave_channel

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Leaves the currently joined channel.

```APIDOC
## leave_channel

### Description
Leaves the current channel.

### Endpoint
leave_channel()
```

--------------------------------

### get_channel_files

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Retrieves a list of all remote files within a specified channel.

```APIDOC
## get_channel_files

### Description
Gets a list of remote files in a channel.

### Parameters
#### Path Parameters
- **channel_id** (int) - Required - The ID of the channel to get the files from.

### Returns
- **List[RemoteFile]** - A list of remote files in the channel.
```

--------------------------------

### TeamTalkBot Class

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Methods for interacting with the TeamTalk bot, including event handling and server management.

```APIDOC
## TeamTalkBot

### Description
Represents a TeamTalk bot client.

### Methods

#### `TeamTalkBot.event()`

##### Description
Decorator to register an event handler.

#### `TeamTalkBot.__init__()`

##### Description
Initializes the TeamTalkBot.

#### `TeamTalkBot.add_server()`

##### Description
Adds a TeamTalk server to the bot.

#### `TeamTalkBot.run()`

##### Description
Starts the bot and connects to the servers.

#### `TeamTalkBot.on_error()`

##### Description
Callback for handling errors.
```

--------------------------------

### Subscription Class

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

A class representing subscriptions in TeamTalk. This class is used for managing subscription-related functionalities.

```APIDOC
## class _teamtalk.subscription.Subscription

A class representing subscriptions in TeamTalk.
```

--------------------------------

### Miscellaneous Events

Source: https://teamtalkpy.readthedocs.io/en/latest/events.html

Events related to the bot's general operation and error handling.

```APIDOC
## Missellaneous Events

Miscellaneous Events

on_ready | None | Called when the bot is started and ready to accept events.
on_error | event_name (str), *args (Any), **kwargs (Any) | Called when another event errors. Has a default implementation
```

--------------------------------

### Register an Event Listener

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Use the @event decorator to register a coroutine function to listen for specific events. The decorated function must be a coroutine.

```python
@client.event
async def on_ready():
    print('Ready!')

```

--------------------------------

### Send Message to Channel

Source: https://teamtalkpy.readthedocs.io/en/latest/api.html

Sends a message to a specific channel. The bot must be in the channel or have admin privileges to send messages.

```python
channel.send_message(_content : str_, _** kwargs_)
```
Tokens:
Raw