Meta tags:
description= This site documents how to interact with the Encoding.com API. It s our go-to reference whether you re just getting started, or already have deep experience working with our platform.;
Headings (most frequently used words):
api, parameters, adaptive, responses, management, advanced, video, rights, graphics, editing, closed, captions, miscellaneous, quality, control, requests, sub, account, error, status, playout, encoding, digital, fields, and, overview, code, libraries, main, output, format, codec, dolby, audio, bitrate, intermediate, post, build, welcome, register, developers, engineers, integrate,
Text of the page (most frequently used words):
and (40), #audio (39), api (37), the (37), video (36), #request (28), #validate (26), #output (26), #your (23), #parameters (23), #source (21), our (19), #encoding (18), for (18), #manifest (16), dolby (15), bitrate (15), sample (15), with (15), format (14), json (14), processing (13), tests (12), xml (12), introduction (12), options (12), hls (12), status (12), template (12), duration (12), validation (12), use (12), media (12), you (11), requests (11), workflow (10), file (10), frames (10), drm (10), #codec (10), actions (10), frame (10), overlay (10), intermediate (9), quality (9), errors (8), version (8), system (8), adaptive (8), stream (8), descriptor (8), settings (8), atmos (8), specific (8), management (8), are (8), job (7), action (7), master (7), watermarking (7), captions (7), that (7), closed (7), breaks (7), out (6), nielsen (6), com (6), main (6), this (6), av1 (6), control (6), playlist (6), auto (6), account (6), automatic (6), can (6), response (6), encryption (6), notify (6), one (6), segment (6), users (6), thumbnail (6), responses (6), from (6), advanced (6), engineers (6), metadata (6), interval (6), workflows (5), developers (5), hdr (5), all (5), code (5), via (5), mode (5), have (5), browser (5), image (5), interface (5), other (5), authentication (5), preset (5), custom (5), post (4), detection (4), codecs (4), get (4), data (4), vp9 (4), broadcast (4), size (4), mpeg (4), blank (4), dts (4), presets (4), set (4), rate (4), php (4), first (4), apple (4), content (4), metrics (4), timecode (4), packaging (4), example (4), error (4), files (4), conversion (4), formats (4), caption (4), alternate (4), keyos (4), asset (4), cue (4), queue (4), extended (4), welcome (4), getstatus (4), transforms (4), slideshow (4), idr (4), clipping (4), overview (4), list (4), month (3), outputs (3), editing (3), just (3), ludicrous (3), end (3), based (3), text (3), looking (3), log (3), platform (3), any (3), qualify (3), plans (3), assets (3), needs (3), baton (3), upload (3), okta (3), register (3), digital (3), available (3), access (3), sub (3), rights (3), take (3), jump (3), started (3), dash (3), mp4 (3), notification (3), web (3), using (3), provide (3), destination (3), reference (3), curl (3), split (3), java (3), whether (3), single (3), transformation (3), test (3), simple (3), transcoding (3), build (3), designed (3), then (3), profile (3), changes (3), wrappers (3), coldfusion (3), notifications (3), report (3), addmedia (3), complete (3), cablelabs (3), destinations (3), these (3), getpreset (2), delete (2), each (2), getpresetslist (2), history (2), over (2), savepreset (2), current (2), getreservedinfo (2), starts (2), sethostkey (2), burns (2), getting (2), screen (2), getmediainfoex (2), getmediainfo (2), gif (2), both (2), gettaskstatus (2), animated (2), effect (2), ken (2), codes (2), burn (2), common (2), existing (2), quicktime (2), multijob (2), repair (2), who (2), default (2), more (2), getmedialist (2), getqueuestats (2), model (2), getqueuetime (2), layout (2), channels (2), ratio (2), intermediates (2), aspect (2), often (2), desired (2), count (2), streams (2), fade (2), detect (2), pts (2), pcr (2), calls (2), few (2), pid (2), increase (2), freeze (2), perform (2), channel (2), tags (2), miscellaneous (2), inserts (2), conditions (2), mpd (2), valid (2), only (2), general (2), segments (2), short (2), discontinuity (2), declared (2), conformance (2), cmaf (2), including (2), aes (2), placement (2), level (2), uri (2), muxing (2), ready (2), black (2), mainconcepts (2), integrate (2), vision (2), beamr (2), cabr (2), start (2), mxf (2), hlg (2), prores (2), creating (2), input (2), several (2), selection (2), global (2), https (2), webm (2), notify_upload (2), padding (2), pre (2), pcm (2), id3 (2), eac3 (2), ac3 (2), create (2), there (2), libvpx (2), typical (2), component (2), descriptors (2), multitrack (2), vp8 (2), regions (2), process (2), call (2), notes (2), guides (2), user (2), release (2), send (2), separate (2), net (2), like (2), cloud (2), progress (2), functions (2), integration (2), box (2), directly (2), recent (2), webhook (2), decryption (2), fields (2), vantage (2), cml (2), insertion (2), mapping (2), locations (2), mediaid (2), unofficial (2), endpoint (2), utilize (2), already (2), callbacks (2), libraries (2), point (2), orchestration (2), injection (2), supplementary (2), waveform (2), own (2), new (2), summary (2), through (2), roku (2), bif (2), vtt (2), need (2), flashaccess (2), connect (2), advanced_fmp4 (2), advanced_mss (2), advanced_dash (2), advanced_hls (2), fmp4_hls (2), repackaging (2), playready (2), byte (2), capture (2), crop (2), cropping (2), rotation (2), concatenation (2), things (2), thumbnails (2), playout (2), packager (2), graphics (2), buydrm (2), usage (2), features (2), cpix (2), atlas (2), widevine (2), per (2), range (2), rle (2), libaom (2), xdcam (2), mpeg2 (2), hevc (2), dolbye (2), subsequent (2), avc (2), but (2), 264 (2), usability (2), type (2), ratecontrol (2), libsvtav1 (2), services (2), damf (2), scale (2), once (2), make (2), steps (2), joc (2), adm (2), bwf (2), aac (2), surround (2), loudness (2), downmix (2), mainconcept (2), analysis (2), programmatic, working, edit, camera, aware, site, documents, how, interact, deep, experience, search, loading, enable, choice, emmy, interactions, select, simply, same, taken, lay, explicitly, see, tend, two, primary, number, choose, received, blob, pay, either, prepare, submit, monitor, optional, optimized, best, certain, aren, devices, target, know, monthly, meet, great, marketplace, vid, apply, rates, powerful, nearly, bandwidth, free, credentials, include, accounts, url, projected, done, integrations, add, above, native, client, should, volume, high, requirements, sla, volumes, way, save, premium, receive, review, which, mediainfo, return, will, alternatively, begin, immediately, their, jobs, when, detailed, parse, topic, addmediabenchmark, packages, into, package, second, ladder, fmp4, encode, look, ugv, storage, bar, includes, videos, prior, design, repeatable, without, defined, top, mobile, expert, generator, templates, scratch, copy, ways, examples, comprehensive, line, writing, verify, vbs, tool, submission, development, accelerate, testing, flat, many, offs, quick, languages, popular, python, ruby, zend, some, developer, engineering, spanning, unbounded, automate, proprietary, optimize, processes, ffmpeg, offload, location, track, name, individual, hundreds, tens, ends, cms, where, versus, centric, rely, resembles, closely, approach, feel, applied, requested, were, document, scalability, mam, quickly, engines, technology, architecture, stitch, winning, award, times, fast, ultra, workload, tackle, stands, million, decoding, maintained, has, professionally, standardize, works, team, bespoke, traditional, amount, massive, support, built, purpose, been, understand, used, going, terminate, identifying, subsets, also, grained, fine, would, those, message, email, determine, underway, during, them, interrogated, well, proactively, robust, paired, functionality, basics, cover, let, now, sso, provider, saml, introspecting, performing, generate, seen, step, multi, complex, even, able, possible, here, results, put, case, meeting, industry, most, final, style, matches, declare, declarative, accomplished, securely, deliver, minimum, storing, automated, verifications, telestream, interra, delivery,
Text of the page (random words):
engineers jump to content release notes user interface system status guides api reference recent api changes v8 13 v8 14 v8 15 v8 16 v8 17 v8 18 release notes user interface system status log in log in v 8 18 guides api reference recent api changes search loading jump to 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 source file clipping advanced source mapping blank frames insertion source file overlay vantage cml playlist file source media decryption notifications notify response format notify_upload response format qc notify response format 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 hdr 10 dolby vision hlg webm video codecs libvpx vp9 vp8 vp9 audio settings audio multitrack settings audio descriptors mpeg ts audio component descriptor mpeg ts supplementary audio descriptor ac3 descriptor eac3 descriptor 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 frame type options ratecontrol analysis usability hevc mpeg2 xdcam av1 av1 libaom av1 libsvtav1 mainconcept avc dolby audio dolby audio processing downmix loudness control audio quality surround aac encoding dolby atmos dolby atmos master files damf or adm bwf dolby atmos joc source dolby atmos output 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 automatic ad breaks custom ad breaks hls manifest example dash manifest example 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 video overlay audio overlay text 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 duration file size bitrate bitrate mode validate closed captions no short segments cmaf conformance baton validation qualify validation video quality metrics qc video tests video codec video bitrate frame rate video duration video codec profile video level frame size aspect ratio video streams count validate dts validate pts pcr interval pid interval validate b frames validate b frames dts increase validate idr interval segment starts with idr blank frames detection detect frames freeze qc audio tests audio codec audio bitrate audio duration audio sample rate audio channels audio channel layout audio stream validation qc manifest tests master manifest bitrate master manifest codec validate discontinuity tags validate drm uri validate hls version validate cue out 0 placement validate sample aes encryption validate segment duration validate declared segment duration cue inserts validation mpd manifest is valid 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 version 1 default version 2 version 3 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 jump to 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 source file clipping advanced source mapping blank frames insertion source file overlay vantage cml playlist file source media decryption notifications notify response format notify_upload response format qc notify response format 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 hdr 10 dolby vision hlg webm video codecs libvpx vp9 vp8 vp9 audio settings audio multitrack settings audio descriptors mpeg ts audio component descriptor mpeg ts supplementary audio descriptor ac3 descriptor eac3 descriptor 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 frame type options ratecontrol analysis usability hevc mpeg2 xdcam av1 av1 libaom av1 libsvtav1 mainconcept avc dolby audio dolby audio processing downmix loudness control audio quality surround aac encoding dolby atmos dolby atmos master files damf or adm bwf dolby atmos joc source dolby atmos output 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 automatic ad breaks custom ad breaks hls manifest example dash manifest example 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 video overlay audio overlay text 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 duration file size bitrate bitrate mode validate closed captions no short segments cmaf conformance baton validation qualify validation video quality metrics qc video tests video codec video bitrate frame rate video duration video codec profile video level frame size aspect ratio video streams count validate dts validate pts pcr interval pid interval validate b frames validate b frames dts increase validate idr interval segment starts with idr blank frames detection detect frames freeze qc audio tests audio codec audio bitrate audio duration audio sample rate audio channels audio channel layout audio stream validation qc manifest tests master manifest bitrate master manifest codec validate discontinuity tags validate drm uri validate hls version validate cue out 0 placement validate sample aes encryption validate segment duration validate declared segment duration cue inserts validation mpd manifest is valid 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 version 1 default version 2 version 3 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 welcome developers and video engineers this site documents how to interact with the encoding com api it s our go to reference whether you re just getting started or already have deep experience working with our platform whether you re looking to offload a set of simple ffmpeg processes optimize existing proprietary media workflows or automate unbounded scalability to your existing cms mam or other asset management platform encoding com s api has been purpose built to support a massive amount of traditional and bespoke media processing functions our team works to standardize the integration of over 40 professionally maintained encoding engines for all your media processing needs including decoding content aware transcoding broadcast camera and edit codecs transforms dolby audio processing image transformation closed captions programmatic editing adaptive bitrate packaging ad breaks hdr watermarking and digital rights management whether you have a few assets a month or a million a month the api stands ready to tackle any workload with ultra fast processing times with our technology engineering emmy award winning split and stitch architecture ludicrous mode the api is designed to have users make a minimum of requests often a single request to take an asset from any source location provide desired transforms transcoding and packaging and deliver it securely to the destination s of choice this is accomplished through the use of declarative xml or json requests that declare the desired action to take this matches the style of job requests most often seen in the broadcast industry meeting the use case of take these things perform these changes and put the results here in as few calls as possible with just one call you ll be able to perform even complex multi step workflows generate or re use intermediates to be used in subsequent requests and quickly understand by looking at a single document all of the actions that were requested or applied in the job request we feel this approach more closely resembles the needs of video engineers and workflow engineers who rely on a job centric model of processing versus a model where each job request ends up spanning tens or hundreds of individual calls to name assets transforms destinations and then track progress for those users who would like more fine grained control over each of the steps of processing there are also separate actions available for subsets of a job request e g identifying source media assets introspecting metadata on them performing transforms and storing intermediates final packaging and delivery and automated quality control qc including both interra s baton validation and telestream s qualify qc validation verifications this functionality is paired with a robust notification system that can both proactively notify via email webhook and or message queue as well as be interrogated during processing to determine status or terminate an action underway now let s cover the basics of getting started with the api 1 register first things first you re going to need an account you can use our own authentication system or use okta sso to connect via a saml provider to register just create a new developer account new accounts include api access credentials 1 gb of free encoding bandwidth per month and access to nearly all of our powerful features usage rates apply to vid ly usage and some premium features if you re looking to integrate via okta you first need to register a master account native to our system as per above then add encoding com to your integrations from this marketplace url once that s done you can provide access to your okta users through our sub account management api or management ui once you re ready to scale up cloud media workflows simply log in to the encoding com client interface and select one of the monthly or pre pay plans to meet your projected encoding volumes and sla requirements high volume users should connect directly with us for custom plans all of our plans are designed to scale with your needs 2 build and post interactions with the encoding com api are received by https post requests to our workflow processing api users can choose a number of actions but the primary two actions we tend to see are requests to use preset based actions or requests that explicitly lay out all the actions to be taken to process an asset the steps to make any request of the platform are the same prepare a job request as either an xml or json text file or blob submit the request with the xml or json to the api use a subsequent api request web interface or notification callbacks to monitor the status of the request optional use an encoding preset utilize one of our expert designed web cablelabs mobile or set top box pre defined presets or build a repeatable workflow via an api call and save your own custom profile as a custom output preset presets are a great way to get started if you know your target devices or codecs but aren t certain of the best parameters to use to get optimized outputs build your xml or json template there are several ways to create your first api request copy the xml or json from our web interface request generator or code from scratch using one of our sample templates a typical mp4 request as a template a typical hls request as a template comprehensive xml and json examples post and go send your xml json template to our api endpoint via an https post or use our browser based xml json submission tool to ...
|