26.3 26.2 26.1 25.3 25.2 25.1 24.3 24.2 24.1 23.4 23.3 23.2 23.1
26.3 26.2 26.1 25.3 25.2 25.1 24.3 24.2 24.1 23.4 23.3 23.2 23.1

Control Engine and Director directly with Bitfocus Buttons

Stream Deck keys can call Blueprint custom events, set Engine properties, change show settings in the Store and send any other Pixotope API message, all without a control panel. Keys can also show live values, for example a light's current intensity.

This page only covers what is specific to this approach. Set up the Buttons connection and learn how to create keys in Using Buttons with Pixotope

Actions on this page target objects by their object name, for example BP_CameraMover_2, not by their Outliner label. Renaming or re-placing an actor breaks every key that points at it. For shows where the scene changes often, consider triggering control panel actions instead.

Prerequisites

  • The Pixotope connection set up in Buttons

  • The level open on the target machine. In Editor mode, Call Event runs on the editor copy of the actor, so logic that depends on BeginPlay or runtime state only works in LIVE mode. Properties can be set and watched in Editor mode as well

Trigger a Blueprint custom event

  1. In the Editor, open the Blueprint

  2. In the My Blueprint panel, right click the custom event or function and click Pixotope API > Copy Call URL

    • The URL is copied with ParamObjectSearch=FILL IN ACTOR NAME and an empty ParamFunctionArguments=[]

    • It targets the Engine on this machine by name, Target=<Machine>-Engine. Replace that with ~LOCAL~-Engine if the key should work on whichever machine runs Gateway

    • ParamFunctionName holds the internal name of the event, which can differ from the name shown in the Blueprint, for example PX_PrintString for PX Print String

    b_ue_01_my_blueprint_copy_call_url-20261104-101846.png
  3. Replace FILL IN ACTOR NAME with the unique name of the placed instance, for example BP_Sample_C_4

    • The Outliner tooltip only shows the label. Enable the ID Name column in the Outliner to see unique names, or read them in the control panel editor's Engine Browser

    • To target several instances, see Choose which instance is called

    • Fill in ParamFunctionArguments if the event has inputs, for example ["HELLO"]. Leave [] for an event without inputs

  4. In Buttons, add the Pixotope: Engine: Call Event (Blueprint) action to a key (1)

  5. Paste the URL into Editor URL (2)

    b_01_call_event-20261103-154213.png
  6. Click the lightning icon to fire the event once, then click Apply

Example URL as copied for the PX Print String event, with the placeholder replaced by BP_Sample_C_4 and one text argument. STUDIO-PC is the machine name:

http://localhost:16208/gateway/publish?Type=Call&Target=STUDIO-PC-Engine&Method=CallFunction&ParamObjectSearch=BP_Sample_C_4&ParamFunctionName=PX_PrintString&ParamFunctionArguments=["HELLO"]

Parameter

Description

ParamObjectSearch

Unique object name of the placed instance that owns the event, not its Outliner label. Use level_blueprint for the Level Blueprint. See Choose which instance is called below

ParamFunctionName

Internal name of the custom event or function, as copied. Use it unchanged

ParamFunctionArguments

(Optional)

Arguments as a JSON array, in the order the event declares them. Numbers and booleans are written as is, text values in double quotes, for example [10,"HELLO"]

Write text arguments with quotes, for example ["HELLO"]. Buttons sends anything that is not valid JSON as plain text, so [HELLO] reaches the event as [HELLO], brackets included. The call still succeeds. Pasted into a browser, [10,HELLO] does work, because Gateway reads URL parameters differently.

Custom events on the Pixotope Event System's BP_Master are triggered the same way. Learn more about the Pixotope Event System

Choose which instance is called

The event runs on the instance named in ParamObjectSearch. Copy Call URL does not fill it in, whichever actor is selected, so set it yourself. The ID Name column in the Outliner shows the unique name, for example BP_Sample_C_4 for an actor labelled BP_Sample2.

ParamObjectSearch

Calls the event on

BP_Sample_C_4

That instance only

["BP_Sample_C_1","BP_Sample_C_4"]

Each listed instance

all_of_type BP_Sample_C

Every instance of the Blueprint in the level

first_of_type BP_Sample_C

One instance of the Blueprint. Only use it when the level holds a single instance

all_of_type and first_of_type take the Blueprint's class name with the _C suffix, separated by a space. The Outliner label and the plain Blueprint name return Failure: No objects found.

Pass Buttons values as arguments

Editor URL accepts Buttons variables once the field is in variable mode. They are filled in each time the key is pressed, before the request is sent, so the event can receive a live value, for example a property kept by a Watch feedback.

…&ParamFunctionArguments=["Sun $(Pixotope.prop_sun)"]

  1. Click the variable icon next to Editor URL (Toggle Variable Mode)

  2. The field is cleared, and a folder icon and Use expression appear next to it

  3. Click the folder icon and paste the URL, including the variable, into the text field

    • The preview line below shows the resolved URL, for example …ParamFunctionArguments=["Status Connected"]

  4. Click Done and Apply

  • Write the variable as $(<Variable Key>.<variable>), for example $(Pixotope.connection_status), or insert it from Browse Variables in the same dialog

  • Keep the double quotes around text that contains a variable. ["Status $(Pixotope.connection_status)"] reaches the event as Status Connected

  • Without variable mode the text is sent as typed, and the event receives Status $(Pixotope.connection_status). The lightning icon resolves variables the same way as a key press

  • Other module fields that take variables, such as Value and State Path, work the same way

