# Presets Lists

API call format

GET /broker/presets					//Use token autorization
GET /broker/private/presets			//Use Api Key		

Description

This call gets all available presets. A preset is a pre-defined collection of encoding parameters.

Precondition

  • Authorization token/Api key is needed.

Postcondition

  • On success response code should be 200
  • On success all available presets in JSON format are returned.
  • On failure an error will be returned with the right error code and description.

Example:

[Request] GET https://<base_api_url>/broker/presets
[Request] GET https://<base_api_url>/broker/private/presets
[Request Headers] {"Content-Type":"application/json","Accept":"application/json","Authorization":"<IdToken>"} //Use token autorization
[Request Headers] {"Content-Type":"application/json","Accept":"application/json","X-Api-Key":"<api_key>"}     //Use Api Key

[Response] 201
[Response Headers] {"Content-Type":["application/json"],"Content-Length":["..."],"Connection":["keep-alive"],"Date":["..... GMT"],"x-amzn-RequestId":["....."],....]}
[Response] 
{
	"status": true,
	"data": 
	[
		{
			"guid": "<prest_guid_01>",
			"presetType": "preset",
			"label": "qa2-vod-mp4_360p",
			"content": 
			{
				"Description": "MP4, TS, AVC, AAC, 16x9 DAR, 640x360p, 29.97 Hz,  1.2 Mbps CBR",
				"Category": "Ignition-MP4",
				"Settings": 
				{
					"VideoDescription": 
					{
						"TimecodeInsertion": "DISABLED",
						"DropFrameTimecode": "ENABLED",
						"ScalingBehavior": "DEFAULT",
						"ColorMetadata": "INSERT",
						"RespondToAfd": "NONE",
						"AntiAlias": "ENABLED",
						"Height": 360,
						"Width": 640,
						"Sharpness": 50,
						"CodecSettings": 
						{
							"H264Settings": 
							{
								"HrdBufferSize": 2400000,
								"Slices": 1,
								"FramerateControl": "SPECIFIED",
								"FlickerAdaptiveQuantization": "ENABLED",
								"NumberBFramesBetweenReferenceFrames": 3,
								"FramerateNumerator": 30000,
								"ParControl": "SPECIFIED",
								"GopClosedCadence": 1,
								"SpatialAdaptiveQuantization": "ENABLED",
								"CodecLevel": "LEVEL_3_1",
								"MinIInterval": 0,
								"SceneChangeDetect": "ENABLED",
								"FramerateDenominator": 1001,
								"RepeatPps": "DISABLED",
								"GopSize": 90,
								"AdaptiveQuantization": "MEDIUM",
								"CodecProfile": "MAIN",
								"FramerateConversionAlgorithm": "DUPLICATE_DROP",
								"EntropyEncoding": "CABAC",
								"NumberReferenceFrames": 3,
								"TemporalAdaptiveQuantization": "ENABLED",
								"ParDenominator": 1,
								"Telecine": "NONE",
								"GopSizeUnits": "FRAMES",
								"QualityTuningLevel": "SINGLE_PASS_HQ",
								"UnregisteredSeiTimecode": "DISABLED",
								"Bitrate": 1200000,
								"ParNumerator": 1,
								"RateControlMode": "CBR",
								"HrdBufferInitialFillPercentage": 90,
								"InterlaceMode": "PROGRESSIVE",
								"FieldEncoding": "PAFF",
								"GopBReference": "ENABLED",
								"Syntax": "DEFAULT",
								"SlowPal": "DISABLED"
							},

							"Codec": "H_264"
						},

						"AfdSignaling": "NONE",
						"VideoPreprocessors": 
						{
							"Deinterlacer": 
							{
								"Algorithm": "INTERPOLATE",
								"Control": "NORMAL",
								"Mode": "DEINTERLACE"
							}
						}
					},

					"AudioDescriptions": 
					[
						{
							"AudioType": 0,
							"AudioSourceName": "Audio Selector 1",
							"AudioTypeControl": "FOLLOW_INPUT",
							"CodecSettings": 
							{
								"Codec": "AAC",
								"AacSettings": 
								{
									"RateControlMode": "CBR",
									"CodecProfile": "HEV1",
									"CodingMode": "CODING_MODE_2_0",
									"AudioDescriptionBroadcasterMix": "NORMAL",
									"SampleRate": 48000,
									"RawFormat": "NONE",
									"Specification": "MPEG4",
									"Bitrate": 96000
								}
							},

							"LanguageCodeControl": "FOLLOW_INPUT"
						}
					],

					"ContainerSettings": 
					{
						"Container": "MP4",
						"Mp4Settings": 
						{
							"CslgAtom": "INCLUDE",
							"FreeSpaceBox": "EXCLUDE",
							"MoovPlacement": "PROGRESSIVE_DOWNLOAD"
						}
					}
				},

				"Name": "qa2-vod-mp4_360p"
			},

			"isActive": 0
		}
		...	
	]
}