The Genvid Settings

The settings are contained under the settings element in a configuration file.

Name

Type

Description

Validations

info

object (required)

Information about the stream.

  • Its property set must contains all elements in True

info.name

string (required)

The name of the stream.

info.game

string (required)

The game being played.

info.description

string (required)

A description of the stream.

ntp

object

Parameters affecting the time synchronization.

  • Its property set must contains all elements in False

ntp.server

string (required)

Host name for the NTP server. We recommend using the 169.254.169.123 server for AWS.

ntp.polling

integer (required)

Interval between two synchronizations.

encode

object (required)

Parameters affecting the encoding of the video stream.

  • Its property set must contains all elements in True

encode.stream

object (required)

Parameters related to the streaming service.

  • Its property set must contains all elements in True

encode.stream.service

string (required)

The live streaming service type.

  • It must be equal to one of the elements in [“youtube”, “twitch”, “standalone”]

encode.stream.addr

string (required)

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 (required)

The user-specific streaming key to allow pushing data to ‘addr’.

encode.stream.delayoffset

string (required)

An optional delay allowing to offset the video stream with regard to the game stream.

encode.stream.extradelay

number (required)

An optional delay allowing to offset the broadcast for the standalone player.

encode.stream.check

object

Settings to configure how Studio will monitor the live stream and if it recovers in case of a failure.

  • Its property set must contains all elements in False

encode.stream.check.enable

boolean (required)

Enable monitoring of the OVP Broadcast health. Default is False.

encode.stream.check.interval

integer (required)

Frequency of Monitoring calls (in seconds). Default is 2.

encode.stream.check.recovery

boolean (required)

Automatically restart a Broadcast in case of failure. Default is False.

encode.stream.check.errorThreshold

integer (required)

Number of consecutive restart failures allowed before aborting the retries. Default is 5.

encode.input

object (required)

Parameters affecting the input encoding inside the game.

  • Its property set must contains all elements in True

encode.input.width

integer (required)

The width, in pixels, of a game frame.

encode.input.height

integer (required)

The height, in pixels, of a game frame.

encode.input.silent

boolean (required)

Disables the audio stream.

encode.input.stamp_timecode

boolean (required)

Activates stamping the game timecode in every frame (bottom right corner).

encode.output

object (required)

Parameters affecting the final encoding being streamed.

  • Its property set must contains all elements in True

encode.output.framerate

number

The frame per second of the final video.

encode.output.width

integer (required)

The width, in pixels, of the final video.

encode.output.height

integer (required)

The height, in pixels, of the final video.

encode.output.abitrate

integer (required)

The audio bitrate to use for the final video.

encode.output.vbitrate

integer (required)

The video bitrate to use for the final video.

encode.output.stamp_timecode

boolean (required)

Activates stamping the video timecode in the final video stream (top left corner).

encode.composition

object (required)

Parameters affecting the composition from sources

  • Its property set must contains all elements in True

encode.composition.enabled

boolean (required)

Enable composition functions

encode.composition.has_monitor

boolean (required)

The monitor screen is in the composition panel

encode.composition.width

integer (required)

The width, in pixels, of the monitor video.

encode.composition.height

integer (required)

The height, in pixels, of the monitor video.

encode.composition.abitrate

integer (required)

The audio bitrate to use for the monitor.

encode.composition.vbitrate

integer (required)

The video bitrate to use for the monitor.

dataStreams

object

Parameters for the data stream

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

object

Parameters for the services

services.leaf

object

Parameters for the leaf service

  • Its property set must contains all elements in False

services.leaf.compression

boolean (required)

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.

services.leaf.websocketURLSuffix

string

The leaf’s websocket endpoint.

services.studio

object

Parameters for the studio service

  • Its property set must contains all elements in False

services.studio.enable

boolean (required)

Start the studio service. If false, the studio service will not start.

broadcast

object

Information about the broadcast behavior.

  • Its property set must contains all elements in False

broadcast.enable

boolean (required)

Start the stream in on-air mode. This setting doesn’t affect the standalone mode. If false, the stream will not be sent immediately and you will need to go in Studio to activate it. See Starting a broadcast when streaming on YouTube or Twitch for more details.

Deprecated Settings

Name

Type

Description

Version

encode.ingest.extradelay

number (required)

An optional delay allowing to offset the encoding delay from the source (seconds).

Deprecated since version 1.20.0.