JUMP TOAPI OverviewWelcome, Developers and Video Engineers!Workflow OverviewEnd PointAuthenticationSample MP4 TemplateSample HLS TemplateComplete Request TemplateTest Your XML or JSON Request in Your BrowserCode LibrariesSimple CurlPHPJAVAColdFusionC#Unofficial API WrappersAPI Main FieldsAuthenticationAction ListMediaIDSource Media LocationsSource File ClippingAdvanced Source MappingBlank Frames InsertionSource File OverlayVantage CML Playlist FileSource Media DecryptionNotificationsNotify Response FormatNotify_upload Response FormatQC notify Response FormatGlobal Processing RegionsAutomatic SelectionRequest MetadataLudicrous ModeVideo Quality Metrics ReportAPI Output Format ParametersOutput FormatsInput FormatsUsing and Creating Output PresetsVideo SettingsApple ProResMainconcepts Broadcast MXFCableLabs®Beamr CABR EncodingHDRHDR 10Dolby Vision®HLGWebm Video CodecsLibvpx VP9VP8/VP9Audio SettingsAudio Multitrack SettingsAudio DescriptorsMPEG-TS Audio Component DescriptorMPEG-TS Supplementary Audio DescriptorAC3 DescriptorEAC3 DescriptorDuration SettingsNielsen WatermarkingNielsen PCM to ID3 ConversionNielsen Watermarking Audio InjectionOutput DestinationsOutput EncryptionOther Format OptionsWaveformExtended Data Services DataApple QT RLEAdvanced Video Codec ParametersH.264Frame-Type OptionsRatecontrolAnalysisUsabilityHEVCMPEG2XDCAMAV1AV1 libaomAV1 libsvtav1Mainconcept AVCDolby AudioDolby Audio ProcessingDownmixLoudness ControlAudio QualitySurroundAAC EncodingDolby Atmos®Dolby Atmos® Master Files: DAMF or ADM BWFDolby Atmos® JOC SourceDolby Atmos® OutputDolbyEAdvanced Adaptive Bitrate EncodingIntroductionSample RequestAlternate SourceByte-rangeI-Frame PlaylistSpecific Options for advanced_hls and fmp4_hls OutputsSpecific Options for advanced_dash OutputSpecific Options for advanced_mss OutputSpecific Options for advanced_fmp4 OutputMain Manifest ParametersStream Manifest ParametersMain Source ParametersAlternate Source ParametersAd BreaksAutomatic Ad BreaksCustom Ad BreaksHLS Manifest ExampleDASH Manifest ExampleVTT Thumbnail ParametersImage Playlist ParametersROKU BIF Thumbnail FormatStream ParametersFormat ParametersOutput summary (Output JSON)Adaptive IntermediateIntroductionIntermediate HLS DestinationIntermediate Output FilesRepackaging from IntermediateDigital Rights ManagementFlashAccess DRMKeyOS for PlayReady DRMWidevine DRM PackagerAtlas DRMBuyDRM KeyOS CPIXB-HLS Content EncryptionPlayout, Graphics, & EditingVideo ClippingThumbnail CaptureThumbnails SetWatermarkingConcatenationVideo RotationCroppingAuto CropPaddingBlack Frame DetectionFade In/OutMuxingMetadataSplit ScreenOverlayVideo OverlayAudio OverlayText OverlayImage TransformationAnimated GIFKen Burns Slideshow EffectSlideshowBurn-In TimecodeQuickTime TimecodeMultijob WorkflowAudio Stream Validation and Automatic RepairClosed CaptionsClosed CaptionsCaption to Caption ConversionQuality ControlIntroductionAvailable TestsQC Request TemplateGet QC StatusQC AutoAuto Tests ListConditionsQC OnlyQC General TestsDurationFile SizeBitrateBitrate ModeValidate Closed CaptionsNo Short SegmentsCMAF ConformanceBaton ValidationQualify ValidationVideo Quality MetricsQC Video TestsVideo CodecVideo BitrateFrame RateVideo DurationVideo Codec ProfileVideo LevelFrame SizeAspect RatioVideo Streams CountValidate DTSValidate PTSPCR IntervalPID IntervalValidate B-FramesValidate B-Frames DTS IncreaseValidate IDR IntervalSegment Starts with IDRBlank Frames DetectionDetect Frames FreezeQC Audio TestsAudio CodecAudio BitrateAudio DurationAudio Sample RateAudio ChannelsAudio Channel LayoutAudio Stream ValidationQC Manifest TestsMaster Manifest BitrateMaster Manifest CodecValidate Discontinuity TagsValidate DRM URIValidate HLS VersionValidate CUE-OUT:0 PlacementValidate Sample AES EncryptionValidate Segment DurationValidate Declared Segment DurationCUE-inserts validationMPD manifest is validMiscellaneous RequestsGetQueueTimeGetQueueStatsGetPresetsListGetPresetSavePresetDelete PresetGetReservedInfoSetHostKeySub-Account ManagementIntroductionActionsParametersSample RequestsSample ResponsesErrorsAPI ResponsesIntroductionAddMediaGetMediaListVersion 1 (default)Version 2Version 3GetStatusGetStatus (extended)GetTaskStatusGetMediaInfoGetMediaInfoExOther ActionsAPI Error ResponsesCommon ErrorsMedia ErrorsQueue ErrorsEncoding Error CodesStatus APIIntroductionCurrent StatusStatus HistoryIntroductionResponses to API requests vary by parameters requested. Examples can be found in this section.
