Cluster API Settings¶

Cluster API documentation for settings

Settings¶

GET /settings/default¶

Get the default settings

Response JSON Object:

info.name (string) – The name of the stream.
info.game (string) – The game being played.
info.description (string) – A description of the stream.
ntp.server (string) – Host name for the NTP server. We recommend using the 169.254.169.123 server for AWS.
ntp.polling (integer) – Interval between two synchronizations.
encode.stream.enabled (boolean) – A flag activating or deactivating the streaming.
encode.stream.service (string) – The live streaming service type.
encode.stream.addr (string) – The address of the live streaming server receiving the video stream (typically, an RTMP URL).
encode.stream.channel (string) – The user-specific channel identifier.
encode.stream.key (string) – The user-specific streaming key to allow pushing data to ‘addr’.
encode.stream.delayoffset (string) – An optional delay allowing to offset the video stream with regard to the game stream.
encode.stream.extradelay (number) – An optional delay allowing to offset the broadcast for the standalone player.
encode.input.width (integer) – The width, in pixels, of a game frame.
encode.input.height (integer) – The height, in pixels, of a game frame.
encode.input.silent (boolean) – Disables the audio stream.
encode.input.stamp_timecode (boolean) – Activates stamping the game timecode in every frame (bottom right corner).
encode.output.width (integer) – The width, in pixels, of the final video.
encode.output.height (integer) – The height, in pixels, of the final video.
encode.output.abitrate (integer) – The audio bitrate to use for the final video.
encode.output.vbitrate (integer) – The video bitrate to use for the final video.
encode.output.stamp_timecode (boolean) – Activates stamping the video timecode in the final video stream (top left corner).
encode.composition.enabled (boolean) – Enable composition functions
encode.composition.has_monitor (boolean) – The monitor screen is in the composition panel
encode.composition.width (integer) – The width, in pixels, of the monitor video.
encode.composition.height (integer) – The height, in pixels, of the monitor video.
encode.composition.abitrate (integer) – The audio bitrate to use for the monitor.
encode.composition.vbitrate (integer) – The video bitrate to use for the monitor.
encode.ingest.extradelay (number) – An optional delay allowing to offset the encoding delay from the source (seconds).
dataStreams.minimumDataCacheAge (integer) – The minimal age (in seconds) of the data cached for initialization. Any data younger than this age will be kept.
dataStreams.maximumDataCacheAge (integer) – When new data arrived, any data older than this setting (in seconds) will be culled from the cache.
services.leaf.compression (boolean) – If the compression is active or not
services.leaf.bufferSize (integer) – The web socket read and write buffer size
services.leaf.maxConnections (integer) – Maximum number of concurrent connections per leafd service.

Example response:

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

GET /settings¶

Get the settings

Response JSON Object:

info.name (string) – The name of the stream.
info.game (string) – The game being played.
info.description (string) – A description of the stream.
ntp.server (string) – Host name for the NTP server. We recommend using the 169.254.169.123 server for AWS.
ntp.polling (integer) – Interval between two synchronizations.
encode.stream.enabled (boolean) – A flag activating or deactivating the streaming.
encode.stream.service (string) – The live streaming service type.
encode.stream.addr (string) – The address of the live streaming server receiving the video stream (typically, an RTMP URL).
encode.stream.channel (string) – The user-specific channel identifier.
encode.stream.key (string) – The user-specific streaming key to allow pushing data to ‘addr’.
encode.stream.delayoffset (string) – An optional delay allowing to offset the video stream with regard to the game stream.
encode.stream.extradelay (number) – An optional delay allowing to offset the broadcast for the standalone player.
encode.input.width (integer) – The width, in pixels, of a game frame.
encode.input.height (integer) – The height, in pixels, of a game frame.
encode.input.silent (boolean) – Disables the audio stream.
encode.input.stamp_timecode (boolean) – Activates stamping the game timecode in every frame (bottom right corner).
encode.output.width (integer) – The width, in pixels, of the final video.
encode.output.height (integer) – The height, in pixels, of the final video.
encode.output.abitrate (integer) – The audio bitrate to use for the final video.
encode.output.vbitrate (integer) – The video bitrate to use for the final video.
encode.output.stamp_timecode (boolean) – Activates stamping the video timecode in the final video stream (top left corner).
encode.composition.enabled (boolean) – Enable composition functions
encode.composition.has_monitor (boolean) – The monitor screen is in the composition panel
encode.composition.width (integer) – The width, in pixels, of the monitor video.
encode.composition.height (integer) – The height, in pixels, of the monitor video.
encode.composition.abitrate (integer) – The audio bitrate to use for the monitor.
encode.composition.vbitrate (integer) – The video bitrate to use for the monitor.
encode.ingest.extradelay (number) – An optional delay allowing to offset the encoding delay from the source (seconds).
dataStreams.minimumDataCacheAge (integer) – The minimal age (in seconds) of the data cached for initialization. Any data younger than this age will be kept.
dataStreams.maximumDataCacheAge (integer) – When new data arrived, any data older than this setting (in seconds) will be culled from the cache.
services.leaf.compression (boolean) – If the compression is active or not
services.leaf.bufferSize (integer) – The web socket read and write buffer size
services.leaf.maxConnections (integer) – Maximum number of concurrent connections per leafd service.

