NMOS Matrox API - Get | Pixotope Help Center

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

NMOS Configuration

Gets for reading the NMOS Matrox service configuration, connection status, and adapter information.

PersistentState [GET]

PersistentState

Returns the current NMOS Matrox configuration state. Supports dot-path field access to retrieve individual fields (e.g. `PersistentState.ServerIP`).

No parameters — message is always {}.

Value

Value

OBJECT

`{ "ServerIP": string, "ServerPort": number, "Enabled": boolean, "LocalIP": string, "LocalPort": number, "RegistryMode": boolean }`.

Example 1 - Get the full NMOS Matrox configuration

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "<MachineName>-Matrox",
  "RespondTo": "<Service>",
  "Name": "PersistentState"
}

Response (you receive)

JSON

{
  "Type": "Update",
  "Source": "<MachineName>-Matrox",
  "Target": "<Service>",
  "Name": "PersistentState"
}

JSON

{
  "ServerIP": "192.168.1.100",
  "ServerPort": 80,
  "Enabled": true,
  "LocalIP": "0.0.0.0",
  "LocalPort": 16226,
  "RegistryMode": true
}

Example 2 - Get a single field

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "<MachineName>-Matrox",
  "RespondTo": "<Service>",
  "Name": "PersistentState.ServerIP"
}

Response (you receive)

JSON

{
  "Type": "Update",
  "Source": "<MachineName>-Matrox",
  "Target": "<Service>",
  "Name": "PersistentState.ServerIP"
}

JSON

"192.168.1.100"

ConnectionStatus [GET]

ConnectionStatus

Returns whether the NMOS Matrox service is currently active and connected to the NMOS registry. The value is `true` only when the service is both enabled in configuration and connected (or running in registry-mode where connection is assumed).

No parameters — message is always {}.

Value

Value

BOOLEAN

`true` if the service is enabled and connected, `false` otherwise.

Example - Get the current connection status

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "<MachineName>-Matrox",
  "RespondTo": "<Service>",
  "Name": "ConnectionStatus"
}

Response (you receive)

JSON

{
  "Type": "Update",
  "Source": "<MachineName>-Matrox",
  "Target": "<Service>",
  "Name": "ConnectionStatus"
}

JSON

true

MatroxAdapters [GET]

MatroxAdapters

Returns information about the installed Matrox video adapter cards available on the machine, retrieved via the Matrox capability library.

No parameters — message is always {}.

Value

Value

OBJECT

JSON object describing the detected Matrox adapters and their capabilities. Returns a raw string if the adapter info cannot be parsed as JSON.

Example - Get Matrox adapter information

Request (you send)

JSON

{
  "Type": "Get",
  "Target": "<MachineName>-Matrox",
  "RespondTo": "<Service>",
  "Name": "MatroxAdapters"
}

Response (you receive)

JSON

{
  "Type": "Update",
  "Source": "<MachineName>-Matrox",
  "Target": "<Service>",
  "Name": "MatroxAdapters"
}

JSON

{
  "adapter0": {
    "name": "Matrox X.mio3 IP",
    "serial": "1234567",
    "enabled": true
  }
}