Skip to main content
Skip table of contents

Set up data integration

Being able to fetch data or make it available for others in the network is essential for realtime productions. With Pixotope there are multiple ways this can be done. Here we will look at the recommended way.

Where to store data

For data to be accessible throughout the whole Pixotope network, we recommend using the Pixotope Store. The Store is a service which runs on the Server machine and allows to read and write data on it. This data is stored per Show.

For an overview of the current data in Store you can use this link on any machine with Pixotope running:

Learn more about the Pixotope Store

Reading data

Read from Store

Reading data can be done in multiple ways.

  • On Tick - recommended

  • On Update

On Tick

This method applies the latest value of fields of interest on tick.

  1. Add a Subscribe node (Pixotope > Data Hub > Remote Values) to Event BeginPlay.

  2. In the Source type Store, and in the Name box enter the path to the value of interest

    1. If Narrow is checked the Engine only listens to changes of that specific property

      • State.ThirdParty.Examples > Listens only to changes of

        • Examples

    2. If Narrow is unchecked the Engine listens to changes of that specific property and all its potential children

      • State.ThirdParty.Examples > Listens to changes of:

        • State.ThirdParty.Examples

        • State.ThirdParty.Examples.ViaStore

User can also add custom subscriptions under Project Settings>Pixotope>API>Data Integration>Custom Subscriptions.

This is an alternative to using a Subscribe node on BeginPlay in your blueprints.

  1. Next to the event tick add a Try Read Last Remote Value node (Pixotope > Data Hub > Remote Values).

  2. Add a Get JSON Float node or any functionality you like!


On Update

On update

This method subscribes to a specific value on Store and then waits to be notified for updates.
It can be used in any Actor blueprint or in the Level Blueprint.
It might be more performant, but the blueprint setup is going to be more complex.

  1. Add a Subscribe node like in the On Tick example.

  2. Add Get Data Hub Delegates Blueprints node and drag out of it Bind Event to On Data Hub Update Received.

  3. Connect bind’s execution pin to the subscribe node.

  4. Drag out of the event pin and Add custom event…, you can set the new event’s name to anything.

  5. Add Is Update Relevant node and a branch node connected to it.

  6. Connect Received Source with Source from the event, and Received Name with Name from the event.

  7. In Required Source type Store, and in Required Name type the path to the variable of interest.

  8. You can use Pixotope’s JSON nodes to further parse your data. For example Get JSON Float.

  9. Add any functionality you like!


Read from local state

Read from local state

This example shows how to read from the Engine state. A value on the local engine under State.ThirdParty.Examples.ViaEngine is read on tick and used to control the height of an actor.

Learn more about the Engine API - State

Screenshot 2024-01-29 at 12.55.37.png

Setting data

Set on Store

This method sends a Set call to change a value on Store.

  1. Add Send Set node

    1. Set Target to "Store"

    2. Set Name to for example State.ThirdParty.Example.MyParameter

    3. Connect the Value to be sent

  2. Configure how/when this should be executed

In this example a random value is set on the Store on every tick.

Screenshot 2024-01-29 at 14.01.34.png

Set on local state

Read from local state

To write to the local state, use the Set Local Value node and specify Name and Value as above.

Check Send Update if you want subscribers to receive updates if the value changed.

Screenshot 2024-01-29 at 16.26.55.png

Learn more about the Engine API - State

Pixotope blueprint nodes related to data handling

Pixotope blueprint nodes related to data handling
  • API

    • Execute Call Locally

    • Get last Executed Call

  • Data Hub

    • Connection

      • Get Machine Name

      • Get Service Name

      • Is Connected

    • Delegates

      • Get Data Hub Delegates Blueprints

    • Local Values

      • Get Local Value

      • Set Local Value

      • Try Get Local Value

    • Remote Values

      • Subscribe

      • Try Read Last Remote Value

      • Unsubscribe

    • Send

      • Publish

      • Send Call

      • Send Get

      • Send Set

      • Send Update

    • Update Broadcaster

      • Get Update Broadcaster

  • Data Hub Values

    • Get Pixotope Local Values

    • Get Pixotope Remote Values

Read and write values using HTTP requests

Reading values using HTTP requests can be done using Pixotope Gateway.

Learn more about How to use Pixotope Gateway

Pixotope Gateway is not available when using Encryption

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.