Example response:

{
  "info": {
    "name": "",
    "game": "",
    "description": ""
  },
  "ntp": {
    "server": "pool.ntp.org",
    "polling": 300
  },
  "encode": {
    "stream": {
      "enabled": true,
      "service": "standalone",
      "addr": "",
      "channel": "",
      "key": "",
      "delayoffset": "0ms",
      "extradelay": 10
    },
    "input": {
      "width": 1280,
      "height": 720,
      "silent": true,
      "stamp_timecode": false
    },
    "output": {
      "width": 1280,
      "height": 720,
      "abitrate": 128000,
      "vbitrate": 2500000,
      "stamp_timecode": false
    },
    "composition": {
      "enabled": false,
      "has_monitor": false,
      "width": 1280,
      "height": 720,
      "abitrate": 128000,
      "vbitrate": 2500000
    },
    "ingest": {
      "extradelay": -0.4
    }
  },
  "dataStreams": {
    "minimumDataCacheAge": 30,
    "maximumDataCacheAge": 35
  },
  "services": {
    "leaf": {
      "compression": false,
      "bufferSize": 4096,
      "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:

info.name (string) – The name of the stream.
info.game (string) – The game being played.
info.description (string) – A description of the stream.
ntp.server (string) – Host name for the NTP server. We recommend using the 169.254.169.123 server for AWS.
ntp.polling (integer) – Interval between two synchronizations.
encode.stream.enabled (boolean) – A flag activating or deactivating the streaming.
encode.stream.service (string) – The live streaming service type.
encode.stream.addr (string) – The address of the live streaming server receiving the video stream (typically, an RTMP URL).
encode.stream.channel (string) – The user-specific channel identifier.
encode.stream.key (string) – The user-specific streaming key to allow pushing data to ‘addr’.
encode.stream.delayoffset (string) – An optional delay allowing to offset the video stream with regard to the game stream.
encode.stream.extradelay (number) – An optional delay allowing to offset the broadcast for the standalone player.
encode.input.width (integer) – The width, in pixels, of a game frame.
encode.input.height (integer) – The height, in pixels, of a game frame.
encode.input.silent (boolean) – Disables the audio stream.
encode.input.stamp_timecode (boolean) – Activates stamping the game timecode in every frame (bottom right corner).
encode.output.width (integer) – The width, in pixels, of the final video.
encode.output.height (integer) – The height, in pixels, of the final video.
encode.output.abitrate (integer) – The audio bitrate to use for the final video.
encode.output.vbitrate (integer) – The video bitrate to use for the final video.
encode.output.stamp_timecode (boolean) – Activates stamping the video timecode in the final video stream (top left corner).
encode.composition.enabled (boolean) – Enable composition functions
encode.composition.has_monitor (boolean) – The monitor screen is in the composition panel
encode.composition.width (integer) – The width, in pixels, of the monitor video.
encode.composition.height (integer) – The height, in pixels, of the monitor video.
encode.composition.abitrate (integer) – The audio bitrate to use for the monitor.
encode.composition.vbitrate (integer) – The video bitrate to use for the monitor.
encode.ingest.extradelay (number) – An optional delay allowing to offset the encoding delay from the source (seconds).
dataStreams.minimumDataCacheAge (integer) – The minimal age (in seconds) of the data cached for initialization. Any data younger than this age will be kept.
dataStreams.maximumDataCacheAge (integer) – When new data arrived, any data older than this setting (in seconds) will be culled from the cache.
services.leaf.compression (boolean) – If the compression is active or not
services.leaf.bufferSize (integer) – The web socket read and write buffer size
services.leaf.maxConnections (integer) – Maximum number of concurrent connections per leafd service.

Example query:

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

GET /schemas/settings.json¶: This schema is used to validate the settings.

Cluster API Settings¶

Settings¶

Related Topics

Table Of Contents