Daemon Director App API - Calls | Pixotope Help Center

Service name: <MachineName>-Daemon (one per machine).

General

General health and lifecycle endpoints for the Director service.

Pixotope-Director-Health [CALL]

Pixotope-Director-Health

Checks whether the Director service is alive and responsive.

No params.

Result

Result

BOOLEAN

Always `true` when the Director responds.

Example - Health check

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "<MachineName>-Daemon",
  "RespondTo": "<Service>",
  "Method": "Pixotope-Director-Health",
  "ID": "<ID>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "<MachineName>-Daemon",
  "Method": "Pixotope-Director-Health",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

Pixotope-Director-Shutdown [CALL]

Pixotope-Director-Shutdown

Gracefully shuts down the Director application. Responds before exiting.

No params.

Result

Result

BOOLEAN

Always `true` (sent immediately before the process exits).

Example - Shut down the Director

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "<MachineName>-Daemon",
  "RespondTo": "<Service>",
  "Method": "Pixotope-Director-Shutdown",
  "ID": "<ID>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "<MachineName>-Daemon",
  "Method": "Pixotope-Director-Shutdown",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

Window Management

Endpoints for managing Director webview windows.

CreateDirectorInstance [CALL]

CreateDirectorInstance

Opens a new Director webview window. If no URL is provided, the configured Director URL is used.

Params

URL

OPTIONAL

STRING

URL to load in the new window. Defaults to the configured Director URL.

Result

Result

BOOLEAN

Always `true`.

Example - Open a new Director window

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "<MachineName>-Daemon",
  "RespondTo": "<Service>",
  "Method": "CreateDirectorInstance",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "URL": "http://127.0.0.1:16210"
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "<MachineName>-Daemon",
  "Method": "CreateDirectorInstance",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

ReloadDirectorInstances [CALL]

ReloadDirectorInstances

Re-navigates all open Director webview windows to their current URL. Default-titled windows are reloaded to the configured Director URL.

No params.

Result

Result

BOOLEAN

Always `true`.

Example - Reload all Director windows

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "<MachineName>-Daemon",
  "RespondTo": "<Service>",
  "Method": "ReloadDirectorInstances",
  "ID": "<ID>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "<MachineName>-Daemon",
  "Method": "ReloadDirectorInstances",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

FocusDirectorInstance [CALL]

FocusDirectorInstance

Brings the first open Director window to the foreground, unminimizing it if necessary.

No params.

Result

Result

BOOLEAN

`false` if a Director window was found and focused, `true` if no window was found.

Example - Focus the Director window

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "<MachineName>-Daemon",
  "RespondTo": "<Service>",
  "Method": "FocusDirectorInstance",
  "ID": "<ID>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "<MachineName>-Daemon",
  "Method": "FocusDirectorInstance",
  "ID": "<ID>"
}

JSON

{
  "Result": false
}

Splash Screen

Endpoints for controlling the Director splash/title-tag overlay window.

HideSplashScreen [CALL]

HideSplashScreen

Destroys all non-main windows, hides the splash window, and clears any title tag text.

No params.

Result

Result

BOOLEAN

Always `true`.

Example - Hide the splash screen

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "<MachineName>-Daemon",
  "RespondTo": "<Service>",
  "Method": "HideSplashScreen",
  "ID": "<ID>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "<MachineName>-Daemon",
  "Method": "HideSplashScreen",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

ShowTitleTagScreen [CALL]

ShowTitleTagScreen

Displays a text label on the splash overlay. If the splash is already visible, updates the text in place. If hidden, destroys non-main windows and shows the splash first.

Params

Text

OPTIONAL

STRING

Text to display on the title tag. Defaults to an empty string.

Result

Result

BOOLEAN

Always `true`.

Example - Show a title tag with text

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "<MachineName>-Daemon",
  "RespondTo": "<Service>",
  "Method": "ShowTitleTagScreen",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "Text": "Restarting..."
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "<MachineName>-Daemon",
  "Method": "ShowTitleTagScreen",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

CleanTitleTagScreen [CALL]

CleanTitleTagScreen

Clears the title tag text from the splash overlay without hiding the window.

No params.

Result

Result

BOOLEAN

Always `true`.

Example - Clear the title tag

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "<MachineName>-Daemon",
  "RespondTo": "<Service>",
  "Method": "CleanTitleTagScreen",
  "ID": "<ID>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "<MachineName>-Daemon",
  "Method": "CleanTitleTagScreen",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

Notifications

Endpoints for triggering Windows system notifications from the Director.

SendNotification [CALL]

SendNotification

Shows a Windows system notification with a title and message.

Params

Service

OPTIONAL

(default: PX_Director)

STRING

Notification title / source service name.

Message

OPTIONAL

STRING

Notification body text.

Result

Result

BOOLEAN

Always `true`.

Example - Send a custom notification

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "<MachineName>-Daemon",
  "RespondTo": "<Service>",
  "Method": "SendNotification",
  "ID": "<ID>"
}

JSON

{
  "Params": {
    "Service": "PX_Director",
    "Message": "Operation complete."
  }
}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "<MachineName>-Daemon",
  "Method": "SendNotification",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

LostConnectionNotification [CALL]

LostConnectionNotification

Shows a notification that the Director lost connection to the Server/Store. The notification includes an "Open Instance" action button that spawns a new Director window when clicked.

No params.

Result

Result

BOOLEAN

Always `true`.

Example - Trigger lost-connection notification

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "<MachineName>-Daemon",
  "RespondTo": "<Service>",
  "Method": "LostConnectionNotification",
  "ID": "<ID>"
}

JSON

{}

Response (you receive)

JSON

{
  "Type": "CallResult",
  "Target": "<Service>",
  "ExecutedOn": "<MachineName>-Daemon",
  "Method": "LostConnectionNotification",
  "ID": "<ID>"
}

JSON

{
  "Result": true
}

Shutdown

Endpoint for shutting down all Pixotope services.

ShutdownAll [CALL]

ShutdownAll

Initiates a full shutdown of all Pixotope services. Closes all Director windows, sends a Shutdown call to the Daemon, waits for confirmation, then stops all services and exits. No CallResult is sent.

No params.

Example - Shut down all services

Request (you send)

JSON

{
  "Type": "Call",
  "Target": "<MachineName>-Daemon",
  "RespondTo": "<Service>",
  "Method": "ShutdownAll",
  "ID": "<ID>"
}

JSON

{}