Dolby Hybrik

https://docs.hybrik.com
Admin
Dolby Hybrik is a cloud-based platform that provides large-scale media processing operations,...
Tokens:216,155
Snippets:1,635
Trust Score:7.4
Update:1 month ago
Show doc for...
Tokens:
Raw
### Example timecode configuration

Source: https://docs.hybrik.com/job_json/tasks/transcode.targets.timecode

Demonstrates a transcode task target configured with a specific start timecode value.

```json
{

  "uid": "transcode_task",

  "kind": "transcode",

  "payload": {

    "location": {

      "storage_provider": "s3",

      "path": "s3://my_bucket/my_folder"

    },

    "targets": [

      {

        "file_pattern": "{source_basename}_converted{default_extension}",

        "existing_files": "replace",

        "timecode": [

          {

            "source": "start_value",

            "start_value": "01:00:00;00"

          }

        ],

        "container": {

          "kind": "mp4"

        },

        "video": {

          "width": 1280,

          "height": 720,

          "codec": "h264",

          "frame_rate": "30000/1001"

        },

        "audio": [

          {

            "codec": "aac",

            "channels": 2,

            "sample_rate": 48000,

            "sample_size": 16,

            "bitrate_kb": 96

          }

        ]

      }

    ]

  }

}
```

--------------------------------

### Example DPP Packager Target Configuration

Source: https://docs.hybrik.com/job_json/tasks/dpp_packager.target

A JSON configuration example demonstrating the structure of a dpp_packager task target.

```json
{

  "uid": "dpp_package_task",

  "kind": "dpp_packager",

  "payload": {

    "target": {

      "location": {

        "storage_provider": "s3",

        "path": "s3://my_bucket/my_destination"

      },

      "file_pattern": "{source_basename}_dpp.mxf"

    },

    "dpp_schema": "d10"

  }

}
```

--------------------------------

### Create Job API Examples

Source: https://docs.hybrik.com/rest_api/create_job

Examples demonstrating how to submit a job using cURL and the JavaScript API client, along with the expected JSON response.

```bash
$ curl -u OAPI_KEY:OAPI_SECRET -X POST https://api-demo.hybrik.com/v1/jobs \

  -d '{

  "name": "Fifth Element, Web Streaming",

  "user_tag": "myjob_012345",

  "schema": "hybrik",

  "payload": "<job JSON goes here>",

  "priority": 100,

  "task_tags": [

    "high_performance",

    "us-west-1"

  ]

}' \

  -H "Content-Type: application/json" \

  -H "X-Hybrik-Sapiauth: api_auth_token" \

  -H "X-Hybrik-Compliance: 20220423"
```

```javascript
//Submit a job

hybrik_api.call_api('POST', '/jobs', null, {

    name: "My job",

    priority: 100,

    task_tags: ["high_performance", "us-west-1"],

    payload: {

        // this is the job JSON

    }

})
```

```json
{

  "id": "12345"

}
```

--------------------------------

### DASH Packaging Adaptation Sets Example

Source: https://docs.hybrik.com/job_json/tasks/package.dash.adaptation_sets

A JSON configuration example demonstrating the inclusion of an adaptation set within a DASH packaging payload.

```json
{

  "uid": "dash_unencrypted_packaging",

  "kind": "package",

  "payload": {

    "kind": "dash",

    "location": {

      "storage_provider": "s3",

      "path": "s3://my_bucket/my_folder",

      "attributes": [

        {

          "name": "ContentType",

          "value": "application/dash+xml"

        }

      ]

    },

    "file_pattern": "manifest.mpd",

    "uid": "main_manifest",

    "force_original_media": false,

    "media_location": {

      "storage_provider": "s3",

      "path": "s3://my_bucket/my_folder",

      "attributes": [

        {

          "name": "ContentType",

          "value": "video/mp4"

        }

      ]

    },

    "dash": {

      "title": "some dash title",

      "info_url": "www.dolby.com",

      "adaptation_sets": [

        {

          "track_group_id": "1",

          "id": 1,

          "role": "main"

        }

      ]

    }

  }

}
```

--------------------------------

### UK DPP AS-11 Configuration Example

Source: https://docs.hybrik.com/job_json/tasks/dpp_packager.as11_options.ukdpp

A complete JSON payload example for configuring the dpp_packager task with ukdpp-specific metadata.

```json
{

  "uid": "dpp_packager",

  "kind": "dpp_packager",

  "task": {

    "retry_method": "fail"

  },

  "payload": {

    "target": {

      "location": {

        "storage_provider": "s3",

        "path": "{{destination_path}}"

      },

      "file_pattern": "tos_mxfdpp_as11_metadata.mxf"

    },

    "dpp_schema": "op1a",

    "as11_options": {

      "core": {},

      "ukdpp": {

        "ProductionNumber": "C5/30571/0001A",

        "Synopsis": "Your Synopsis Here",

        "Originator": "Originator or Studio Name Here",

        "CopyrightYear": 2010,

        "PictureRatio": "16:9",

        "Distributor": "Distributor Name Here",

        "ThreeD": false,

        "ProductPlacement": false,

        "PSEPass": 1,

        "PSEManufacturer": "Harding FPA",

        "PSEVersion": "3.4.0",

        "SecondaryAudioLanguage": "zxx",

        "TertiaryAudioLanguage": "zxx",

        "AudioLoudnessStandard": 0,

        "LineUpStart": "09:59:30:00",

        "IdentClockStart": "09:59:50:00",

        "AudioDescriptionPresent": false,

        "OpenCaptionsPresent": false,

        "SigningPresent": 1,

        "CompletionDate": "2020-10-10",

        "ContactEmail": "contact@emailaddress.com",

        "ContactTelephoneNumber": "02035403630",

        "TotalNumberOfParts": 3,

        "TotalProgrammeDuration": "00:04:30:00"

      },

      "segmentation": []

    }

  }

}
```

