Skip to main content
Skip table of contents

Daemon API - State

State

Daemon does not have a "per show" state.

Non-state values

Daemon is using its own persistent data which is stored separately from the show file.
[Installation folder]/Local storage/MachineSettings.json

Use Get/Set for these values.

Role

Get or Set the role of a machine.

Parameters

Role

STRING

"STAND_ALONE" | "SERVER" | "CLIENT"

IPAddress

STRING OPTIONAL

set a specific IP address (for the client role)

Response

Role

STRING

"STAND_ALONE" | "SERVER"

HasSelectedRole

BOOLEAN

OR

Role

STRING

"CLIENT"

HasSelectedRole

BOOLEAN

IPAddress

STRING

set a specific IP address (for the client role)

Example - Get
Get
JSON
Topic:{"Type":"Get","Target":"RenderMachine1-Daemon","Name":"Role"}
Message:{"Value":{}}

Response

JSON
Topic: {
    "Type": "Update",
    "Source": "RenderMachine1-Daemon",
    "Name": "Role"
}
Message: {
    "Value": {
        "Role": "CLIENT",
        "HasSelectedRole": true,
        "IPAddress": "20.11.36.52"
    }
}
Example - Set
Set
JSON
Topic:{"Type":"Set","Target":"RenderMachine1-Daemon","Name":"Role"}
Message:{"Value":{"Role":"STAND_ALONE"}}

Response

JSON
Topic: {
    "Type": "Update",
    "Source": "RenderMachine1-Daemon",
    "Name": "Role"
}
Message: {
    "Value": {
        "Role": "STAND_ALONE",
        "HasSelectedRole": true
    }
}

MetaInfo

Get meta information about a machine including machine name, machine role, machine IP address and Hostname

Response

Name

STRING

Machine name

License

STRING

"AR/VS" | "XR" | "Artist" | "Control"

IPAddress

STRING

Host

STRING

Example - Get
Get
JSON
Topic:{"Type":"Get","Target":"RenderMachine1-Daemon","Name":"MetaInfo"}
Message:{"Value":{}}

Response

JSON
Topic: {
    "Type": "Update",
    "Source": "RenderMachine1-Daemon",
    "Name": "MetaInfo"
}
Message: {
    "Value": {
        "Name": "RenderMachine1",
        "License": "Live",
        "IPAddress": "192.123.224.21",
        "Host": "RenderMachine1"
    }
}

Paths

Get information about paths from services, installation folder, store database folder etc

Response

InstallationDirectory

STRING

C:\Pixotope Technologies\Pixotope\[version number]-[build number] - default

DocumentsDirectory

STRING

C:\Users\[User name]\Documents

EngineDirectory

STRING

[Installation folder]\Pixotope Engine\Engine\Binaries\Win64

LocalStorageDirectory

STRING

[Installation folder]\Local Storage

LocalShowsDirectory

STRING

[Installation folder]\Local Storage\Show Files

VsTemplateDirectory

STRING

[Installation folder]\Pixotope Engine\Templates\TP_PixotopeVS\TP_PixotopeVS.uproject

ArTemplateDirectory

STRING

[Installation folder]\Pixotope Engine\Templates\TP_PixotopeVS\TP_PixotopeAR.uproject

Example - Get
Get
JSON
Topic:{"Type":"Get","Target":"RenderMachine1-Daemon","Name":"Paths"}
Message:{"Value":{}}

Response

JSON
Topic: {
    "Type": "Update",
    "Source": "RenderMachine1-Daemon",
    "Name": "Paths"
}
Message: {
    "Value": {
        "InstallDirectory": "C:\\Pixotope Technologies\\Pixotope\\2.0.0-474",
        "DocumentsDirectory": "C:\\Users\\User\\Documents",
        "EngineDirectory": "C:\\Pixotope Technologies\\Pixotope\\2.0.0-474\\Pixotope Engine\\Engine\\Binaries\\Win64",
        "LocalStorageDirectory": "C:\\Pixotope Technologies\\Pixotope\\2.0.0-474\\Local Storage",
        "LocalShowsDirectory": "C:\\Pixotope Technologies\\Pixotope\\2.0.0-474\\Local Storage\\Show Files",
        "VsTemplateDirectory": "C:\\Pixotope Technologies\\Pixotope\\2.0.0-474\\Pixotope Engine\\Templates\\TP_PixotopeVS\\TP_PixotopeVS.uproject",
        "ArTemplateDirectory": "C:\\Pixotope Technologies\\Pixotope\\2.0.0-474\\Pixotope Engine\\Templates\\TP_PixotopeAR\\TP_PixotopeAR.uproject"
    }
}

NetworkAdapters

Get all network adapters on a computer that have an IP address.

Response

Name

STRING

Name of the network adapter

Address

STRING

IP address

Netmask

STRING

Example - Get
Get
JSON
Topic:{"Type":"Get","Target":"RenderMachine1-Daemon","Name":"NetworkAdapters"}
Message:{"Value":{}}

Response

