This documentation teaches us how to configure our .json file

01 What is this file for?

Once the template and the audio are created, the next step is to create the configuration file, called “configuration.json”.

This file allows you to provide all the information regarding the template to be synchronized on the platform:

• The video resolution
• The names of the compositions in the template
• The variables used in the template
• The conditions allowing the custom sequences to be triggered
• In case a composition is divided into several parts, the start and end frames corresponding to the parts in question

02 Example of config

"VideoQuality": "Resolution720p",
"UseSoundFromCompositions": true,
"Parts": [
	// Part_01
	{
		"CompositionName": "00_LOGO",
		"Variables": [],
		"Condition": ""
	},
	// Part_02
	{
		"CompositionName": "01_INTRO",
		"FrameToStart": 0,
		"Variables": [
			"TXT_civilite",
			"TXT_date_souscription"
		],
		"Condition": ""
	},
	// Part_03
	{
		"CompositionName": "02_CONTRAT_MONO",
		"Variables": [
			"TXT_nom_contrat"
		],
		"Condition": "TXT_mono_contrat == 1 && TXT_multi_contrats == 0"
	},
	// Part_04
	{
		"CompositionName": "02_CONTRAT_MULTI",
		"Variables": [
			"TXT_nom_contrat"
		],
		"Condition": "TXT_mono_contrat == 0 && TXT_multi_contrats == 1"
	},
	// Part_05
	{
		"CompositionName": "03_ESPACE_CLIENT",
		"Variables": [],
		"Condition": ""
	},
	// Part_06
	{
		"CompositionName": "04_LIBRE",
		"Variables": [
			"TXT_type_gestion"
		],
		"Condition": "TXT_type_gestion equals LIBRE"
	},
	// Part_07
	{
		"CompositionName": "04_AUTRE",
		"Variables": [
			"TXT_type_gestion"
		],
		"Condition": "TXT_type_gestion not equals LIBRE"
	},
	// Part_08
	{
		"CompositionName": "05_OUTRO",
		"Variables": [],
		"Condition": ""
	},
],
"Audios": [
	// MUSIC
	{
		"Path": "audio.aac",
		"Variables": [],
		"Condition": "",
	},
],
"Covers": [
	{
		"Start": 1,
		"End": 1,
		"RushType": "AE",
		"Path": "Template_GanVie.aepx",
		"CompositionName": "COVER",
		"Variables": [],
		"Condition": ""
	},
],
"Variables": [
	{
		"Name": "TXT_civilite",
		"DefaultValue": "",
		"ExampleValue": "Madame",
		"MaxLength": 100
	},
	{
		"Name": "TXT_date_souscription",
		"DefaultValue": "",
		"ExampleValue": "1998",
		"MaxLength": 5
	},
	{
		"Name": "TXT_nom_contrat",
		"DefaultValue": "",
		"ExampleValue": "Gan Prévoyance Retraite active",
		"MaxLength": 100
	},
	{
		"Name": "TXT_mono_contrat",
		"DefaultValue": "",
		"ExampleValue": "1",
		"MaxLength": 2
	},
	{
		"Name": "TXT_multi_contrats",
		"DefaultValue": "",
		"ExampleValue": "0",
		"MaxLength": 2
	},
	{
		"Name": "TXT_type_gestion",
		"DefaultValue": "",
		"ExampleValue": "LIBRE",
		"MaxLength": 100
	},
],

}

03 Fill in the Json file (Set up)

• [ ] First, fill in the video resolution in the JSON file. Here are the possible resolutions:

Video quality between templates and codebase ?

• [ ] Then, indicate whether the sound from the compositions should be used (for example, if the voice-over and sound design are inside the compositions and not in an external audio.aac file):