> Direct web renderer output from SPX SPX [[Documentation/Renderer/Overview|renderer]] is accessible at `/renderer` URL and supports additional parameters for specialized workflows. In typical use (such as 16:9 single renderer production), these can be safely ignored. --- ## Base Renderer URL ``` http://localhost:5656/renderer ``` ## Supported Parameters | Parameter | Datatype | Example | Description | |-----------|----------|---------|-------------| | `layers` | Array of numbers | `[1,2,3,4,20]` | Filter which [[Documentation/Renderer/Layers|layers]] are rendered | | `preview` | Boolean | `true` | Mark renderer as [[Documentation/Renderer/Preview & Program|preview]] renderer | | ~~`width`~~ | ~~integer~~ | ~~`1920`~~ | Removed in 1.3.0 | | ~~`height`~~ | ~~integer~~ | ~~`1080`~~ | Removed in 1.3.0 | | `fps` | number | `50` or `29.97` | FPS value passed to templates | ### Layers Parameter Filter which layers are rendered in this renderer instance. **Example:** ``` http://localhost:5656/renderer/?layers=[2,4,20] ``` This will only render layers 2, 4, and 20, hiding all other layers. **Use cases:** - Multiple renderers showing different content - Separating presenter graphics from lower thirds - Creating different outputs for different screens ### Preview Parameter Mark a renderer as a preview renderer. Preview renderers are controlled by the `general.preview` setting in [[Documentation/Server/Configurations|configuration]]. **Example:** ``` http://localhost:5656/renderer/?preview=true ``` **Behavior:** - When `preview=selected`: Preview plays when focus changes on [[Documentation/Graphics Controller/Rundown Settings|rundown]] - When `preview=none`: Preview is not triggered - Preview renderers don't affect main playout ### FPS Parameter FPS value is passed to [[Documentation/Graphic Templates/Overview|templates]] but none of the official templates uses this property at all. **Example:** ``` http://localhost:5656/renderer/?fps=50 ``` The value is stored to `window.top.spxRenderer.fps` global variable of the renderer. Utilization requires support from the templates themselves. > [!warning] `fps` parameter value is stored to `window.top.spxRenderer.fps` global variable of the renderer and its utilization requires support from the templates themselves. This value IS NOT USED by any templates at the moment developed by SPX Graphics. ### Width and Height (Removed) The `width` and `height` parameters were removed in v1.3.0 as [[Documentation/Graphics Controller/Application Configuration|Application Configuration]] now supports `AUTO` sizing mode that will adjust renderer size to match dimensions of the holding viewport, such as browser size settings in OBS or similar software. Use `general.resolution` in configuration instead: - `HD` = 1920 x 1080 pixels - `4K` = 3840 x 2160 pixels - `AUTO` = Full browser viewport size ## Example URLs ### Standard Single Renderer ``` http://localhost:5656/renderer ``` ### Multiple Layers Only ``` http://localhost:5656/renderer/?layers=[2,3] ``` ### Preview Renderer ``` http://localhost:5656/renderer/?preview=true ``` ### Combined Parameters ``` http://localhost:5656/renderer/?layers=[2,4,20]&preview=true&fps=50 ``` ### Vertical HD-Ready Screen Example for a vertical screen showing only layers 2 and 3 at 15 fps: ``` http://localhost:5656/renderer/?layers=[2,3]&fps=15 ``` > [!note] The old `width` and `height` parameters are no longer supported. Use browser/viewport sizing or configuration [[Documentation/Renderer/Resolutions|resolution]] settings instead. ## Layer Numbers Layers are numbered from 1 to 20: - **Layer 1** - Backmost (furthest from camera) - **Layer 20** - Frontmost (closest to camera) Higher numbered layers appear on top of lower numbered layers. ## Use Cases ### Multiple Presenters Different renderers for different presenters: - Presenter 1: `http://localhost:5656/renderer/?layers=[1,2,3]` - Presenter 2: `http://localhost:5656/renderer/?layers=[4,5,6]` - Shared graphics: `http://localhost:5656/renderer/?layers=[20]` ### Preview and Program - Program output: `http://localhost:5656/renderer` - Preview output: `http://localhost:5656/renderer/?preview=true` ### Video Wall Setup Different screens showing different layers: - Screen 1 (Main): `http://localhost:5656/renderer/?layers=[1,2,3,4,5]` - Screen 2 (Stats): `http://localhost:5656/renderer/?layers=[10,11,12]` - Screen 3 (Clock): `http://localhost:5656/renderer/?layers=[20]` ## Integration with Production Software ### OBS Add as Browser Source: 1. Add Source → Browser 2. URL: `http://localhost:5656/renderer/?layers=[1,2,3]` 3. Width: 1920, Height: 1080 (or use AUTO resolution) ### vMix Add as Web Browser input: 1. Add Input → Web Browser 2. Address: `http://localhost:5656/renderer/?layers=[1,2,3]` ### CasparCG Renderer parameters don't apply to [[Documentation/Renderer/Workflows/CasparCG - AMCP|CasparCG]] playout, as CasparCG uses its own layer system. --- # Read Next - [[Documentation/Renderer/Workflows/Live Streaming Software|Live Streaming Software]] - Using SPX with OBS, vMix, etc. - [[Documentation/Graphic Templates/Overview|Graphic Templates Overview]] - How templates use layers - [[Documentation/Graphics Controller/Application Configuration|Application Configuration]] - General configuration - [[Documentation/Renderer/Overview|Renderer Overview]] - Understanding SPX rendering