--------------------------------

### Example results_file configuration

Source: https://docs.hybrik.com/job_json/tasks/analyze.deep_properties.video.vmaf.results_file

Demonstrates how to define the results_file object within the deep_properties.video.vmaf structure.

```json
{

  "uid": "analyze_task",

  "kind": "analyze",

  "payload": {

    "compare_asset": {

      "kind": "asset_url",

      "payload": {

        "storage_provider": "s3",

        "url": "s3://my_bucket/my_reference_file.mov"

      }

    }

  },

  "deep_properties": {

    "video": {

      "settings": {

        "comparative": {

          "size_selector": "config",

          "width": 1280,

          "height": 720

        }

      },

      "vmaf": {

        "enabled": true,

        "results_file": {

          "file_pattern": "{source_basename}_vmaf_analysis.txt",

          "location": {

            "storage_provider": "s3",

            "url": "s3://my_bucket/my_folder"

          }

        }

      }

    }

  }

}
```

--------------------------------

### Trim by Seconds Example

Source: https://docs.hybrik.com/job_json/common_elements/trim

A focused example of the trim object using inpoint_sec and outpoint_sec.

```json
{

  "uid": "source_file",

  "kind": "source",

  "payload": {

    "kind": "asset_url",

    "payload": {

      "storage_provider": "s3",

      "url": "s3://my_bucket/my_input_folder/my_file.mp4",

      "trim": {

        "inpoint_sec": 600,

        "outpoint_sec": 720

      }

    }

  }

}
```

--------------------------------

### Simple Source Configuration

Source: https://docs.hybrik.com/tutorials/decoding_error_options

Example of applying decoding options to a simple asset_url source configuration.

```json

{  

    "uid": "source",  

    "kind": "source",  

    "payload": {  

        "kind": "asset_url",  

        "payload": {  

            "storage_provider": "s3",  

            "url": "{{source_file}}",  

            "options": {  

                "max_decode_errors": 20,  

                "max_sequential_decode_errors": 5  

            }  

        }  

    }  

},  



```

--------------------------------

### Subtitle Equality Error JSON

Source: https://docs.hybrik.com/tutorials/troubleshooting

Example of the error message returned when subtitle start and stop times are invalid or equal.

```json
"message": "exception in core transcode",  

"details": "Subtitle start and stop time can not be equal, stop time can not be a zero and start time must be smaller than stop time",  
```

--------------------------------

### Hybrik Include_if_source_has Example

Source: https://docs.hybrik.com/job_json/common_elements/include_if_source_has

A full payload example demonstrating how to conditionally create an output audio file only if the input source contains an audio track.

```json
{

  "name": "Hybrik Include_if_source_has Example",

  "payload": {

    "elements": [

      {

        "uid": "source_file",

        "kind": "source",

        "payload": {

          "kind": "asset_url",

          "payload": {

            "storage_provider": "s3",

            "url": "s3://my_bucket/my_input_folder/my_file.mp4"

          }

        }

      },

      {

        "uid": "transcode_task",

        "kind": "transcode",

        "payload": {

          "location": {

            "storage_provider": "s3",

            "path": "s3://my_bucket/my_output_folder"

          },

          "targets": [

            {

              "file_pattern": "{source_basename}_video.mp4",

              "existing_files": "replace",

              "container": {

                "kind": "mp4"

              },

              "video": {

                "codec": "h264",

                "bitrate_mode": "vbr",

                "bitrate_kb": 1000,

                "max_bitrate_kb": 1150,

                "height": 720

              }

            },

            {

              "include_if_source_has": [

                "audio[0]"

              ],

              "file_pattern": "{source_basename}_audio.mp4",

              "existing_files": "replace",

              "container": {

                "kind": "mp4"

              },

              "audio": [

                {

                  "channels": 2,

                  "codec": "aac_lc",

                  "sample_rate": 48000,

                  "bitrate_kb": 128

                }

              ]

            }

          ]

        }

      }

    ],

    "connections": [

      {

        "from": [

          {

            "element": "source_file"

          }

        ],

        "to": {

          "success": [

            {

              "element": "transcode_task"

            }

          ]

        }

      }

    ]

  }

}
```

--------------------------------

### Subtitle Timing Error JSON

Source: https://docs.hybrik.com/tutorials/troubleshooting

Example of the error message returned when a subtitle cue has invalid start and end timestamps.

```json
"message": "exception in package task",  

"details": "Start timestamp greater than end (cue #1368)",  
```

--------------------------------

### Example image_sequence configuration

Source: https://docs.hybrik.com/job_json/tasks/transcode.targets.video.image_sequence

Demonstrates a transcode payload configured to output a sequence of 100 JPEG thumbnails.

