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. |
|
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. |
|
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. |
|
encode.stream | object (required) | Parameters related to the streaming service. |
|
encode.stream.enabled | boolean (required) | A flag activating or deactivating the streaming. | |
encode.stream.service | string (required) | The live streaming service type. |
|
encode.stream.addr | string (required) | The address of the live streaming server receiving the video stream (typically, an RTMP URL). | |
encode.stream.channel | string (required) | 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.input | object (required) | Parameters affecting the input encoding inside the game. |
|
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. |
|
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 |
|
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. | |
encode.ingest | object (required) | Parameters affecting the ingest service | |
encode.ingest.extradelay | number | An optional delay allowing to offset the encoding delay from the source (seconds). | |
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 | |
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. | |
broadcast | object | Information about the broadcast behavior. |
|
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. |