Set an Engine property

  1. In the Editor, right click the property in the Details panel and click Copy SetProperty URL

    b_ue_02_property_copy_url-20261104-101846.png
  2. In Buttons, add the Pixotope: Engine: Set Property action

  3. Paste the URL into Editor URL

  4. Enter the value to send in Value

    • Any value already in the URL is ignored

    b_02_set_property-20261103-145804.png

Field

Description

Editor URL

The copied GetProperty or SetProperty URL. It identifies the object and property

Value

The value to set. Plain text, numbers, true/false and JSON are detected automatically, for example {"R":1,"G":0,"B":0} for a color

Persist as adjustment

Stores the change as an adjustment, so it persists

Show a live value on a key

  1. Select the key and open the Feedbacks tab

  2. Click Add Feedback… and select Pixotope: Engine: Watch property → variable (live) (1)

    b_03_feedback_list-20261103-145804.png
  3. Paste the property's URL into Editor URL and enter a name in Store in variable, for example sun

    • The value is polled into the variable prop_sun. The module adds prop_ and lowercases the name, so Sun Light becomes prop_sun_light

    • prop_sun only appears in Browse Variables after both fields are filled in

    • Ignore the red Preview in the feedback panel. A Watch feedback does not restyle the key

    b_04_watch_property_options-20261103-145904.png
  4. Open the Design tab and click the folder icon next to Text

    • Not fx, which turns Text into an expression

  5. Type the label (1), then expand Pixotope in Browse Variables, hover prop_sun and click Insert (2)

    • The field below previews the result, here Sun 10

    b_05_variable_browser-20261104-140305.png
  6. Click Done and Apply

Buttons writes module variables as $(<Variable Key>.<variable>), for example $(Pixotope.prop_sun). Pixotope is the Variable Key in the connection's Config tab, and it is case-sensitive.

The module's feedback descriptions, tooltips and built-in help show the Companion syntax $(pixotope:prop_sun). It does not resolve in Buttons, and the key shows $ instead of the value. Insert variables from Browse Variables to get the right syntax.

  • Live values refresh at the connection's Live Value Poll Interval (default 1000 ms). Only properties with a Watch feedback are polled

  • Engine: Property differs from default (2) highlights a key while a property differs from its default value

  • To read a value only when a key is pressed, use the Engine: Get Property (→ variable) action instead

Change show settings in the Store

Show-wide settings live in the Pixotope Store.

  1. Add the Pixotope: Store: Set Value action

  2. Enter the State Path, for example State.Compositing.MachineInfoVisualizer.Enabled

  3. Enter the Value, for example true

    b_06_store_set_value-20261103-145804.png

To find a state path, open this URL in a browser. The tree is under Message.Value. The path is State plus the keys below that, for example State.Compositing.MachineInfoVisualizer.Enabled:

http://127.0.0.1:16208/gateway/2.2.0/publish?Type=Get&Target=Store&Name=State

To check a path, open the same URL with the full path as Name. It returns the current value:

http://127.0.0.1:16208/gateway/2.2.0/publish?Type=Get&Target=Store&Name=State.Compositing.MachineInfoVisualizer.Enabled

To show a Store value on a key, add the Pixotope: Store: Watch value → variable (live) feedback (3), enter the same State Path and a name in Store in variable, for example info, which gives prop_info. Service defaults to Store and can point at another stateful service.

b_07_store_watch_options-20261103-145804.png

Store values apply to the whole show, on every machine. Test new paths on a non-critical setting first. A wrong or empty path returns nothing, and the variable stays blank.

Call other Director and service APIs

Anything else in the Pixotope API can be sent with the Pixotope: Raw API Request action.

  1. Find the message you need

    • In Director, open the API Log tab, perform the action in the UI and copy the logged Topic and Message

    • OR copy the example URL from the "Try via Pixotope Gateway" section of the API documentation

  2. Add the Raw API Request action and fill in the fields from the message

    b_08_raw_api_director-20261103-145804.png

Field

Taken from

Example: Director health check

Topic Type

Type

Call

Target

Target. Leave empty to use the Default Engine Target

~LOCAL~-Director

Name (for Set/Get)

Name

Leave empty

Method (for Call)

Method

Health

Message (JSON object)

The Message object. In a URL, Param… values become {"Params":{…}}

{}

Raw API Request does not show the response. Use the Watch feedbacks to read values back.

Learn more about the Pixotope API

Example layout

b_09_finished_layout-20261103-145804.png

Key

Action

Feedback

Pink / Green

Call Event Change to Pink with [0] / [1]

-

Sun

Set Property light intensity to 20

Watch property, text Sun $(Pixotope.prop_sun)

Sun reset

Set Property light intensity to 10

-

Info / Info off

Store: Set Value machine info overlay to true / false

Store: Watch value, text Info $(Pixotope.prop_info)

Health

Raw API Request Director Health

-

Troubleshooting

Symptom

Likely cause

Fix

Log shows 200, nothing happens

Wrong object or event name, or the event needs runtime state

Open the URL in a browser. Failure: No objects found means a wrong object name: compare ParamObjectSearch with the ID Name column in the Outliner and check for renamed or re-placed actors. If the response shows a Result, the event ran on the editor actor. Run the level in LIVE mode for logic that depends on BeginPlay or runtime state

Text argument arrives with brackets

ParamFunctionArguments is not valid JSON, so it is sent as one plain string

Quote text values and keep the event's input order, for example [10,"HELLO"]

Key shows $ instead of a value

Variable written in Companion syntax or with the wrong case

Insert it from Browse Variables. It must read $(Pixotope.prop_<name>)

Live value stays blank

The path returned nothing

Check the URL or State Path

Connection shows disconnected

Gateway is unreachable, or a Gateway passkey is set

Check Gateway IP and port, and keep the passkey empty