Settings

GET /settings/default

Get the default settings

Response JSON Object:  

• [key].info.name (string) – The name of the stream.
• [key].info.game (string) – The game being played.
• [key].info.description (string) – A description of the stream.
• [key].ntp.server (string) – Host name for the NTP server.
• [key].ntp.polling (integer) – Interval between two synchronizations.
• [key].encode.stream.enabled (boolean) – A flag activating or deactivating the streaming.
• [key].encode.stream.service (string) – The live streaming service type.
• [key].encode.stream.addr (string) – The address of the live streaming server receiving the video stream (typically, an RTMP URL).
• [key].encode.stream.channel (string) – The user-specific channel identifier.
• [key].encode.stream.key (string) – The user-specific streaming key to allow pushing data to ‘addr’.
• [key].encode.stream.delayoffset (string) – An optional delay allowing to offset the video stream with regard to the game stream.
• [key].encode.stream.extradelay (number) – An optional delay allowing to offset the broadcast for the standalone player.
• [key].encode.input.width (integer) – The width, in pixels, of a game frame.
• [key].encode.input.height (integer) – The height, in pixels, of a game frame.
• [key].encode.input.silent (boolean) – Disables the audio stream.
• [key].encode.input.stamp_timecode (boolean) – Activates stamping the game timecode in every frame (bottom right corner).
• [key].encode.output.width (integer) – The width, in pixels, of the final video.
• [key].encode.output.height (integer) – The height, in pixels, of the final video.
• [key].encode.output.abitrate (integer) – The audio bitrate to use for the final video.
• [key].encode.output.vbitrate (integer) – The video bitrate to use for the final video.
• [key].encode.output.stamp_timecode (boolean) – Activates stamping the video timecode in the final video stream (top left corner).
• [key].encode.composition.enabled (boolean) – Enable composition functions
• [key].encode.composition.has_monitor (boolean) – The monitor screen is in the composition panel
• [key].encode.composition.width (integer) – The width, in pixels, of the monitor video.
• [key].encode.composition.height (integer) – The height, in pixels, of the monitor video.
• [key].encode.composition.abitrate (integer) – The audio bitrate to use for the monitor.
• [key].encode.composition.vbitrate (integer) – The video bitrate to use for the monitor.
• [key].services.leaf.compression (boolean) – If the compression is active or not
• [key].services.leaf.bufferSize (integer) – The web socket read and write buffer size

Example response:

{}

GET /settings

Get the settings

Response JSON Object:  

• [key].info.name (string) – The name of the stream.
• [key].info.game (string) – The game being played.
• [key].info.description (string) – A description of the stream.
• [key].ntp.server (string) – Host name for the NTP server.
• [key].ntp.polling (integer) – Interval between two synchronizations.
• [key].encode.stream.enabled (boolean) – A flag activating or deactivating the streaming.
• [key].encode.stream.service (string) – The live streaming service type.
• [key].encode.stream.addr (string) – The address of the live streaming server receiving the video stream (typically, an RTMP URL).
• [key].encode.stream.channel (string) – The user-specific channel identifier.
• [key].encode.stream.key (string) – The user-specific streaming key to allow pushing data to ‘addr’.
• [key].encode.stream.delayoffset (string) – An optional delay allowing to offset the video stream with regard to the game stream.
• [key].encode.stream.extradelay (number) – An optional delay allowing to offset the broadcast for the standalone player.
• [key].encode.input.width (integer) – The width, in pixels, of a game frame.
• [key].encode.input.height (integer) – The height, in pixels, of a game frame.
• [key].encode.input.silent (boolean) – Disables the audio stream.
• [key].encode.input.stamp_timecode (boolean) – Activates stamping the game timecode in every frame (bottom right corner).
• [key].encode.output.width (integer) – The width, in pixels, of the final video.
• [key].encode.output.height (integer) – The height, in pixels, of the final video.
• [key].encode.output.abitrate (integer) – The audio bitrate to use for the final video.
• [key].encode.output.vbitrate (integer) – The video bitrate to use for the final video.
• [key].encode.output.stamp_timecode (boolean) – Activates stamping the video timecode in the final video stream (top left corner).
• [key].encode.composition.enabled (boolean) – Enable composition functions
• [key].encode.composition.has_monitor (boolean) – The monitor screen is in the composition panel
• [key].encode.composition.width (integer) – The width, in pixels, of the monitor video.
• [key].encode.composition.height (integer) – The height, in pixels, of the monitor video.
• [key].encode.composition.abitrate (integer) – The audio bitrate to use for the monitor.
• [key].encode.composition.vbitrate (integer) – The video bitrate to use for the monitor.
• [key].services.leaf.compression (boolean) – If the compression is active or not
• [key].services.leaf.bufferSize (integer) – The web socket read and write buffer size

Example response:

{}

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].info.name (string) – The name of the stream.
• [key].info.game (string) – The game being played.
• [key].info.description (string) – A description of the stream.
• [key].ntp.server (string) – Host name for the NTP server.
• [key].ntp.polling (integer) – Interval between two synchronizations.
• [key].encode.stream.enabled (boolean) – A flag activating or deactivating the streaming.
• [key].encode.stream.service (string) – The live streaming service type.
• [key].encode.stream.addr (string) – The address of the live streaming server receiving the video stream (typically, an RTMP URL).
• [key].encode.stream.channel (string) – The user-specific channel identifier.
• [key].encode.stream.key (string) – The user-specific streaming key to allow pushing data to ‘addr’.
• [key].encode.stream.delayoffset (string) – An optional delay allowing to offset the video stream with regard to the game stream.
• [key].encode.stream.extradelay (number) – An optional delay allowing to offset the broadcast for the standalone player.
• [key].encode.input.width (integer) – The width, in pixels, of a game frame.
• [key].encode.input.height (integer) – The height, in pixels, of a game frame.
• [key].encode.input.silent (boolean) – Disables the audio stream.
• [key].encode.input.stamp_timecode (boolean) – Activates stamping the game timecode in every frame (bottom right corner).
• [key].encode.output.width (integer) – The width, in pixels, of the final video.
• [key].encode.output.height (integer) – The height, in pixels, of the final video.
• [key].encode.output.abitrate (integer) – The audio bitrate to use for the final video.
• [key].encode.output.vbitrate (integer) – The video bitrate to use for the final video.
• [key].encode.output.stamp_timecode (boolean) – Activates stamping the video timecode in the final video stream (top left corner).
• [key].encode.composition.enabled (boolean) – Enable composition functions
• [key].encode.composition.has_monitor (boolean) – The monitor screen is in the composition panel
• [key].encode.composition.width (integer) – The width, in pixels, of the monitor video.
• [key].encode.composition.height (integer) – The height, in pixels, of the monitor video.
• [key].encode.composition.abitrate (integer) – The audio bitrate to use for the monitor.
• [key].encode.composition.vbitrate (integer) – The video bitrate to use for the monitor.
• [key].services.leaf.compression (boolean) – If the compression is active or not
• [key].services.leaf.bufferSize (integer) – The web socket read and write buffer size

Example query:

{}

GET /schemas/settings.json

This schema is used to validate the settings.