```json
{

  "uid": "transcode_thumbnails",

  "kind": "transcode",

  "payload": {

    "location": {

      "storage_provider": "s3",

      "path": "s3://my_bucket/my_folder/thumbnails"

    },

    "targets": [

      {

        "uid": "thumbnails",

        "file_pattern": "thumb_%05d.jpg",

        "existing_files": "replace",

        "video": {

          "codec": "jpeg",

          "width": 256,

          "height": 144,

          "image_sequence": {

            "total_number": 100,

            "offset_sec": 0

          }

        }

      }

    ]

  }

}
```

--------------------------------

### Smooth Encrypted Packaging Configuration

Source: https://docs.hybrik.com/job_json/tasks/package.smooth

Example configuration for a Smooth packaging task with encryption enabled.

```json
{

  "uid": "smooth_encrypted_packaging",

  "kind": "package",

  "payload": {

    "location": {

      "storage_provider": "s3",

      "path": "s3://my_bucket/my_folder",

      "attributes": [

        {

          "name": "ContentType",

          "value": "application/vnd.ms-sstr+xml"

        }

      ]

    },

    "file_pattern": "manifest.ism",

    "kind": "smooth",

    "uid": "main_manifest",

    "force_original_media": false,

    "encryption": {

      "enabled": true,

      "schema": "mpeg-cenc",

      "drm": [

        "playready"

      ],

      "key_id": "XXXXXX51686b5e1ba222439ecec1f12a",

      "key": "0000002cbf1a827e2fecfb87479a2",

      "playready_url": "http://playready.directtaps.net/pr/svc/rightsmanager.asmx"

    },

    "media_location": {

      "storage_provider": "s3",

      "path": "s3://my_bucket/my_folder",

      "attributes": [

        {

          "name": "ContentType",

          "value": "video/mp4"

        }

      ]

    }

  }

}
```

--------------------------------

### Example video_overlay configuration

Source: https://docs.hybrik.com/job_json/tasks/transcode.targets.video.filters.payload.video_overlay

A JSON configuration demonstrating the use of video_overlay within a transcode task payload.

```json
{

  "uid": "transcode_media",

  "kind": "transcode",

  "payload": {

    "location": {

    },

    "targets": [

      {

        "file_pattern": "{source_basename}_converted.mp4",

        "container": {

          "kind": "mp4"

        },

        "video": {

          "codec": "h264",

          "filters": [

            {

              "kind": "video_overlay",

              "payload": {

                "video_file": {

                  "storage_provider": "s3",

                  "url": "s3://my_bucket/my_input_folder/my_file.mp4"

                },

                "x": "overlay_w - 20",

                "y": 0,

                "height": "source_h / 2",

                "opacity": 0.75,

                "start_sec": 5,

                "fadein_duration_sec": 10

              }

            }

          ]

        },

        "audio": [

          {

          }

        ]

      }

    ]

  }

}
```

--------------------------------

### MediaInfo Reference Frames Output

Source: https://docs.hybrik.com/tutorials/troubleshooting

Example output from MediaInfo showing reference frame settings.

```text
Format profile                           : High@L4  

Format settings                          : CABAC / 4 Ref Frames  

Format settings, CABAC                   : Yes  

Format settings, CABAC                   : Yes  

Format settings, Reference frames        : 4 <----------  

Format settings, Reference frames        : 4 frames  
```

--------------------------------

### Identify Machine Termination Error

Source: https://docs.hybrik.com/tutorials/troubleshooting

Example of the JSON response indicating a spot instance termination.

```json
"result_define": "SYS_TSK_MACHINE_TERMINATED",  

"message": "machine id 1476067(i-0f004775272cbbf08) was terminated",  
```

--------------------------------

### BIF file error message

Source: https://docs.hybrik.com/tutorials/troubleshooting

Example of an error message generated when a BIF file is too small.

```text
BIF file < 100 byte, invalid  
```

--------------------------------

### Configure size_hint for EBS Allocation

Source: https://docs.hybrik.com/tutorials/troubleshooting

Example of specifying the size_hint parameter in the targets configuration to prevent disk space errors.

```json
"targets": [  

    {  

        "file_pattern": "{file_pattern}.mov",  

        "size_hint": 300000000000, <--- 300 GB  

        ...  
```

--------------------------------

### Identify UID Path Errors

Source: https://docs.hybrik.com/tutorials/troubleshooting

Examples of invalid UID formatting containing slashes and the resulting file system error.

```json
"uid": "vault/F5/1E/F51E5017-4AE2-443B-B40B-1B97BA99CAB1"  


```

```json
"details": "ENOENT: no such file or directory, open '/tmp/hybrik/transcode/20162637_s0-12/side_cars_0/0/840216816633_Pharma_Bro_de_DE_Feature-DE5CED1A-6B96-4FA3-BCE8-BB8C0A57A101.itt_ger_stitched.ttml_pre_pyc.ttml_itt_profile_vault/F5/1E/F51E5017-4AE2-443B-B40B-1B97BA99CAB1'",  


```

--------------------------------

### URL encoding for FairPlay URI

Source: https://docs.hybrik.com/tutorials/troubleshooting

Examples showing how to replace special characters like '&' with their URL-encoded equivalents to prevent job failures.

```json
"fairplay_uri": "skd://test.foo.com/v1/fp?kid=5fda0844993256b29ed12215&contentID=0123456789"  
```

```json
"fairplay_uri": "skd://test.foo.com/v1/fp?kid=5fda0844993256b29ed12215%26contentID=0123456789"  
```

