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.
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.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.input.video_frame_size (integer) – The size of a raw video frame in bytes. If negative (the default), the encoder will try to determine it himself.
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.use_ffmpeg (boolean) – Activate the use of broadcastd service with ffmpeg instead. This mode is intended for development purpose. It has limitations and is far less robust, please advise us of any particular needs if you required this for production.

Example response:

{
  "info": {},
  "ntp": {
    "server": "us.pool.ntp.org",
    "polling": 300
  },
  "encode": {
    "stream": {
      "enabled": true,
      "service": "youtube",
      "delayoffset": "0ms"
    },
    "input": {
      "width": 1280,
      "height": 720,
      "silent": true,
      "stamp_timecode": false,
      "video_frame_size": -1
    },
    "output": {
      "width": 1280,
      "height": 720,
      "abitrate": 128000,
      "vbitrate": 2500000,
      "stamp_timecode": false
    },
    "use_ffmpeg": false
  }
}

GET /settings¶

Set 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.
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.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.input.video_frame_size (integer) – The size of a raw video frame in bytes. If negative (the default), the encoder will try to determine it himself.
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.use_ffmpeg (boolean) – Activate the use of broadcastd service with ffmpeg instead. This mode is intended for development purpose. It has limitations and is far less robust, please advise us of any particular needs if you required this for production.

Example response:

{
  "info": {},
  "ntp": {
    "server": "us.pool.ntp.org",
    "polling": 300
  },
  "encode": {
    "stream": {
      "enabled": true,
      "service": "youtube",
      "delayoffset": "0ms"
    },
    "input": {
      "width": 1280,
      "height": 720,
      "silent": true,
      "stamp_timecode": false,
      "video_frame_size": -1
    },
    "output": {
      "width": 1280,
      "height": 720,
      "abitrate": 128000,
      "vbitrate": 2500000,
      "stamp_timecode": false
    },
    "use_ffmpeg": false
  }
}

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.
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.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.input.video_frame_size (integer) – The size of a raw video frame in bytes. If negative (the default), the encoder will try to determine it himself.
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.use_ffmpeg (boolean) – Activate the use of broadcastd service with ffmpeg instead. This mode is intended for development purpose. It has limitations and is far less robust, please advise us of any particular needs if you required this for production.

Example query:

{
  "info": {},
  "ntp": {
    "server": "us.pool.ntp.org",
    "polling": 300
  },
  "encode": {
    "stream": {
      "enabled": true,
      "service": "youtube",
      "delayoffset": "0ms"
    },
    "input": {
      "width": 1280,
      "height": 720,
      "silent": true,
      "stamp_timecode": false,
      "video_frame_size": -1
    },
    "output": {
      "width": 1280,
      "height": 720,
      "abitrate": 128000,
      "vbitrate": 2500000,
      "stamp_timecode": false
    },
    "use_ffmpeg": false
  }
}

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

Related Topics

Table Of Contents

Settings¶