JSON
Topic: {
    "Type": "Update",
    "Source": "RenderMachine1-Daemon",
    "Name": "NetworkAdapters"
}
Message: {
    "Value": [
        {
            "Name": "vEthernet (Default Switch)",
            "Address": "192.123.224.21",
            "Netmask": "255.255.240.0"
        },
        {
            "Name": "vEthernet (New Virtual Switch)",
            "Address": "192.168.137.1",
            "Netmask": "255.255.255.0"
        },
        {
            "Name": "Ethernet 2",
            "Address": "29.41.30.93",
            "Netmask": "255.255.255.0"
        }
    ]
}

ActiveAdapter

Get or Set the active network adapter that is connected to the router or other network machines.

Parameters

Name

STRING

Name of the network adapter

Address

STRING

IP address

Response

Name

STRING

Name of the network adapter

Address

STRING

IP address

Netmask

STRING

Example - Get
Get
JSON
Topic:{"Type":"Get","Target":"RenderMachine1-Daemon","Name":"ActiveAdapter"}
Message:{"Value":{}}

Response

JSON
Topic: {
    "Type": "Update",
    "Source": "RenderMachine1-Daemon",
    "Name": "ActiveAdapter"
}
Message: {
    "Value": {
        "Name": "vEthernet (Default Switch)",
        "Address": "192.123.224.21",
        "Netmask": "255.255.240.0"
    }
}

SetupControlMode

Get or Set the SETUP view permissions for this machine (for client and server role).

Parameters

Mode

STRING

"SHOW_ALL" | "SHOW_MINE_GREY_OTHERS" | "SHOW_MINE"

Response

Mode

STRING

"SHOW_ALL" | "SHOW_MINE_GREY_OTHERS" | "SHOW_MINE"

Example - Get
Get
JSON
Topic:{"Type":"Get","Target":"RenderMachine1-Daemon","Name":"SetupControlMode"}
Message:{"Value":{}}

Response

JSON
Topic: {
    "Type": "Update",
    "Source": "RenderMachine1-Daemon",
    "Name": "SetupControlMode"
}
Message: {
    "Value": {
        "Mode": "SHOW_MINE_GREY_OTHERS"
    }
}
Example - Set
Set
JSON
Topic:{"Type":"Set","Target":"RenderMachine1-Daemon","Name":"SetupControlMode"}
Message:{"Value":{"Mode":"SHOW_ALL"}}

Response

JSON
Topic: {
    "Type": "Update",
    "Target": "BROADCAST",
    "Source": "RenderMachine1-Daemon",
    "Name": "SetupControlMode"
}
Message: {
    "Value": {
        "Mode": "SHOW_ALL"
    }
}

ProductionControlMode

Get or Set the PRODUCTION view permissions for this machine (for stand-alone role).

Parameters

Active

BOOLEAN

Active

IPAddress

STRING OPTIONAL

IP address to connect to

Response

Active

BOOLEAN

Active

IPAddress

STRING OPTIONAL

IP address to connect to

CameraTypes

Get all camera types stored in [Installation folder]/Local storage/CameraTypes.json

Use AddCameraType to add to this list

Response

OBJECT ARRAY

Array of camera type objects

TYPESCRIPT
{
  id: number;
  label: string;
  camera_name: string;
  width: string;
  height: string;
}
Example - Get
Get
JSON
Topic:{"Type":"Get","Target":"RenderMachine1-Daemon","Name":"CameraTypes"}
Message:{"Value":{}}

Response

JSON
Topic: {
    "Type": "Update",
    "Source": "RenderMachine1-Daemon",
    "Name": "CameraTypes"
}
Message: {
    "Value": [
        {
            "id": 0,
            "label": "2/3inch - 16:9",
            "camera_name": "2/3inch - 16:9",
            "width": "9.59",
            "height": "5.39"
        },
        ...
    ]
}

FavouriteShows

Get information about favourite shows, levels and its filter state.

Response

Shows

STRING ARRAY

Favorite shows

Levels

STRING ARRAY

Favorite levels

FavoritesFilter

BOOLEAN

State of the favorites filter for shows

FavoritesLevelsFilter

BOOLEAN

State of the favorites filter for levels

Example - Get
Get
JSON
Topic:{"Type":"Get","Target":"RenderMachine1-Daemon","Name":"FavouriteShows"}
Message:{"Value":{}}

Response

JSON
Topic: {
    "Type": "Update",
    "Target": "BROADCAST",
    "Source": "RenderMachine1-Daemon",
    "Name": "FavouriteShows"
}
Message: {
    "Value": {
        "Shows": [],
        "Levels": [
            "Show1",
            "Show1",
            "Show1"
        ],
        "FavoritesFilter": false,
        "FavoritesLevelFilter": false
    }
}

CustomDirector (not in use yet)

Get or Set the friendly computer name and color for this machine.

Parameters

Name

STRING

Name

Color

STRING

Color

Response

Name

STRING

Name

Color

STRING

Color

JavaScript errors detected

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

If this problem persists, please contact our support.