URL/API Source - OBS Plugin

Introduction

The URL/API Source is a plugin for OBS Studio that allows users to add a media source that fetches data from a URL or API endpoint and displays it as text. OBS Forums page | Blog post

If this free plugin has been valuable to you consider adding a ⭐ to this GH repo, rating it on OBS, subscribing to my YouTube channel where I post updates, and supporting my work: https://github.com/sponsors/royshil

Usage Tutorials

Watch quick tutorials on how to use and setup the URL/API source on your OBS scene.

https://youtu.be/E_UMNIfgR5w & https://youtu.be/hwHgNcPJEfM & HTML Scraping Tutorial (18 min)

AI on OBS Tutorials

Bring AI to your OBS! Be a x10 streamer and content creator with AI tools:

Inspiration

Out of ideas on what to do with URL/API Source? Here's a repo with 1,000s of public APIs https://github.com/public-apis/public-apis

Dynamic Templating

The URL source supports both input and output templating using the Inja engine.

Output templates include {{output}} in case of a singular extraction from the response or {{output1}},{{output2}},... in case of multiple extracted value. In addition the {{body}} variable contains the entire body of the response in case of JSON. Advanced output templating functions can be achieved through Inja like looping over arrays, etc.

The input template works for the URL (querystring or REST path) or the POST body

Use the {{input}} variable to insert the output from a Text source. Inja advanced templates are available too. A special function strftime is available for formatting the current time using conventions from C++ STL (strftime), as well as urlencode which is useful for dynamic input in the querystring.

Code Walkthrough

Watch an explanation of the major parts of the code and how they work together.

https://youtu.be/TiluUg1LxcQ

Features:

• HTTP request types: GET, POST
• Request headers (for e.g. API Key or Auth token)
• Request body for POST
• Output parsing: JSON via JSONPointer & JSONPath, XML/HTML via XPath & XQuery, Regex and CSS selectors
• Update timer for live streaming data
• Test of the request to find the right parsing
• Output styling (font, color, etc.) and formatting (via regex post processing)
• Image output (via URL)
• Output to external Text Source
• Multi-value (array, union) parsed output capture, object unpacking (via Inja)
• Support binary output (Image, Audio)

Coming soon:

• Authentication (Basic, Digest, OAuth)
• Websocket support
• More parsing options (CSV, etc.)
• More request types (HTTP PUT / DELETE / PATCH, and GraphQL)
• More output formats (Markdown, slim, reStructured, HAML, etc.)
• Output to more built-in OBS sources (Image, etc.)

Check out our other plugins:

• Background Removal removes background from webcam without a green screen.
• 🚧 Experimental 🚧 CleanStream for real-time filler word (uh,um) and profanity removal from live audio stream
• LocalVocal speech AI assistant plugin for real-time, local transcription (captions), translation and more language functions
• Polyglot translation AI plugin for real-time, local translation to hunderds of languages

If you like this work, which is given to you completely free of charge, please consider supporting it on GitHub: https://github.com/sponsors/royshil

Download

Check out the latest releases for downloads and install instructions.

Building

The plugin was built and tested on Mac OSX (Intel & Apple silicon), Windows and Linux.

Start by cloning this repo to a directory of your choice.

Mac OSX

Using the CI pipeline scripts, locally you would just call the zsh script. By default this builds a universal binary for both Intel and Apple Silicon. To build for a specific architecture please see .github/scripts/.build.zsh for the -arch options.

$ ./.github/scripts/build-macos -c Release

Install

The above script should succeed and the plugin files (e.g. obs-urlsource.plugin) will reside in the ./release/Release folder off of the root. Copy the .plugin file to the OBS directory e.g. ~/Library/Application Support/obs-studio/plugins.

To get .pkg installer file, run for example

$ ./.github/scripts/package-macos -c Release

(Note that maybe the outputs will be in the Release folder and not the install folder like pakage-macos expects, so you will need to rename the folder from build_x86_64/Release to build_x86_64/install)

Linux (Ubuntu)

Use the CI scripts again

$ ./.github/scripts/build-linux.sh

Copy the results to the standard OBS folders on Ubuntu

$ sudo cp -R release/RelWithDebInfo/lib/* /usr/lib/x86_64-linux-gnu/
$ sudo cp -R release/RelWithDebInfo/share/* /usr/share/

Note: The official OBS plugins guide recommends adding plugins to the ~/.config/obs-studio/plugins folder.

Windows

Use the CI scripts again, for example:

> .github/scripts/Build-Windows.ps1 -Target x64 -CMakeGenerator "Visual Studio 17 2022"

The build should exist in the ./release folder off the root. You can manually install the files in the OBS directory.