--------------------------------

### Normalize filter configuration

Source: https://docs.hybrik.com/tutorials/troubleshooting

Example of a normalize filter payload. Note that loudness_lra_lufs must be between 1 and 20.

```json
"filters": [   

  {   

    "kind": "normalize",   

    "payload": {   

      "kind": "ebur128",   

      "payload": {   

        "allow_unprecise_mode": false,   

        "integrated_lufs": -16.45,   

        "loudness_lra_lufs": -12.6,   

        "true_peak_dbfs": -3.5,   

        "analyzer_track_index": 0   

      }   

    }   

  }   

]
```

--------------------------------

### GCP Storage Provider Payload Configuration

Source: https://docs.hybrik.com/tutorials/troubleshooting

Example payload configuration for using Google Cloud Storage as a provider.

```json
"payload": {  

    "storage_provider": "gs",  

    "url": "{{source}}",  

    "access": {  

        "credentials_key": "my-google-compute-access-credentails"  

    },  

    ...  
```

--------------------------------

### Definitions and Inheritance Example

Source: https://docs.hybrik.com/job_json/definitions

Demonstrates defining global variables for paths and settings, and using $inherits to apply shared configurations to job elements.

```json
{

  "definitions": {

    "source": "s3://my_bucket/my_folder/my_file.mp4",

    "destination": "s3://my_bucket/output_folder",

    "video_basics": {

      "codec": "h264",

      "profile": "high",

      "level": "3.0",

      "frame_rate": "24000/1001"

    },

    "audio_basics": {

      "codec": "aac_lc",

      "sample_rate": 48000,

      "bitrate_kb": 128

    }

  },

  "name": "My job: {{source}}",

  "payload": {

    "elements": [

      {

        "uid": "source_file",

        "kind": "source",

        "payload": {

          "kind": "asset_url",

          "payload": {

            "storage_provider": "s3",

            "url": "{{source}}"

          }

        }

      },

      {

        "uid": "transcode_task",

        "kind": "transcode",

        "payload": {

          "location": {

            "storage_provider": "s3",

            "path": "{{destination}}"

          },

          "targets": [

            {

              "file_pattern": "{source_basename}_1200kbps.mp4",

              "existing_files": "replace",

              "container": {

                "kind": "mp4"

              },

              "video": {

                "$inherits": "video_basics",

                "width": 1280,

                "height": 720,

                "bitrate_kb": 1200

              },

              "audio": [

                {

                  "$inherits": "audio_basics",

                  "channels": 2

                }

              ]

            }

          ]

        }

      }

    ],

    "connections": [

      {

        "from": [

          {

            "element": "source_file"

          }

        ],

        "to": {

          "success": [

            {

              "element": "transcode_task"

            }

          ]

        }

      }

    ]

  }

}
```

--------------------------------

### Get Job Info Response

Source: https://docs.hybrik.com/rest_api/get_job_info

Example JSON response structure returned when querying job information.

```json
{

  "id": "12345",

  "name": "Fifth Element, Web Streaming",

  "progress": 42,

  "status": "running",

  "start_time": "2022-01-01T12:00:00Z",

  "end_time": "2022-01-01T12:10:30Z"

}
```

--------------------------------

### Identify Video Codec Not Supported Error

Source: https://docs.hybrik.com/tutorials/troubleshooting

Example of the error message returned when a package task receives unsupported codecs like JPEG from a streaming ladder.

```json
"message": "exception in package task",   

"details": "ERROR: video codec not supported",  

  


```

--------------------------------

### Example results_file configuration

Source: https://docs.hybrik.com/job_json/tasks/analyze.deep_properties.audio.channel_compare.results_file

Defines the storage provider, path, and file naming pattern for the output of an audio channel comparison analysis.

```json
{

  "uid": "dual_mono_detect",

  "kind": "analyze",

  "payload": {

    "general_properties": {

      "enabled": true

    },

    "deep_properties": {

      "audio": {

        "channel_compare": {

          "results_file": {

            "location": {

              "storage_provider": "s3",

              "path": "{{destination_path}}"

            },

            "file_pattern": "{source_basename}_dual_mono_detect.txt"

          },

          "enabled": true,

          "sensitivity": 5,

          "correlation_threshold": 0.6,

          "min_duration_sec": 1

        }

      }

    }

  }

}
```

--------------------------------

### Get Job Info API Request

Source: https://docs.hybrik.com/rest_api/get_job_info

Examples of how to request job information using cURL and the JavaScript SDK.

```bash
$ curl -u OAPI_KEY:OAPI_SECRET https://api-demo.hybrik.com/v1/jobs/12345/info \

 -G \

  -d fields[]=id \

  -d fields[]=progress \

  -H "X-Hybrik-Sapiauth: api_auth_token" \

  -H "X-Hybrik-Compliance: 20220412"
```

```javascript
//Get job info for Job #12345

hybrik_api.call_api('GET', '/jobs/12345/info',  {

  fields: [

    "id",

    "name",

    "progress",

    "status",

    "start_time",

    "end_time"

  ]

})
```

--------------------------------

### HLS Packaging Configuration Example

Source: https://docs.hybrik.com/job_json/tasks/package.hls

A complete JSON object demonstrating the structure for an HLS packaging task, including storage locations for manifests and media files.

