H2R Graphics

The H2R Graphics action lets you trigger live graphics workflows from phrases by sending REST commands to H2R Graphics over HTTP, including running sessions, showing/hiding or updating graphics, driving timers, and controlling lyric/variable outputs in a single automation action. It builds the endpoint URL from connection settings plus message-specific parameters, with request bodies sent as JSON where required.

Required Parameters

• Protocol (HTTP or HTTPS)
• Host
• Port (0–65535)
• Project ID
• Message

Commands

Run

• Required inputs: none
• Constraints/ranges: none beyond connection and project settings
• Supported targets/options: General control endpoint to run graphics processing

Clear All Graphics

• Required inputs: none
• Constraints/ranges: none beyond connection and project settings
• Supported targets/options: Global clear action for active graphics

Show Graphic

• Required inputs: Graphic ID
• Constraints/ranges: Graphic ID is a string path value
• Unsupported combinations: none
• Supported targets/options: Shows a specific graphic by ID

Hide Graphic

• Required inputs: Graphic ID
• Constraints/ranges: Graphic ID is a string path value
• Unsupported combinations: none
• Supported targets/options: Hides a specific graphic by ID

Update Graphic Contents

• Required inputs: Graphic ID, Body JSON
• Constraints/ranges: JSON object body is optional but defaults to {} when blank
• Supported targets/options: posts body payload to update a graphic definition

Update Score Graphic

• Required inputs: Graphic ID, Team, Level, Type, Amount
• Constraints/ranges: Team, Level, Amount are treated as path parameters; default values are Team 1, Level 1, Type set, Amount 0
• Unsupported combinations: no built-in validation for Type values
• Supported targets/options: score graphics with team/level/type/amount path arguments

Update Variable Text

• Required inputs: Variable Text ID, Text
• Constraints/ranges: Text is wrapped as JSON payload under a text key
• Unsupported combinations: none
• Supported targets/options: updates variable text content for a specific text variable

Select Variable List Row

• Required inputs: List ID, Row
• Constraints/ranges: List ID defaults to 1; Row defaults to next; Row accepts next, previous, or explicit value as provided
• Supported targets/options: selects rows in variable-driven lists

Open Output

• Required inputs: Output Number
• Constraints/ranges: Output Number defaults to 1
• Supported targets/options: opens a configured output channel/feed

Run/Resume Speaker Timer

• Required inputs: Graphic ID
• Constraints/ranges: Graphic ID is required path input
• Supported targets/options: starts or resumes the speaker timer for a graphic

Pause Speaker Timer

• Required inputs: Graphic ID
• Constraints/ranges: Graphic ID is required path input
• Supported targets/options: pauses a graphic’s speaker timer

Reset Speaker Timer

• Required inputs: Graphic ID
• Constraints/ranges: Graphic ID is required path input
• Supported targets/options: resets a graphic’s speaker timer state

Adjust Speaker Timer

• Required inputs: Graphic ID, Amount Seconds
• Constraints/ranges: Amount Seconds default 0; treated as path parameter
• Supported targets/options: jumps timer by the configured offset seconds

Set Speaker Timer Duration

• Required inputs: Graphic ID, Duration Seconds
• Constraints/ranges: Duration Seconds default 0; treated as path parameter
• Supported targets/options: sets timer duration for a graphic

Next Lyric

• Required inputs: Graphic ID
• Constraints/ranges: Graphic ID is required path input
• Supported targets/options: advances lyric playback to next line/entry

Previous Lyric

• Required inputs: Graphic ID
• Constraints/ranges: Graphic ID is required path input
• Supported targets/options: steps lyric playback back

Back to Start

• Required inputs: Graphic ID
• Constraints/ranges: Graphic ID is required path input
• Supported targets/options: returns lyric playback to start