minster586/RadioDJViewer
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 4 Wiki Activity

Added some endpoint

Browse Source 
I added some endpoints but they were already in there but I wanted them documented
This commit is contained in:
minster586
2026-04-13 00:46:48 -04:00
parent ca20267307
commit e73176f806
1 changed files with 21 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
README.md
View File

@@ -1,6 +1,6 @@
# RadioDJViewer v1.8.0
**RadioDJViewer** is a Windows Forms application designed to display song information and album art from a RadioDJ REST API. It bridges the gap between your automation software and your broadcast visuals by serving data to physical local files and a built-in network web server simultaneously.
**RadioDJViewer** is a high-performance Windows application designed to bridge the gap between RadioDJ and your broadcast visuals. It fetches live "Now Playing" data from the RadioDJ REST API and serves it simultaneously to physical local files and a built-in network web server.
## 🚀 New in v1.8.0: The Web Update
* **Integrated Web Server:** Hosts a live, high-performance web widget for OBS Browser Sources.
@@ -18,31 +18,35 @@
* Supports multiple profiles for different RadioDJ instances.
* Auto-regenerates missing `profiles.json` and fallback images.
## 🌐 Web API Endpoints
Once the server is active (Blue Status), you can access the following data URLs locally or over your network:
| Resource | URL (Localhost) | Purpose |
| :--- | :--- | :--- |
| **Main Widget** | `http://127.0.0.1:8181/` | Loads the full HTML/CSS/JS widget for OBS. |
| **Song Title** | `http://127.0.0.1:8181/title.txt` | Returns the raw text of the current song. |
| **Artist Name** | `http://127.0.0.1:8181/artist.txt` | Returns the raw text of the current artist. |
| **Album Art** | `http://127.0.0.1:8181/Album-Art.png` | Serves the current album art image bytes. |
*Note: Replace `127.0.0.1` with your computer's local IP address to access these from other devices.*
## 📋 Requirements
* Windows 7 or later.
* .NET Framework 4.7.2.
* RadioDJ with **REST Server Plugin** enabled and accessible.
* RadioDJ with the **REST Server Plugin** enabled and accessible.
## 🔧 Installation & Setup
1. Download the release ZIP and extract all files.
2. Ensure `RadioDJViewer.exe`, `Newtonsoft.Json.dll`, and `RadioDJViewer.exe.config` are present.
3. **Run `RadioDJViewer.exe` as Administrator** (Required for the Web Server to bind to your network port).
4. Configure your profile (IP, Port, Password, and Output Folder).
5. Click **Connect**. When the status box turns **Blue**, your web server is live.
1. **Download & Extract:** Run the `RadioDJViewer.exe`.
2. **Run as Administrator:** This is required for the Web Server to bind to your network port.
3. **Configure API:** Enter your RadioDJ IP, Port, and Auth Key in the settings.
4. **Set Output:** Choose a folder for your physical text and image files (e.g., `H:/RDJ-Output/`).
5. **Connect:** Click **Connect**. Your status box should turn **Blue** when everything is active.
## 🌐 Web Widget & Network Setup
### **Using in OBS**
Add a **Browser Source** in OBS using the URL: `http://localhost:8181`. You can customize the look using the "Custom CSS" box in the OBS properties.
### **Network Verification (Firewall)**
## 🌐 Network & Firewall Setup
To access the widget from another device (like a phone or second PC), you must open a port in the Windows Firewall:
1. Open **Windows Firewall with Advanced Security**.
2. Create a **New Inbound Rule** -> **Port** -> **TCP**.
3. Enter Port **8181** and select **Allow the connection**.
4. Access on your phone via: `http://{your-pc-ip}:8181`.
## 📂 URL Variables
The URL format follows the RadioDJ standard: `http://{ip}:{port}/np?auth={password}`. Ensure `{ip}`, `{port}`, and `{password}` are correctly entered in the profile settings, or the program will be unable to parse the API data.
3. Enter Port **8181** (or your chosen port) and select **Allow the connection**.
## 📝 Project Background
This project was born from a desire to move away from purely web-based external tools and create a native Windows utility for stream overlays. Special thanks to [Roderick's RadioDJ Tutorials](https://www.youtube.com/@RodericksRadioDJTutorials) for the inspiration and initial logic concepts.