NMOS Matrox API - Set | Pixotope Help Center

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

NMOS Configuration

Sets for modifying the NMOS Matrox service configuration. Changes are written to the Matrox JSON config file on disk, the NMOS network service is restarted, and the updated state is broadcast to all subscribers.

PersistentState [SET]

PersistentState

Updates the NMOS Matrox configuration. Accepts the full configuration object or a single field using dot-path syntax (e.g. `PersistentState.Enabled`). After applying the change, writes the new values to the Matrox config file on disk, restarts `mvNetworkService.exe`, syncs `RegistryMode` with the Daemon, and broadcasts the updated `PersistentState` to all subscribers.

Value

Value

OBJECT

Configuration object with any combination of: `ServerIP` (string), `ServerPort` (number), `Enabled` (boolean), `LocalIP` (string), `LocalPort` (number), `RegistryMode` (boolean). When using dot-path syntax (e.g. `Name: "PersistentState.Enabled"`), provide only the scalar value for that field.

Example 1 - Set the full NMOS Matrox configuration

Request (you send)

JSON

{
  "Type": "Set",
  "Target": "<MachineName>-Matrox",
  "Name": "PersistentState"
}

JSON

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

Response (you receive)

JSON

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

JSON

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

Example 2 - Enable or disable the NMOS service

Request (you send)

JSON

{
  "Type": "Set",
  "Target": "<MachineName>-Matrox",
  "Name": "PersistentState.Enabled"
}

JSON

{
  "Value": false
}

Response (you receive)

JSON

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

JSON

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