Daemon API - Calls

Services

StartService

Starts a specific service.

Params

Name	STRING	Name of the service to start (not concatenated with the computerName). Available names: `"PX_Daemon", "PX_Datahub", "PX_Gateway", "PX_License", "PX_VideoIO", "PX_Tracking", "PX_Store", "Director", "UnrealEditor"`
Value	ANY OPTIONAL	Service specific parameters.

Example - Starting PX_VideoIO service.

Call (you send) Topic: { "Type": "Call", "Target": "RenderMachine1-Daemon", "Method": "StartService" } Message: {"Params":{"Name":"PX_VideoIO"}}

CallResult (you can receive, if subscribed) Topic: { "Type": "CallResult", "ExecutedOn": "RenderMachine1-Daemon", "Method": "StartService" } Message: {"Result":{"Success":true}}

StopService

Stops a specific service.

Params

Name

STRING

Name of the service to start (not concatenated with computerName).

Example - Stopping PX_VideoIO service.

Call (you send) Topic: { "Type": "Call", "Target": "RenderMachine1-Daemon", "Method": "StopService" } Message: {"Params":{"Name":"PX_VideoIO"}}

CallResult (you can receive, if subscribed) Topic: { "Type": "CallResult", "ExecutedOn": "RenderMachine1-Daemon", "Method": "StopService" } Message: {"Result":{"Success":true}}

Shutdown

Stops all services and exits.

No params.

RestartService

Restarts a specific service.

Params

Name	STRING	Name of the service to start (not concatenated with computerName).
Value	ANY OPTIONAL	Service specific parameters.

Example - Restarting PX_VideoIO service.

Call (you send) Topic: { "Type": "Call", "Target": "RenderMachine1-Daemon", "Method": "RestartService" } Message: {"Params":{"Name":"PX_VideoIO"}}

CallResult (you can receive, if subscribed) Topic: { "Type": "CallResult", "ExecutedOn": "RenderMachine1-Daemon", "Method": "RestartService" } Message: {"Result":{"Success":true}}

Shows

CopyShowFileToLocal

Copies a specific show file from the server machine to this machine (client).

Params

ShowName

STRING

Name of the show to copy.

Example

Call (you send) Topic: { "Type": "Call", "Target": "RenderMachine1-Daemon", "Method": "CopyShowFileToLocal" } Message: {"Params":{"ShowName":"Show1"}}

CallResult (you can receive, if subscribed) Topic: { "Type": "CallResult", "ExecutedOn": "RenderMachine1-Daemon", "Method": "CopyShowFileToLocal" } Message: {"Result":{"Success":true}}

CheckShowFileLocal

No params.

RescanProjects

No params.

RemoveLocalProjectPath

No params.

AddLinkedProject

No params.

ChangeLocalLinkedProject

No params.

EnableEncryption

No params.

RegenerateEncryptionKeys

No params.

AddEncryptionKeys

No params.

RemoveEncryptionKeys

No params.

TestNetworkConnection

No params.

ToggleFavorite

Either adds or removes show or level from the favorite shows or levels array (see Get FavouriteShows).

Params

Name	STRING	Name of the show/level to add/remove.
Add	BOOLEAN	`true` if it should be added instead of removed.
Levels	BOOLEAN	`true` if the provided name is a level instead of a show.

Example - Adding Show1 to favorites.

Call (you send) Topic: { "Type": "Call", "Target": "RenderMachine1-Daemon", "Method": "ToggleFavorite" } Message: { "Params": { "Name": "Show1", "Add": true, "Levels": false } }

ToggleFavoriteFilter

Toggles filter boolean for favorites shows or levels in database.

Params

Levels

BOOLEAN

true if it toggles the favorite filter for levels instead of shows.

Example

Call (you send) Topic: { "Type": "Call", "Target": "RenderMachine1-Daemon", "Method": "ToggleFavoriteFilter" } Message: {"Params":{"Levels":false}}

Health

Checks daemon health

No params.

SetRole

Sets role for machine

No params.

CreateControlPanel

Creates new control panel

No params.

LicenseCheckout

Checks out license

No params.

RenameControlPanel

Renames existing control panel

No params.

DuplicateControlPanel

Duplicate existing control panel

No params.

DeleteControlPanel

Delete existing control panel

No params.

RestartMachine

Restart current machine

No params.

DisconnectFromServer

Restart current machine

No params.

RefreshNetworkAdapters

Get netowrk adapters

No params.