This documentation teaches us how to configure our .json file
01 What is the purpose of this file?
- [ ] Once the template and audio have been created, all that remains is to create the configuration file, called "configuration.json"..
- [ ] This file is used to enter all the information concerning the template to be synchronised on the platform:
- Template location
- Video resolution
- Variables used in the template
- The duration (in frames) of the template*.
02 How is it created?
- [ ] Here is an example of config.json :
{
"VideoQuality": "Resolution720p",
"UseSoundFromCompositions": true,
"Files": [
{
"Filename": "Audio_Noel.aac",
"Target": "Audio_Noel.aac"
},
{
"Filename": "Audio_Ete.aac",
"Target": "Audio_Ete.aac"
},
{
"Filename": "Audio_Generique.aac",
"Target": "Audio_Generique.aac"
},
{
"Filename": "Audio_Hiver.aac",
"Target": "Audio_Hiver.aac"
}
],
"Parts": [
{
"RushType": "AE",
"Path": "Petits_freres_des_pauvres_animation_XML.aepx",
"CompositionName": "_FINAL",
"FrameToStart": 0,
"Start": 0,
"End": 71,
"Variables": [ ],
"Condition": ""
},
{
"RushType": "AE",
"Path": "Petits_freres_des_pauvres_animation_XML.aepx",
"CompositionName": "_FINAL",
"FrameToStart": -1,
"Start": 72,
"End": 299,
"Variables": [ "TXT_NAME","TXT_LOCALISATION" ],
"Condition": ""
},
{
"RushType": "AE",
"Path": "Petits_freres_des_pauvres_animation_XML.aepx",
"CompositionName": "_FINAL",
"FrameToStart": -1,
"Start": 300,
"End": 1003,
"Variables": [ ],
"Condition": ""
},
{
"RushType": "AE",
"Path": "Petits_freres_des_pauvres_animation_XML.aepx",
"CompositionName": "_ETE",
"FrameToStart": 0,
"Start": 1004,
"End": 1230,
"Variables": [ "TXT_NAME" ],
"Condition": "TXT_Periode equals Ete"
},
{
"RushType": "AE",
"Path": "Petits_freres_des_pauvres_animation_XML.aepx",
"CompositionName": "_HIVER",
"FrameToStart": 0,
"Start": 1004,
"End": 1230,
"Variables": [ "TXT_NAME" ],
"Condition": "TXT_Periode equals Hiver"
},
{
"RushType": "AE",
"Path": "Petits_freres_des_pauvres_animation_XML.aepx",
"CompositionName": "_NOEL",
"FrameToStart": 0,
"Start": 1004,
"End": 1230,
"Variables": [ "TXT_NAME" ],
"Condition": "TXT_Periode equals Noel"
},
{
"RushType": "AE",
"Path": "Petits_freres_des_pauvres_animation_XML.aepx",
"CompositionName": "_GENERIQUE",
"FrameToStart": 0,
"Start": 1004,
"End": 1230,
"Variables": [ "TXT_NAME" ],
"Condition": "TXT_Periode not contains Noel && TXT_Periode not contains Hiver && TXT_Periode not contains Ete"
},
{
"RushType": "AE",
"Path": "Petits_freres_des_pauvres_animation_XML.aepx",
"CompositionName": "_FINAL",
"FrameToStart": -1,
"Start": 1231,
"End": 1485,
"Variables": [ ],
"Condition": ""
},
],
"Covers": [
{
"Start": 0,
"End": 74,
"RushType": "AE",
"Path": "Petits_freres_des_pauvres_animation_XML.aepx",
"CompositionName": "COVER",
"Variables": [],
"Condition": ""
},
],
"Audios": [
// Audio Generique
{
"Path": "Audio_Generique.aac",
"Variables": [ "TXT_Periode" ],
"Condition": "TXT_Periode not contains Ete && TXT_Periode not contains Noel && TXT_Periode not contains Hiver"
},
// Audio Ete
{
"Path": "Audio_Ete.aac",
"Variables": [ "TXT_Periode" ],
"Condition": "TXT_Periode equals Ete"
},
// Audio Noel
{
"Path": "Audio_Noel.aac",
"Variables": [ "TXT_Periode" ],
"Condition": "TXT_Periode equals Noel"
},
// Audio Hiver
{
"Path": "Audio_Hiver.aac",
"Variables": [ "TXT_Periode" ],
"Condition": "TXT_Periode equals Hiver"
},
],
"Variables": [
{
"Name": "TXT_NAME",
"DefaultValue": "",
"ExampleValue": "Jean_Emmanuel",
"MaxLength": 50
},
{
"Name": "TXT_LOCALISATION",
"DefaultValue": "",
"ExampleValue": "Marseille",
"MaxLength": 30
},
{
"Name": "TXT_Periode",
"DefaultValue": "",
"ExampleValue": "Hiver",
"MaxLength": 30
},
{
"Name": "TXT_date_don",
"DefaultValue": "",
"ExampleValue": "",
"MaxLength": 30
},
{
"Name": "TXT_num_transaction",
"DefaultValue": "",
"ExampleValue": "",
"MaxLength": 30
},
],
}
03 Fill in the Json file (Set up)
- [ ] The first step is to enter the video resolution and the location of the audio files (.aac) in the Json file.
{
"VideoQuality": "Resolution540p",
"Files": [
{
"Filename": "Audio_Noel.aac",
"Target": "Audio_Noel.aac"
},
{
"Filename": "Audio_Ete.aac",
"Target": "Audio_Ete.aac"
},
{
"Filename": "Audio_Generique.aac",
"Target": "Audio_Generique.aac"
},
{
"Filename": "Audio_Hiver.aac",
"Target": "Audio_Hiver.aac"
}
- [ ] Videos can be in 360p, 540p, 720p or 1080p.
04 Fill in the Json file (Parts)