Services

StartService

StartService

Starts a specific service.

Params
Name STRINGName of the service to start (not concatenated with the computerName). Available names: "PX_Daemon", "PX_Datahub", "PX_Gateway", "PX_Bridge", "PX_DirectorAPI", "PX_VideoIO", "PX_Tracking", "PX_Store", "Director", "UE4Editor"
Value ANY OPTIONALService 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

StopService

Stops a specific service.

Params
Name STRINGName 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}}

RestartService

RestartService

Restarts a specific service.

Params
Name STRINGName of the service to start (not concatenated with computerName).
Value ANY OPTIONALService 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

CopyShowFileToLocal

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

Params
ShowName STRINGName 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

CheckShowFileLocal

No params.
RescanProjects

RescanProjects

No params.
RemoveLocalProjectPath

RemoveLocalProjectPath

No params.
ToggleFavorite

ToggleFavorite

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

Params
Name STRINGName of the show/level to add/remove.
Add BOOLEANtrue if it should be added instead of removed.
Levels BOOLEANtrue 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

ToggleFavoriteFilter

Toggles filter boolean for favorites shows or levels in database.

Params
Levels BOOLEANtrue 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}}

Other

ResetRole

ResetRole

Resets the role of this machine to its initial state.

No params.
Example

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

CallResult (you can receive, if subscribed) Topic: { "Type": "CallResult", "ExecutedOn": "RenderMachine1-Daemon", "Method": "ResetRole" } Message: { "Value": { "Role": "STAND_ALONE", "HasSelectedRole": false } }

DisconnectServer

DisconnectServer

Called on a machine connected to a server machine, when the server changes its role. This will change the role of the client to stand-alone and will disable production mode (Permissions - affecting SETUP or PRODUCTION).
Sends an Update message named "ServerChangedRole" to Director that role has been updated.

No params.
AddCameraType

AddCameraType

Adds a provided camera type to the existing array of types and stores it in [Installation folder]/Local storage/CameraTypes.json

Params
id NUMBERUnique Id.
label STRINGDisplay name of camera.
camera_name STRINGName of camera.
width STRINGWidth of backplate in mm.
height STRINGHeight of backplate in mm.
Example

Call (you send) Topic: { "Type": "Call", "Target": "RenderMachine1-Daemon", "Method": "AddCameraType" } Message: { "Params": { "id": 4242, "label": "SquareCam", "camera_name": "SquareCam", "width": "42", "height": "42" } }

Update (you can receive, if subscribed) Topic: { "Type": "Update", "Target": "BROADCAST", "Source": "RenderMachine1-Daemon", "Name": "CameraTypes" } Message: { "Value": [ { "id": 4242, "label": "SquareCam", "camera_name": "SquareCam", "width": "42", "height": "42" } ] }