Documentation — StreamFX

⚡ Quick start

New here? This is the five-minute path from signup to a live overlay.

Create your account Sign up and your 7-day Pro trial starts immediately — every feature unlocked.

Open Dashboard → Playout Pick your connection method (PUSH for DJ software on your PC, PULL for a radio stream) and follow the built-in wizard — it shows the exact settings for your software.

Send a test track Use the "Send Test Track" box on the same page to confirm tracks arrive and your overlay springs to life.

Add your overlays Copy each overlay URL into OBS / TikTok LIVE Studio as a Browser Source (sizes below). That's it — you're live! 🎉

💡

Tip: every overlay URL is personal to your account (it contains your token). If you ever think someone else is using your links, hit Regenerate Token on the Playout page and update your software.

📤 Push mode (DJ software)

Push mode sends each track to StreamFX the moment it plays. Your personal URL looks like this (copy the exact one from Dashboard → Playout):

…/push.php?token=YOUR_TOKEN&artist=ARTIST&title=TITLE

Setup per software

Software	Where to paste the URL	Template
PlayIt Live	Tools → Now Playing → Add New → URL / HTTP Request (GET)	`&artist={{artist}}&title={{title}}`
RadioDJ	Options → Stream Titles → Web Export (enable, GET)	`&artist=$artist$&title=$title$`
mAirList	Configuration → Logging → Add → HTTP GET	`&artist=%a&title=%t`
SAM Broadcaster	Config → HTML Output → HTTP call	`&artist=$artist$&title=$title$`
StationPlaylist	Options → Now Playing → URL	`&artist=%a&title=%t`
ProppFrexx	Events → Streaming.OnSongTitleChanged → EXEC_SEND_HTTP_GET	`&artist=${artist}&title=${title}`
AzuraCast	Webhooks → Generic Web Hook (Song Change)	Use the webhook URL as-is — we read the standard JSON body.
Serato / rekordbox / VirtualDJ / Traktor / Mixxx / anything that writes a file	Download the 1-Click File Watcher from the Playout page and leave it running	It watches `C:\NowPlaying\nowplaying.txt` and pushes every change automatically.

Blocklist: hiding jingles & station IDs

On the Playout page, add comma-separated keywords (e.g. Sweeper, Station ID, Advert). When a track matches, StreamFX keeps the previous song on screen instead.

📡 Pull mode (radio streams)

If you stream with Icecast, Shoutcast, AzuraCast or a plain MP3/AAC stream, StreamFX can read the track directly. Choose your type on Dashboard → Playout:

Direct audio stream (.mp3/.aac) — we read ICY metadata straight from the stream.
Icecast — point us at your status-json.xsl URL.
Shoutcast — your stats?json=1 or 7.html page.
JSON API — any public JSON (AzuraCast, Radio.co…) — you can even set which keys hold the artist and title.
Plain text — any URL that returns Artist - Title.

Always hit Test Connection after pasting the URL — it tells you exactly what we found before you go live.

⚠️

Public URLs only: the URL must be reachable from the internet (not a localhost or home-network address) — that's what your listeners see too.

🖥️ Adding overlays to OBS / TikTok LIVE Studio

Copy the overlay URL From your dashboard — each card has its own URL and a Copy button.

Add a Browser Source OBS: Sources → + → Browser. TikTok LIVE Studio: add a Web Page source. Streamlabs and vMix work the same way.

Paste the URL and set the size Match the recommended sizes below, tick "Shutdown source when not visible" off, and you're done.

Overlay	Recommended size	Where to find it
🎵 Now Playing	`650 × 160`	Dashboard → Playout
🎁 Gift Jar	`380 × 520`	Dashboard → Gift Jar & Likes
🙋‍♂️ Song Requests banner	`600 × 130`	Dashboard → Requests
🏆 Top Gifters	`520 × 230`	Dashboard → Top Gifters
❤️ Like Goal bar	`600 × 100`	Dashboard → Gift Jar & Likes

Overlays are transparent — they blend straight onto your stream background. Changes you make in the dashboard (theme, colours, pinned requests…) appear on stream within a few seconds automatically.

🎨 Themes & customisation

Dashboard → Themes lets you make the overlay yours:

30+ built-in themes across FX, Club & Rave, Retro and Glass categories, with a live preview.
Custom accent colours — override the theme's neon colours.
Custom font, corner radius, transitions (slide, flip, scale, fade) and an auto-hide timer that pops the card away after a track starts.
Custom fallback logo — upload your station logo to show whenever album art isn't found.

Album art is fetched automatically from iTunes for each track.

🎁 TikTok LIVE features

These are powered by the native StreamFX daemon — enter your @TikTok username once in Dashboard → Gift Jar & Likes and everything below runs automatically while you're live.

Gift Jar

Gifts drop into a real physics jar — choose a mason jar, cylinder, potion or trophy shape, plus your own neon colour, sound effects and confetti.
Set a coin goal to show progress to your audience; the jar celebrates when you hit it.

Song Requests

Viewers type !request Artist - Song (also !sr, !songrequest, !play) in chat, or use your bio page.
Requests queue in Dashboard → Requests: pin one to the overlay banner, mark played, or clear the list. Open/close requests any time with the toggle.
Recent gifters, subscribers and moderators get a gold ⭐ VIP badge on their request.

Like Goals & Leaderboards

Screen-tap likes fill your Like Goal bar — set the target and banner text in the dashboard.
The Top Gifters overlay ranks tonight's biggest gifters (podium or scrolling ticker), with an all-time hall of fame.

💡

Tip: your TikTok features need an active Pro plan or trial — that's how we keep the daemon running for you.

🔗 Your public bio page

Every streamer gets a public page (live.php?u=yourname) with the current track, recently played tracks, a like button and a song request form — perfect for your TikTok/Instagram bio.

Customise your tagline, avatar, social and tip links in Dashboard → Bio & Account.
Likes and requests from the bio page land in the same queue as chat requests.

💳 Billing, trials & cancelling

Free 7-day trial Every new account gets 7 days of Pro free — no card needed. A countdown in the dashboard header shows how long is left.

Subscribe Dashboard → Billing shows monthly and yearly options. Checkout is handled by Stripe — we never see your card.

Manage or cancel The same page has a "Manage Billing & Cancel" button which opens the secure Stripe portal — update cards, download invoices, or cancel. You keep Pro until the end of your paid period.

If a plan expires Overlays pause with a friendly "subscription expired" note and TikTok features stop — your account, settings and history stay safe. Resubscribe and everything switches back on instantly.

Prices are always shown live on the pricing section of the homepage.

🔧 Troubleshooting

Symptom	Fix
Overlay says "Waiting for track data"	No track has arrived yet. Send a test track (Playout page) or play a song in your DJ software. Pull mode: press Test Connection on your stream URL.
Overlay was working, now blank	Check your internet connection and that the overlay URL still contains your current token (did you regenerate it?). Re-paste the URL if needed.
Gift jar not filling	Confirm your @TikTok username in Gift Jar & Likes, that you're actually live, and that your plan/trial is active.
Requests not appearing	Check the requests toggle is set to OPEN on the Requests page, and that viewers are using the !request command format.
Album art is a vinyl disc	We couldn't find artwork for that track — usually live remixes or unreleased tracks. You can upload a custom fallback logo in Themes.
Pull mode shows the wrong song	Your stream's metadata may include jingles — add them to the Blocklist so the previous real track stays on screen.

Still stuck? The FAQ covers the common questions, and your site admin can reset passwords, regenerate tokens and check your account.