```json
{

  "uid": "package_hls",

  "kind": "package",

  "payload": {

    "kind": "hls",

    "location": {

      "storage_provider": "s3",

      "path": "s3://my_bucket/my_output_folder/hls_manifests",

      "attributes": [

        {

          "name": "ContentType",

          "value": "application/x-mpegURL"

        }

      ]

    },

    "file_pattern": "master_manifest.m3u8",

    "segmentation_mode": "segmented_ts",

    "segment_duration_sec": "6",

    "force_original_media": false,

    "media_location": {

      "storage_provider": "s3",

      "path": "s3://my_bucket/my_output_folder/hls_media",

      "attributes": [

        {

          "name": "ContentType",

          "value": "video/MP2T"

        }

      ]

    },

    "media_file_pattern": "{source_basename}.ts",

    "hls": {

      "media_playlist_location": {

        "storage_provider": "s3",

        "path": "s3://my_bucket/my_output_folder/hls_manifests"

      },

      "include_iframe_manifests": true,

      "primary_layer_uid": "Layer4"

    }

  }

}
```

--------------------------------

### Identify Ping Timeout Error

Source: https://docs.hybrik.com/tutorials/troubleshooting

Example of the JSON error response when a machine stops reporting progress due to resource exhaustion.

```json
"result_define": "SYS_TSK_PING_EXPIRED",  

"message": "ping timeout on first execution, overdue: 1096, permitted is: 90",  
```

--------------------------------

### Comparative Analysis Configuration Example

Source: https://docs.hybrik.com/job_json/tasks/analyze.deep_properties.video.settings.comparative

Demonstrates a JSON payload for an analyze task with comparative video settings, including size selection and image overlay filters.

```json
{

  "uid": "analyze_task",

  "kind": "analyze",

  "payload": {

    "compare_asset": {

      "kind": "asset_url",

      "payload": {

        "storage_provider": "s3",

        "url": "s3://my_bucket/my_reference_file.mov"

      }

    }

  },

  "general_properties": {

    "enabled": true

  },

  "deep_properties": {

    "video": {

      "settings": {

        "size_selector": "compare_asset",

        "compare_filters": [

          {

            "kind": "image_overlay",

            "payload": {

              "top": 10,

              "bottom": 10

            }

          }

        ],

        "ssim": {

          "enabled": true

        }

      }

    }

  }

}
```

--------------------------------

### Identify Stream Data Inactivity Error

Source: https://docs.hybrik.com/tutorials/troubleshooting

Example of the error message indicating Hybrik cannot access source content, often due to mismatched content length reporting.

```json
"message": "exception in core analyze",  

"details": "premature transcode end error: 0xBAAD2682, stream data inactivity for 900 seconds",  

"diagnostic": "too long (14027), beginning:\n\ntoo long (74859), beginning:\n\n{ fil  


```

--------------------------------

### Identify SRT subtitle formatting error

Source: https://docs.hybrik.com/tutorials/troubleshooting

Example of an SRT subtitle entry containing an invalid line break that triggers a 'Cannot read property split of undefined' error.

```text
254   

00:14:00,840 --> 00:14:03,000  

Could all combat-ready squadrons  

proceed--?  



```

```text
255    

00:14:03,210 --> 00:14:04,660  

                            <-- should not have a line break                                   

It's a new day, people.  



```

--------------------------------

### Get Job Definition API Request

Source: https://docs.hybrik.com/rest_api/get_job_definition

Examples for retrieving job definitions using cURL and the Hybrik JavaScript API client.

```bash
$ curl -u OAPI_KEY:OAPI_SECRET https://api-demo.hybrik.com/v1/jobs/$JOB_ID/definition \

  -H "X-Hybrik-Sapiauth: api_auth_token" \

  -H "X-Hybrik-Compliance: YYYYMMDD"
```

```javascript
//Get job definition for Job #12345

hybrik_api.call_api('GET', '/jobs/12345/definition')
```

--------------------------------

### Configure DPP Segmentation

Source: https://docs.hybrik.com/job_json/tasks/dpp_packager.as11_options.segmentation

Example JSON configuration for defining multiple segments using start timecodes and durations within the as11_options object.

```json
{

  "uid": "dpp_packager",

  "kind": "dpp_packager",

  "task": {

    "retry_method": "fail"

  },

  "payload": {

    "target": {

      "location": {

        "storage_provider": "s3",

        "path": "{{destination_path}}"

      },

      "file_pattern": "tos_mxfdpp_as11_metadata.mxf"

    },

    "dpp_schema": "op1a",

    "as11_options": {

      "core": {},

      "ukdpp": {},

      "segmentation": [

        {

          "start": "10:00:00:00",

          "duration": "00:01:00:00"

        },

        {

          "start": "10:01:00:00",

          "duration": "00:02:00:00"

        },

        {

          "start": "10:03:00:00",

          "duration": "00:01:30:00"

        }

      ]

    }

  }

}
```

--------------------------------

### Watchfolder Configuration Example

Source: https://docs.hybrik.com/job_json/tasks/watchfolder.settings

A JSON object demonstrating the structure of a watchfolder task definition, including source storage and specific watchfolder settings.

