Telegram RTMPS Voice Chat music streaming engine (educational, non-commercial)
Project description
RTMPS
RTMPS is a high-performance Telegram Voice Chat music streaming engine built using Telethon and FFmpeg, designed specifically for RTMPS-based voice chats.
It supports multiple Telegram groups simultaneously, each with its own RTMPS stream, queue, and FFmpeg process, while preserving a clean and informative user experience.
✨ Features
- 🎧 Stream music to Telegram Voice Chats via RTMPS
- 🧩 Multi-group support
- Different chats
- Different songs
- Different queues
- Different FFmpeg processes
- 🔐 Secure global configuration via CLI
- ⚙️ Per-chat RTMPS setup using
/setup - 📥 Smart queue management with preloading
- 🔁 Loop, shuffle, skip, clear queue
- 🕊️ Informative status messages (Downloading…, Added to queue, etc.)
- 🚀 Built as a real PyPI package, not a raw script
📦 Installation
pip install rtmps
⚠️ FFmpeg is required and must be available in your system PATH.
🔧 Global Configuration (One-Time)
Run the configuration wizard:
rtmps-config
You will be asked for:
API_ID
API_HASH
BOT_TOKEN
Session name (optional)
Configuration is stored at:
~/.rtmps/config.json
▶️ Start the Bot
rtmps
Expected output:
🎵 RTMPS running
🔑 Per-Chat Setup (Required)
Each Telegram group or channel must configure its own RTMPS stream.
Inside the target chat:
/setup
Follow the prompts:
-
Send RTMPS URL
-
Send RTMPS Stream Key
Example:
/setup
rtmps://dc5-1.rtmp.t.me/s/
AOV1a58_FgtC2oPzneeehUg
Configuration is stored per chat, allowing unlimited simultaneous streams.
🎵 Music Commands
All commands operate independently per chat.
▶️ Play (reply-based)
Reply to an audio file:
*play
If music is already playing, the track is added to the queue.
⏭️ Skip
*skip
Skips the current track and plays the next one (if available).
📜 Queue
*queue
Shows:
Currently playing track
Up to 10 upcoming tracks
Remaining count (+ n more)
🔀 Shuffle Queue
*shuffle
🔁 Loop Current Track
*loop current <n>
Example:
*loop current 3
🧹 Clear Queue
*clearqueue
(Current track continues playing.)
🧠 Architecture Overview
Telethon for Telegram MTProto communication
-
FFmpeg for RTMPS audio streaming
-
One player per chat
-
One FFmpeg process per chat
-
Fully asynchronous, non-blocking design
-
Restart-safe configuration storage
📁 Configuration Files
├── config.json # Global Telegram credentials
└── chats.json # Per-chat RTMPS configuration
🚧 Roadmap
*stream <profile> support
Song metadata via info.json
-
Admin-only permissions
-
Persistent queue resume after restart
-
FFmpeg crash auto-recovery
-
Optional web dashboard
🛡️ Requirements
-
Python 3.8+
-
FFmpeg
-
Telegram bot with voice chat permissions
-
RTMPS-enabled voice chat
📜 License
PolyForm Noncommercial License © 2026
Ankit Chaubey
Educational and non-commercial use only.
🔗 Links
- GitHub: https://github.com/ankit-chaubey/rtmps
- Issues: https://github.com/ankit-chaubey/rtmps/issues
📬 Contact
For educational, non-commercial use, questions, or feedback:
- GitHub: @ankit-chaubey
- Email: Write Me
- Telegram: @ankify
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file rtmps-0.1.1.tar.gz.
File metadata
- Download URL: rtmps-0.1.1.tar.gz
- Upload date:
- Size: 11.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c0d3241f6e564a1c5b3a7925f34db2e2cce3153e72d555e6df4d2b562a25f2cf
|
|
| MD5 |
c2b7ceb65af41598da1eaab8725f736b
|
|
| BLAKE2b-256 |
0b284683ba5bbcd8721e609c32e9a54ea653163f73c004360bf1ede4a41ef5d6
|
Provenance
The following attestation bundles were made for rtmps-0.1.1.tar.gz:
Publisher:
publish.yml on ankit-chaubey/RTMPS
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
rtmps-0.1.1.tar.gz -
Subject digest:
c0d3241f6e564a1c5b3a7925f34db2e2cce3153e72d555e6df4d2b562a25f2cf - Sigstore transparency entry: 790780269
- Sigstore integration time:
-
Permalink:
ankit-chaubey/RTMPS@6361d2d1bcb161d51b9131cc3347f3c4c18cf8b9 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/ankit-chaubey
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@6361d2d1bcb161d51b9131cc3347f3c4c18cf8b9 -
Trigger Event:
workflow_dispatch
-
Statement type:
File details
Details for the file rtmps-0.1.1-py3-none-any.whl.
File metadata
- Download URL: rtmps-0.1.1-py3-none-any.whl
- Upload date:
- Size: 10.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
72baac4d41a264f1bc8a7608655e50b5b9286af5220448c72360221b1be059a3
|
|
| MD5 |
f8a2c5cc43a47ba132b88f2868fab49f
|
|
| BLAKE2b-256 |
3afbfcbfea8e89dee92dd9bbff278e3310d692fbb51ea496ebe6adcf4956088f
|
Provenance
The following attestation bundles were made for rtmps-0.1.1-py3-none-any.whl:
Publisher:
publish.yml on ankit-chaubey/RTMPS
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
rtmps-0.1.1-py3-none-any.whl -
Subject digest:
72baac4d41a264f1bc8a7608655e50b5b9286af5220448c72360221b1be059a3 - Sigstore transparency entry: 790780273
- Sigstore integration time:
-
Permalink:
ankit-chaubey/RTMPS@6361d2d1bcb161d51b9131cc3347f3c4c18cf8b9 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/ankit-chaubey
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@6361d2d1bcb161d51b9131cc3347f3c4c18cf8b9 -
Trigger Event:
workflow_dispatch
-
Statement type: