Ingest Profiles Fields Reference

Profile fields

Top-Level Profile Options

Property	Type	Description	DD	CAE	Default
id	string	The profile id (read-only)			none
version	integer	The profile version (read-only)			none
account_id	integer	The Video Cloud account id			none
name	string	The profile name - must be unique within the account			none
description	string	The profile description			none
date_created	integer (epoch timestamp (milliseconds)	Date profile was created (read-only)			none
date_last_modified	integer (epoch timestamp in milliseconds)	Date profile was last modified (read-only)			none
brightcove_standard	boolean	Read-only - false for all custom profiles	false
digital_master	object	Defines if and how to archive a digital master			{}
dynamic_origin	object	Defines renditions and images			{}
renditions	array	Array of rendition objects; not used for DD or CAE, so will be an empty array for these profiles			[]

Digital master fields

The digital_master object defines if and how to store a digital master that you can use for retranscoding later. See Archiving Masters for details.

Digital Master Fields

Property	Type	Description	DD	CAE	Default
rendition	string	The rendition to archive - either passthrough or none are the only options for DD and CAE profiles			passthrough
distribute	boolean	Whether the digital_master should be pushed to the CDN to available for playback; this option does not currently work for DD or CAE profiles and will revert to false if you set it to true			false

Dynamic Origin Fields

Dynamic Origin Fields

Property	Type	Description	DD	CAE	Default
renditions	array	Array of renditions to be produced; for CAE, only include any audio-only renditions you want. See the available renditions you can select from	[]
images	array	Array of image objects for the poster and thumbnail			[]
dynamic_profile_options	object	Defines rendition options for CAE profiles			{}

Image fields

Image Fields

Property	Type	Description	DD	CAE	Default
label	string	The image type: either poster or thumbnail			none
height	number	Height of the image in pixels			none
width	number	Width of the image in pixels			none

Dynamic Profile Options Fields

The dynamic profile options fields provide guidelines for rendition creation when you are using Context Aware Encoding.

Dynamic Profile Options

Property	Type	Description	DD	CAE	Default
video_codecs	Array	For mixed-codec outputs, an array of the codecs to create renditions for. Currently, the allowed item values are h264 and hevc		[2-1]	none
video_codec_options	Array	For mixed-codec outputs, an object specifying the options for each codec. Each property is an object with the name h264 or hevc, its properties are the set the constraints for renditions for that codec. The allowed properties for these objects are: min_renditions required min_bitrate max_bitrate max_first_rendition_bitrate min_resolution max_resolution max_first_rendition_resolution		[2-2]	none
min_renditions	Number	The minimum number of renditions that should be created (required)			none
max_renditions	Number	The maximum number of renditions that should be created (required)			none
min_resolution	object	The minimum resolution for renditions			none
min_resolution.width	number	The minimum width for renditions in pixels			none
min_resolution.height	number	The minimum height for renditions in pixels			none
max_resolution	object	The maximum resolution for renditions			defaults to source resolution
max_resolution.width	number	The maximum width for renditions in pixels			source width
max_resolution.height	number	The maximum height for renditions in pixels			source height
max_bitrate	number	The maximum bitrate for renditions in kbps			source bitrate
max_first_rendition_bitrate	number	The maximum bitrate for the lowest bitrate rendition in kbps			source bitrate
max_frame_rate	number	The maximum frame rate for renditions in fps			30
keyframe_rate	number	The number of keyframes per second for renditions (So a value of 0.5 would result in one keyframe every two seconds; a value of 3 would result in three keyframes per second)			0.5
select_baseline_profile_configuration	boolean	At least one rendition used in the profile will be baseline profile			false
watermarks	array	Array of watermark objects specifying one or more watermarks to be added to renditions			false

Notes

Watermark Fields

Watermark images are burned into each video frame in the lower right corner.

Notes

• ^[3-1] If you specify the width only, the image aspect ratio will be maintained automatically
• ^[3-2] Although the width, height, x, and y fields are string values; they contain numbers (pixels or percentage)