Ingest Profiles API Fields Reference for Dynamic Delivery and Context Aware Encoding

Product(s)
Video Cloud
Role(s)
API Developer
Topic(s)
Dynamic Delivery
Ingest Profiles
API(s)
Ingest Profiles API

This is a reference to fields for ingest profiles for Dynamic Delivery (DD) and Context Aware Encoding (CAE).

Also see Ingest Profiles API Fields Reference (Legacy Ingest) if your account is on the legacy ingest system.

Profile fields

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

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 yes yes 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 yes no 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 yes yes []
dynamic_profile_options object Defines rendition options for CAE profiles no yes {}

Image fields

Image Fields
Property Type Description DD CAE Default
label string The image type: either poster or thumbnail yes yes none
height number Height of the image in pixels yes yes none
width number Width of the image in pixels yes yes 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
min_renditions Number The minimum number of renditions that should be created (required) no yes none
max_renditions Number The maximum number of renditions that should be created (required) no yes none
min_resolution object The minimum resolution for renditions no yes none
min_resolution.width number The minimum width for renditions in pixels no yes none
min_resolution.height number The minimum height for renditions in pixels no yes none
max_resolution object The maximum resolution for renditions no yes defaults to source resolution
max_resolution.width number The maximum width for renditions in pixels no yes source width
max_resolution.height number The maximum height for renditions in pixels no yes source height
max_bitrate number The maximum bitrate for renditions in kbps no yes source bitrate
max_first_rendition_bitrate number The maximum bitrate for the lowest bitrate rendition in kbps no yes source bitrate
max_frame_rate number The maximum frame rate for renditions in fps no yes 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) no yes 0.5
select_baseline_profile_configuration boolean At least one rendition used in the profile will be baseline profile no yes false