Overlay URLs

How an overlay's browser-source URL is built, every route and widget ID, and how copies and LAN keys fit in

Every overlay is a web page on Vfinity's own server that OBS, or TikTok LIVE Studio, opens as a browser source. This page takes its URL apart.

Try it

Copy the OBS browser source URL

Pick a widget and see the address its Copy URL button gives you.

Widget

http://127.0.0.1:21424/#overlay-goal?id=goal1&lang=en

http://127.0.0.1:21424/#overlay-goal?id=goal1&lang=en

The overlay server on this PChttp://127.0.0.1:21424
Which widget#overlay-goal
Which one of its kind?id=goal1
Language, pinned to the app’s&lang=en

Pick a widget and a copy to see its URL, with each part labelled. Try it above.

The parts of a URL

http://127.0.0.1:21424/#overlay-goal?id=goal1&copy=copy_lx4k2a9fz&lang=en

Part	Example	What it is
Address	`127.0.0.1`	This PC. With LAN access on, this PC's network address
Port	`21424`	The overlay server's port. If it is busy, Vfinity picks another
Access key	`?token=…`, before the `#`	Only with LAN access on
Route	`#overlay-goal`	Which kind of widget the page draws
`id`	`goal1`	Which widget of that kind, for routes that hold several
`copy`	`copy_lx4k2a9fz`	Which copy of the widget; left out for the original
`lang`	`en`	The language the page draws its own words in: `en`, `th`, `zh`, `ja`, `hi` or `es`

Copy URL on a widget, or Copy OBS URL in its right-click menu, builds all of this for you, with the port the server really opened and your app language. Copy from there rather than typing a URL.

Route	Widget
`#overlay-chat`	Chat Box
`#overlay-alerts`	Alerts
`#overlay-events`	Events Board
`#overlay-timer`	Countdown Timer
`#overlay-buddies`	Viewer Buddies
`#overlay-actions`	Actions media, which shows the media of Show an image or video steps
`#overlay-custom`	Custom Widget
`#overlay-clock`	Clock and Countdown
`#overlay-scene`	Scene Card
`#overlay-checklist`	Checklist

The widgets new in Alpha 0.4.0 follow the same pattern, so the Clock and Countdown's address looks like http://127.0.0.1:21424/#overlay-clock?lang=en, and a copy of the Scene Card's like http://127.0.0.1:21424/#overlay-scene?copy=copy_lx4k2a9fz&lang=en.

Routes with an ID

Route	`id` values
`#overlay-stat`	`viewerCount`, `followerCount`, `streamClock`, `giftCounter1` to `giftCounter3`, `statLabel1` to `statLabel3`
`#overlay-leaderboard`	`topGifter`, `topLiker`, `topStreaker`, `topChatter`, `pointsRanking`, `credits`
`#overlay-goal`	`goal1` to `goal4`
`#overlay-feed`	`giftFeed`, `diamondTicker`, `lastGifter`, `lastFollower`, `lastLiker`, `lastSharer`, `lastChatter`, `lastSubscriber`, `lastJoiner`
`#overlay-gauge`	`coinJar`, `streamBoss`
`#overlay-particles`	`giftCannon`, `likeFountain`, `giftFirework`, `fallingSnow`, `emojify`, `emoteWall`, `confetti`
`#overlay-media`	`staticText`, `staticImage`, `videoPlayer`, `socialRotator`, `sponsorBanner`
`#overlay-frame`	`webcamFrame`, `overlayFrame`, `talkingBanner`
`#overlay-games`	`giftJar`, `wheel`, `poll`, `viewerQueue`, `giveaway`, `tugOfWar`, `hypeMeter`

Overlay widgets names each one and lists its settings.

Sources that are not widgets

Route	What it is
`#throwing`	The throwing scene: gifts thrown at your model. Copy it from the Throwing tab
`#overlay-audio`	An invisible source that plays text to speech set to play in OBS

Adding #overlay-audio twice is safe: only one copy plays. To use it in several scenes, add the one source to each scene with Add Existing.

Copies

Add copy makes a second, independent version of a widget with its own settings and its own URL, which ends in copy= and the copy's ID.

Limit	Value
Copies across all widgets	16
A copy's name	Up to 60 characters
Widgets that cannot be copied	Alerts

A copy keeps the original's id, so the page knows which widget it is. When you delete a copy, its OBS source goes blank rather than showing the original twice.

OBS on another PC

Turn on Let OBS on another PC use these overlays in SettingsConnectionsLocal server and restart Vfinity. Copy URL then gives this PC's network address with an access key:

http://192.168.1.5:21424/?token=YOUR_KEY#overlay-chat?lang=en

The key sits before the # because the server has to see it on the first request. Anything on your network without the key is refused, and so is anything from outside your network. New access key retires every URL that carries the old one, so copy each URL into OBS again afterwards.