Jump to Content

Release Notes User Interface System Status

Guides API Reference Recent API Changes

Release Notes User Interface System Status Log In

API Reference

Guides API Reference Recent API Changes

All

Pages

Start typing to search…

API Overview

Welcome, Developers and Video Engineers!
Workflow Overview
End Point
Authentication
Sample MP4 Template
Sample HLS Template
Complete Request Template
Test Your XML or JSON Request in Your Browser

Code Libraries

Simple Curl
PHP
JAVA
ColdFusion
C#
Unofficial API Wrappers

API Main Fields

Authentication
Action List
MediaID
Source Media Locations
Vantage CML Playlist File
Source Media Decryption
Notifications
Global Processing Regions
- Automatic Selection
Request Metadata
Ludicrous Mode
Video Quality Metrics Report

API Output Format Parameters

Output Formats
Input Formats
Using and Creating Output Presets
Video Settings
Apple ProRes
Mainconcepts Broadcast MXF
CableLabs®
Beamr CABR Encoding
HDR
Webm Video Codecs
- Libvpx VP9
- VP8/VP9
Audio Settings
Audio Multitrack Settings
Audio Descriptors
Duration Settings
Nielsen Watermarking
- Nielsen PCM to ID3 Conversion
- Nielsen Watermarking Audio Injection
Output Destinations
Output Encryption
Other Format Options
Waveform
Extended Data Services Data
Apple QT RLE

Advanced Video Codec Parameters

H.264
HEVC
MPEG2
XDCAM
AV1
- AV1 libaom
- AV1 libsvtav1
Mainconcept AVC

Dolby Audio

Dolby Audio Processing
Dolby Atmos®
DolbyE

Advanced Adaptive Bitrate Encoding

Introduction
Sample Request
Alternate Source
Byte-range
I-Frame Playlist
Specific Options for advanced_hls and fmp4_hls Outputs
Specific Options for advanced_dash Output
Specific Options for advanced_mss Output
Specific Options for advanced_fmp4 Output
Main Manifest Parameters
Stream Manifest Parameters
Main Source Parameters
Alternate Source Parameters
Ad Breaks
VTT Thumbnail Parameters
Image Playlist Parameters
ROKU BIF Thumbnail Format
Stream Parameters
Format Parameters
Output summary (Output JSON)

Adaptive Intermediate

Introduction
Intermediate HLS Destination
Intermediate Output Files
Repackaging from Intermediate

Digital Rights Management

FlashAccess DRM
KeyOS for PlayReady DRM
Widevine DRM Packager
Atlas DRM
BuyDRM KeyOS CPIX
B-HLS Content Encryption

Playout, Graphics, & Editing

Video Clipping
Thumbnail Capture
- Thumbnails Set
Watermarking
Concatenation
Video Rotation
Cropping
Auto Crop
Padding
Black Frame Detection
Fade In/Out
Muxing
Metadata
Split Screen
Overlay
Image Transformation
Animated GIF
Ken Burns Slideshow Effect
Slideshow
Burn-In Timecode
QuickTime Timecode
Multijob Workflow
Audio Stream Validation and Automatic Repair

Closed Captions

Closed Captions
Caption to Caption Conversion

Quality Control

Introduction
Available Tests
QC Request Template
Get QC Status
QC Auto
- Auto Tests List
- Conditions
QC Only
QC General Tests
QC Video Tests
QC Audio Tests
QC Manifest Tests

Miscellaneous Requests

GetQueueTime
GetQueueStats
GetPresetsList
GetPreset
SavePreset
Delete Preset
GetReservedInfo
SetHostKey

Sub-Account Management

Introduction
Actions
Parameters
Sample Requests
Sample Responses
Errors

API Responses

Introduction
AddMedia
GetMediaList
GetStatus
GetStatus (extended)
GetTaskStatus
GetMediaInfo
GetMediaInfoEx
Other Actions

API Error Responses

Common Errors
Media Errors
Queue Errors
Encoding Error Codes

Status API

Introduction
Current Status
Status History

GetPreset

This request returns a named preset's details.