```json
{

  "uid": "watchfolder_source",

  "kind": "watchfolder",

  "task": {

    "tags": [

      "WATCH_FOLDER"

    ]

  },

  "payload": {

    "source": {

      "storage_provider": "s3",

      "path": "s3://my_bucket/my_watchfolder"

    },

    "settings": {

      "key": "watch_folder",

      "interval_sec": 5,

      "pattern_matching": "wildcard",

      "wildcard": "*",

      "recursive": true,

      "process_existing_files": true

    }

  }

}
```

--------------------------------

### Example MPEG2 Transcode Job

Source: https://docs.hybrik.com/job_json/tasks/transcode.targets.video.mpeg2

An example of a JSON payload for a transcode job targeting MPEG2 output.

```APIDOC
### Request Example
{
  "uid": "transcode_media",
  "kind": "transcode",
  "payload": {
    "location": {
      "storage_provider": "s3",
      "path": "s3://my_bucket/my_folder"
    },
    "targets": [
      {
        "file_pattern": "{source_basename}_converted.ts",
        "existing_files": "replace",
        "container": {
          "kind": "mpeg2ts"
        },
        "video": {
          "codec": "mpeg2",
          "width": 1920,
          "height": 1080,
          "bitrate_kb": 6000,
          "max_bitrate_kb": 8000,
          "bitrate_mode": "vbr",
          "closed_captions": {
            "enable_cea608": true,
            "enable_cea708": true
          }
        },
        "audio": [
          {
            "codec": "heaac_v2",
            "channels": 2,
            "sample_rate": 48000
          }
        ]
      }
    ]
  }
}
```

--------------------------------

### Example spliceInsert

Source: https://docs.hybrik.com/job_json/tasks/transcode.targets.container.scte35_in_json.scte35_sections.spliceInfoSection.spliceInsert

Configuration example showing a transcode task with an SCTE-35 spliceInsert object defined within the container settings.

```json
{

  "uid": "transcode_task",

  "kind": "transcode",

  "payload": {

    "location": {

      "storage_provider": "s3",

      "path": "s3://my_bucket/my_folder"

    },

    "targets": [

      {

        "file_pattern": "{source_basename}_scte35.ts",

        "existing_files": "replace",

        "container": {

          "kind": "mpegts",

          "scte35": {

            "write_scte35_packets": true,

            "scte35_sections": [

              {

                "insertTime": 180000,

                "spliceInfoSection": {

                  "spliceInsert": {

                    "spliceEventId": 8,

                    "program": {

                      "spliceTime": {

                        "ptsTime": 360000

                      }

                    }

                  }

                }

              }

            ]

          }

        },

        "video": {

          "codec": "mpeg2",

          "width": 720,

          "height": 480

        },

        "audio": [

          {

            "codec": "ac3",

            "channels": 2,

            "sample_rate": 48000,

            "bitrate_kb": 224

          }

        ]

      }

    ]

  }

}
```

--------------------------------

### Dolby E Configuration Example

Source: https://docs.hybrik.com/job_json/tasks/transcode.targets.audio.dolbye

Basic JSON structure for defining Dolby E audio transcoding parameters.

```json
{

  TEMP

}
```

--------------------------------

### Conditional Start Timecode

Source: https://docs.hybrik.com/tutorials/timecode

Uses a conditional expression to set the start timecode based on the source video frame rate.

```json
"timecode": [  

    {  

        "source": "start_value",  

        "overrides": {  

            "start_value": "source.video.frame_rate == (30000/1001) ? '00:00:00;00' : '00:00:00:00'"  

        }  

    }  

]  

```

--------------------------------

### Configure as11_options for dpp_packager

Source: https://docs.hybrik.com/job_json/tasks/dpp_packager.as11_options

Example configuration for the dpp_packager task including core, ukdpp, and segmentation metadata.

```json
{
  "uid": "dpp_packager",
  "kind": "dpp_packager",
  "task": {
    "retry_method": "fail"
  },
  "payload": {
    "target": {
      "location": {
        "storage_provider": "s3",
        "path": "{{destination_path}}"
      },
      "file_pattern": "tos_mxfdpp_as11_metadata.mxf"
    },
    "dpp_schema": "op1a",
    "as11_options": {
      "core": {
        "SeriesTitle": "Your Title Here",
        "ProgrammeTitle": "Your Title Here",
        "EpisodeTitleNumber": "3",
        "ShimName": "UK DPP HD",
        "ShimVersion": "1.1",
        "AudioTrackLayout": 3,
        "PrimaryAudioLanguage": "eng",
        "ClosedCaptionsPresent": false
      },
      "ukdpp": {
        "ProductionNumber": "C5/30571/0001A",
        "Synopsis": "Your Synopsis Here",
        "Originator": "Originator or Studio Name Here",
        "CopyrightYear": 2010,
        "PictureRatio": "16:9",
        "Distributor": "Distributor Name Here",
        "ThreeD": false,
        "ProductPlacement": false,
        "PSEPass": 1,
        "PSEManufacturer": "Harding FPA",
        "PSEVersion": "3.4.0",
        "SecondaryAudioLanguage": "zxx",
        "TertiaryAudioLanguage": "zxx",
        "AudioLoudnessStandard": 0,
        "LineUpStart": "09:59:30:00",
        "IdentClockStart": "09:59:50:00",
        "AudioDescriptionPresent": false,
        "OpenCaptionsPresent": false,
        "SigningPresent": 1,
        "CompletionDate": "2020-10-10",
        "ContactEmail": "contact@emailaddress.com",
        "ContactTelephoneNumber": "02035403630",
        "TotalNumberOfParts": 3,
        "TotalProgrammeDuration": "00:04:30:00"
      },
      "segmentation": [
        {
          "start": "10:00:00:00",
          "duration": "00:01:00:00"
        },
        {
          "start": "10:01:00:00",
          "duration": "00:02:00:00"
        },
        {
          "start": "10:03:00:00",
          "duration": "00:01:30:00"
        }
      ]
    }
  }
}
```

