Skip to content

Control OBS with Reveal JS

UUoocl edited this page Jan 27, 2025 · 1 revision

Control OBS with Reveal JS Slides

Setup Obsidian

Download and Install Obsidian and the required Community Plugins.

How to use Obsidian UUhimsy Plugin

Connect to OBS

In the UUhimsy settings tab, configure the OBS launch parameters. The settings will be used in the "Open OBS" command.

image

OBS WebSocket Server (WSS) Settings

Settings Value
IP 'localhost' or the host machines IP
PORT default 4455.
Password set a secure password.

OBS Launch Parameters

Settings Value
Name If multiple instances of OBS are installed enter the custom OBS name.
Folder Path Windows Only. Enter the Folder Path to the OBS executable
Collection Enter an OBS Scene Collection name
OBS Debug Port OBS Browser Sources can be debugged at https://localhost:{Port}. Default Port = 9222

Open OBS

The UUhimsy Plugin features a command to open OBS.

Open the command palette and enter "Open OBS"

image

OBS should launch with the choosen parameters

Create Slide Tags

UUhimsy uses slide tags to automate actions when a slide transitions. For example, use a slide to change scenes in OBS when a slide transition starts.

In the UUhimsy settings, click the "Add UUhimsy scripts to Slides Extended Template" button.

Slide tags are created with commands. Open the Command Palette and choose a UUhimsy action.

Slide tag Command Notes
OBS Scenes "Get OBS Scene tags" - A tag is made for each Scene starting with "scene|||" and
- A tag is made for each Source in the "Input Camera" scene
Apple Shortcut "Get Apple Shortcuts Tags" - A tag is made for each Shortcut starting with "uuhimsy". MacOS only feature.
USB Camera: Pan, Tilt, Zoom "Start sending camera PTZ position to OBS" The utility application UVC-Util is included to retrieve Pan, Tilt, Zoom (PTZ) data from USB PTZ cameras.
MacOS only feature.
ZoomOSC "Start OSC to OBS Websocket connection" ZoomOSC is a client by Zoom with an OSC interface. UUhimsy includes an OSC to WebSocket interface.

Insert a Slide Tags

In a Slides Extended slide, position the cursor above the slide break indicator "---". Open the command palette, and choose "Insert slide exit tag" or "Insert slide entrance tag".

[!NOTE] Tag Types 'Exit' tags run when a slide transition starts 'Entrance' tags run when a slide transition ends

After choosing to insert a tag, then a list of tags appear in the command palette. Select the tag to insert

Setup OBS

Download OBS and the required plugins.

Note

macOS Installing plug-in note:

  1. After Downloading a plug-in, expand the .zip file and in the expanded folder click to open the installer for your Mac.
  2. A warning will appear that Apple could not verify the plug-in. Click the "Done" button

image

  1. Go to System Settings,
    1. choose Privacy & Security settings.
    2. scroll to the bottom of the settings page.
    3. click "Open Anyway"

image

Get User Media

In Obsidian, use the Templater command "Open insert template modal". In the modal window select "Open Get User Media Page"

This will open the "Get User Media Page" using the Slides Extended local server.

Using Get User Media Page