Cluster API Settings

Cluster API documentation for settings.

Deprecated since version 1.44.0: This API is now provided by the SDK.

Settings

GET /settings/default

Get the default settings

Response JSON Object:

• [key] (undefined) –

Example response:

{
  "broadcast": {
    "enable": true
  },
  "dataStreams": {
    "maximumDataCacheAge": 35,
    "minimumDataCacheAge": 30
  },
  "encode": {
    "composition": {
      "abitrate": 128000,
      "enabled": true,
      "has_monitor": true,
      "height": 720,
      "vbitrate": 2500000,
      "width": 1280
    },
    "input": {
      "height": 720,
      "silent": true,
      "stamp_timecode": false,
      "width": 1280
    },
    "output": {
      "abitrate": 128000,
      "height": 720,
      "stamp_timecode": false,
      "vbitrate": 2500000,
      "width": 1280
    },
    "stream": {
      "addr": "",
      "channel": "",
      "delayoffset": "0ms",
      "extradelay": 10,
      "key": "",
      "service": "standalone"
    }
  },
  "info": {
    "description": "Sample to demonstrate genvid",
    "game": "Tutorial",
    "name": "Tutorial Sample"
  },
  "ntp": {
    "polling": 300,
    "server": "pool.ntp.org"
  },
  "services": {
    "leaf": {
      "bufferSize": 4096,
      "compression": false,
      "maxConnections": 500
    }
  }
}

GET /settings

Get the settings

Response JSON Object:

• [key] (undefined) –

Example response:

{
  "broadcast": {
    "enable": true
  },
  "dataStreams": {
    "maximumDataCacheAge": 35,
    "minimumDataCacheAge": 30
  },
  "encode": {
    "composition": {
      "abitrate": 128000,
      "enabled": true,
      "has_monitor": true,
      "height": 720,
      "vbitrate": 2500000,
      "width": 1280
    },
    "input": {
      "height": 720,
      "silent": true,
      "stamp_timecode": false,
      "width": 1280
    },
    "output": {
      "abitrate": 128000,
      "height": 720,
      "stamp_timecode": false,
      "vbitrate": 2500000,
      "width": 1280
    },
    "stream": {
      "addr": "",
      "channel": "",
      "delayoffset": "0ms",
      "extradelay": 10,
      "key": "",
      "service": "standalone"
    }
  },
  "info": {
    "description": "Sample to demonstrate genvid",
    "game": "Tutorial",
    "name": "Tutorial Sample"
  },
  "ntp": {
    "polling": 300,
    "server": "pool.ntp.org"
  },
  "services": {
    "leaf": {
      "bufferSize": 4096,
      "compression": false,
      "maxConnections": 500
    }
  }
}

POST /settings

Validate and set the settings. Any missing values is replaced by the default values. If the job services is running the server will return a status 500.

Request JSON Object:

• [key] (undefined) –

Example query:

{
  "broadcast": {
    "enable": true
  },
  "dataStreams": {
    "maximumDataCacheAge": 35,
    "minimumDataCacheAge": 30
  },
  "encode": {
    "composition": {
      "abitrate": 128000,
      "enabled": true,
      "has_monitor": true,
      "height": 720,
      "vbitrate": 2500000,
      "width": 1280
    },
    "input": {
      "height": 720,
      "silent": true,
      "stamp_timecode": false,
      "width": 1280
    },
    "output": {
      "abitrate": 128000,
      "height": 720,
      "stamp_timecode": false,
      "vbitrate": 2500000,
      "width": 1280
    },
    "stream": {
      "addr": "",
      "channel": "",
      "delayoffset": "0ms",
      "extradelay": 10,
      "key": "",
      "service": "standalone"
    }
  },
  "info": {
    "description": "Sample to demonstrate genvid",
    "game": "Tutorial",
    "name": "Tutorial Sample"
  },
  "ntp": {
    "polling": 300,
    "server": "pool.ntp.org"
  },
  "services": {
    "leaf": {
      "bufferSize": 4096,
      "compression": false,
      "maxConnections": 500
    }
  }
}

GET /settings/schema

This schema is used to validate the settings.

Changed in version 1.26.0: New API for future extensions.

PUT /settings/schema

This schema is used to validate the settings.

New in version 1.41.0.