--------------------------------

### Specify Starting Timecode

Source: https://docs.hybrik.com/tutorials/timecode

Sets a specific starting timecode value. Use a colon (:) for non-dropframe and a semicolon (;) for dropframe timecode.

```json
"timecode": [  

    {  

        "source": "start_value",  

        "start_value": "01:00:00;00"  

    }  

]  

```

--------------------------------

### MPEG DASH ContentProtection Manifest Example

Source: https://docs.hybrik.com/tutorials/drm

Example of a ContentProtection tag within an AdaptationSet of an MPEG DASH manifest, including the PSSH box.

```xml
<ContentProtection cenc:default_KID="1b47a131-e125-496c-be5d-867ee09eb801" schemeIdUri="urn:mpeg:dash:mp4protection:2011" value="cenc"/>  

<ContentProtection schemeIdUri="urn:uuid:edef8ba9-79d6-4ace-a3c8-27dcd51d21ed">  

  <cenc:pssh>AAAAWXBzc2gAAAAA7e+LqXnWSs6jyCfc1R0h7QAAADkSEBtHoTHhJUlsvl2GfuCeuAESEBtHoTHhJUlsvl2GfuCeuAEaDXRlc3RfcHJvdmlkZXJI49yVmwY=</cenc:pssh>  

</ContentProtection>  
```

--------------------------------

### Comprehensive QC Task Configuration

Source: https://docs.hybrik.com/tutorials/analyze_qc

A full QC task example validating file size, video dimensions, audio properties, and black frame duration.

```json
{

    "uid": "qc_task",

    "kind": "qc",

    "payload": {

        "tests": [

            {

                "conditions": [

                    {

                        "condition": "general_properties.container.size_kb > 10000",

                        "message_pass": "PASS: Source file size is greater than 10 megabytes, size = {general_properties.container.size_kb} kb.",

                        "message_fail": "FAIL: Source file size is less than or equal to 10 megabytes, size = {general_properties.container.size_kb} kb."

                    },

                    {

                        "condition": "general_properties.video.width >= 1920",

                        "message_pass": "PASS: Video frame width is greater than or equal to 1920, width is {general_properties.video.width} pixels.",

                        "message_fail": "FAIL: Video frame width is less than 1920, width is {general_properties.video.width} pixels."

                    },

                    {

                        "condition": "general_properties.video.height >= 1080",

                        "message_pass": "PASS: Video frame height is greater than or equal to 1080, height is {general_properties.video.height} pixels.",

                        "message_fail": "FAIL: Video frame height is less than 1080, height is {general_properties.video.height} pixels."

                    },

                    {

                        "condition": "general_properties.audio.size() >= 1",

                        "message_pass": "PASS: Number of audio tracks is greater than or equal to 1, there are {general_properties.audio.size()} tracks",

                        "message_fail": "FAIL: There are no audio tracks."

                    },

                    {

                        "condition": "general_properties.audio[0].sample_rate >= 44100",

                        "message_pass": "PASS: Audio sample rate is greater than or equal to 44.1 kHz, sample rate is {general_properties.audio[0].sample_rate} Hz.",

                        "message_fail": "FAIL: Audio sample rate is less than 44.1 kHz, sample rate is {general_properties.audio[0].sample_rate} Hz."

                    },

                    {

                        "condition": "deep_properties.video.black.leading_sec <= 5",
```

--------------------------------

### Example target configuration

Source: https://docs.hybrik.com/job_json/tasks/copy.target

A JSON configuration object demonstrating a copy task target using an S3 storage provider and a delete-and-replace conflict strategy.

```json
{

  "uid": "copy_task",

  "kind": "copy",

  "payload": {

    "target": {

      "location": {

        "storage_provider": "s3",

        "path": "s3://my_destination_bucket/my_destination_folder"

      },

      "existing_files": "delete_and_replace"

    }

  }

}
```

--------------------------------

### Example track_selector configuration

Source: https://docs.hybrik.com/job_json/tasks/analyze.deep_properties.audio.track_selector

Demonstrates how to specify an audio track by PID within the analyze task payload.

```json
{

  "uid": "analyze_task",

  "kind": "analyze",

  "payload": {

    "general_properties": {

      "enabled": true

    },

    "deep_properties": {

      "audio": [

        {

          "track_selector": {

            "pid": 381

          },

          "volume": {

            "enabled": true

          },

          "levels": {

            "enabled": true

          }

        }

      ],

      "video": {

        "black": {

          "duration_sec": 5,

          "enabled": true

        }

      }

    }

  }

}
```

--------------------------------

### Telecine Filter Configuration Example

Source: https://docs.hybrik.com/job_json/tasks/transcode.targets.video.filters.payload.telecine

Example of a transcode task payload utilizing the telecine filter with a 23 pattern and top field first interlacing.

