Options

Name	Type	Description
report_version	enum                           v2.0 v3.0	*****
use_timecode	boolean	*****
timecode_kind	enum                           timecode_auto timecode_drop timecode_nodrop frame_nr media_time	Choose the time/timecode format. If timecode_auto is used, drop/non-drop is chosen based on the frame rate. default: timecode_auto
timecode_frame_rate	string number	*****
display_paths	boolean	Show the full file path in the PDF report. default: true
include_in_pdf	array enum                           all analysis analysis_summary thumbnails charts	Choose sections to include in pdf document. Applies to only > v3.0 pdf generation default: all
custom_logo	object	location of custom logo to dislay in pdf. Default is a dolby logo
time_unit_display	enum                           time time_code frames	Choose the time/time_code/frames format in general and deep properties. default: time
source_timecode_selector	enum                           first highest lowest mxf gop sdti smpte material_package source_package	Specifies the metadata track to be used for time code data. [DESC] default: first

---

Example options

{
  "uid": "analyze_task",
  "kind": "analyze",
  "payload": {
    "reports": [
      {
        "create_condition": "always",
        "file_pattern": "{source_basename}_report.pdf",
        "location": {
          "storage_provider": "s3",
          "path": "s3://my_bucket/my_reports_folder"
        },
        "options": {
          "report_version": "v3.0",
          "display_paths": false,
          "time_unit_display": "time_code"
        }
      }
    ],
    "general_properties": {
      "enabled": true
    },
    "deep_properties": {
      "audio": [
        {
          "volume": {
            "enabled": true
          },
          "levels": {
            "enabled": true
          }
        }
      ],
      "video": {
        "black_borders": {
          "black_level": 0.08,
          "enabled": true
        },
        "levels": {
          "chroma_levels": true,
          "histograms": true,
          "enabled": true
        }
      }
    }
  }
}