OSC API

H2R Graphics can be controlled by OSC (Open Sound Control).

IP address and Port

By default, H2R Graphics is running on 127.0.0.1, port 8181. Send all your OSC commands to that address.

You can change the IP address and the port in the settings tab.

API

Below is a full list of currently supported OSC messages and the configurations needed.

Clear all graphics

Type: OSC Message without arguments

Path: /h2r-graphics/clear

Lower thirds

Lower Thirds Show

Type: OSC String

Path: /h2r-graphics/lower-third

String: 1 (replace with number of lower third you want to show)

Lower Thirds Hide

Type: OSC String

Path: /h2r-graphics/lower-third

String: hide

Ticker

Ticker Show

Type: OSC String

Path: /h2r-graphics/ticker

String: show

Ticker Hide

Type: OSC String

Path: /h2r-graphics/ticker

String: hide

Time

Timer Show

Type: OSC String

Path: /h2r-graphics/timer

String: show

Timer Hide

Type: OSC String

Path: /h2r-graphics/timer

String: hide

Custom Up Timer

Type: OSC String

Path: /h2r-graphics/timer-custom-up

String: hh:mm (e.g. 01:00 = 1 hour timer)

Custom Down Timer

Type: OSC String

Path: /h2r-graphics/timer-custom-down

String: hh:mm (e.g. 00:01 = 1 minute timer)

Custom Down to Time of Day

Type: OSC String

Path: /h2r-graphics/timer-custom-down-time-of-day

String: hh:mm (e.g. 13:00 = Count down to 13:00)

Current Time of Day

Type: OSC Message without arguments

Path: /h2r-graphics/timer-current-time

Stopwatch

Type: OSC Message without arguments

Path: /h2r-graphics/stopwatch

Pause time

Type: OSC String

Path: /h2r-graphics/timer

String: pause

Resume time

Type: OSC String

Path: /h2r-graphics/timer

String: resume

Set pre-timer custom message

Type: OSC String

Path: /h2r-graphics/timer-pre-message

String: Message text you want to set

Logo

Logo Show

Type: OSC String

Path: /h2r-graphics/logo

String: show

Logo Hide

Type: OSC String

Path: /h2r-graphics/logo

String: hide

Message

Message Show

Type: OSC String

Path: /h2r-graphics/message

String: show

Message Hide

Type: OSC String

Path: /h2r-graphics/message

String: hide

Display Custom Message

Type: OSC String

Path: /h2r-graphics/message

String: Message that you want to show

Break

Break Show

Type: OSC String

Path: /h2r-graphics/break

String: show

Break Hide

Type: OSC String

Path: /h2r-graphics/break

String: hide

Chat

Chat Hide

Type: OSC String

Path: /h2r-graphics/chat

String: hide

Image

Image Show Next

Type: OSC String

Path: /h2r-graphics/image

String: next

Image Show Previous

Type: OSC String

Path: /h2r-graphics/image

String: previous

Image Show Specific

Type: OSC String

Path: /h2r-graphics/image

String: 1 (Where '1' will show the first image)

Image Hide

Type: OSC String

Path: /h2r-graphics/image

String: hide

Score

Score Show

Type: OSC String

Path: /h2r-graphics/score

String: show

Score Hide

Type: OSC String

Path: /h2r-graphics/score

String: hide

Increase Team 1 score by 10 points

Type: OSC String

Path: /h2r-graphics/score-team-1

String: 10

Decrease Team 2 score by 5 points

Type: OSC String

Path: /h2r-graphics/score-team-2

String: -5