davidl/IPTV-Restream
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: add tv playlist description

Browse Source
This commit is contained in:
antebrl
2025-01-19 14:21:37 +00:00
parent a5d42685ae
commit ca7c1dcdb5
2 changed files with 13 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -15,6 +15,7 @@
- [x] **Share your iptv access** without revealing your actual stream-url (privacy-mode) and watch together with your friends.
## ✨ Features
**IPTV Player** - IPTV web player with support for any other iptv players by exposing the playlist.
**Restream / Proxy** - Proxy your iptv streams through the backend. <br>
**Synchronization** - The selection and playback of the stream is perfectly synchronized for all viewers. <br>
**Channels** - Add multiple iptv streams and playlists, you can switch between. <br>
@@ -84,6 +85,13 @@ Which streaming mode should I choose for the channel?
> Proxy mode is most likely the mode, you will use! You will need restream mode especially when your iptv playlist has no programDateTime set and you want to have playback synchronization.
---
How can I use the channels on any other iptv player (e.g. on TV)?
> Please click on the 📺 (TV-button) in the top-right in the frontend. There you'll find the playlist you have to use in any other iptv player.
> This playlist contains all your channels and one **CURRENT_CHANNEL**, which forwards the content of the currently played channel.
> If this playlist does not work, please check if the base-url of the channels in the playlist is correct and set the `BACKEND_URL` in the `docker-compose.yml` if not.
---
My playlist only supports xtream codes api!
> [IPTV playlist browser](https://github.com/PhunkyBob/iptv_playlist_browser) allows you to export a m3u playlist from your xtream codes account, and let's you select single channels or the whole playlist. Official xstreams-code integration is planned!

13
backend/README.md
View File

@@ -72,15 +72,12 @@ To use together with the frontend, [run with docker](../README.md#run-with-docke
- users: `user-connected` and `user-disconnected`
## ℹ️ Usage without the frontend (with other iptv player)
If you want to watch the current stream in any other IPTV player e.g. on tv, there will be a central m3u link provided in the near future. Watch the [progress of this feature](https://github.com/antebrl/IPTV-Restream/issues/24).
You can use all the channels with any other IPTV player. The backend exposes a **M3U Playlist** on `http://your-domain/api/channels/playlist`. You can also find it by clicking on the TV-button on the top right in the frontend!
If this playlist does not work, please check if the base-url of the channels in the playlist is correct and set the `BACKEND_URL` in the `docker-compose.yml` if not.
This playlist contains all your channels and one **CURRENT_CHANNEL**, which forwards the content of the currently played channel.
If you can't wait, these are your options to watch from other IPTV players right now:
- You can use the [ProxyController](#ProxyController) standalone. Just use `{baseUrl}/proxy/channel` in your iptv player. It is also possible to watch different channels simultaneously by setting the expected query parameters: `url` (and `headers` if needed).
- Use `/streams/{currentChannelId}/{currentChannelId}.m3u` to watch the current playing restream!
- [ChannelController](#ChannelController) endpoints should be used to manage the channels. If you just want to have static channels, you can also set them directly in the [ChannelService.js](./services/ChannelService.js).
- [WebSocket](#WebSocket) is only used by the frontend for chat and channel updates. You likely won't need it!
To modify the channel list, you can use the frontend or the [api](#channelcontroller).
> [!NOTE]
> These options are only tested with VLC media player as other iptv player. Use them at your own risk. Only for the usage together with the frontend will be support provided. <br>
> Support for a central m3u link for other players will be provided soon!
> These options are only tested with VLC media player as other iptv player. Use them at your own risk. Only for the usage together with the frontend will be support provided.