```json
{

  "uid": "transcode_media",

  "kind": "transcode",

  "payload": {

    "location": {

    },

    "targets": [

      {

        "file_pattern": "{source_basename}_converted.mp4",

        "container": {

          "kind": "mp4"

        },

        "video": {

          "codec": "h264",

          "filters": [

            {

              "kind": "telecine",

              "payload": {

                "interlace_mode": "tff",

                "pattern": "23"

              }

            }

          ]

        },

        "audio": [

          {

          }

        ]

      }

    ]

  }

}
```

--------------------------------

### Example results_file configuration

Source: https://docs.hybrik.com/job_json/tasks/analyze.deep_properties.video.ssim.results_file

Defines the storage provider, URL, and file naming pattern for SSIM analysis results within an analyze task.

```json
{

  "uid": "analyze_task",

  "kind": "analyze",

  "payload": {

    "compare_asset": {

      "kind": "asset_url",

      "payload": {

        "storage_provider": "s3",

        "url": "s3://my_bucket/my_reference_file.mov"

      }

    }

  },

  "general_properties": {

    "enabled": true

  },

  "deep_properties": {

    "video": {

      "ssim": {

        "enabled": true,

        "results_file": {

          "file_pattern": "{source_basename}_ssim_analysis.txt",

          "location": {

            "storage_provider": "s3",

            "url": "s3://my_bucket/my_folder"

          }

        }

      }

    }

  }

}
```

--------------------------------

### Example encryption configuration

Source: https://docs.hybrik.com/job_json/tasks/package.encryption

A JSON payload demonstrating an HLS packaging task with mpeg-cenc encryption enabled and PlayReady DRM configured.

```json
{

  "uid": "package_hls",

  "kind": "package",

  "payload": {

    "kind": "hls",

    "location": {

      "storage_provider": "s3",

      "path": "s3://my_bucket/my_output_folder/hls_manifests",

      "attributes": [

        {

          "name": "ContentType",

          "value": "application/x-mpegURL"

        }

      ]

    },

    "file_pattern": "master_manifest.m3u8",

    "segmentation_mode": "segmented_ts",

    "segment_duration_sec": "6",

    "force_original_media": false,

    "media_location": {

      "storage_provider": "s3",

      "path": "s3://my_bucket/my_output_folder/hls_media",

      "attributes": [

        {

          "name": "ContentType",

          "value": "video/MP2T"

        }

      ]

    },

    "media_file_pattern": "{source_basename}.ts",

    "hls": {

      "media_playlist_location": {

        "storage_provider": "s3",

        "path": "s3://my_bucket/my_output_folder/hls_manifests"

      }

    },

    "encryption": {

      "enabled": true,

      "schema": "mpeg-cenc",

      "drm": [

        "playready"

      ],

      "key_id": "[32 char hex sequence]",

      "key": "[32 char hex sequence]",

      "content_id": "2a",

      "playready_pssh": "[base-64 encoded pssh]...=="

    }

  }

}
```

--------------------------------

### Print Frame Count

Source: https://docs.hybrik.com/tutorials/print_timecode

Displays the frame number instead of timecode. Can be configured to use the media's start point or a custom start value.

```json
"filters": [  

    {  

        "kind": "print_timecode",  

        "payload": {  

            "y": 100,  

            "x": 100,  

            "font": "sans",  

            "font_color": "white",  

            "background_color": "black",  

            "font_size": 32,  

            "timecode_kind": "frame_nr",  

            "timecode_source": "media"                             

        }  

    }  

]  
```

```json
"filters": [  

	{  

		"kind": "print_timecode",  

		"payload": {  

			"y": 10,  

			"x": 255,  

			"font": "sans",  

			"font_color": "white",  

			"background_color": "black",  

			"font_size": 32,  

			"timecode_kind": "frame_nr",  

			"timecode_source": "start_value",  

			"timecode_start_value": "00:00:00:00"  

		}  

	}  

]  
```

--------------------------------

### Analyze video configuration example

Source: https://docs.hybrik.com/job_json/tasks/analyze.deep_properties.video

A JSON payload demonstrating how to enable various video analysis features like black detection, black borders, interlacing, and levels.

```json
{

  "uid": "analyze_task",

  "kind": "analyze",

  "payload": {

    "general_properties": {

      "enabled": true

    },

    "deep_properties": {

      "audio": {

        "volume": {

          "enabled": true

        }

      },

      "video": {

        "black": {

          "duration_sec": 5,

          "enabled": true

        },

        "black_borders": {

          "black_level": 0.08,

          "enabled": true

        },

        "interlacing": {

          "enabled": true

        },

        "levels": {

          "chroma_levels": true,

          "histograms": true,

          "enabled": true

        }

      }

    }

  }

}
```

--------------------------------

### Print Timecode Starting at Zero

Source: https://docs.hybrik.com/tutorials/print_timecode

Overrides the media timecode by setting a custom start value. Ensure the timecode_start_value format matches the timecode_kind (semicolon for drop-frame, colon for non-drop-frame).

```json
"filters": [  

    {  

        "kind": "print_timecode",  

        "payload": {  

            "y": 100,  

            "x": 100,  

            "font": "sans",  

            "font_color": "white",  

            "background_color": "black",  

            "font_size": 32,  

            "timecode_kind": "timecode_auto",  

            "timecode_source": "start_value",  

            "timecode_start_value": "00:00:00:00"  

        }  

    }  

]  
```
Tokens:
Raw