obtainse9999se.com

ELEMENTALLIVEAPIANDUSERGUIDE2.
16.
3.
0RELEASESEPTEMBER4,2019TABLEOFCONTENTSOverviewWebInterfaceRESTInterfaceElemental/Live/LiveEventParametersSNMPInterfaceAuthenticationReferenceSupportedCodecsSupportedCaptionsElementalLiveAPIandUserGuide09/04/19ElementalTechnologiesConfidentialandProprietary2/169OVERVIEWPurposeProductOverviewLiveEventsLiveEventProfilesPresetsSchedulesMPTSMultiplexersNotificationsStatisticsAdvancedPreandPostProcessingCustomScriptsTroubleshootingPURPOSEThisdocumentisintendedforsystemintegratorsandusersofElementalLive.
Itoutlinesinterfacesformachineandhumancontrol,configuration,andmonitoring.
EachAPIisdefinedinenoughdetailtoexplainhowtousethesystemandhowitcanbeintegratedintolargerworkflowautomationsystems.
PRODUCTOVERVIEWElementalLiveisapowerfulmediaencoderwhichcanacceptinputthroughanHD-SDIinterface,IPoverEthernet,oralocalfile.
Itcanproducemultiplevideooutputstreamsusingavarietyoflivestreamingprotocols.
ElementalLivecanbecontrolled,configuredandmonitoredthroughthefollowinginterfaces:WebbrowserviaHTMLWebServicesRESTinterfaceSNMPinterfaceUsingawebbrowseristheeasiestwaytocontrol,configure,andmonitorElementalLive.
Thisinterfaceisusedwhenahumanisinteractingwiththeserver,orwhennoautomationorintegrationwithothersystemsisrequired.
ElementalrecommendsMozillaFirefoxastheclientwebbrowser.
TheREST-basedinterfacesupportsallfeaturesofthewebinterfaceaswellasautomationfeatures.
MoregeneralinformationonREST-basedinterfacesisavailableonline.
TheSNMPinterfaceallowsbasicmonitoringandcontroloftheElementalLivesystem.
ItallowsamanagementsystemtoquerythestateoftheserviceandLiveEvents,aswellasstartandstopLiveEvents.
Finally,secureshellaccessallowstheusertomodifythesystem'sconfigurationfiles,directorystructure,andbuilt-intests.
ThesecureshellinterfaceisprovidedforuserswhoneedtomodifythebasebehavioroftheElementalLivesystemorfordiagnostics.
LIVEEVENTSALiveEventisanencodingsessionstartedandstoppedbytheoperatorofthesystem.
LiveEventsarecreatedbyselectinganinputfromtheavailableHD-SDIcapturedevicesorspecifyinganetworkstreamlocation.
Theoperatorcanalsoselectafileinput,whichwillbedecodedinreal-timetosimulatealiveinput.
Thisfeatureisusefulfortestingencodingparametersandoutputdestinationswhenalivesourceisnotavailable.
ElementalLiveAPIandUserGuideOverview09/04/19ElementalTechnologiesConfidentialandProprietary3/169Whenusingthewebinterface,theusercanclickthe"Preview"buttononcetheyhavefilledininputparameters.
ElementalLivewillattempttoacquiretheinputsourceanddisplayascaledframeandaudiolevelfortheusertoverifytheirsourceiscorrectlyconnectedtoElementalLive.
Theoperatorthendefinestheoutputstreamencodingparametersthattheywouldlikethesystemtoproduce.
SeeSupportedCodecsforinformationaboutwhichcodecsElementalLivesupports.
TheusercanselectwhichGPUtheywouldlikethestreamtoutilize,orallowthesystemtoautomaticallyselecttheGPU.
Outputstreamscanbeconnectedtomultipleoutputgroups,whichdefineendpointsforstreamingapplications.
ElementalLivecurrentlysupportsAdobeRTMPoutputsforAdobeFlashMediaServer,pushencodingforMicrosoftSmoothStreaming,AppleiPhonelivestreaming,AdobeHTTPdynamicstreaming,UDPoutput,RTSPoutput,andarchivingtothelocalharddrive.
SeeSupportedCodecsforalistofallthesupportedcontainerformats.
LIVEEVENTPROFILESALiveEventProfileisasavedLiveEventdefinitionthatincludesalloutputsettingsforaLiveEventand,optionally,theinputsettings.
LiveEventscanbesubmittedwithaLiveEventProfileIDandinputparameterstore-usepreviouslyenteredsettings.
NotethatifaLiveEventProfileisedited,thosechangesareonlyappliedtoLiveEventscreatedafterthechange.
LiveEventsalreadyinprogressorinthePENDINGstatewillretainthesettingswithwhichtheyweresubmitted.
SomeexampleLiveEventProfilesaresuppliedbydefaultineachreleaseoftheElementalLivesoftware.
Theseexamplesshouldbecopiediftheyareintendedtobeusedinanactualworkflowastheymaychangefromreleasetorelease.
PRESETSApresetisapredefinedgroupofsettingsforasingleoutputstream.
Apresetallowstheusertocreateoutputstreamstargetedataparticulardeviceorstandardoutputformat.
Forexample,theH.
264HDMediumpresetproducesastreamwithH.
264videoat1280x720resolutionand2.
4mbit/s,andAACaudioat128kbit/s.
ElementalmaintainsalistofcommonpresetsthataredeliveredtotheElementalLivesystemviasoftwareupdates.
Additionally,theusercanspecifynamedpresetsusinganyoftheinterfacestotheElementalLivesystem.
SCHEDULESSchedulescanbecreatedtoruncertainLiveEventProfilesatscheduledtimes,orasetofrepeatingtimes.
Forexample,aschedulecanbecreatedtoruneveryweekdayfrom1:00PMto2:00PMtostreamaprogram.
EachofthesescheduledprogramswillbeconvertedtoaLiveEvent.
MPTSMULTIPLEXERTheMulti-ProgramTransportStreammultiplexer(MPTSmux)combinesaudio,videoanddatafrommultipleLiveEventsintoasingleMPEG-2transportstream,outputoverUDP.
MPTSmuxesaremanagedfromtheMPTSControlpage,accessedfromtheEventControldrop-down.
TheMPTSmuxtakesitsinputsfromoneormoreLiveEvents.
InordertobeeligibleforMPTSmuxing,aLiveEventmustbeconfiguredwithasingleUDP/TSoutputgroupthathasanMPTSMembership.
AsettingofLocalallowstheeventtoparticipateinanMPTSmuxrunningontheLivenodeitself.
TheoutputalsomustbeattachedtoastreamthatisusingeitherCBRorStatmuxasitsRateControlMode.
Ifthesecriteriaaremet,theLiveEventwillbeavailableforinclusion.
LiveEventscanbeaddedandremovedfromtheMPTSatanytime,butmustberemovedfromoneMPTSbeforejoininganother.
WhenLiveEventsinanMPTSmuxareconfiguredwithStatmuxastheirratecontrolmode,statisticalmultiplexingisusedtoallocatethetotalavailableMPTSbitrateamongthevideostreambitratesbasedoncomplexity.
Thisistypicallyusedforstreamsthatarepartofafixedcapacitytransportmechanism.
Bitsaretransferreddynamicallyfromsimplecontenttocomplexcontent,maximizingtheoverallvisualqualityoftheoutput.
NOTIFICATIONUserscansetupaLiveEventsothatanotificationissentiftheLiveEventisstarted,stopped,orhasanalertorerror.
Theusercanbenotifiedinthefollowingways:EmailElementalLiveAPIandUserGuideProductOverview09/04/19ElementalTechnologiesConfidentialandProprietary4/169Webservicecallbacks-AnHTTPPOSTwillbeperformedtoaURLthatyouprovide,withinformationabouttheLiveEventTheusermayalsorequestdetailsaboutaLiveEvent'sstatusatanytime.
Thesedetailsaredescribedlaterinthisdocument.
STATISTICSElementalLiveiscontinuouslyloggingstatisticsaboutmediatype,quality,speed,temperature(CPUandGPU),fanspeed,andresourceutilization(CPU,GPU,network,diskandmemory).
Historicalstatisticsareavailableinthewebinterface,ontheStatspage.
ADVANCEDPREANDPOSTPROCESSINGMostworkflowshaveacertainnumberofcustomcommandsthatmustbeexecutedbeforeorafteraLiveEventisrun.
Examplesoftheseoperationsinclude:RunningcustomvalidationoninputoroutputfilesbeforeorafteraconversionRunningcustomnotificationsbeforeoraftertheLiveEventisrunSomeofthesecommandsaresupportednativelythroughtheElementalLiveuserinterface,andtherestcanberunthroughcustomscriptsthattheuserprovides.
CUSTOMSCRIPTSForeachLiveEventcreated,theusercanspecifyapreand/orapostscripttorun.
TheuserspecifiesalocationforthescriptaspartoftheLiveEventUIorRESTAPI.
Thislocationmustbeaccessiblebytheserver.
Itisrecommendedtoputthesescriptsinthe/opt/elemental_se/web/public/scriptdirectory;theBrowsebuttonforscriptsissetuptosearchthisdirectory.
/opt/elemental_se/web/public/script/example_script.
rbisanexamplescriptthatparsestheinputparametersusingRubyandprintsthemtothelive_runner.
outputlogfile.
Thepreprocessingscriptiscalledfromtheelemental_seservicejustbeforetheLiveEventrunsandmusthaveexecutepermissionfortheelementaluser.
TheLiveEvent'sstateischangedtoPREPROCESSINGwhentheprescriptisrunning,andPOSTPROCESSINGwhenthepostscriptisrunning.
TheLiveEventcanstillbecancelledwhenitisinoneofthesestates.
ThereportedstartandendtimesforaLiveEventwillcontaintherunningtimeofthesescripts;however,theelapsedtimeonlymeasuresthetimespentprocessingvideo.
ThescriptispassedaJSON-formattedhash.
Theoverallstructureisdescribedbelow:idIDoftheLiveEventscript_typePREforpreprocessing,POSTforpostprocessinginputsArrayofallinputs.
Eachiteminthearraycontainsthefollowingkeys:typeTypeofinput(file_input,network_input,device_input)uriPathtoinputfileoutput_groupsArrayofalloutputgroups.
Eachiteminthearraycontainsthefollowingkeys:nameIndicatesgrouptype(Archive,AppleHLS,etc.
)outputsArrayofalloutputsinthisgroup.
Eachiteminthearraycontainsthefollowingkeys:output_pathContainsthepathoftheoutputdestinationvideoHashofbasicvideosettings.
Containsthefollowingkeys:bitrateheightwidthcodecaudioArrayofaudiostreamsinthisoutput.
Eachaudiostreaminthearrayisahashofbasicaudiosettingscontainingthefollowingkeys:ElementalLiveAPIandUserGuideProductOverview09/04/19ElementalTechnologiesConfidentialandProprietary5/169bitratesampleratecodecThescriptshouldreturn0forsuccess,1forerror,2forwarning.
Ifthescriptechoes"RETURNMESSAGE:"toSTDOUTthenthismessageisinsertedinthedatabasefortheLiveEvent.
OnlyonemessagecanbesentbacktothesystemandstoredwiththeLiveEventinthedatabase;however,allmessagesandoutputstoSTDOUTwillbepresentinthesequencerlogfile.
ErrorswillnotallowtheLiveEventtocontinue,butwarningswill.
Someveryusefultoolsareincludedwiththisproducttohelprunsomeofthepreandpostprocessingscripts.
Theyarelocatedinthe/bindirectoryundertheinstallationdirectoryandinclude:ffmpeg:auniversalvideoprocessingutilitymp4box:anMP4muxinganddemuxingutilityldecod:thereferenceH.
264decoderfromtheJMgroupMostlinuxtoolsareavailableaswell,includinggrep,awk,sed,perl,python,andruby.
ElementalrecommendsimplementingscriptsinalanguagethatincludesJSONparsinglibraries.
TROUBLESHOOTINGProblemswithElementalLivemaybediagnosedbyviewingthelogfilesavailablehere:http://server_ip/logs.
Foradditionalsupport,contactyourElementalsupportrepresentative,oremailsupport@elemental.
comElementalLiveAPIandUserGuideProductOverview09/04/19ElementalTechnologiesConfidentialandProprietary6/169WEBINTERFACEQUICKSTARTGUIDETermsIconsNavigationGettingStartedCreatingaNewLiveEventArchiveGroupsAppleLiveGroupsDASHISOGroupsMicrosoftSmoothGroupsAdobeRTMPGroupsUDP/TSGroupsCreatingaLiveEventfromXMLorProfileSavingandManagingaLiveEventSwitchingInputsAdvancedAudioTrackSelectionsPresetsProfilesSchedulesMPTSMultiplexersStatsSettingsWEBINTERFACEQUICKSTARTGUIDEElementalLiveincludesabasicwebinterfaceimplementationtohelpyougetstartedstreamingquickly.
Thispageexplainsthebasicstepsforusingthedefaultwebinterfaceanddefinesthetermsusedintheinterface.
DEFINITIONOFCOMMONTERMSLiveEvent:astreamorstreamstobebroadcastinreal-time,specifiesinputsource(s),outputstream(s),outputgroup(s),optionallymayincludeastart/stoptimeandvideoeffectstobeappliedtotheoutputstreams.
HowtocreateaLiveEventPreset:Apresetisapredefinedgroupofsettingsforastream.
Thisincludesboththeencodingparametersaswellastheeffectstobeapplied.
HowtocreateaPresetHowtocreateaPresetfromanexistingLiveEventNoteabouteditingPresetsLiveEventProfile:ALiveEventProfileisasavedLiveEventdefinitionthatincludesalloutputsettingsandmayoptionallyincludeinputdetails.
LiveEventProfilesprovideaquickmethodforcreatingidenticalLiveEvents.
UsingtheLiveEventProfilesPagetoCreateaNewLiveEventHowtocreateaLiveEventProfileElementalLiveAPIandUserGuideWebInterfaceQuickStartGuide09/04/19ElementalTechnologiesConfidentialandProprietary7/169Input:Aninputcontainsinformationaboutthesourceinput(s)forthebroadcaststreams.
TheinputcanbefromanHD-SDIinputcard,fromanRTMP,UDPorRTPmulticastorunicastnetworkstream,orfromafile.
ALiveEventcandefinemultipleinputs,eitherforinputfailoverorfordynamicinputswitching.
SwitchingbetweeninputsStream:Astreamisapredefinedgroupofvideoandaudioencodesettingsforasingleencodingoutput.
Thisincludesboththeencodingparametersaswellastheeffectstobeapplied.
Group:Groupscontainthecommoninformationforanoutputdeliveryformat.
Theinformationincludedinagroupisdifferentforeachgroupbutalloftheinformationrequiredfordeliverytoanoutputiscontainedinitsgroup.
Forexample,groupsmaycontainCDNinformationordeliveryaddressesforstreaminggroups(AdobeRTMP,SmoothStreaming)orfilenamesandnetworklocationsforarchivegroups.
Inaddition,eachstreammayneedspecificinformationforeachgroup,suchasthefilenamefortheoutputortheindividualIPaddresstarget.
HowtosetupanArchiveGroupwithOutputsHowtosetupanAppleHLSGroupwithOutputsHowtosetupanMSSmoothStreamingGroupwithOutputsHowtosetupanAdobeRTMPGroupwithOutputsHowtosetupaUDP/TSGroupwithOutputsOutput:Anoutputismadeupofthecombinationofastreamandagroup.
Timing:AtimingobjectdirectsaLiveEventtostartandstopataparticulartime.
Schedule:AschedulecontainsinformationforschedulingrepeatingLiveEventsfromaparticularLiveEventProfile.
HowtocreateaScheduleMPTS:AnMPTSrepresentsaMulti-ProgramTransportStreammultiplexer.
HowtosetupanMPTSPresetCategory:User-definedcategorythatcanbeusedtoorganizepresets.
DEFINITIONOFCOMMONICONSOntheEventControlpage,aswellasthePresetsandLiveEventProfilesandmanyotherpages,iconsareusedtoindicatebothstateandavailableactions.
Manyoftheseiconsarenotexplicitlylabeled(thoughifyouhoverovertheicon,atooltipwillappeartoindicatetheicon'saction).
AnexampleofhowthislookscanbefoundintheEventControlpagescreenshot.
Clickingonaniconwilltriggertheactionassociatedwiththaticon.
Show:Thisiconindicatesthatmoreinformationisavailableaboutthegivenobject.
Forexample,thisiconisusedontheEventControlpagetolinktodetailedinformationaboutaLiveEvent.
Edit:Thisiconindicatesthatthegivenobjectisallowedtobeedited.
NotethatLiveEventsmaynotbeeditedwhiletheyarerunningandthedefaultPresetsthatcomeloadedwithElementalLivecannotbeedited.
Duplicate:Thisiconindicatestheduplicationofanobject.
ItisusedontheEventControlpage,thePresetspageandtheProfilespage.
ClickingthisiconwillnavigatetotheNewpageforthegivenobject,withalloftheinformationfilledoutfromtheduplicatedobject.
CreateLiveEvent:ThisiconisfoundontheProfilespageandisaquickwaytogenerateaLiveEventfromagivenLiveEventProfile.
ClickingthisiconwillnavigatetotheNewLiveEventpagewithinformationfilledoutfromthegivenLiveEventProfile.
Delete:Thisiconallowsforthedeletionofobjects.
NotethatthecollectionofdefaultPresetsthatcomeloadedwithElementalLivecannotbedeleted.
Cancel/Stop:ElementalLiveAPIandUserGuideWebInterfaceQuickStartGuide09/04/19ElementalTechnologiesConfidentialandProprietary8/169Thisiconindicatestwoseparateactions.
InthelasticoncolumnthisiconisfoundwhenaLiveEventispending,anditisusedtocanceltheLiveEvent.
Inthesecond-to-lasticoncolumnthisiconisfoundwhentheLiveEventisrunning,andinthispositionitindicatesacommandtostoptheLiveEvent.
Reset:Thisiconisusedtoresetacancelled,completedorerroredLiveEvent.
Play:ThisiconisusedtostartapendingLiveEvent.
ItalsoappearsbesideeachInputwhenviewingacurrentlyrunningLiveEvent.
HereitcanbeusedtoswitchtoanInputontheflyduringthecourseoftheLiveEvent.
Archive:Thisiconisusedtoarchiveacancelled,completedorerroredLiveEvent.
ArchivingaLiveEventdoesnotdeleteit,butitremovesitfromthemainEventControlpage.
ArchivedLiveEventscanbefoundbyclickingtheArchivefilterbuttonontheEventControlpage.
TherearesixbasepagesforthedefaultwebinterfaceEventControl:ViewstatusofcurrentLiveEvents,currentandpastLiveEventdetails,orcreatenewLiveEventsPresets:View,createandeditPresetsandPresetCategoriesLiveEventProfiles:View,createandeditLiveEventProfilesSchedules:View,createandeditSchedulesStats:ProvidesstatisticsforElementalLiveAlerts:AccesssystemandLiveEventalertsSettings:ModifyElementalLivesettingsSupport:Documentationforthewebinterface,theRESTinterface,andtheSNMPAPITYPICALSTEPSFORGETTINGSTARTEDWITHELEMENTALLIVEPointawebbrowserattheElementalLivewebaddress:http://Youshouldseeascreenlikethis:Ifthisisthefirsttimethesystemhasbeenstarted,theLiveEventslistwillbeempty.
CREATINGANEWLIVEEVENTAfterselectingtheEventControlpage,simplyclickthe"NewEvent"button.
ElementalLiveAPIandUserGuideWebInterfaceQuickStartGuide09/04/19ElementalTechnologiesConfidentialandProprietary9/169Tobegin,givetheLiveEventaname,andsetanyotheroptionsyouwouldlikethisLiveEventtouse.
CONFIGURINGINPUTSToconfigureaninput,selectaninputsource(HD-SDI,Network(UDP,RTP,RTMP),orFile)andenteranyfieldssuchasanetworkorfilelocationthattheinputsourcerequires.
Additionalinputscanbeaddedbyclickingthe"AddInput"button.
Whenmorethanoneinputispresent,theinputordercanbeadjustedusingtheorangeupanddownbuttons.
Besideeachinput,the"Preview"buttoncanbeusedtoverifythattheElementalLivesystemcanaccessyoursourcecorrectly.
Thepreviewwindowwilldisplayasamplevideoframefromthesourceandasummaryofitsmetadatasuchasprograms,audio,andvideostreams.
CONFIGURINGOUTPUTSSettingupanoutputinvolvesconfiguringbothastreamandanoutputgroup,inadditiontotheindividualoutput.
ThevariousoutputsgeneratedbyaLiveEventareacombinationoftheoutput'sstreamvaluesanditsoutputgroupparameters.
First,decideonthetypeofoutputsthatwillbeneededforthisLiveEvent(Archive,AppleHLS,MSSmooth,AdobeRTMP,orUDP).
Clickonanoutputgrouptabtoconfigureparametersthatwillbesharedamongalloutputsinthatgroup.
Additionaloutputgroupscanbeaddedbyclicking"AddOutputGroup",andthosethatarenotneededcanbedeletedbyclicking"DeleteGroup".
Ifanoutputgroupisleftunconfigured(i.
e.
itisnotassociatedwithanyoutputsandparametersareleftblank),thegroupwillbeautomaticallyremovedwhentheLiveEventissaved.
OutputsshouldbeaddedtothisgroupintheNewOutputboxbyselecting'NewStream'oranexistingstream(tore-usevideoandaudioencodingparameters).
APresetcanbeappliedtoanewoutputbeingaddedwhen'NewStream'isselected.
SelectingaPresetfromwithintheNewOutputboxappliestheOutputSettingstothenewoutputandtheStreamSettingstothenewStream.
ThePresetsavailabletobeusedinthismannerareonlythosePresetswithOutputSettingsthatarecompatiblewiththegivenoutputgroup,orPresetswithoutOutputSettings.
Theorderofoutputscanbeadjustedusingtheorangeupanddownbuttons.
Thisdeterminesorderinginmanifestfilesforadaptivebitrateoutputgroups.
ElementalLiveAPIandUserGuideWebInterfaceQuickStartGuide09/04/19ElementalTechnologiesConfidentialandProprietary10/169CONFIGURINGSTREAMSStreamconfigurationcanbefoundbelowtheoutputgroupconfiguration.
StreamsarecreatedwhennewOutputsarecreated;toaddmoresimplyusethe"AddStream"button.
Thefullsetofvideo,audio,andcaptionparametersareavailabletoconfigureyourstreambyclickingthe"Advanced"dropdowntoggle.
Eachstreammustbeassociatedwithatleastoneoutputamongyouroutputgroups.
APresetmaybeselectedforastream,howeveronlytheStreamSettingsfromthePresetwillbeappliedtothestream.
SETTINGUPANARCHIVEGROUPGlobalArchiveparametersfoundundertheArchivetabapplytoalltheoutputsinthisgroup.
Formoredetailedparameterinformation,seetheArchiveGroupSettingsparametersdocumentation.
ThenamesofoutputsinanArchivegroupareacompositeofthegroupDestination,andeachoutput'snamemodifierandextension.
TheDestinationfieldspecifiestheoutputdirectoryandoptionallyabasefilename.
Forexample,settingadestination/data/server/completed/my_archivewillcreatefilesinthe/data/server/completeddirectorywithnamesthatstartwith"my_archive".
Excludingthebasefilenamebyendingthedestinationfieldwithaslash,forexample/data/server/completed/,willcreatethefilesintheindicateddirectory,andthefilenamewilldependpurelyontheindividualoutput'snamemodifier.
TheNameModifierisappendedtotheinformationinthegroupdestinationfield.
Forexample,anamemodifierof"_2400"wouldappendtotheglobalbasefilename"my_archive"intheexampleusedpreviouslytoproduce"my_archive_2400"asthefinalfilename.
Ifnobasefilenameisselected,thenthefilenamewillsimplybethenamemodifier.
Finally,theExtensionfortheoutputisappendedtothefullDestination-NameModifierpath.
Ifnoextensionisspecified,adefaultwillbeusedbasedonthecontainer.
ElementalLiveAPIandUserGuideWebInterfaceQuickStartGuide09/04/19ElementalTechnologiesConfidentialandProprietary11/169SETTINGUPANAPPLELIVEGROUPGlobalAppleLiveparametersfoundundertheAppleLivetabapplytoalltheoutputsinthisgroup.
Formoredetailedparameterinformation,seetheAppleHLSGroupSettingsparametersdocumentation.
TheAppleLiveGroupDestinationfieldacceptseitheralocaloutputdirectoryoranHTTPendpoint.
Whencreatingfilesondisk,theAppleLiveGroupusesthesamefilenamingmechanismastheArchiveGroup.
Thedestinationdirectoryisalsowherethe.
m3u8filesthatcontainthestreaminformationwillbecreated.
UnliketheArchiveGroup,AppleLiveGroupsrequirethatabasefilenamebeset.
Ifclientswillviewstreamsfromthislocation,thedirectoryshouldbedirectlyservablebyawebserver(i.
e.
publiclyaccessible).
PushingtoanHTTPendpointalsorequiresthespecificationofabasefilename.
Forexample:http:///directory/base_file_name.
AnAppleLivegroupcancontaintwospecialkindsofoutputs:AudioOnlyandExternaloutputs.
Audioonlyoutputscanbecreatedbyconnectinganoutputtoastreamthatdefinesonlyaudiosettings.
Audioonlyoutputsincludeanadvancedsettingthatallowsyoutospecifyastaticplaceholderimagetoembedintheoutput.
Externaloutputscanbeaddedusingthe"AddExternalOutput"button.
Includinganexternaloutputdirectstheoutputmanifesttoinsertanentryforanassetthatisgeneratedbyaseparateencoder.
NotethatatleastoneoftheoutputsinanAppleLivegroupmusthavevideo.
SETTINGUPADASHISOGROUPGlobalDASHISOparametersfoundundertheDASHISOtabapplytoalltheoutputsinthisgroup.
Formoredetailedparameterinformation,seetheDASHISOGroupSettingsparametersdocumentation.
TheDestinationfieldspecifiestheoutputdirectoryandoptionallyabasefilename.
SETTINGUPANMSSMOOTHSTREAMINGGROUPGlobalMSSmoothparametersfoundundertheMSSmoothtabapplytoalltheoutputsinthisgroup.
Formoredetailedparameterinformation,seetheMSSmoothGroupSettingsparametersdocumentation.
ThePublishPointfieldspecifiestheoutputserverlocationandstreamnamethatwillmatchtheSmoothStreamingPublishingPointsthathavebeenconfiguredontheIISserver.
Forexample,aPublishPointwouldbehttp://iis/livesmooth/livesmoothstream1.
isml.
TheNameModifierisappendedasusualtotheinformationintheglobaldestinationfield.
AnMSSmoothgroupcanoptionallycontainoneormoreCaptionoutputs.
Thesecanbecreatedbyconnectinganoutputtoastreamthatdefinesonlycaptionsettings.
NotethatatleastoneoftheoutputsinanMSSmoothgroupmusthavevideo.
SETTINGUPANADOBERTMPGROUPGlobalRTMPparametersfoundundertheRTMPtabapplytoalltheoutputsinthisgroup.
Formoredetailedparameterinformation,seetheAdobeRTMPGroupSettingsparametersdocumentation.
TheRTMPEndpointisusedbytheCDNtospecifytheingestpoint.
Anexamplewouldbe:rtmp://p.
ep9999.
i.
akamaientrypoint.
net/EntryPoint.
ClickingthecredentialsbuttonnexttotheRTMPEndpointdisplaysUsernameandPasswordfieldsthatareusedforCDNssuchasAkamai,whichrequireauthentication.
SETTINGUPAUDP/TSGROUPGlobalUDP/TSparametersfoundundertheUDP/TStabapplytoalltheoutputsinthisgroup.
Formoredetailedparameterinformation,seetheUDP/TSGroupSettingsparametersdocumentation.
TheMPTSMembershipdefineswhethertheoutputshouldbeamemberofanMPTS.
IfNoneorRemoteisselected,theURIspecifiestheaddresswheretheUDPstreamistobepublished.
Aportmustbespecifiedforastream.
Unicast:usetheURIfieldtospecifytheIPaddressofthedeviceyouwishtostreamto:udp://:.
AnexampleofavalidURIentrywouldbeudp://10.
1.
1.
10:5020.
ElementalLiveAPIandUserGuideWebInterfaceQuickStartGuide09/04/19ElementalTechnologiesConfidentialandProprietary12/169Multicast:usetheURIfieldtospecifytheIPaddressofthedeviceyouwishtostreamtowiththeadditionalTTLparameter:udp://:ttl=x.
AnexampleofavalidURIentrywouldbeudp://239.
255.
11:5020ttl=1.
CREATINGALIVEEVENTFROMANXMLRESOURCEORAPROFILEThereisanorangebuttonlabeled'Load'atthetoprightofthepagenexttothe'Create'button.
Clickingonthebuttonwillpresenttwochoices:LiveEventXMLLiveEventProfileSelectingLiveEventXMLwilldisplayafilebrowseformthatallowsyoutoselectanXMLfiletopopulatetheLiveEventpage.
XMLsubmittedthroughthisinterfacemustbevalidandconformtothecurrentsystemversion.
SelectingLiveEventProfilewilldisplayadrop-downlistofallavailableProfiles.
ApplyingaprofilefromthelistwillreloadtheLiveEventpagewiththesettingsfromtheselectedprofile.
Pleasenotethatloadingeitheroneoftheseresourceswilloverwriteanyuserdatacurrentlyonthepage.
Bothoftheseformsarealsoaccessiblebytheirownendpoints/new_from_xmland/new_from_profile.
SAVINGANDMANAGINGALIVEEVENTAfterallofyourOutputGroups,StreamsandOutputshavebeensetup,clickthe"Create"buttonintheupperrighttocreatetheLiveEvent.
TheLiveEventwillthenbeplacedina"Pending"state.
TostarttheLiveEvent,clickthe"Start"button.
ThemainviewforaLiveEventiscalledtheControlPanel.
Fromthe"ControlPanel"youcanmonitorarunningLiveEvent,seeapreviewwindowwithliveupdatedframecaptures,seeandswitchthecurrentlyrunninginput,pauseandunpauseoutputsandwholeoutputgroups,stopandresettheLiveEvent,andmore.
IfyouneedmorecompleteinformationabouttheLiveEventclick"Details"nearthetopofthispage.
TheDetailspagecontainsthecompletesetofLiveEventparametersforreference.
SWITCHINGINPUTSALiveEventcancontainmultipleinputsources,whichgettranscodedsequentiallybydefault.
WhileinputscanbeswitchedmanuallyviatheInputControlsoftheControlPanel,therearealsoseveraltoolsinplacetomanagetheautomaticswitchingofinputs.
FailoverConditionsdictatewheninputs'failover'tothenextsubsequentinput,duetounexpectedinputfailures.
Multiplefailoverconditionscanbeset,butonlyoneconditionneedstobemetforaninputtofailover.
HotBackuppairsaninputwiththenextorpreviouslistedinputtoprovidesimultaneousdemuxinganddecodingofbothinputs.
Thisallowsinstantaneousfailoverbetweeninputs,andautomaticfailbacktoarestoredinput.
BothInputsaredemuxedanddecoded,andonlyoneofthemisconnectedtotherestoftheencodingpipeline.
Eachinputcanthenhaveitsownsetoffailoverconditions.
Ifafailoverconditiononthefirstsequentialinputismet,thesystemfailsovertothesubsequentpairedinputimmediately(asitisalreadybeingdecoded).
Iftherearenofailoverconditionsset,theHotBackuppairwilldecodesimultaneouslywithfailoveracompletelymanualprocess.
WhenapairofinputshaveHotBackupenabled,theymayalsohaveuniqueFailbackRulesspecified.
FailbackRulesdictatetheconditionstorestoreaninputtoanactivestate,basedonaspecifiederrorfreeinterval.
WithHotBackupandFailoverrulesdefined,validoutputisguaranteed,aslongasonlyoneoftheinputsiscorruptedatagiventime.
ElementalLiveAPIandUserGuideWebInterfaceQuickStartGuide09/04/19ElementalTechnologiesConfidentialandProprietary13/169ADVANCEDAUDIOTRACKSELECTIONSElementalLiveallowsaudiotrackselectionfrominputswithmultipleaudiotracksaswellastracksfromexternalfilesthroughtheuseofAudioSelectors.
Additionally,Selectorscanbegroupedtomergemultipleaudiotracksintoasingleoutputtrack.
Forexample,tocombinetwomonotracksintoonestereotrack,addtwoAudioSelectorsandoneAudioSelectorGroup,selectbothinthegroupbox,andnameit"Stereo":IntheAudiosettingsoftheoutput,notethatyourAudioSelectorsandthe"Stereo"groupareavailableforthisoutput.
Formoreinformation,seeAudioSelectorUSINGPRESETSPresetssimplifystreamcreationwhenthesameencodingparameterswillbeusedrepeatedly.
CreatingaPresetisnotrequired,butifyouplantousethesameencodinginformationmultipletimes,itisrecommended.
ClickthePresetstabtoviewexistingPresetsandtocreatenewPresets.
ElementalLiveAPIandUserGuideWebInterfaceQuickStartGuide09/04/19ElementalTechnologiesConfidentialandProprietary14/169CREATINGANEWPRESETDuplicateanexistingPresetandmodifyittomeetyourtargetsettingsorclicktheNewPresetbutton.
Forexample,duplicatingtheiPadAdaptiveHighpresetwillshowthedetailedsettingsforthePresetwhichyoucanthenmodifytocreateyourowncustomPreset.
APresetcontainstwodistinctsettingsareas,OutputSettingsandStreamSettings.
OutputSettingscontainscontainersettingsthatareappliedtoanoutput.
APresetdoesnothavetospecifyOutputSettings;leavingthecontainerblankwillcreateaPresetthatisagnostictooutputtypes.
StreamSettingscontainsvideo,audioandcaptionencodinginformationthatareappliedtoastream.
APresetmustspecifyencodinginformation.
ForamoredetaileddescriptionofeachoftheavailablesettingspleaseseePresetParameters.
Aftermakingyourdesiredchanges,includinganewNameandDescriptionforthePreset,selecttheSavebuttontocommitthechangestothedatabase.
ElementalLiveAPIandUserGuideWebInterfaceQuickStartGuide09/04/19ElementalTechnologiesConfidentialandProprietary15/169CREATINGANEWPRESETUSINGANEXISTINGLIVEEVENTCreatingaPresetusingtheStreamsettingsofanexistingLiveEventisusefulifthesesettingswillbeusedagain.
Navigatetothe"Show"pagefortheLiveEventandfindtheStreamthatyouwishtosaveasapreset.
NexttotheStreamlabelisa"SaveasPreset"button.
ClickingthisbuttonbringsupfieldsforselectingthePresetNameandDescription,aswellasPresetCategory.
Clicking"Save"willsavethePreset.
EDITINGPRESETSNotethatwheneveraPresetisedited,theLiveEventProfilesandLiveEventsthathadbeencreatedusingthisPresetwillnotbeupdated.
IfaPresetmustbeedited,allassociatedLiveEventProfileswillneedtobeupdatedtousetheupdatedPreset.
USINGLIVEEVENTPROFILESCreatingLiveEventProfilescansimplifyLiveEventcreationwhilemakingsurethatyourLiveEventssharethesamesetofstreamandgroupoptions.
AfternavigatingtotheProfilespage,eachexistingLiveEventProfileislisted.
ByselectingaLiveEventProfile,youcanseethedetailsofthestreamandgroupsettings.
CREATEANEWLIVEEVENTFROMALIVEEVENTPROFILEFromtheNewLiveEventpage:Click"Load"(nexttothegreencreatebutton).
Select"LiveEventProfile"fromthedropdownmenuthatappearsbelowthebutton.
Choosethedesiredprofilefromthelistandclick"Apply"toloadthesettings.
Thisactionwillreloadthepageandoverwriteallfields.
FromthemainProfilespage:ThereisaCreateLiveEventiconlistedforeachLiveEventProfileonthemainProfilespage.
ClickingthisiconwilltakeyoutotheNewLiveEventpagewithalltheinformationfromthegivenLiveEventProfilealreadyfilledout.
Additionally,anychangestotheLiveEventProfile'sparameterscanbemadeatthistimeaswell.
CREATINGANEWLIVEEVENTPROFILENext,createaLiveEventProfiletocontainthePresetorlistofPresetsalongwiththedetailsofanypre-orpost-processingscriptsandwheretheoutputsshouldbesent.
ThiscanbeaccomplishedbyclickingtheProfilestabandthenclickingtheNewProfilebutton.
ThesettingsforaLiveEventProfileareverysimilartotheNewLiveEventpage.
ThetopsectionofthedetailedLiveEventProfilepageshowstheinformationrelatedtotheLiveEventProfile.
ThelowersectionofthepageshowsthestreamsandgroupsassociatedwiththeLiveEventProfile.
MoredetailsontheavailableLiveEventProfileParameterscanbefoundontheParameterspage.
USINGSCHEDULESIfyouhaveLiveEventsthatwillberepeatedatspecificintervals,youcansetupaScheduletoautomaticallygeneratethoseLiveEvents.
TheSchedulespagedisplaysallofthescheduledLiveEvents.
ElementalLiveAPIandUserGuideWebInterfaceQuickStartGuide09/04/19ElementalTechnologiesConfidentialandProprietary16/169CREATINGANEWSCHEDULEAScheduleiscreatedusingapre-existingLiveEventProfiletogeneratetheLiveEventoutputsettings,sofirstmakesurethataLiveEventProfilewiththedesiredoutputsettingsexists.
ThisLiveEventProfilemayoptionallyindicateaninputmethod,butthisisnotrequired.
ClickingNewScheduleontheSchedulespagewillbringyoutotheNewSchedulepage.
OntheNewSchedulepageselectthedesiredLiveEventProfile,Node,andanydesiredfailuresettings.
IftheLiveEventProfiledoesnothaveaninputspecified,orifadifferentinputisdesiredforthescheduledLiveEvents,clicktheAddInputbuttonandfilloutthedesiredinputsettings.
TherightsideofthescreencontainstheinformationencapsulatingtherepeatingscheduleoftheLiveEvents.
First,filloutthedesiredStartTimeandEndTimeofthefirstscheduledLiveEvent.
ThedatespecifiedintheStartTimefieldrepresentsthedateofthefirstrepeatingLiveEvent.
NextspecifyhowlongthisScheduleistoberepeated,eitherforeveroruntilaspecificdate.
Thenspecifytherepeatingschedule.
Thiscanbespecifiedonadailybasis(i.
e.
every2days),oronaweeklybasis(i.
e.
everyM,W,F).
Therearealsooptionsforrepeatingonamonthlybasis,eitheronaspecificday(i.
e.
the15thofthemonth)oraspecificdayoftheweek(i.
e.
theSecondThursdayofthemonth).
OnceaSchedulehasbeencreated,thescheduledLiveEventsforthenextthreemonthswillbedisplayedonthecalendar.
TheLiveEventsthemselvesareonlycreated24hoursinadvance.
WhentheactualLiveEventhasyettobecreated,thenthescheduledLiveEventwillbedisplayedasalightbluecolorandclickingontheLiveEventwillnavigatetotheSchedulepage.
WhentheLiveEventhasbeencreateditwillshowupintheLiveEventslist,andtheLiveEventwillbedisplayedindarkgreenonthecalendar.
ClickingontheLiveEventwillnavigatetotheShowLiveEventpage.
USINGMPTSMULTIPLEXERSMPTSmuxesaremanagedfromtheMPTSControlpage,accessedfromtheEventControldrop-down.
FromthereyoucancreateanMPTS,manageitschannels,startorstopitsoutput,andviewagraphofperformancestatistics.
ElementalLiveAPIandUserGuideWebInterfaceQuickStartGuide09/04/19ElementalTechnologiesConfidentialandProprietary17/169CREATINGANEWMPTSMUXTocreateanewMPTS,selectCreateMPTS.
Ataminimum,provideaname,atransportstreamID,atransportstreambitrate,avideoallocationbitrate,andadestination.
Thevideoallocationbitratemustbelessthanthetransportstreambitrate,andthebufferbetweenisintendedforaudio,data,andnullpackets.
ThedestinationcanbeaUDPorRTPaddress.
ADDINGCHANNELSOnceanMPTSiscreated,clickitsnametoviewitschannellisting.
LiveEventscanbeaddedaschannelsviatheAddChannelbutton.
InordertobeeligibleforMPTSmuxing,aLiveEventmustbeconfiguredwithasingleUDP/TSoutputgroupthathasanMPTSMembershipset.
AsettingofLocalallowstheeventtoparticipateinanMPTSmuxrunningontheLivenodeitself,whileasettingofRemoteconfiguresittocommunicatewitharemoteElementalStatmuxnode.
TheoutputalsomustbeattachedtoastreamthatisusingeitherCBRorStatmuxasitsRateControlMode.
YoumustremoveaLiveEventfromoneMPTSbeforeaddingittoanother.
WhenconfiguringaLiveEventforMPTSmembership,itsUDPSettingsdefineasetofdestinationvalues,includingtheDestination,thePrimaryComplexityTransmitDestination,andthePrimaryAllocationReceiptDestination.
ForLocalMPTSmembership,theElementalLivesystemsetstheaddressesforalldestinations(thesefieldsarehidden).
ForRemote,multicastaddressesmustbeaddedmanually.
ThevaluessetattheLiveEventmustcorrespondwithvaluessetattheMPTS.
Thearrangementoffieldsisintendedtosupportaside-by-sideview.
DestinationsgotoInputs,TransmitsgotoReceipts,andReceiptsgotoTransmits.
ThePrimaryDestinationattheLiveEventmustmatchthePrimaryInputattheMPTS.
ThePrimaryComplexityTransmitDestinationattheLiveEventmustmatchthePrimaryComplexityReceiptDestinationattheMPTS.
ThePrimaryAllocationReceiptDestinationattheLiveEventmustmatchthePrimaryAllocationTransmitDestinationattheMPTS.
Allsecondarydestinationsareoptional,butmustcorrespondwiththesameMPTSastheprimarydestinations.
CorrespondingIGMPSourceandVirtualSourcesperdestination/inputmustmatch.
SETTINGUPNETWORKREDUNDANCYFORELEMENTALMPTSESMPTSmuxesandLiveEventscancommunicatewithfullnetworkredundancy.
Thismeansthatallcommunicationpathscanbeduplicatedandsentthroughtwodifferentnetworkssimultaneously.
Thisprovidesprotectionfromnetworkingequipmentfailureandallowstheflowofessentialmediaandstatmuxalgorithmdatatoflowerror-free.
TherearethreestreamsofdataforeachchannelofanMPTS,asfollows:ThereistheflowofcomplexityestimatesfromtheEventtotheMPTS,whichareusedforstatmuxaccountingandtoweighthechannelsagainsteachother.
ThereisaflowofbitrateallocationsfromtheMPTStotheEvent,whichinformstheencoderhowmanybitsmaybeallocatedtoasectionofcontent.
ThereistheSingleProgramTransportStreamthatflowsfromtheEventtotheMPTScontainingtheencodedmedia,readyformuxingintothefinalMPTSoutput.
Eachofthesestreamsofdataisassignedadestinationaddress.
Typically,thisisdonewithmulticastaddresses,butunicastaddressescanalsobeused.
MulticastaddressesarerequiredforfunctionalEventandMPTSlevelfailover,whichisdifferentfromnetworkredundancy.
TheLiveEventandMPTSprovidethefollowingaddressfieldsforeachchannel:ForSPTSdata:PrimaryDestinationSecondaryDestinationForinitialcomplexityestimates:PrimaryComplexityTransmit/ReceiptDestinationElementalLiveAPIandUserGuideWebInterfaceQuickStartGuide09/04/19ElementalTechnologiesConfidentialandProprietary18/169SecondaryComplexityTransmit/ReceiptDestinationForfinalallocations:PrimaryAllocationTransmit/ReceiptDestinationSecondaryAllocationTransmit/ReceiptDestinationWhenfillingtheseout,onlytheprimaryaddressesarerequired.
Ifsecondarydestinationsarespecified,thenthesystemwillusetwoindependentdataflows,andimplementanautomaticswitchbetweenthemasrequired.
Toensurethatthetwodataflowsareactuallymovingoverseparatenetworksitisstronglyrecommendedthatthe"interface"parameterisused.
Thisallowsthedatatobeforcedoveraspecificnetworkinterface(suchas"eth1"or"eth2").
Inthisexampleeth1andeth2shouldbephysicallywiredtotwoseparatenetworks.
AfterconfiguringtheEvent,theMPTSshouldbesimilarlyconfigured.
Thesamemulticastaddressesshouldbeusedforeachofthecorrespondingsixfields,andinterfacesshouldbespecifiedtoenforcethatthedataflowsoverthecorrectnetworks.
ItisnotrequiredthatthesameinterfacenamesbeusedontheMPTSandontheEvent,butthecorrespondinginterfacesshouldconnecttothesamenetwork.
Forexample:ElementalLiveEvent"PrimaryComplexityDestination"issetto230.
100.
100.
100oninterfaceeth1,whichisconnectedtonetworkA.
ElementalStatmuxMPTS"PrimaryComplexityDestination"issetto230.
100.
100.
100oninterfaceeth3,whichisconnectedtonetworkAaswell.
TheEventandMPTSlogscontaininformationaboutthepercentageofdroppedpacketsonthenetwork,andthepercentageofthosedropsthatwererecoveredbyusingthedatafromtheothernetworkpath.
PIDASSIGNMENTWhenaddingachannel,PIDvaluesfortheMPTSoutputareautomaticallyassignedtoavoidcollision,basedontheexistenceofPIDvaluesintheLiveEventsconfiguration.
Forremotechannels,allPIDtypesareconsideredtobepresent.
Thesevaluescanthenbeedited,withvalidationsinplacetoavoidcollisions.
Itsworthnotingthat,sincePCRmaybecarriedinanotherPID,assigningaPCRvalueintheMPTSisonlyrelevantifithasbeengivenanisolatedPIDvalueintheLiveEventconfiguration.
IftheLiveEventislaterconfiguredtouseanadditionalPID,anewPIDvaluewillbeautomaticallyassignedwithintheMPTS.
ChanginganexistingPIDvalue,orremovinganoptionalPIDfromtheLiveEventwillhavenoeffectontheMPTSPIDconfiguration.
Onceagain,thesevaluescanbedirectlyeditedattheMPTSatanytime.
STARTINGORSTOPPINGTHEMPTSAnMPTScanbestartedorstoppedfromtheMPTSindex,oranywherewithintheindividualMPTSviews.
AnMPTSmustbestoppedbeforebeingdeleted.
USINGTHESTATSPAGEThestatspagesprovidevariousstatisticsaboutElementalLive.
TheStreamStatisticspagedisplaysinformationaboutthecurrentlyrunningstreams,whiletheNodestatspagedisplaysinformationabouttheElementalLiveserver.
Inaddition,thestatspagesprovideaccesstothealertingsystemaswellasabrowsablelistoflogfilesmaintainedbythesystem.
CHARTSAvarietyofchartsthatdisplayinformationaboutthesystemareshownonthestatspages.
Thesechartsupdateautomaticallyinreal-time.
Toenlargeanyparticularchartinordertoseemoredetailedinformation,simplyclickonthechart'stitleorthechartitself.
AnexamplechartshowingtheFrames/SecondbeingtranscodedoneachGPUisshownbelow.
ElementalLiveAPIandUserGuideWebInterfaceQuickStartGuide09/04/19ElementalTechnologiesConfidentialandProprietary19/169STREAMSTATISTICSStreamStatisticscanbefoundbynavigatingtothemainstatspage.
ThisincludeschartsprovidinginformationonthePercentRealtimeandTotalFrames/SecondofthecurrentlyrunningLiveEvents.
Thereisalsohistoricalinformationaboutthetotalnumberofoutputstreamsthatthesystemhasproducedovervarioustimeframes.
AtthebottomofthepageisinformationontheElementalLivenodeitself.
Thisinformationincludesthenode'sstatus,thenumberofLiveEventscurrentlyrunning,thenumberofcompletedLiveEvents,andtheaverageoutputFPSforthatnode.
TherearealsochartsshowingthePercentCPUUtilizationandtheGPUFrames/Secondbeingprocessedbythenode.
Inordertoaccessmoredetailedstatisticsforthenode,clickonthenode'snametonavigatetotheNodestatspage.
NODESTATISTICSDetailedinformationabouttheElementalLivenodecanbefoundontheNodestatspage,includingchartsprovidinginformationonthenode'sCPUusage,Memoryusage,Diskusage,GPUtemperatureandGPUFrames/Second.
AtthebottomofthepageisalistofthecurrentlyrunningLiveEventsaswellasthelasttencompletedLiveEvents.
LinkstomoredetailedinformationabouteachLiveEventareavailable.
USINGTHEALERTSPAGETheAlertspageisaccessiblefromadropdownmenuontheStatusmenu.
Itcanalsobeaccessedbyclickingonanactivealertintheupperrightcornerofanypage.
Alertscanbegeneratedforsystemleveleventsincluding:CPUAlert-CumulativeCPUusageistoohighDiskAlert-AdiskpartitionisalmostfullGPUTemperatureAlert-TheGPUtemperatureistoohighElementalLiveAPIandUserGuideWebInterfaceQuickStartGuide09/04/19ElementalTechnologiesConfidentialandProprietary20/169Theusercanconfigureanotificationemailaddressorwebcallbackforsystemalerts,aswellasadjustthethresholdforwhenthesealertsaregenerated.
AlertswillalsotriggeranSNMPTrapifatrapdestinationisconfiguredintheSNMPSettingspage.
AlertscanalsobegeneratedforanindividualLiveEvent,suchas:RealtimeAlert-TheLiveEventisrunningbelowrealtimeNetworkInputAlert-TheLiveEventisnotreceivingdataonitsnetworkinputportRTPInputAlert-TheLiveEventlostsyncwithRTPheadersVideoInputAlert-TheLiveEventisnotreceivingvideodatatodecodeAudioInputAlert-TheLiveEventisnotreceivingaudiodatatodecodeOutputAlert-Thesystemcannotsendoutputtothespecifiedendpoint,orhasinsufficientoutgoingthroughputHD-SDIInputAlert-TheLiveEventisnotreceivingHD-SDIinputOutputLockAlert-TheLiveEventfailedtolockoutputstoexternalencoderNotificationsettingsforLiveEventalertscanbesetonthe'NewLiveEvent'pagebycheckingthe"Alert"and"Clear"boxesintheNotificationsection.
ThesesettingscanbeadjustedontheAlertspagewhiletheLiveEventisrunning;however,thosechangeswillnotpersistwhentheLiveEventisreset.
USINGTHESETTINGSPAGEThesettingspageprovidesaccesstoavarietyofconfigurationoptionsforElementalLive.
GENERALSETTINGSTheGeneralSettingspageallowsforselectingthetimezonefortheElementalLivesystem,andalsoprovidesanoptionfordisablingthebrowserwarningthatappearsonunsupportedbrowsers.
ElementalsuggestssettingthetimezonebeforecreatinganyLiveEventsorSchedules.
IfthetimezoneisupdatedElementalsuggestsrestartingtheserviceontheElementalLivenode,andrecreatinganySchedules.
Notethatdisablingthebrowserwarningonlyaffectsthecurrentbrowsingsession.
Therearealsooptionsformanagingthecluster-widebackgroundtasksthatauto-archiveandauto-deleteLiveEventsanddeleteoldthumbnailimagesoffeachnode.
Auto-archivewillremovecompletedLiveEventsfromthedisplayedLiveEventslist.
Auto-deletepermanentlyremovesLiveEventsfromthesystem.
Settingthesevaluesto"0"willdisablethisfunctionality.
Periodic,automaticbackupsofthemanagementdatabasecanalsobeconfiguredfromhere.
Theavailablesettingsaretheintervalbetweenperformingthebackups,howmanydatabasebackupstokeep,andthelocationondisktostorethebackups.
Enteringabackupintervalofevery"0"minutes,disablestheautomaticbackups.
Torestoreanautomaticbackupfilecalledelemental-db-backup_Live_2.
16.
3.
0_2014-09-11_05-13-04.
tar,inthebackuplocation/home/elemental/database_backups:ElementalLiveAPIandUserGuideWebInterfaceQuickStartGuide09/04/19ElementalTechnologiesConfidentialandProprietary21/169$cd/opt/elemental_se/$sudo.
/configure--restore-db-backup/home/elemental/database_backups/elemental-db-backup_Live_2.
16.
3.
0Additionally,settingsfortheGlobalAlertNotificationarelocatedonthispage.
TheGlobalAlertNotificationisasetofdefaultnotificationsettingsthatwillbeappliedtoanynewalertthatiscreatedontheElementalsystem.
NETWORKSETTINGSTheNetworkSettingspageisdividedintofoursections,eachaccessibleviaasub-tabonthelefthandside.
Pleaseallowafewminutesfornewsettingstobeappliedtothesystem.
Inordertocommitmostchanges,the"Save"buttonmustbepressed.
Restoringdefaultswilloccurimmediately.
CURRENTSETTINGSTheCurrentSettingssub-tabwilldisplayallinformationaboutthecurrentnetworkinareadonlyformat.
Thisincludeshostname,DNSServers,NTPServers,IPaddress,netmask,andgatewayforeachethernetdevice,andanoutputoftheroutingtable.
HOSTNAME,DNS,&NTPTheHostname,DNS&NTPsub-taballowsthechangingofthehostname,theDNSnameservers,andtheNTPservers.
NotethatitisnotpossibletoeditthenameofanexistingDNSnameserverorNTPserver.
Theoldnamemustbedeletedandanewnameadded.
NTPserversmaybespecifiedbynameorIPaddress.
DNSserversmustbespecifiedbyIPaddressonly.
NETWORKDEVICESTheNetworkDevicessub-taballowsforlimitededitingofnetworkdevices.
Advancedpropertiessuchasbondsofmultiplephysicalports,oraVirtualLocalAreaNetwork(VLAN)devicesarebeyondthescopeofthisuserinterface.
Ifyouneedhelpsettinguponeofthesetypesofnetworkdevice,pleaseconsulttheappropriateKnowledgeBaseArticle.
The"Edit"buttonnexttoeachNetworkDevicewillbringupthe"EditaNetworkDevice"dialogboxwithseveralavailableoptions:AddressMode-DHCPautomaticallyassignsIPAddress,Netmask,andGateway.
Staticallowsforspecificconfiguration.
Noneisalsovalidforeth.
StaticRoutes-Ifchecked,atableallowingcreationofstaticroutesusingthisnetworkdevicebewillexposed.
RESTOREDEFAULTSThe"RestoreDefaults"buttonwillreplaceanynetworkdeviceswiththesystemdefault.
MOUNTPOINTSETTINGSTheMountPointSettingspageprovidesstatusinformationonactivemountpointsandprovidestheabilitytoaddnewCIFS,NFS,orDAVFSmountpointstotheElementalLivesystem.
Mountpointsarelimitedtothe/data/mntdirectory.
Pleaseallowafewminutesforthesettingstobeappliedtothesystem.
FIREWALLSETTINGSTheFirewallSettingspageprovidesaccesstotheoverallstateofthefirewall,andallowsfortheadditionofnewopenTCPorUDPports.
Whenthefirewallison,youwillseealistofalltheopenincomingportsthataremanagedbyElementalLive.
Thereisacheckboxavailabletomarkanyopenincomingportsfordeletion,andthereisafieldbelowtoaddanewincomingTCPorUDPport.
Incomingportsmustbeaddedoneatatime.
Pleaseallowafewminutesforthesettingstobeappliedtothesystem.
SNMPSETTINGSTheSNMPSettingspageprovidesaccesstothesettingsthatalloworrestrictSNMPaccess.
ThereisanoptiontoturnonSNMPtrapsforalertsandtosettheportnumberthatthemangerreceivesthetrapson.
PleaseseeSNMPInterfaceformoreinformation.
Pleaseallowafewminutesforthesettingstobeappliedtothesystem.
ElementalLiveAPIandUserGuideWebInterfaceQuickStartGuide09/04/19ElementalTechnologiesConfidentialandProprietary22/169AUTHENTICATIONSETTINGSTheAuthenticationSettingspageprovidesaccesstothesettingsthataffecttheauthenticationprocess.
Authenticationcanonlybeenabledviatheconfigurescript.
Onceauthenticationisenabled,theauthenticationsettingspagecontrolsthenumberoffailedloginattemptsallowedandthelengthoftimetobanauserafterafailedloginattempt,thesessioninactivitytimeout,andwhethertoenablepasswordexpiration.
SeetheAuthenticationpageformoreinformation.
ROUTERSETTINGSTheRouterspageallowsfortheconfigurationofSDIinputrouters.
First,click"NewRouter"tosetupanewrouter.
Thenfilloutsettingsfortherouter'sname,IPaddress,numberofinputsandoutputs,androutertype.
HarrisPanacearouterscanshareanIPaddress,butrequireauniquelevelID.
Next,click"Apply"tocustomizenamingfortheinputs,andidentifythedevicesconnectedtotherouter.
Click"Create"tosavetherouter.
INPUTDEVICESTheInputDevicespagedisplaysdevicescurrentlyavailabletothesystem,andprovidestheabilitytocustomizethedevicenamesastheyareviewedwithinthesystem.
ADVANCEDSETTINGSTheAdvancedSettingspageprovidesaccesstosettingsforfine-tuningthevideotranscodingsequencer.
TheCPULoadFactorcontrolsthenumberofavailableCPUthreads.
Thisvaluescalesbydefaultwiththenumberofcoresandtheirclockrates.
Pleaseallowafewminutesforthesettingstobeappliedtothesystem.
Defaultsettingscanberestoredbyclickingthe"RestoreDefaults"buttonatthetopofthepage.
Thiswilldisplaythedefaultadvancedsettings.
Adjustmentsmaythenbemadetothedefaultsettings.
Inordertocommitthesechanges,the"Save"buttonmustbepressed.
ElementalLiveAPIandUserGuideWebInterfaceQuickStartGuide09/04/19ElementalTechnologiesConfidentialandProprietary23/169WEBSERVICESRESTINTERFACETheElementalLivesystemcanbecontrolledthroughaRESTinterfaceoverHTTP.
AclientprograminteractswiththeserverbysendingHTTPGET,POST,PUT,orDELETErequeststoresourcesontheserverorservercluster.
AwiderangeofavailableendpointsprovideasimpleinterfacetocontrolandqueryallaspectsoftheElementalsystem.
ExplorefeaturesoftheRESTAPIbelow.
RESTBasicsHTTPHeadersAPIVersionsSimpleExamplesCleanXMLSchemaDefinitionsErrorsandWarningsLiveEventsExampleXML:CreateaLiveEventfromaLiveEventProfileExampleXML:CreateasimpleLiveEventwithoneAdobeRTMPoutputExampleXML:CreateamoreadvancedLiveEventwith3streamsusingpresetsExampleXML:UsingaLiveEventProfiletocreateanewLiveEventwithadvancedoverridesLiveEventProfilesSchedulesPresetsPresetCategoriesMPTSMultiplexersSettingsAlertsandMessagesDevicesSystemStatusRoutersErrorCodesWarningCodesAuditMessageCodesQueryParametersAuthenticationandRESTRESTBASICSRepresentationalstatetransfer(REST)isastyleofsoftwarearchitecturefordistributedsystemssuchastheWorldWideWeb.
HTTPHEADERSAllrequestsmustincludetheHTTP"Accept"headertospecifythemediatypeoftheserver'sresponse.
ResponsescanbeHTML(Accept:text/html)orXML(Accept:application/xml).
Requeststhatincludeadatapayload(POSTandPUT),mustalsoincludetheHTTP"Content-Type"headertospecifythemediatypeofthedata;ElementalsupportsonlyXML(Content-Type:application/xml).
Additionalheadersarerequiredwhenauthenticationisenabledontheserver.
ElementalLiveAPIandUserGuideWebServicesRESTinterface09/04/19ElementalTechnologiesConfidentialandProprietary24/169APIVERSIONSWhensubmittingRESTrequestsmanuallyorfromwithinanautomationsystem,itisrecommendedtouseanAPIversionprefixforallendpoints.
TheAPIversionprefixallowsyoutospecifywhichAPIversiontheservershouldusetointerpretyourdata.
Forexample,POSThttp:///api/v2.
16.
3.
0/live_eventswillsendarequesttothe/live_eventsendpoint,andtheserverwillinterpretthedataascompatiblewithElementalAPIversion2.
16.
3.
0.
AlthoughitisrecommendedthattheAPIversionprefixisincludedinallRESTendpoints,omittingtheprefixwillassumethemostcurrentup-to-dateAPIversion:POSThttp:///api/live_events.
ResponsesfromtheserverwillalwaysbeformedaccordingtothecurrentAPIversion.
SIMPLEEXAMPLESInallthefollowingexamples,replaceserver_ipwiththeIPaddressorDNSnameofyourElementalserver.
TorequestalistofLiveEventsfromtheserver,youcanusecURLorasimilarutility:curl-H"Accept:application/xml"http:///api/live_eventsResponse:1HD-SDIAutoAJA022010-01-2602:07:08UTCcomplete.
.
.
AddingorupdatingresourcesisaccomplishedbyissuinganHTTPPOSTorPUTcommandwiththebodycontainingXMLdescribingtheresource.
TheclientapplicationmustsettheHTTP"Content-Type"headerto:Content-Type:application/xml.
Forexample,tocreateabasicpresetforastreamwithH.
264videoandAACaudio:curl-H"Accept:application/xml"-H"Content-type:application/xml"\-d@filenamehttp:///api/v2.
16.
3.
0/presetswherethefileindicatedbyfilenamecontainsExamplePreset1280720H.
2643000000ElementalLiveAPIandUserGuideWebServicesRESTinterface09/04/19ElementalTechnologiesConfidentialandProprietary25/169AAC128000returnsExamplePresetfalse7201301280h.
264off3000000falsetrue1280mediumtrue1true0MainCBRprogressive126aac128000244100LCCBRElementalLiveAPIandUserGuideWebServicesRESTinterface09/04/19ElementalTechnologiesConfidentialandProprietary26/169Thexmlcontainedinthefilecanalsobeenteredinlineafterthe-doption.
CLEANXMLTheXMLthatisreturnedbytheserverfromaGETrequestisnotinthecorrectformatforcreatingnewobjects.
TheGETXMLcontainstagstouniquelyspecifytheobjectandanysub-objects,anditmayalsocontainstatusinformationthatwillnotbeacceptedbytheserverinaPOSTcommand.
BeingabletoquerytheserverforXMLthatisinavalidformatforPOSTingtocreatenewobjectsisveryuseful--itcanbeusedtoduplicateLiveEvents,ortoslightlymodifyLiveEvents,LiveEventProfiles,orPresets.
Therefore,theElementalLiveRESTinterfaceoffersawaytoget'clean'XMLthatisacceptableforcreatingnewobjects.
Asanexample,thefollowingcommandgetsthecleanXMLforLiveEvent1.
SimplymaketheregularGETrequestandaddanextraparameterclean=trueattheend.
curl-H"Accept:application/xml"http:///api/live_events/1clean=trueThisXMLcanbesavedtoafileandthenPOSTedbacktothesameserveroranotherservertocreateanidenticalLiveEvent,orthefilemaybeeditedtomakeanynecessaryadjustments.
ThecleanxmlforaLiveEventcanalsobedownloadeddirectlyfromthewebinterface--fromtheLiveEventControlpage,click'LiveEventXML'.
SCHEMADEFINITIONSElementalproductsshipwithXMLschemadefinitions(XSDs)forthemostcommonassetcreationrequests.
Thesemaybefoundinthe/schemapathasfollows:/schema/LiveEvent.
xsd-liveeventcreationschema/schema/LiveEventProfile.
xsd-liveeventprofilecreationschema/schema/LivePreset.
xsd-presetcreationschema(Right/command-click>>SaveAstodownloadfiles.
)ERRORSANDWARNINGSValidationerrorswhensubmittinganobjectarereturnedintheresponseXML.
curl-H"Accept:application/xml"-H"Content-type:application/xml"\-d""http:///api/v2.
16.
3.
0/presetsreturnsVideodescriptioncan'tbeblankAudiodescriptioncan'tbeblankNamecan'tbeblankErrors,warnings,andauditmessagesforLiveEventsareindicatedbythestatus,error,warning,andauditmessagefieldsreturnedintheLiveEvent'sstatusmessage.
Messagesincludeacodeandamessage.
Forexample:curl-H"Accept:application/xml"http:///api/live_events/58/statusonasystemwhereLiveEvent58hassomeerrorsreturnssomethinglike2010-02-2213:46:34-0700error16ElementalLiveAPIandUserGuideWebServicesRESTinterface09/04/19ElementalTechnologiesConfidentialandProprietary27/16953.
42010-02-2213:46:34-070083519992010-02-2214:00:29-0700EMEtimeoutdetectedAuditmessagesprovidetheuserwithadditionalinformationabouttheexecutionoftheLiveEvent.
LIVEEVENTSThefollowingtabledescribestheRESTLiveEventcontrolinterface.
URLMETHODPARAMETERSRETURNSDESCRIPTION/live_eventsGETPaginationparameters,FilterparametersLiveEventListDescriptionRetrievesalistofLiveEventsinthesystem/live_eventsPOSTLiveEventParametersLiveEventDescriptionCreatesanewLiveEvent/live_events/GETLiveEventDescriptionRetrievesaspecificLiveEventinthesystem/live_events/PUTLiveEventParametersLiveEventDescriptionUpdatesanexistingLiveEventwithnewsettings.
AppendwiththeURLquery-paramunlocked=1tostopandrestartarunningevent.
/live_events/unlocked=1&active_input_id=PUTLiveEventParametersLiveEventDetailsStopstheeventandrestartsitwiththenewsettings(specifiedintheLiveEventParameters)andstartingattheinputidentifiedbythespecifiedinputID.
TheinputIDmustbepartoftheoriginaleventdefinition;itcannotidentifyaninputthatwasaddedusingthe/live_events//playlistendpoint.
/live_events/unlocked=1&active_input_label=PUTLiveEventParametersLiveEventDetailsStopstheeventandrestartsitwiththenewsettings(specifiedintheLiveEventParameters)andstartingattheinputidentifiedbythespecifiedinputlabel.
Theinputlabelmustbepartoftheoriginaleventdefinition;itcannotidentifyaninputthatwasaddedusingthe/live_events//playlistendpoint.
/live_events/DELETEPermanentlydeletesaLiveEvent/live_events//statusGETLiveEventStatusRetrievesasummaryofLiveEvent'sstatus,withoutdetailedencodingparameters/live_events//priorityGETLiveEventPriorityRetrievesLiveEvent'spriority/live_events//priorityPOSTvalueLiveEventPrioritySetsLiveEvent'spriority/live_events//startPOSTLiveEventDetailsStartsencodingLiveEvent/live_events//startactive_input_id=POSTLiveEventDetailsStartstheeventatthespecifiedinputID.
TheinputIDmustbepartoftheoriginaleventdefinition;itcannotidentifyaninputthatwasaddedusingthe/live_events//playlistendpoint.
ElementalLiveAPIandUserGuideWebServicesRESTinterface09/04/19ElementalTechnologiesConfidentialandProprietary28/169URLMETHODPARAMETERSRETURNSDESCRIPTION/live_events//startactive_input_label=POSTLiveEventDetailsStartstheeventattheinputidentifiedbyspecifiedinputlabel.
Theinputlabelmustbepartoftheoriginaleventdefinition;itcannotidentifyaninputthatwasaddedusingthe/live_events//playlistendpoint.
/live_events//stopPOSTLiveEventDetailsStopsencodingLiveEvent/live_events//cancelPOSTLiveEventDetailsCancelspendingLiveEvent/live_events//archivePOSTLiveEventDescriptionMarksaLiveEventasArchived.
LiveEventwillnolongerappearinmain/live_eventslist.
/live_events//resetPOSTLiveEventDetailsResetsLiveEventbacktothePendingstate.
Toavoidaccidentallyoverwritingarchiveoutputsafterareset,useatimestamp$d$inthedestination.
/live_events//mute_audioPOSTMutestheaudioofLiveEvent.
Setsaudiogainto-60.
/live_events//unmute_audioPOSTUnmutestheaudioofLiveEvent.
Setsaudiogainto0.
/live_events//adjust_audio_gainPOSTvalueSetstheaudiogainforLiveEventtovalue.
/live_events//rollover_outputPOSToutputidOutputmustbeanArchiveoutputthatiscurrentlyrunning.
InstructsOutputtorollover.
/live_events//pause_outputPOSToutputidOutputmustbeanoutputthatiscurrentlyrunning.
InstructsOutputtopause.
/live_events//unpause_outputPOSToutputidOutputmustbeanoutputthatiscurrentlypaused.
InstructsOutputtoresume.
/live_events//stop_outputPOSToutputidOutputmustbeanoutputthatiscurrentlyrunning.
InstructsOutputtostop.
/live_events//start_outputPOSToutputidOutputmustbeanoutputthatiscurrentlystopped.
InstructsOutputtostart.
/live_events//pause_output_groupPOSToutputgroupidor_name_OutputGroup(orgroup_name)mustbeagroupthatiscurrentlyrunning.
InstructsOutputGrouptopause.
/live_events//unpause_output_groupPOSToutputgroupidor_name_OutputGroup(orgroup_name)mustbeagroupthatiscurrentlypaused.
InstructsOutputGrouptoresume.
/live_events//stop_output_groupPOSToutputgroupidor_name_OutputGroup(orgroup_name)mustbeagroupthatiscurrentlyrunning.
InstructsOutputGrouptostop.
/live_events//start_output_groupPOSToutputgroupidor_name_OutputGroup(orgroup_name)mustbeagroupthatiscurrentlystoppedorpaused.
InstructsOutputGrouptostart.
/live_events//stream_metadataPOSTArbitraryStreamMetadata:anycontentinsidetheXMLfileSendsthebodyofthePOSTrequesttoallAdobeRTMPoutputsasmetadata(viaonUserDataEvent).
TheproperContent-typeheadermustbeusedforthebodycontent.
ElementalLiveAPIandUserGuideWebServicesRESTinterface09/04/19ElementalTechnologiesConfidentialandProprietary29/169URLMETHODPARAMETERSRETURNSDESCRIPTION/live_events//amf_metadataPOSTAMFMetadataSendsthebodyofthePOSTrequesttoallAdobeRTMPoutputsasAMFmetadataviaonCuePoint.
/live_events//update_timingPOSTTimingParametersTimingparametersAdjuststhetimingparametersofacurrentlyrunningLiveEvent.
ThisallowstheusertocontractorextendtheendtimeofascheduledLiveEvent.
/live_events//cue_pointPOSTCuePointParametersInsertionInformationManuallyeditsanSCTE-35cuepointinthestream.
Timegiveniseithersystemtimeorpreroll.
Outputsthathavescte35_passthroughenabledwilloutputthiscuepoint.
NotethatanSDIsourceusingtheEmbeddedtimecodesourcemusthaveembeddedtimecodesforthisfeaturetowork.
/live_events//time_signalPOSTTimeSignalParametersInsertionInformationManuallyeditsanSCTE-67timesignalinthestream.
Timeisgiveninsystemtime.
Outputsthathavescte35_passthroughenabledwilloutputthistimesignal.
NotethatanSDIsourceusingtheEmbeddedtimecodesourcemusthaveembeddedtimecodesforthisfeaturetowork.
/live_events//image_inserterPOSTImageInserterforRESTParametersImageInserterRESTparametersInsertsandremovesimagesintoimageinserterobjectsthathaveRESTcommandsenabled/live_events//motion_image_inserterPOSTMotionImageInserterforRESTParametersMotionImageInserterRESTparametersUpdatesimagesonthemotionimageinserterthatisRESTenabled/live_events//activate_inputPOSTi_idORuniquenameforinputORspecifyanactivationtime(inutc)i_id20151231T235959.
999SwitchesthecurrentlyrunningLiveEventtoInput,immediatelyoratthespecifiedtime.
FormatoftheUTCtimeisexpressedisYYYYMMDDThhmmss.
[frac_second],forexample20151231T235959.
999.
/live_events//prepare_inputPOSTRequired:specifytheinputasi_idORuniquenameforinputOptional:specifythetimefortheinputpreparationtobegin20151231T23595959.
999.
Theinputispreparedimmediatelywhennotpresent.
Optional:specifytheinputshouldbeperpetuallypreparedoritshouldonlylastuntiltheinputbecomesactive.
Specifyviatrueorfalse.
Thedefaultsettingisfalse.
Optional:specifyapreparation_indexof0or1(defaultsto0whennotpresent)0Ifoptionalfieldsareprovided,theentirepayloadmustbesurroundedbytags,i.
e.
i_id1234556789.
PreparesthecurrentlyrunningLiveEventforswitchingtoInputeitherimmediatelyoratthespecifiedtime.
FormatoftheUTCtimeisexpressedisYYYYMMDDThhmmss.
[frac_second],forexample20151231T235959.
999.
Theoptionalpreparation_indexcanbe0or1allowinguptotwoinputstobepreparedsimultaneously.
Whenissettotruethespecifiedinputwillcontinuetobeprepareduntilthepreparation_indexitwaspreparedwithisreusedinasubsequentprepare_inputcommandwitheitheranothervalidinputID,orthespecialvalueof0xffffffffwhichcancelspreparation.
Whenissettofalsethespecifiedinputwillcontinuetobeprepareduntilthepreparation_indexitwaspreparedwithisreusedinasubsequentprepare_inputcommandwitheitheranothervalidinputID,orthespecialvalueof0xffffffffwhichcancelspreparation,orthespecifiedinputbecomesactive.
/live_events//playlistPOST.
.
.
Thisendpointcausesallnon-activeinputstoberemovedfromtherunningevent.
Thenewinputsdefinedinthepayloadwillbeappendedafterthecurrentlyrunninginput.
ElementalLiveAPIandUserGuideWebServicesRESTinterface09/04/19ElementalTechnologiesConfidentialandProprietary30/169URLMETHODPARAMETERSRETURNSDESCRIPTION/live_events//inputsGETListofallinputsontheeventRetrievelistofinputsontheevent.
/live_events//inputs/GETInputIDSpecifiedinputdetailsRetrievefullinputinformationforthespecifiedinput_idonthespecifiedLiveEvent.
/live_events//inputsPOSTInputtagInput_idifsuccessAddaninputtoarunningevent.
Maxinputsis30.
InputtagcanbecopiedfromanexistingvalidLiveeventXML.
/live_events//inputs/PUTInputtagModifyaninputtoarunningevent.
Anactiveinputcantbemodified.
input_idcanbeobtainedfromtheInputControlspanelofarunningevent.
/live_events//inputs/DELETEDeleteaninputtoarunningevent.
Anactiveinputcantbedeleted.
/live_events//inputs/by_label/PUTInputtagModifyaninputtoarunningevent.
Anactiveinputcantbemodified.
input_labelcanbeobtainedfromtheInputControlspanelofarunningevent.
/live_events//inputs/by_label/DELETEDeleteaninputtoarunningevent.
Anactiveinputcantbedeleted.
/live_events//outputsGETListofalloutputsontheeventRetrievelistofalloutputsontheevent.
/live_events//reset_video_buffer_statsPOSTResetstheinputvideobuffersummarystatisticswhileaLiveEventisrunning.
/live_events//timed_metadataPOSTTimedMetadataParametersInsertstimedmetadata(ID3tags)intoAppleHLSorMPEGTransportstreamoutputswithinsert_timed_metadataenabled.
/live_events//private_metadataPOSTPrivateMetadataParametersInsertsprivatemetadataencodedinAMFintoMPEGTransportstreamswithinsert_private_metadataenabled.
/live_events//bulk_metadataPOSTTimedMetadataParametersPrivateMetadataParametersInsertsoneormoretimedmetadataandprivatemetadataitemsatthesametime.
/live_events//avail_imagePOSTAdAvailImageParametersReplacestheconfiguredadavailblankingimage/live_events//blackout_imagePOSTBlackoutImageParametersReplacestheconfiguredblackoutimageinsertionimage.
/live_events//cut_listsGETLiveEventCutListsRetrievesalistofLiveEvent'scutlists.
Cutlistsaregeneratedforeachoutputwhere"LogEditPoints"istrue.
/live_events//cut_lists/GETLiveEventOutputCutListRetrievesthecutlistXMLforOutputinLiveEvent.
canberetrievedbyusingtheaboveendpointtogetalistofallcutlistsforLiveEvent.
EXAMPLEXML:CREATEALIVEEVENTFROMALIVEEVENTPROFILEWhenspecifyingaprofile,theid,nameorpermalinkmaybegiven.
Thesystemwillsearchfirstforaprofileid,thennameandfinallypermalinkuntilitfindsamatch.
Ifnomatchisfound,anerrorwillbereturnedandtheLiveEventwillnotbecreated.
1HD-SDIElementalLiveAPIandUserGuideWebServicesRESTinterface09/04/19ElementalTechnologiesConfidentialandProprietary31/169Auto11EXAMPLEXML:CREATEASIMPLELIVEEVENTWITHONEADOBERTMPOUTPUT1HD-SDI1080i59941stream11480640h.
264medium1000000true1001false300001290mediumtrue0MainCBRprogressiveAdaptiveaac64000244100HIGH3LCCBRElementalLiveAPIandUserGuideWebServicesRESTinterface09/04/19ElementalTechnologiesConfidentialandProprietary32/169rtmp_group_settingsNonestream1rtmp2Stream1rtmp://flashmediaserver/liveNotethatstream_assemblysectionshaveaelementthatisusedlaterinthesectiontospecifyanoutputforagivenstream.
OncetheLiveEventissubmitted,thesystemassignsanelementtothetocreateapermanentreference,andtheelementisnolongerused.
EXAMPLEXML:CREATEAMOREADVANCEDLIVEEVENTUSINGPRESETS1HD-SDI720p59941stream11stream22stream33stream48archive_group_settings/data/server/archiveElementalLiveAPIandUserGuideWebServicesRESTinterface09/04/19ElementalTechnologiesConfidentialandProprietary33/169mp4_3mbitstream4mp4apple_live_group_settingstrue102010false/data/server/apple/livem3u8_1450000stream1m3u8m3u8_800000stream2m3u8m3u8_450000stream3m3u8EXAMPLEXML:USINGALIVEEVENTPROFILETOCREATEANEWLIVEEVENTWITHADVANCEDOVERRIDESWhencreatinganewLiveEventusinganexistingLiveEventProfile,itissometimesnecessarytooverridespecificsettingsdeepwithintheLiveEventProfiletosuittheparticularneedsofyourLiveEvent.
SomecommonexamplesofthisaretooverridetheDRMsettingswithinanMSSmoothGroup,ortoupdateindividualsettingsinastreamvideodescription.
Thiscanbeaccomplishedusingasimpleworkflow.
First,retrievethe'clean'XMLfortheLiveEventProfileyouwanttouse.
ThiscanbedoneviaaRESTrequest,orusingthewebinterface.
Second,theXMLmustbemodifiedtotransformitintoavalidLiveEventXML.
AnyspecificfieldswithintheXMLcanthenbeoverridden.
Finally,submitthemodifiedXMLviaRESTorthewebinterfacetocreateyournewLiveEvent.
Considerthefollowingexampleofthisworkflowforasimplecase.
Tobegin,let'sassumeyouhaveaLiveEventProfilethatisconfiguredwithasingleMSSmoothoutputwithPlayreadyDRMenabled.
WhenyouretrieveitsXMLviatheRESTinterface,youobtainanXMLthatlooksliketheexamplebelow:BasicMSSmoothbasic_ms_smoothOneMSSmoothoutputwithDRMfalseembedded50ElementalLiveAPIandUserGuideWebServicesRESTinterface09/04/19ElementalTechnologiesConfidentialandProprietary34/169false060stream_assembly_0NonetruetruefalsetrueNone50falsefalsefalsemedium5000000truetruefalsetruefalse1false290.
0framesfalsemedium01true1falsefalsetruefalse0falsetrue0NonetrueMainCBRprogressiveElementalLiveAPIandUserGuideWebServicesRESTinterface09/04/19ElementalTechnologiesConfidentialandProprietary35/169h.
2641audio_164000244100wma212ee939e0d-52ff-4b04-b01a-22e2e51674c6playreadyAES-128-CTR300false2164ee939e0d-52ff-4b04-b01a-22e2e51674c6http://my_playready_license_server.
com10true0truetrue2011-01-01truehttp://my_playready_ui_license_server.
comtruehttp://different_publishing_server/endpointms_smooth_group_settingsismvfalse_basic_ms_smooth1falseismvstream_assembly_0ElementalLiveAPIandUserGuideWebServicesRESTinterface09/04/19ElementalTechnologiesConfidentialandProprietary36/169TotransformthisLiveEventProfileXMLintoavalidLiveEventXMLseveralitemsmustbemodified.
First,theroottagofthexmlmustbechangedfromlive_event_profiletolive_event.
Next,thepermalinkanddescriptiontagsshouldberemoved.
ThenametagmayalsobechangedtosuityournewLiveEvent.
Finally,youmustaddatleastoneinputtoyourLiveEvent.
Followingtheabovebasicsteps,theXMLisnowvalidtocreateanewLiveEvent.
AtthispointyoumayalsoupdateanyofthefieldsintheXMLtosuitthespecificneedsofyourLiveEvent.
Inthisexamplewewillupdatethecontent_key,key_id,andpublish_pointURIfieldswithintheMSSmoothGroupsettings,andthebitratewithinthevideocodecsettings.
AfterweupdatetheXMLitshouldlooklikethefollowingexample.
Thefewplacesthatrequiredmodificationinthiscasearehighlighted:BasicMSSmoothudp://my_video_server:5001falseembedded50false060stream_assembly_0NonetruetruefalsetrueNone50falsefalsefalsemedium5000000truetruefalsetruefalse1false290.
0framesfalsemediumElementalLiveAPIandUserGuideWebServicesRESTinterface09/04/19ElementalTechnologiesConfidentialandProprietary37/16901true1falsefalsetruefalse0falsetrue0NonetrueMainCBRprogressiveh.
2641audio_164000244100wma212ee939e0d-52ff-4b04-b01a-22e2e51674c7playreadyAES-128-CTR300false2164ee939e0d-52ff-4b04-b01a-22e2e51674c7http://my_playready_license_server.
com10true0truetrue2011-01-01ElementalLiveAPIandUserGuideWebServicesRESTinterface09/04/19ElementalTechnologiesConfidentialandProprietary38/169truehttp://my_playready_ui_license_server.
comtruehttp://different_publishing_server/endpointms_smooth_group_settingsismvfalse_basic_ms_smooth1falseismvstream_assembly_0ThismodifiedXMLcannowbesubmittedviaeitherRESTorthewebinterfacetocreateyournewLiveEventwithyourspecificupdatedsettings.
LIVEEVENTPROFILESLiveEventProfilescanbeusedforcommonlyusedLiveEventsettings.
ThepermalinkofaLiveEventProfilemaybesubstitutedforitsid.
URLMETHODPARAMETERSRETURNSDESCRIPTION/live_event_profilesGETPaginationparametersLiveEventProfileListRetrievesalistofLiveEventProfilesinthesystem/live_event_profilesPOSTLiveProfileParametersLiveEventProfileDescriptionCreatesanewLiveEventProfile/live_event_profiles/GETLiveEventProfileDescriptionRetrievesaspecificLiveEventProfileinthesystem/live_event_profiles/PUTLiveProfileParametersLiveEventProfileDescriptionUpdatesanexistingLiveEventProfilewithnewsettings/live_event_profiles/DELETEDeletesLiveEventProfileSCHEDULESSchedulescanbecreatedtoruncertainLiveEventProfilesatscheduledtimes,orasetofrepeatingtimes.
URLMETHODPARAMETERSRETURNSDESCRIPTION/schedulesGETPaginationparametersScheduleListRetrievesalistofSchedulesinthesystem/schedulesPOSTScheduleParametersScheduleDescriptionCreatesanewSchedule/schedules/GETScheduleDescriptionRetrievesaspecificScheduleinthesystem/schedules/PUTScheduleParametersScheduleDescriptionUpdatesanexistingschedulewithnewsettings/schedules/DELETEDeletesscheduleElementalLiveAPIandUserGuideWebServicesRESTinterface09/04/19ElementalTechnologiesConfidentialandProprietary39/169PRESETSPresetsdefinecommonlyusedsettingsforoutputsandstreamassemblies.
Thepermalinkofapresetmaybesubstitutedforitsid.
URLMETHODPARAMETERSRETURNSDESCRIPTION/presetsGETPaginationparametersPresetListRetrievesalistofPresetsinthesystem/presetsPOSTPresetParametersPresetDescriptionCreatesanewPreset/presets/GETPresetDescriptionRetrievesaspecificPresetinthesystem/presets/PUTPresetParametersPresetDescriptionUpdatesanexistingPresetwithnewsettings/presets/DELETEDeletesPresetPRESETCATEGORIESPresetCategoriesallowforthesortingofPresets.
URLMETHODPARAMETERSRETURNSDESCRIPTION/preset_categoriesGETPaginationparametersPresetCategoryListRetrievesalistofPresetCategories,anddisplaysthelistofPresetsassociatedwitheachcategory.
/preset_categoriesPOSTPresetCategoryParametersPresetCategoryDescriptionCreatesanewPresetCategory/preset_categories/GETPresetCategoryDescriptionRetrievesaspecificPresetCategoryanddisplaysitslistofPresets/preset_categories/PUTPresetCategoryParametersPresetCategoryDescriptionUpdatesanexistingPresetCategorywithnewsettings/preset_categories/DELETEDeletesPresetCategoryMPTSMULTIPLEXERSTheMPTSAPIallowstheusertostartandstopanMPTS.
URLMETHODPARAMETERSRETURNSDESCRIPTION/mptsGETListofMPTSXMLGetXMLforeveryMPTS/mpts/GETMPTSXMLGetXMLforasingleMPTS/mptsPOSTMPTSParametersMPTSXMLofnewly-createdMPTS,orerrorsCreateanewMPTS/mpts/PUTMPTSParametersMPTSXMLofupdatedMPTS,orerrorsUpdateanexistingMPTS/mpts/DELETESuccessfulresponse,orerrorsDeleteanexistingMPTS/mpts//muxPOSTSuccessfulresponse,orerrorsStartanMPTS/mpts//muxDELETESuccessfulresponse,orerrorsStopanMPTS/mpts/statusesGETMPTSstatusesGetthestatusofeveryMPTS/mpts//statusGETMPTSstatusGetthestatusofsingleMPTS/mpts//statsGETMPTSbitratestatsGetbitrateinformationforanMPTS/mpts//mpts_membersGETListofMPTSMemberXMLGetallmemberchannelsofanMPTS/mpts//mpts_members/:idGETMPTSMemberXMLGetasinglememberchannelofanMPTSElementalLiveAPIandUserGuideWebServicesRESTinterface09/04/19ElementalTechnologiesConfidentialandProprietary40/169URLMETHODPARAMETERSRETURNSDESCRIPTION/mpts//mpts_membersPOSTMPTSMemberParametersMPTSMemberXMLofnewly-createdchannel,orerrorsAddanewchannelmembertoanMPTS/mpts//mpts_members/PUTMPTSMemberParametersMPTSMemberXMLofupdatedchannel,orerrorsUpdateanexistingchannelmemberofanMPTS/mpts//mpts_members/DELETESuccessfulresponse,orerrorsRemoveanexistingchannelmemberofanMPTSEXAMPLEXML:CREATEANMPTS3200000030000000SimpleMPTSfromXMLfalse1001000udp://localhost:5555udp://localhost:5556SETTINGSSettingsprovidesinformationonoverallsystemsettings.
TheRESTinterfacecanonlyqueryinformationaboutthesettings.
AnysettingsupdatesmustbemadeviatheUI.
URLMETHODRETURNSDESCRIPTION/settingsGETTimezone,NetworkSettings,FirewallSettings,MountPointSettings,AuthenticationSettings,SequencerSettings,(ClusterSettingsifpartofacluster)Retrievesinformationaboutthecurrentsystemsettings.
ThisXMLisinaformatthatisacceptedbytheconfigurescript(-i).
Thiscanbeusedtoconfiguremanyidenticalboxes.
/settingscluster=trueGETTimezone,NetworkSettings,FirewallSettings,MountPointSettings,AuthenticationSettings,SequencerSettings,ClusterSettingsRetrievesinformationaboutthecurrentsystemsettingsincludingexampleclustersettingsconfiguredsuchthatthecurrentserveristhemasternode.
ThiscanbeusedtohelpconfigureSlavenodesaftertheMasternodehasbeenconfigured.
/settings/networkGETNetworkSettingsRetrievesinformationaboutthecurrentnetworksettings.
OtherElementalServerunitscancommunicateontheinterfacemarkedinaclusteredenvironment.
/settings/mount_pointsGETMountPointSettingsRetrievesinformationaboutthecurrentmountpointsettings.
/settings/firewallGETFirewallSettingsRetrievesinformationaboutthecurrentfirewallsettings.
/settings/snmpGETSNMPSettingsRetrievesinformationaboutthecurrentSNMPsettings.
/settings/authenticationGETAuthenticationSettingsRetrievesinformationaboutthecurrentauthenticationsettings.
/settings/advancedGETSequencerParametersRetrievesinformationaboutthecurrentsequencersettings.
/settings/clusterGETClusterSettingsRetrievesinformationaboutthecurrentclustersettings.
Onlyavailableforclusteredsystems.
ElementalLiveAPIandUserGuideWebServicesRESTinterface09/04/19ElementalTechnologiesConfidentialandProprietary41/169URLMETHODRETURNSDESCRIPTION/settings/stopPOSTEnablesagracefulshutdownoftheElementalservice.
CurrentlyrunningLiveEventswillruntocompletion,butnonewLiveEventswillbestarted.
WhenallLiveEventshavecompletedtheservicewillshutdown.
/settings/startPOSTSendsastartcommandtotheElementalservice.
Usedtorestarttheserviceaftera/settings/stopcommand.
/settings/advancedPOSTSequencerParametersUpdatesSequencersettings.
RequiresarestartoftheServiceinordertotakeeffect.
ALERTSANDMESSAGESThealertsAPIprovidesinformationaboutcurrentalertconditionsonthesystem.
MessagesprovidemoreinformationabouttheresultsofLiveEventsURLMETHODPARAMETERSRETURNSDESCRIPTION/alertsGETPaginationparameters,FilterparameterscanbeappendedtotheURL,eg:/alertsfilter=allListofalertsActive(oralliffilter=all)alertsforthesystem.
/messagesGETPaginationparameters,FilterparameterscanbeappendedtotheURL,eg:/messagesfilter=ErrorListofmessagesMessagescanbeErrors,Warnings,orAuditmessages.
Theyhaveacodeandatextmessage,andareassociatedwithaparticularLiveEvent.
SeeCodesforcommonmessagescodes.
DEVICESDevicesareauto-detectedonthenode,sothereisnoPOST.
YoucanPUTtoaddanoptional.
GETreturnsseveralread-onlyattributes,includinginformationabouttherouterandrouterinputthatthedeviceisconnectedto,ifitisinfactconnectedtoadevice.
Toconnectthedevicetoarouter,seetheRouterandRouterOutputentities.
GETandGETListreturnslightlydifferentinformation;ifyoucannotfindtheinformationyouarelookingforwithonecommand,thentrytheother.
URLMETHODPARAMETERSRETURNSDESCRIPTION/devicesGETListofinputdevices(HD-SDIinputs)Retrievesavailableinputdevicesinthesystem.
/devices/GETDeviceDescriptionRetrievesadevicefromthesystem.
/devices/PUTDeviceParametersDeviceDescriptionUpdatesanexistingdevicewiththenewsettings.
/devices//previewPOSTPreviewimagelist(seeexamplebelow)PreviewimagelocationsGeneratesjpegimagesofthespecifiedsizesfromthecurrentinputondevice.
RESPONSEINFORMATIONNAMETYPEDESCRIPTIONdevice_numberIntegerRead-only.
Theportnumber,asspecifiedbythecarditself.
device_typeStringRead-only.
Themanufacturer'stypeforthecard,asspecifiedbythecarditself.
idIntegerRead-only.
TheIDforthisportonthisIDcard,uniqueamongallcardsonthisnode:itistheoneassignedbythesystemandistheIDthatthesystemusestoidentifytheport.
nameStringRead-write.
Anameyouassigntotheport.
Maybenull.
quadStringRead-only.
False:Thisportisaphysicalportonthecard.
True:Itisavirtualporttohandlequad-linkinput,andwillonlyappearifthecardsupportsquad-linkinput.
ElementalLiveAPIandUserGuideWebServicesRESTinterface09/04/19ElementalTechnologiesConfidentialandProprietary42/169NAMETYPEDESCRIPTIONnode_idStringRead-only.
Ifthisnodeispartofacluster,theIDforthenodeinthatcluster.
Ifthisnodeisnotpartofacluster,always1.
Allareread-only.
SameinfoasfromGETRouter.
Allread-only.
Theseattributesarepresentonlyifthedeviceisconnectedtoanoutputonarouter.
TheidentifiestheID(asassignedbyElemental)oftheconnectedrouter.
routerStringTheIDforthisrouter,assignedbythesystemwhentherouteriscreated.
OtherattributesSeeGETRouter.
router_outputAllareread-only.
SameinfoasfromGETRouterOutput.
Theseattributesarepresentonlyifthedeviceisconnectedtoanoutputonarouter.
TheidentifiestheID(asassignedbyElemental)oftheconnectedoutputontherouterspecifiedby.
router_outputAnIDforthisrouteroutputthatisuniqueonthisrouter.
router_outputIntegerAnIDfortherouterthatthiscardisconnectedto.
Identicaltorouter_outputrouter_outputrouter_outputStringIdenticaltoEXAMPLEXML:GETPREVIEWIMAGESFROMDEVICE1320240small.
jpg720480large.
jpgreturnssmall.
jpg320240/images/preview/small.
jpglarge.
jpg720480/images/preview/large.
jpgThepreviewimageswillbeavailableathttp:///images/preview/ElementalLiveAPIandUserGuideWebServicesRESTinterface09/04/19ElementalTechnologiesConfidentialandProprietary43/169SYSTEMSTATUSThesystemstatusAPIallowstheusertoquerystatusofinputdeviceswhenrunning,RAIDstatuswhenavailable,andPSUstatuswhenavailable.
Inaddition,basicsysteminformationsuchasmemory,CPUandGPUloadaredisplayedwhentheserviceisrunning.
URLMETHODPARAMETERSRETURNSDESCRIPTION/system_status.
jsonGETSysteminformationinJSONformatRetrievesavailablesystemstatuses.
/system_status.
xmlGETSysteminformationinXMLformatRetrievesavailablesystemstatuses.
EXAMPLEJSON:GETSYSTEMSTATUS{"cpu":{"pct":"1.
46","num":0},"mem":{"pct":48,"num":5},"gpu":[{"pct":0,"num":0}],"status":"orange_status","date":"Jan20,201516:01:47","devices":[],"psu_status":"Status:Present,OK","raid_status":"Therewasanerrorwhiletryingtogetinformationaboutthedevice.
"}ROUTERSThefollowingtabledescribestheRESTRoutercontrolinterface.
URLMETHODRETURNSDESCRIPTION/routersPOSTPOSTRouterCreateanewrouter.
/routers/PUTPUTRouterModifytheattributesofthespecifiedrouter.
/routersGETGETRouterListGetthelistofrouters.
/routers/GETGETRouterGettheattributesofthespecifiedrouter.
/routers/DELETEDELETERouterDeletethespecifiedrouter.
/routers//inputsPOSTPOSTRouterInputCreateanewinputforthespecifiedrouter.
/routers//inputs/input-PUTPUTRouterInputModifytheattributesofthespecifiedinputonthespecifiedrouter.
routers//inputsGETGETRouterInputListGetthelistofinputsforthespecifiedrouter.
/routers//inputs/input-GETGETRouterInputGettheattributesofthespecifiedinputonthespecifiedrouter.
/routers//inputs/input-DELETEDELETERouterInputDeletethespecifiedinputonthespecifiedrouter/routers//outputsPOSTPOSTRouterOutputCreateanewoutputforthespecifiedrouter.
/routers//outputs/output-PUTPUTRouterOutputModifytheattributesofthespecifiedoutputonthespecifiedrouter.
/routers//outputsGETGETRouterOutputListGetthelistofoutputsforthespecifiedrouter.
/routers//outputs/output-GETGETRouterOutputGettheattributesofthespecifiedoutputonthespecifiedrouter.
/routers//outputs/output-DELETEDELETERouterOutputDeletethespecifiedoutputonthespecifiedrouterElementalLiveAPIandUserGuideWebServicesRESTinterface09/04/19ElementalTechnologiesConfidentialandProprietary44/169WORKINGWITHROUTERSPOSTROUTERSHTTPURLPOST/routersBODYOFHTTPXMLcontentconsistingofonerouterelement,consistingofthefollowingtags:TAGVALUEDESCRIPTIONnameStringAnameofyourchoosing.
ipStringTheIPaddresswithoutanyprotocol.
max_inputsIntegerTypically,thenumberofphysicalinputsontherouter.
max_outputsIntegerTypically,thenumberofphysicaloutputsontherouter.
router_typeStringOneof:blackmagic_videohubmiranda_nvisionharris_panaceasnell_auroralevel_idIntegerAppearsonlyforHarrisPanacea,MirandanVisionandSnellAurora.
user_idIntegerAppearsonlyforMirandanVisionandSnellAurora.
matrix_idIntegerEXAMPLERequestThisrequestcreatesonerouterwiththename"BlackMagic1".
Thisrouterhas12inputsand12outputs,sothesenumbersaresetinthemax_inputsandmax_outputs.
POSThttp:///routersBlackMagic1192.
168.
10.
10blackmagic_videohub1212ResponseInthisexample,therouterisgiventheID1.
1BlackMagic1192.
168.
10.
10blackmagic_videohub1212ElementalLiveAPIandUserGuideWebServicesRESTinterface09/04/19ElementalTechnologiesConfidentialandProprietary45/169PUTROUTERModifytheattributesofthespecifiedrouter.
Youcannotusethiscommandtomodifytheinputsoroutputsoftherouter;todothat,usePUTRouterInputandPUTRouterOutput.
HTTPURL/routers/BODYOFHTTPThebodycontainsonlythetagstochange;seePOST.
GETROUTERLISTGetalistofallvideoSDIrouters,includingthedatathatiscontainedintheRouterInputandRouterOutputentities.
HTTPURLGET/routersRESPONSEXMLcontentconsistingofonerouterselementthatcontains:AHREFattributethatspecifiestheproductandversioninstalledonthenode.
Zeroormorerouterelements,oneforeachrouterfound.
Eachelementconsistsofseveraltags:TAGVALUEDESCRIPTIONidIntegerTheIDforthisrouter,assignedbythesystemwhentherouteriscreated.
nameStringSeeGETRouterList.
ipStringmax_inputsIntegermax_outputsIntegerrouter_typeStringlevel_idIntegeruser_idIntegermatrix_idIntegerinputsContainsoneormoreinputelements,oneforeachrouterinputintherouter.
SeeGETRouterInputList.
outputsContainsoneormoreoutputelements,oneforeachrouteroutputintherouter.
SeeGETRouterOutputList.
EXAMPLEGEThttp:///routers1BlackMagic1192.
168.
10.
10blackmagic_videohub12121Input111ElementalLiveAPIandUserGuideWebServicesRESTinterface09/04/19ElementalTechnologiesConfidentialandProprietary46/1692Input2129111Device.
.
.
.
.
.
GETROUTERGettheattributesofthespecifiedvideoSDIrouter,includingthedatathatiscontainedintheRouterInputandRouterOutputHTTPURLGET/routers/RESPONSEXMLcontentconsistingofonerouterelement,containingthesametagsastheresponseforGETRouterList,above.
DELETEROUTERDeletesthespecifiedrouter(identifiedbyitsinternalrouterID)andtheassociatedinputsandoutputs.
TogettheinternalrouterIDofaspecificrouter,useGETRouter.
HTTPURLDELETE/routers/WORKINGWITHROUTERINPUTSTheRouterInputsentityholdsinformationabouttherouterinputsthatareinuse.
POSTROUTERINPUTCreateanewinputforthespecifiedrouter.
Usethiscommandrepeatedlytosetupalltherouterinputs.
HTTPURLPOST/routers//inputsElementalLiveAPIandUserGuideWebServicesRESTinterface09/04/19ElementalTechnologiesConfidentialandProprietary47/169BODYOFHTTPXMLcontentconsistingofoneinputelement,consistingofthefollowingtags:TAGVALUEDESCRIPTIONnameStringAnameforthisinput,ofyourchoosing.
ThisnamewillappearintheInputsdropdownlistontheElementalLivewebinterface.
input_numberIntegerTheIDoftherouterinputthatyouwanttomakeknowntoElementalLive.
ThisistheIDfortheinputasassignedbytherouter(notasassignedbyElementalLive).
RESPONSETheresponserepeatsbackthedatathatyoupostedwiththeadditionof:id:ThenewlyassignedIDfortherouter.
router_id:Therouterthatthisrouterinputbelongsto.
TheresponseisidenticaltotheresponsetoaGETRouterInput.
Seebelowforanexample.
EXAMPLERequestThisrequestcreatesoneinputfortherouterwiththeID2.
ThisinputhasbeenautomaticallyassignedtheID5.
POSThttp:///routers/2/inputsInput11ResponseInthisexample,therouterinputhasbeenautomaticallyassignedtheID4.
4Input121PUTROUTERINPUTModifytheattributesofthespecifiedinputonthespecifiedrouter.
If,aftertheinitialsetup,youeverchangethecablingontheinputsideofyourrouter,youmustusePUTRouterInputtoreflectthesechanges.
HTTPURLPUT/routers//inputs/BODYOFHTTPThebodycontainsonlythetagstochange;seePOST,above.
EXAMPLEThisrequestchangestheinputwiththeID3.
ThisinputbelongstotherouterwiththeID2.
Itchangesitsinput_IDto4;thischangewouldonlybemadetofixanerrorintheoriginalsetuportoreflectachangeinthecabling(sothattherouter's4thinputisnowbeingused).
PUThttp:///routers/2/inputs/3ElementalLiveAPIandUserGuideWebServicesRESTinterface09/04/19ElementalTechnologiesConfidentialandProprietary48/1694`GETROUTERINPUTLISTGetthelistofalltheinputsforthespecifiedrouter.
HTTPURLGET/routers//inputsRESPONSEXMLcontentconsistingofoneinputselementthatcontains:AnHREFattributethatspecifiestheproductandversioninstalledonthenode.
Zeroormoreinputelements,oneforeachinputfound.
Eachelementconsistsofseveraltags:TAGVALUEDescriptionidIntegerTheIDforthisinput,uniqueforthisrouterandassignedbythesystemwhentheinputiscreated.
nameStringThenameforthisinput.
router_idIntegerTherouterthatthisinputbelongstoinput_numberIntegerTheIDoftherouterinputasassignedbytherouter(notasassignedbyElementalLive).
EXAMPLEThisrequestisfortheinputsassociatedwiththerouterwiththeID4.
TheresponsespecifiesthattherearetwoinputsinthisrouterwithIDs3and4.
GEThttp:///routers/4/inputs3Input1214Input222GETROUTERINPUTGettheattributesofthespecifiedinputonthespecifiedrouter.
HTTPURLGET/routers//inputs/RESPONSEXMLcontentconsistingofoneinputelement,containingthesametagsastheresponseforGETRouterInputList,above.
EXAMPLEThisrequestgettheattributesfortheinputthathastheID3.
TheinputbelongstotherouterwiththeID4.
GEThttp:///routers/4/inputs/3ElementalLiveAPIandUserGuideWebServicesRESTinterface09/04/19ElementalTechnologiesConfidentialandProprietary49/1693Input141DELETEROUTERINPUTDeletethespecifiedinputonthespecifiedrouter.
TogettheIDoftheinput,useGETRouterListandlookfortheelement(nottheelement!
).
HTTPURLDELETE/routers//inputs/WORKINGWITHROUTEROUTPUTSTheRouterOutputsentityholdsinformationabouteachrouteroutputthatisconnectedtoanSDIcardonanElementalLivehardwareunit.
TheinformationisamappingfromtherouteroutputtotheSDIinput.
POSTROUTEROUTPUTCreateanewoutputforthespecifiedrouter.
Usethiscommandrepeatedlytosetupalltherouteroutputs.
ThetotalnumberofRouterOutputentitiesforaspecifiedroutermustnotexceedthemax_inputonthatRouterentity:itmustnotexceedtheactualphysicaloutputsontherouter.
HTTPURLPOST/routers//outputsBODYOFHTTPXMLcontentconsistingofoneoutputelement,consistingofthefollowingtags:TAGVALUEDESCRIPTIONoutput_numberIntegerTheIDoftherouteroutputthatisconnectedtoanSDIcardontheElementalLivenode.
SpecifytherouterbyitsoutputIDasassignedbytherouter(notasassignedbyElementalLive).
device_idStringTheIDtheSDIinputthatisconnectedtotherouteroutputidentifiedbyoutput_number.
ThisIDisassignedbyElementalLivewhentheSDIcardisauto-detected.
EachportontheentirenodeisassignedauniqueID(forexample,IDs1-4onthefirstcard,5-8onthesecond.
UseGETDevicesontheElementalLiveAPIontheindividualElementalLivenodetogetalistofIDs.
(NotethatthisElementalLiveAPIdoesnotexposethisDeviceentity.
)RESPONSETheresponserepeatsbackthedatathatyoupostedwiththeadditionof:id:ThenewlyassignedIDfortherouter.
router_id:Therouterthatthisrouteroutputbelongsto.
TheresponseisidenticaltotheresponsetoaGETRouterOutput.
Seebelowforanexample.
EXAMPLERequestThisrequestcreatesoneoutputfortherouterwiththeID2.
ItspecifiesthatrouteroutputID3isconnectedtoSDIcardinputID4.
POSThttp:///routers/2/outputsElementalLiveAPIandUserGuideWebServicesRESTinterface09/04/19ElementalTechnologiesConfidentialandProprietary50/16934ResponseInthisexample,therouteroutputisgiventheID4.
4121PUTROUTEROUTPUTModifytheattributesofthespecifiedoutputonthespecifiedrouter.
ModifytheattributesifacablefromtherouteroutputmovestoadifferentSDIcardinput.
HTTPURLPUT/routers//outputs/BODYOFHTTPThebodycontainsonlythetagstochange;seePOST,above.
EXAMPLEThisrequestchangestherouteroutputwiththeID4.
ThisinputbelongstotherouterwiththeID2.
Itchangesitsdevice_idto3,toindicatethattheconnectionrepresentedbythisrouteroutputisactuallytotheSDIinputthathastheID3.
PUThttp:///routers/2/outputs/43GETROUTEROUTPUTLISTGetthelistofoutputsforthespecifiedrouter.
HTTPURLGET/routers//outputsRESPONSEXMLcontentconsistingofoneoutputselementthatcontains:AnHREFattributethatspecifiestheproductandversioninstalledonthenode.
Zeroormoreoutputelements,oneforeachinputfound.
Eachelementconsistsofseveraltags:TAGVALUEDESCRIPTIONidIntegerTheIDforthisoutput,uniqueforthisrouterandassignedbythesystemwhentheoutputiscreated.
output_numberIntegerTheIDoftherouteroutputthatisconnectedtotheSDIcardidentifiedbydevice_id(below).
ThisIDistheIDassignedbytherouter(notasassignedbyElementalLive).
router_idIntegerTherouterthatthisoutputbelongsto,auniqueIDassignedbyElementalLive.
device_idStringTheIDtheSDIinputthatisconnectedtotherouteroutputidentifiedbyoutput_number.
ThisIDisassignedbyElementalLivewhentheSDIcardisauto-detected.
EachportontheentirenodeisassignedauniqueID(forexample,IDs1-4onthefirstcard,5-8onthesecond.
ElementalLiveAPIandUserGuideWebServicesRESTinterface09/04/19ElementalTechnologiesConfidentialandProprietary51/169TAGVALUEDESCRIPTIONdevice_typeAlwaysspecifiesDeviceEXAMPLEThisrequestisfortheoutputsassociatedwiththerouterwiththeID2.
TheresponsespecifiesthattherearetwooutputsinthisrouterwithIDs3and4.
GEThttp:///routers/2/outputs35214227GETROUTEROUTPUTGettheattributesofthespecifiedoutputonthespecifiedrouter.
HTTPURLGET/routers//outputs/RESPONSEXMLcontentconsistingofoneoutputelement,containingthesametagsastheresponseforGETRouterOutputList,above.
EXAMPLEThisrequestgettheattributesfortheoutputthathastheID3.
TheinputbelongstotherouterwiththisID4.
GEThttp:///routers/4/outputs/33411DeviceDELETEROUTEROUTPUTDeletethespecifiedoutputonthespecifiedrouter.
HTTPURLDELETEhttp:///routers/2/outputs/1ElementalLiveAPIandUserGuideWebServicesRESTinterface09/04/19ElementalTechnologiesConfidentialandProprietary52/169ERRORCODESThefollowinglistdetailscommonerrorsthatthesystemmayreport.
Errormessagesthatcontainitalicsinthefollowingtablearedynamicatruntimeandwillcontainmoredetailsonthespecificerror.
CODEERRORMESSAGETROUBLESHOOTING1010Unabletoprocessinputfilefilename.
Problemprocessinganinput.
TheElementalMediaEngine(EME)wasunabletoprocessaninput.
1020Novideostreamininputfile.
Elementalproductsrequireatleastonevideostreamintheinputfile.
Audioonlystreamsarenotsupported.
1021Noaudiostreamininputfile.
WhentheaudioencoderisconfiguredforDolbyDigitalPassthroughmodeitisrequiredthattheinputcontainsaDolbyDigitalaudiotrack.
1030Unknownorunsupportedvideocodec.
Checkthatthisproductsupportstheinputsourceaudioandvideocodec.
SeeSupportedCodecsforalistofvalidinputmedia.
1040DetailsoninvalidsettingOneormoreprocessingsettingsarenotsupportedorcompatiblewiththeLiveEvent.
Detailsaregivenintheerrormessage.
Ifyouseethiserror,pleasecontactanElementalsupporttechnicianwithdetails.
1050AppleHTTPPush>nerrorsPushingApplestreamsoverHTTPhadmorethannum_retrieserrors.
Seelive_runner.
outputforHTTPerrorcodes1055Errorsendingoutputtodest.
uriCheckthatthecredentialsarecorrect,theuserhaspermissionstowritetothedestinationURIandthatthesystemsupportstheURI.
1056FailedtoopenfileThespecifiedfilecouldnotbeopened.
Checkthatthefileordirectoryexists,andthatthepermissionsallowthesystemtoopenthefile.
1060Inputclippingregionnotfoundininput.
ThestartandendtimecodesspecifiedintheClipInputsectionofeachInputmustexistintheassociatedinputstream.
1075DemuxerParseErrorDemuxercouldnotrecoverfromaproblematicfile.
Detailsaregivenintheerrormessage.
1076SourceReadErrorSourcereaderror,possiblyunexpectedendoffile.
Detailsaregivenintheerrormessage.
1077MemoryAllocationErrorMemoryallocationfailed.
Detailsaregivenintheerrormessage.
1080MXFmuxererrorAnerrorintheMXFmuxerhasoccurred.
Thiscouldbefromaninvalidconfiguration(atjobstart)orfromaruntimeexception.
Specificdetailsaregivenintheerrormessage.
1090ESAMerrorTherewasanerrorwithESAM.
Detailsaregivenintheerrormessage.
1091EncryptionerrorTherewasanerrorencryptingtheoutput.
Detailsaregivenintheerrormessage.
1110SDIdriverversionerrorTheSDIdriverversionisincorrect.
1111SDIhardwarefirmwareversionerrorTheSDIhardwarefirmwareversionisincorrect.
1112SDIIngestcommunicationerrorTherewasanerrorcommunicatingwithanotherElementalprocess.
1999CriticalEME(ElementalMediaEngine)errorThiscodeisreturnedforerrorsthatrequireanElementalsupporttechniciantocontinuetroubleshooting.
2010LiveEventliveevent.
idhastoomanyoutputstorunsuccessfully.
PleasesplittheoutputsintotwoormoreLiveEvents.
TheLiveEventwillrequiretoomanyresourcestorunasoneinstance.
ItshouldbebrokenupintosmallerLiveEventssothesystemcanworkontheLiveEventinpieces.
2030Processingscriptscript_locationreturnedmessage:messageApre-orpost-processingscriptreturnedamessage.
Thiserrorcomesfromacustompre-orpost-scriptthathasbeenexecutedbeforeoraftertheLiveEvent.
2040Errordeletingfilefrominput.
uriChecksequencerlogformoredetailsTherewasanerrordeletingtheinputsourcefileduringapostprocessingstep.
Checkthattheelementaluserhaspermissionstodeletethefile.
2050Errorcopyingfilefrominput.
uritodest.
uri:moredetails.
.
.
CheckthattheelementaluserhaspermissionstomovethefilefromtheinputtothedestinationURIandthatthesystemsupportstheURI.
2056ErrorloggingintoaccessremoteresourceCheckthatthecredentialssuppliedarecorrect.
2060LiveEventidwasrunningpastitsendtimeALiveEventwasrunningwhentheserverrecoveredfromanun-cleanshutdown(possiblepoweroutage).
TheLiveEventwasnotrestartedbecauseitwaspastitsscheduledendtime.
2070DevicenameisalreadyinuseALiveEventattemptedtorunwhileitsassignedinputdevicewasinusebyanotherLiveEvent.
2072NoavailableDeviceALiveEventwithaRouterinputcouldnotfindanavailableDeviceElementalLiveAPIandUserGuideWebServicesRESTinterface09/04/19ElementalTechnologiesConfidentialandProprietary53/169CODEERRORMESSAGETROUBLESHOOTING2080LicensingErrorAlicensingerror/issueisraisedwheneitherthelicensesdoesn'tsupportthehardware,theinstalledsoftware,oratriallicensehasexpired.
2999CriticalErrorThiscodeisreturnedforerrorsthatrequireanElementalsupporttechniciantocontinuetroubleshooting.
WARNINGCODESThefollowingisalistofcommonwarningsthatthesystemmayreport.
CODEWARNINGMESSAGETROUBLESHOOTING102010Problemwithpre-processing:moredetails.
.
.
Therewasaproblemwiththepre-processingscript.
ThesystemwillcontinuewiththeLiveEvent,andmoredetailscanbefoundinthesequencer.
outputlogfile.
102020Problemwithpost-processing:moredetails.
.
.
Therewasaproblemwiththepost-processingscript.
ThesystemwillcontinuewiththeLiveEvent,andmoredetailscanbefoundinthesequencer.
outputlogfile.
102030Processingscriptscript_locationreturnedmessage:messageAcustompre-orpost-processingscriptexecutingbeforeoraftertheLiveEventreturnedamessage.
102040ThisLiveEventisbeingupdatedwithtimestampsinthefuturerelativetothemanagementnode.
ThenodewheretheLiveEventisrunninghasadifferentsystemtimethanthemanagementnode.
ThiscancauseerrorswithmanagingstaleLiveEvents.
Itcanbesolvedbyensuringallnodesintheclusteraresettothesametimeand/orareusingthesameNTPserver.
102050Inputfiledoesnotyetexistonthisserver.
Theinputfilecouldnotbefoundtogenerateapreviewimage.
Sincetheinputmaybethereinthefuturebecauseofapreprocessingscriptorotheroutsideautomation,thisisonlyawarning.
IftheinputisnotavailablewhentheEMErunstheLiveEvent,thenthesystemlogsanerror102060LiveEventidwasinrunningstate,butitsprocesswasnotfound(possiblepowerfailure).
RestartingLiveEventElementalLivewillstartanyLiveEventitfindswasrunningafteranun-cleanshutdown(suchasapowerfailure).
Thiswarningwillbeloggedinthatcase.
102070GPUselectionoverriddenUserassignedGPUwasoverriddenbythesystem.
ThiscanhappenifthechosenGPUisdisabledinadvancedsettings,orifthesystemcombinesimageprocessingwithanotherstreamforefficiency.
AUDITCODESThefollowinglistarecommonauditmessagesthatthesystemmayreport.
CODEAUDITMESSAGEDESCRIPTION10InitialtimecodeHD-SDIinputswillreporttheinitialtimecodeofthestreamfromtheselectedtimecodesource.
11FinaltimecodeHD-SDIinputswillreportthefinaltimecodesofthestreamfromtheselectedtimecodesource.
12GOPtimecodeHD-SDIinputswillreporttheGOPtimecodesofthestreamfromtheselectedtimecodesource.
13TimecodeResyncTheencoderwillreportwhentimecodeissyncedtotimecodesource.
42EncodeProfileandLevelTheencoderwillreportactualprofileandlevelsettingsforeachstreamassembly.
QUERYPARAMETERSTheElementalLiveRESTInterfaceallowsforaseriesofqueryparameterstobeappendedtocertainGETrequests.
Thesequeryparameterscanbecombinedtogetherforadvancedquerying.
PAGINATIONAllGETrequestsforlistsofobjectsreturnapaginatedsetofresults.
Theparametersusedtopaginatetheresultscanbeadjustedbyappendingpageandper_pageparameterstotheendoftherequestasfollows:ElementalLiveAPIandUserGuideWebServicesRESTinterface09/04/19ElementalTechnologiesConfidentialandProprietary54/169/live_eventspage=3&per_page=30Thenumberofobjectsperpageiscappedat100,anyrequestforagreaternumberwillonlyreturnthefirst100.
Toaccessmorethanthecappednumber,usetheper_pageandpageparameterinconjunctiontowalkthelistwithmultiplerequests.
/live_eventspage=1&per_page=100/live_eventspage=2&per_page=100/live_eventspage=3&per_page=100/live_eventspage=4&per_page=100Note:Inmanycommandshellenvironments,certaincharacterssuchas&maybeinterpretedasspecialcharacterssoitisrecommendedtouseaquotingmechanismspecifictoyourshell.
Forexample,issuethefollowingcommandintheBashshellusingsingleordoublequotes:curl-H"Accept:application/xml""http:///jobspage=3&per_page=30"FILTERLiveEventscanbefilteredbystate,foramorefocusedsetofresults.
Theparametersusedtofiltertheresultscanbeadjustedbyappendingthefilterparametertotheendoftherequest:/live_eventsfilter=activeAtthistime,onlyasinglefilterparameterisallowedperrequest.
Thesetofvalidfiltervaluesarelistedbelow.
FILTERDESCRIPTIONpendingLiveEventsinthependingstateactiveLiveEventsinthepreprocessing,runningorpostprocessingstatepreLiveEventsinthepreprocessingstaterunningLiveEventsintherunningstatepostLiveEventsinthepostprocessingstatecompleteLiveEventsinthecompletestatecancelledLiveEventsinthecancelledstateerrorLiveEventsintheerrorstatearchivedLiveEventsthathavebeenarchivedAUTHENTICATIONANDRESTWhenauthenticationisenabledontheElementalLivesystem,additionalinformationmustbesentwiththeRESTcommandinordertoproperlyauthenticatetherequest.
Thefollowingadditionalheadersmustbeset:X-Auth-User,X-Auth-Expires,X-Auth-Key.
TheX-Auth-Userheadercontainstheloginoftheusertoauthenticate.
TheX-Auth-ExpiresheadercontainstheUnixtimestamp(inUTC)thatindicatesthetimeafterwhichtheserverwillnolongeraccepttherequestasvalid.
Forsecuritypurposes,Elementalrecommendsthatthisvalueshouldbe~30secondsinthefuture.
TheX-Auth-Keyheadershouldbeconstructedusingthefollowingalgorithm:md5(api_key+md5(url+X-Auth-User+api_key+X-Auth-Expires))Eachparameterinthisexpressionshouldbeenteredasastring,andthe'+'operatorindicatesstringconcatenationwithoutanydelimiters.
Theapi_keyparameteristheuser'ssecretAPIkeythatcanberetrievedontheUserProfilepage.
Forsecurity,itisrecommendedthatthiskeyberesetperiodically.
TheurlparameteristhepathpartoftherequestURLminusanyqueryparametersandwithoutanyAPIversionprefix.
Forexample,consideraGETrequesttohttps:///api/live_events/1clean=truebytheuser'admin'withtheapi_key'1acpJN7oEDn3BDDYhQ'thatexpiresonJune1,2011UTC.
Inthiscasetheurlparameteris'/live_events/1'andtheX-Auth-Expiresvalueis'1306886400'.
ThusthevalueofX-Auth-Keyshouldbecomputedasfollows:ElementalLiveAPIandUserGuideWebServicesRESTinterface09/04/19ElementalTechnologiesConfidentialandProprietary55/169md5('1acpJN7oEDn3BDDYhQ'+md5('/live_events/1'+'admin'+'1acpJN7oEDn3BDDYhQ'+'1306886400'))=>md5('1acpJN7oEDn3BDDYhQ'+md5('/live_events/1admin1acpJN7oEDn3BDDYhQ1306886400'))=>'180c88df8d0d4182385f6eb7e7045a42'Thisisasingleaccessrequest,itisnotpersisted.
Ifanotherrequestneedstobemade,theX-Auth-Keymustberecalculatedandalltheheadersmustbesetcorrectly.
AUTHCURLSCRIPTSInordertohelpconstructandsettheseheaderscorrectly,twohelperscripts(auth_curl.
rbandauth_curl.
pl)canbefoundin/opt/elemental_se/web/public/authentication_scripts.
ThesescriptsshowhowtoconstructandsettheheaderscorrectlyusingRubyorPerl.
Inaddition,theycanbeusedoutrighttoeasetheuseofsettingtheseheadersusingcURL.
Usingthesameexamplefromabove,tosendaGETrequestto'/live_events/1'usingtheuser'admin'withtheapi_key'1acpJN7oEDn3BDDYhQ',simplyusethefollowingcommand:.
/auth_curl.
[rb|pl]--loginadmin--api-key1acpJN7oEDn3BDDYhQ\-H'Accept:application/xml'https:///api/live_events/1ThescriptwilluseanX-Auth-Expiresheaderthatis30secondsinthefuture,anditwillcalculatetheX-Auth-Keyheaderandsetalltheadditionalheaderscorrectly.
Anyadditionaloptionsbeyondthe--loginand--api-keyoptionswillbepassedtocURL.
Whenusingthescriptsinthismanner,itdoesnotmatteriftheRubyorPerlscriptsareusedastheirfunctionisidentical.
POSTandPUTrequestscanalsobeissuedusingthehelperscripts.
ForthesecasesitisimportanttoremembertoincludeanappropriateHTTP"Content-Type"header,aswellasspecifyingyourxmldatapayload.
Hereisanexampleofthisusage:.
/auth_curl.
[rb|pl]--loginadmin--api-key1acpJN7oEDn3BDDYhQ\-X[POST|PUT]\-H'Accept:application/xml'-H'Content-Type:application/xml'\-d@filenamehttps:///api/v2.
16.
3.
0/live_eventsNote:HTTPSisonlysupportedbydefaultonElementalCloudnodes,andmustbemanuallyconfiguredforotherproducts.
ElementalLiveAPIandUserGuideWebServicesRESTinterface09/04/19ElementalTechnologiesConfidentialandProprietary56/169LIVEEVENTPARAMETERSGeneralLocationInputDeviceInputRouterInputNetworkInputFileInputHLSInputSettingsVideoSelectorAudioSelectorAudioSelectorGroupCaptionSelectorEmbeddedSourceSettingsFileSourceSettingsTeletextSourceSettingsDVBSubSourceSettingsSCTE-27SourceSettingsInputClippingImageInserterInsertableImageTimecodeConfigNielsenConfigurationFailoverConditionFailureRuleProcessorsNotificationPre-ProcessPost-ProcessTimingAvailBlankingBlackoutSlateESAMOutputLockingXDSManipulationImageInserterInsertableImageOutputGroupArchiveGroupSettingsAppleLiveGroupSettingsElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary57/169MicrosoftSmoothStreamingGroupSettingsDASHISOGroupSettingsAdobeRTMPGroupSettingsUDPGroupSettingsReliableTSGroupSettingsAlternateManifestDestinationVerimatrixSettingsSecureMediaSettingsIrdetoSettingsConaxSettingsGenericKeyproviderSettingsStaticKeySettingsSelf-GeneratedSettingsPikselSettingsOneMainstreamSettingsCiscoSettingsThePlatformSettingsSeachangeSettingsOutputAppleLiveSettingsMP4SettingsAdobeRTMPSettingsUDPSettingsReliableTSSettingsFECOutputSettingsMovSettingsUVUSettingsM2TSSettingsDVBNetworkInformationTable(NIT)DVBServiceDescriptionTable(SDT)DVBTimeandDateTable(SDT)SimulcryptAESSettingsM3U8SettingsExternalOutputStreamAssemblyVideoDescriptionRectangleH.
264SettingsH.
265SettingsMPEG-2SettingsProResSettingsElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary58/169FrameCaptureSettingsUncompressedSettingsVideoPreprocessorsColorCorrectorImageInserterInsertableImageDeinterlacerNoiseReducerWatermarkingTimecodeBurn-inAudioDescriptionAACSettingsWAVSettingsAIFFSettingsMPEG-1LayerIISettingsDolbyDigitalSettingsDolbyDigitalPlusSettingsDTSESettingsPassThroughSettingsRemixSettingsAudioNormalizationSettingsCaptionDescriptionBurn-InDestinationSettingsSCCDestinationSettingsPresetPresetCategoryRemixSettingsPresetLiveEventProfileScheduleCuePointParametersTimeSignalParametersAvailImageParametersBlackoutImageParametersDeviceRouterRouterInputRouterOutputMPTSLocalMPTSMemberRemoteMPTSMemberSequencerConfigElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary59/169FormatIdentifierParametersScanTypesElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary60/169PARAMETERSThefollowingtablesoutlineparametersthatcanbesetforobjectsinElementalLive.
ThesecanbesetusingRESTortheappropriatepagesinthewebinterface.
TheNamecolumncontainstheappropriateXMLtagforeachparameter,andnamesinboldarerequiredfields.
Ifthereisaspecificrangeofvalidvaluesforaparameter,itwillbedisplayedintheRangecolumn.
Defaultvaluesareshowninbold.
LIVEEVENTNAMETYPERANGEDESCRIPTIONnamestringAnamefortheLiveEvent.
Ifleftblankthenameofthefirstinputwillbeused.
nodestringValidnodeIDorhostnameorIPAddressNodeonwhichtoruntheLiveEventwhencreatedonaConductorLivecluster.
inputInputLiveEventinputparameters.
TherecanbemultipleinputsinasingleLiveEvent.
timecode_configTimecodeConfigContainssettingsusedtoacquireandadjusttimecodeinformationfrominputs.
loop_all_inputsbooleantrueorfalseProcesslistofinputssequentiallyandloopfromthefirstinputwhencomplete.
failure_ruleFailureRuleLiveEventfailoverparameters.
profilestringValidProfileID,name,orpermalinkThisparameterisusedonlytocreateaneventfromtheRESTAPI.
Includethisparameterinordertobuildtheeventusingaprofile.
SpecifytheIDornameorpermalinkofaprofile.
Whenthisprofileparameterisincludedandthereferencedprofileincludesanparameter,thentheentireeventmustcontainonlythisprofileparameter.
Whenthisprofileparameterisincludedandthereferencedprofiledoesnotincludeanparameter,theeventcontainsaandan.
Whenthisprofileparameterisnotincluded,theeventmustcontainevery(relevant)parametertag.
timingTimingSettingsforstartandendtimes.
ad_triggerstringscte35_splice_insert,scte35_time_signal_apos,esamControlswhichtypesofSCTEsignalssignalAdAvails.
Adscanbesignaledwith"SpliceInsert"messages,whichistraditional,orwith"TimeSignal"messages,carrying"AdPlacementOpportunityStart"segmentationmessages(type_id0*35).
SeeSCTE352013formoreinformation.
InESAMmode,aPOISserverisusedforconditioningallSCTE-35messagesandinsertingconditionedsignals.
ignore_web_delivery_allowed_flagbooleantrueorfalseWhenenabled,SegmentDescriptorswithweb_delivery_allowed_flagsetto0willnolongertriggerblackoutsorAdAvailslatesignore_no_regional_blackout_flagbooleantrueorfalseWhenenabled,SegmentDescriptorswithno_regional_blackout_flagsetto0willnolongertriggerblackoutsorAdAvailslatesinitial_audio_gaininteger-60to60dB(Default:0dB)ValuetosettheinitialaudiogainfortheLiveEvent.
ThisisalsoeditablewhiletheLiveEventisrunning.
avsync_enablebooleantrueorfalseEnablesA/Vsync.
avsync_pad_trim_audiobooleantrueorfalseEnablesA/Vsynctrimaudio.
input_loss_behaviorInputLossBehaviorSettingsforsystemactionswheninputislost.
input_end_actionstringswitch_input,ornoneIndicatestheactiontotakewhenaninputcompletes(e.
g.
end-of-file.
)Optionsincludeimmediatelyswitchingtothenextsequentialinput(via"switch_input")ortranscodingblack/color/slateimagesperthe"InputLossBehavior"configurationuntilanactivate_inputRESTcommandisreceived(via"none").
ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary61/169NAMETYPERANGEDESCRIPTIONoutput_timing_sourcestringinput_clock,orsystem_clockIndicateswhethertherateofframesemittedbytheLiveencodershouldbepacedbyitssystemclock(whichoptionallymaybelockedtoanothersourceviaNTP)orshouldbelockedtotheclockofthesourcethatisprovidingtheinputstream.
input_buffer_sizeinteger4–300(Default:60)Numberofframestobufferatinput.
Highervalueswillallowlessdroppedframes,butusemorememory.
Lowervaluescanimprovestreaminglatency.
resource_reservationstringnoneor4k_decodeWhen4KDecodeisselected,thesystemreservesadditionalresourcestoprovidereal-time4Kdecodeofasecondnetworkinput.
Thisoptionallowsthesystemtoreserveresourcesfor4Kseamlessinputswitchingor4KHot-Hotredundancywhennetwork(IP)sourcesareused.
ResourcereservationisnotrequiredwhenusingQuadSDIsourcesfor4Kencoding.
Note–thisoptiononlyhaseffectfor4KworkflowshostedontheAWSElementalLiveL700AEseries(orgreater)when4Kencodingisconfigured.
TheRESTparametercontrolledbythischeckboxisresource_reservation.
Itsupportsvaluesofnoneand4k_decode.
low_framerate_inputbooleantrueorfalseAdjustsvideoinputbufferforstreamswithverylowvideoframerates.
Thisiscommonlyusedformusicchannelswithlessthanonevideoframepersecond.
low_latency_modebooleantrueorfalseReduceslatencyofaudio/videosync.
ThisreducesoveralllatencyofLiveEvent,butmayresultinmoredroppedaudiopacketsoninputtimestampdiscontinuities.
ParametervaluessuchasBFrameandMin-IIntervalmaystillincreaselatencywhileLowLatencyisset,buttheneteffectisanoverallreduction.
notificationNotificationSettingsfornotificationonstatuschangesofthisLiveEvent.
user_datastringUser-defineddatatobeattachedtotheLiveEvent.
ThisdataisavailablewithLiveEventstatusrequestsviatheAPI.
extract_sdtbooleantrueorfalseExtractsSDTinformationfrominputstream.
DisplaysServiceProviderandServiceNamesduringrunningstate.
pre_processPre-ProcessSettingsforpreprocessingsteps.
post_processPost-ProcessSettingsforpostprocessingsteps.
image_inserterImageInserterSettingsfortheimageinserter.
WhenattachedtotheLiveEvent,insertsintothedecodedinputandappearsineveryoutput.
motion_image_inserterMotionImageInserterSettingsforthemotionimageinserter.
WhenattachedtotheLiveEvent,insertsintothedecodedinputandappearsineveryoutput.
avail_blankingAvailBlankingSettingsforadavailblanking.
blackout_slateBlackoutSlateSettingsforblackoutslate.
esamESAMSettingsforEventSignalingAndMessaging(ESAM).
nielsen_configurationNielsenConfigurationNielsenconfigurationsettingsoutput_lockOutputLockSettingsforoutputlocking.
output_groupOutputGroupOutputgroupsforthisLiveEvent.
Outputgroupscontaininformationaboutwherestreamsshouldbedistributed.
stream_assemblyStreamAssemblyStreamassembliesforthisLiveEvent.
ALiveEventcanhaveseveralstreamassemblieswhichdefineoutputcodecsettings.
ad_avail_offsetinteger-1000–1000(Default:0)Whenspecified,thisoffset(inmilliseconds)isaddedtotheinputAdAvailPTStime.
ThisonlyappliestoembeddedSCTE104/35messagesanddoesnotapplytoOOBmessages.
ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary62/169LOCATION.
.
.
archive_group_settings/data/server/archive/outfile.
.
.
NAMETYPERANGEDESCRIPTIONuristringUniformResourceIdentifier–ThisshouldbeapathtoafileaccessibletotheElementalLivesystem,eitheronthelocalfilesystemorthroughaSMBmount,oraURIdependingontheoutputtype.
Forexample,artmp_endpointshouldhaveaurisimliarto:"rtmp://fmsserver/live".
usernamestringUsernameifcredentialsarerequiredtoaccessfileorpublishingpoint.
passwordstringPasswordifcredentialsarerequiredtoaccessfileorpublishingpoint.
check_server_certificatebooleantrueorfalseCheckHTTPSservercertificates.
Whendisabled,wewillstillcheckthecryptographyinthecertificate,butwewillnotvalidatetheserver'sname.
Certainsubdomains(notablyS3bucketsthatusedotsinthebucketname)donotstrictlymatchthecorrespondingcertificate'swildcardpatternandwouldotherwisecausetheeventtoerror.
Thissettingisignoredforotherprotocols.
URITYPESURIsidentifythelocationofinputsources(bothstreamingandfilesources),outputdestinations,andassetssuchasgraphicsfilesandscripts.
TheformatfortheURImayincludeaprotocol.
Forsomeprotocols,authenticationwiththeremoteserverissupportedandtheusernameandpasswordcanbespecified.
URISANDPROTOCOLSPROTOCOLURIFORMATAUTHENTICATIONUDPudp://[:port]NoneRTPrtp://[:port]NoneZixiZixi://[:port]NoneAWSElementalMediaConnectarn://EntertheAccessKeyIDintheusernamefield.
EntertheSecretAccessKeyinthepasswordfield.
RTMPrtmp://[:port]NoneLocalfile/data/server/folder/file.
extNoneHTTPhttp://[:port]/path/file.
extBasicandAWS(Ifauthenticationisrequired,entertheAccessKeyIDintheusernamefieldandtheSecretAccessKeyinthepasswordfield.
)HTTPShttps://[:port]/path/file.
extBasicandAWS(Ifauthenticationisrequired,entertheAccessKeyIDintheusernamefieldandtheSecretAccessKeyinthepasswordfield.
)FTPftp://[:port]/path/file.
extBasicSFTPsftp://[:port]/path/file.
extBasicandSSHauthentication;hostkeyauthentication(add/home/elemental/.
ssh/id_rsa.
pubtoremoteserver'sauthorizedkeylist).
SCPscp://[:port]/path/file.
extBasicandSSHauthentication;hostkeyauthentication(add/home/elemental/.
ssh/id_rsa.
pubtoremoteserver'sauthorizedkeylist).
ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary63/169PROTOCOLURIFORMATAUTHENTICATIONAmazonS3s3:///EntertheAccessKeyIDintheusernamefield.
EntertheSecretAccessKeyinthepasswordfield.
Usesse=truetoenableS3ServerSideEncryption(SSE).
Userrs=truetoenableReducedRedundancyStorage(RRS).
DefaultvaluesforRRSandSSEarefalse.
Example:s3://elemental.
test/bucketname/encryptedrrs=true&sse=trueAmazonS3SSLs3ssl:///EntertheAccessKeyIDintheusernamefield.
EntertheSecretAccessKeyinthepasswordfield.
Usesse=truetoenableS3ServerSideEncryption(SSE).
Userrs=truetoenableReducedRedundancyStorage(RRS).
DefaultvaluesforRRSandSSEarefalse.
Example:s3ssl://elemental.
test/bucketname/encryptedrrs=true&sse=trueAWSElementalMediaStorehttps:///EntertheAccessKeyIDintheusernamefield.
EntertheSecretAccessKeyinthepasswordfield.
Example:https://fje9x3myzr37b9.
data.
mediastore.
us-west-2.
amazonaws.
com/live_eventAsperaaspera://Enterausernameandpasswordasspecifiedbytheserveradministrator.
PROTOCOLSFORNETWORK(STREAMING)INPUTSInputsthatarenetwork(streaming)inputscanusetheHTTP/HTTPS(onlyforHLS)andRTMP,UDP,RTPprotocols.
Somenotes:RTMPstreamsshouldbeconfiguredasnetworkinputstolocalhost(eg,rtmp://localhost/live/streamname).
HLSinputscanincludeoptionsforspecialhandling.
Forexample,includingthebandwidth,retriesandretryintervalprogressivelydownloadedwhiletranscoding.
CompletetheURIinthestyle:http://[:port]/path/file.
m3u8[bandwidth=20000&retries=10&retry_interval=2])Inthisexample,ifthefilepointedtobytheURIisavariantplaylist,thehighestbitratestreamwillbechosenasthesource;theoptionalbitrateargumentcanbeusedtoselectaspecificstreamfromtheplaylist.
Tospecifystartingnsegmentsfromtheend,followthisexample:http://[:port]/path/file.
m3u8[buffer_segments=n])nmustbeapositivenumber.
WhenusingAmazonS3tohosttheHLSsourcecontent,usethisformat:http(s)://s3-.
amazonaws.
com//Forexample:https://s3-eu-west-1.
amazonaws.
com/elemental.
test.
ireland2/input/hls.
m3u8retries=40&retry_interval=2SpecifytheS3AccessKeyastheusernameandtheSecretAccessKeyasthepassword.
PROTOCOLSFORFILEINPUTSInputsthatarefileinputscanusetheHTTP,HTTPS,FTP,SFTP,SCP,AmazonS3andAsperaprotocols.
TheycanalsobestoredonlocalfilesorCIFSorNFSmountedfilesystems.
HLSinputcanbehandledasafileinputbyspecifyingHTTPorHTTPSastheprotocol.
PROTOCOLSFOROUTPUTSForinformationontheprotocolsandformatsforidentifyingthedestinationforoutputs,seetheindividualparametersineachoutputgrouptype.
ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary64/169INPUTNAMETYPERANGEDESCRIPTIONnamestringOptionalnameforinput.
Shouldbeauniqueidentifierperevent.
input_settingsInputSettingsdevice_input,network_input,router_input,file_inputInputsettings,mustbeoneofdevice_input,network_input,router_input,orfile_input.
Note:replaceinput_settingswiththetypeofinputsettingsyouareusingintheXMLtag(e.
g.
).
orderinteger>0Requiredformultipleinputs.
Specifiestheordertheinputshouldbelistedin.
program_idintegerSelectsaspecificprogramfromwithinamulti-programtransportstream.
Iftheprogramdoesntexist,thefirstprogramwithinthetransportstreamwillbeselectedbydefault.
Usethepreviewbuttontopopulatethelistofavailableprograms.
loop_sourcebooleantrueorfalseLoopinputifitisafile.
Thisallowsafileinputtobestreamedindefinitely.
hot_backup_pairbooleantrueorfalsePairstheinputwiththenextlistedinputtosimultaneouslyrunforredundancy,withonlyoneproducinganoutputatatime.
Failoverconditionsdictateinputswitching,andfailbackrulesdeterminewhentofailbackupontheresolution.
error_clear_timeintegerAtleast1secondlongerthanthelongestfailoverdurationWhenaHotBackupinputhasfailedover,thetimethresholdtobeerrorfreeofallfailoverconditionsbeforefailback.
failback_rulestringManually,Immediately,WhenNecessaryWhenaHotBackupinputhasbeenerrorfreefortheerrorcleartimeduration,thetimingforrestoringtheinputtoapublishingstate.
failover_conditionfailover_conditionInputfailoverconditionparameters.
filter_enablestringAuto,Disable,orForceTurnsonthefilterforthisinput.
MPEG-2inputshavethedeblockingfilterenabledbydefault.
1)Auto–filteringwillbeapplieddependingoninputtype/quality2)Disable–nofilteringwillbeappliedtotheinput3)Force–filteringwillbeappliedregardlessofinputtypefilter_strengthinteger1–5Adjuststhemagnitudeoffilteringfrom1to5,with1beingthenominalvalue.
deblock_selectedbooleantrueorfalseAllowthedeblockfilterwhenfiltering.
denoise_selectedbooleantrueorfalseAllowthedenoisefilterwhenfiltering.
no_psibooleantrueorfalseOnlyeffectivewithTransportStreaminputs.
CausestransportstreamdemuxtoscanallPIDsforaudioandvideoratherthanrelyingonPSIdata.
input_clippingInputClippingSpecifiesadditionalclippinginformation.
video_selectorVideoSelectorSpecifiesaparticularvideostreamwithinaninputsource.
Aninputmayhaveonlyasinglevideoselector.
audio_selectorAudioSelectorSpecifiesaparticularaudiostreamwithinaninputsource.
Aninputmayhavemultipleaudioselectors.
audio_selector_groupAudioSelectorGroupSpecifiessetofaudioselectorswithinaninputtocombine.
Aninputmayhavemultipleaudioselectorgroups.
SeeAudioSelectorGroupformoreinformation.
caption_selectorCaptionSelectorSpecifiesaparticularcaptionstreamwithinaninputsource.
Aninputmayhavemultiplecaptionselectors.
timecode_sourcestringembedded,zerobased,systemclock,systemclock_localSpecifiesthesourceoftimecodeassociatedwiththisinput.
UsedforInputClippingandinputbasedImageInsertion.
"Embedded"(embedded)willusethetruetimecodecarriedintheinput.
"Startat0"(zerobased)associates00:00:00:00withthefirstframeoftheinput.
"SystemClock"(systemclock)usesUTCtime.
"LocalSystemClock"(systemclock_local)usestheUTCtimeadjustedforthetimezonespecifiedonthehardwareunitwheretheeventisrunning.
ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary65/169NAMETYPERANGEDESCRIPTIONprefer_smpte2038booleanForaTScontainingTR01,specifieswhetherLiveshouldingestspecificdatafromaSMPTE-2038streamintheprogramorfromnon-SMPTE-2038"other"sources.
CommonexamplesofancillarydatathatLivecaningestarecaptions,embeddedtimecodes,andactiveformatdescriptors(AFD).
IfyourinputisaTS(transportstream)containingTR01,thenyoutypicallysetthisfieldtotrue(checked).
IfyourinputisaTSwithoutTR01orisnotaTS,thenthevalueofthefieldisnotimportant.
FormoreinformationonthisfieldandonTR01inatransportstream,gototheKBAsectionoftheUserCommunityandsearchforTSTR01DEVICEINPUTNAMETYPERANGEDESCRIPTIONdevice_idintegerdevice_typestringdevice_numberinteger1channelinteger1InputchannelofHD-SDIinputcard.
Currentlysupportschannel1.
channel_typestringHD-SDI,HD-2SI,ASI,HDMI,FECTheinputchanneltype.
device_channel_settingsDeviceChannelSettingsfec_settings,hdmi_settings,sdi_settingsDevicechannelsettingsrequiredbythespecifiedchanneltype.
Note:replacedevice_channelwiththechanneltypeyouareusingintheXMLtag.
ForHD-SDIorHD-2SIchanneltypes,thesettingstagmustbe"sdi_settings".
ASIchanneltypesdonotrequireasettingstag.
namestringTheuserspecifiedaliasforthegivendevice.
CanbeusedinRESTcallsinsteadofchannel,device_numberandchannel_typespecification.
device_namestringThehardwarespecifieduniquealiasforthegivendevice.
CanbeusedinRESTcallsinsteadofchannel,device_numberandchannel_typespecification.
FECSETTINGSNAMETYPERANGEDESCRIPTIONuristringValidURIURIofRTPorUDPinputtoingest.
Shouldcontainahostnameandport(Example:rtp://239.
255.
1.
10:5001).
Ports5000–5100areopenbydefaultontheElementalLivesystem.
udp_igmp_sourcestringIPaddressSourceaddressforSourceSpecificMulticaststreams.
HDMISETTINGSNAMETYPERANGEDESCRIPTIONinput_formatstringAuto,1080i5994,1080i60,1080i50,1080psf2398,1080psf24,1080p2398,1080p24,1080p25,1080p2997,1080p30,1080p50,1080p5994,1080p60,720p60,720p50,720p5994,NTSC,NTSC2398,NTSC16x9,PAL,andPAL16x9Inputvideoformat.
ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary66/169SDISETTINGSNAMETYPERANGEDESCRIPTIONinput_formatstringAuto,1080i5994,1080i60,1080i50,1080psf2398,1080psf24,1080p2398,1080p24,1080p25,1080p2997,1080p30,1080p50,1080p5994,1080p60,720p60,720p50,720p5994,NTSC,NTSC2398,NTSC16x9,PAL,andPAL16x9Inputvideoformat.
scte104_offsetinteger-120–120AtimingoffsetcanbeappliedintheSCTE-104applicationprocess.
ThevalueisthisfieldwillcausetheSCTE-104messagetobeappliedasifithadcomeinthespecifiednumberofframesearlierorlater.
Specifyzerotoapplymessagesatthenormaltime.
Specifyapositivenumbertoapplymessageslaterthanarrival,andanegativenumbertoapplymessagesearlierthanarrival.
Ifthepre-rolltimeissmallerthanthe(negative)offsetthenthemessagewillbeappliedassoonaspossible.
ROUTERINPUTNAMETYPERANGEDESCRIPTIONrouter_ipstringValidIPaddressIPaddressoftherouter.
router_typestringblackmagic_videohub,harris_panacea,miranda_nvisionDesignatestheroutertype.
router_settingsRouterSettingsharris_panacea_settings',miranda_nvision_settings'Routersettingsrequiredbythespecifiedroutertype.
Note:replacerouterwiththeroutertypeyouareusingintheXMLtag.
input_numberinteger>=1DesiredSDIinputfromtherouter.
input_number_endinteger>=1Currentlysetautomaticallytoinput_number+3whenquadissettotrue.
DesignatestheendoftheinputnumberrangewhenusingQuadrant4Kinput.
quadbooleanSetwhenusingQuadrant4K.
DeterminesinputrangeforHD-SDInumbers.
input_formatstringAuto,1080i5994,1080i60,1080i50,1080psf2398,1080psf24,1080p2398,1080p24,1080p25,1080p2997,1080p30,1080p50,1080p5994,1080p60,720p60,720p50,720p5994,NTSC,NTSC2398,NTSC16x9,PAL,andPAL16x9Inputvideoformat.
scte104_offsetinteger-120–120AtimingoffsetcanbeappliedintheSCTE-104applicationprocess.
ThevalueisthisfieldwillcausetheSCTE-104messagetobeappliedasifithadcomeinthespecifiednumberofframesearlierorlater.
Specifyzerotoapplymessagesatthenormaltime.
Specifyapositivenumbertoapplymessageslaterthanarrival,andanegativenumbertoapplymessagesearlierthanarrival.
Ifthepre-rolltimeissmallerthanthe(negative)offsetthenthemessagewillbeappliedassoonaspossible.
level_idintegerElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary67/169NETWORKINPUTNAMETYPERANGEDESCRIPTIONuristringValidURIURIofRTMP,UDP,HLSinputorRTPinputtoingest.
–ForUDPorRTP,specifyahostnameandport.
Example:udp://239.
255.
1.
10:5001.
Makesurethatportisopenonyourappliance.
–ForHLS,specifyhttporhttpsastheprotocolandspecifythelocationofthemanifest.
Forexample,https://203.
0.
113.
0/newschannel/anytownusa.
m3u8.
–ForRTMPinputsspecifyanaddressinthisformat:rtmp://localhost/live/streamname,where"live"isanexampleoftheapplicationnameand"streamname"istheapplicationinstance.
KeepinmindRTMPinputsarepushedtotheappliance.
InaConductorcluster,setupRTMPinputsontheprimaryandbackupnodes.
(ToingestMPTSoverRTP,usingtheRTPprotocol.
)usernamestringUsernameifcredentialsarerequiredtoaccessfile.
passwordstringPasswordifcredentialsarerequiredtoaccessfile.
check_server_certificatebooleantrueorfalseCheckHTTPSservercertificates.
Whendisabled,wewillstillcheckthecryptographyinthecertificate,butwewillnotvalidatetheserver'sname.
Certainsubdomains(notablyS3bucketsthatusedotsinthebucketname)donotstrictlymatchthecorrespondingcertificate'swildcardpatternandwouldotherwisecausetheeventtoerror.
Thissettingisignoredforotherprotocols.
interfacestringIPaddressornameOptionallyspecifythenetworkinterfacetouse.
CanbeenteredastheinterfaceIPaddress("10.
11.
12.
13")orasaninterfacename("eth2"or"bond0.
45").
Ifleftblank,thesystemroutingtablewillbeusedtoselectaninterface.
udp_igmp_sourcestringIPaddressorURL.
SourceaddressforSourceSpecificMulticaststreams.
quadbooleantrueorfalseConfigurestheprogram_idinto4quadrantstosupport4Kmulticastprograminputs.
enablefecdecodebooleanEnablesSMPTE2022-1andSMPTE2022-2(ProMPEG)FECreceptiononinputstream.
IfFECdataisnotreceived,inputwillfunction,butanerrorwillbelogged.
OnlycompatiblewithRTPinputs.
hls_input_settingsHLSInputSettingsSpecifiesanHLSnetworkinput.
FILEINPUTNAMETYPERANGEDESCRIPTIONuristringValidfilelocationFiletoingest.
MustbeaccessibletotheElementalLivesystem,eitheronthelocaldiskoraSMBmount.
Fileinputisdecodedinrealtimefortranscodingandstreaming.
hls_input_settingsHLSInputSettingsSpecifiesanHLSfileinput.
check_server_certificatebooleantrueorfalseCheckHTTPSservercertificates.
Whendisabled,wewillstillcheckthecryptographyinthecertificate,butwewillnotvalidatetheserver'sname.
Certainsubdomains(notablyS3bucketsthatusedotsinthebucketname)donotstrictlymatchthecorrespondingcertificate'swildcardpatternandwouldotherwisecausetheeventtoerror.
Thissettingisignoredforotherprotocols.
ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary68/169HLSINPUTSETTINGSNAMETYPERANGEDESCRIPTIONbandwidthinteger>=0ornilWhenspecifiedtheHLSstreamwiththem3u8BANDWIDTHthatmostcloselymatchesthisvaluewillbechosen,otherwisethehighestbandwidthstreaminthem3u8willbechosen.
Thebitrateisspecifiedinbitspersecond,asinanHLSmanifest.
retriesinteger>=0ornil(Default:10)Thenumberofconsecutivetimesthatattemptstoreadamanifestorsegmentmustfailbeforetheinputisconsideredunavailable.
retry_intervalinteger>=0ornil(Default:2)Thenumberofsecondsbetweenretrieswhenanattempttoreadamanifestorsegmentfails.
buffer_segmentsinteger>=0ornilWhenspecified,readingoftheHLSinputwillbeginthismanybuffersegmentsfromtheend(mostrecentlywrittensegment).
Whennotspecified,theHLSinputwillbeginwiththefirstsegmentspecifiedinthem3u8.
static_decryption_keystringEithernilorexactly32hexadecimalcharactersThe32-characterhexadecimalstaticdecryptionkeyfordecryptingHLSsegmentsthatareAES-128encrypted.
VIDEOSELECTORAvideoselectorallowsforfine-grainedcontrolofexactlywhatvideodataisextractedfromaninput.
NAMETYPERANGEDESCRIPTIONnamestringSelectorname.
Thisisusedtoattachselectorstoinputremixobjects.
Thisfieldisnotsaved,itisreplacedwithanidfieldoncesaved.
program_idintegerSelectsaspecificprogramfromwithinamulti-programtransportstream.
ForQuadrant4Kinputs,thisprogramcarriesthespecified1080pquadrantofthe2160p(4K)image.
Iftheprogramdoesn'texist,thefirstprogramwithinthetransportstreamwillbeselectedbydefault.
Usethepreviewbuttontopopulatethelistofavailableprograms.
piddecimalinteger>0SelectsaspecificPIDfromwithinavideosource(e.
g.
257selectsPID0*101).
color_spacestringfollow,rec_601,rec_709,sdr_2020,hdr10,hlg_2020Identifiesthecolorspaceoftheinput.
TypicallysettoFollow.
Chooseaspecificcolorspaceonlyifthecolorspaceis(orissometimes)missingfromtheinputorifthecolorspaceisintheinputbutyouknowitiswrong.
Alsoseeforce_color.
Select601toenabletransferfunctionandcolorgamutperITUBT.
601-7.
Select709toenabletransferfunctionandcolorgamutperITUBT.
709-6.
SelectSDR2020toenabletransferfunctionandcolorgamutperITUBT.
2020-2.
SelectHDR10toenablePQtransferfunctionandnon-constantluminancecolorgamutperITUBT.
2100-1.
SelectHLG2020toenableHLGtransferfunctionandnon-constantluminancecolorgamutperITUBT.
2100-1.
ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary69/169NAMETYPERANGEDESCRIPTIONforce_colorbooleanAppliesonlyifcolor_spaceisavalueotherthanFollow.
Thisfieldcontrolshowthevalueinthecolor_spacefieldandvaluesintheHDRMasterDisplayInformationfieldswillbeused.
Unchecked(false)meansthatwhentheinputdoesincludecolorspacedata,thatdatawillbeused,butwhentheinputhasnocolorspacedata,thevalueincolor_spacewillbeused.
Choosefalseifyourinputissometimesmissingcolorspacedata,butwhenitdoeshavecolorspacedata,thatdataiscorrect.
Checked(true)meanstoalwaysusethevalueincolor_space.
Choosetrueifyourinputusuallyhasnocolorspacedataormighthaveunreliablecolorspacedata.
Inbothcasesifyousetcolor_spacetoHDR10andyoudon'tconvertthecolorspaceintheoutput,thenmakesureyouentervalidvaluesintheHDRMasterDisplayInformationfields;thesevalueswillbeusedwhenthevaluesintheinputarenotused.
Makesuretoobtainvaluesusedinthecolorgradingprocessfortheinput;youcannotusethedefaultsornullvaluesandexpecttoobtainvalidcolorresults.
default_afdinteger0–15ThisfourbitAFDvaluewillbeappliedtoframeswhichhavenoAFDvalue.
Thiswillonlyaffectvideostreamswhichhave'respondtoafd'setto'passthrough'or'respond'AUDIOSELECTORAnaudioselectorallowsforfine-grainedcontrolofexactlywhataudiodataisextractedfromaninput.
NAMETYPERANGEDESCRIPTIONnamestringSelectorname.
Thisisusedtoattachselectorstoinputremixobjects.
Thisfieldisnotsaved,itisreplacedwithanidfieldoncesaved.
orderinteger>0Requiredwhenaninputhasmultipleaudioselectors.
TheorderisimportantwhenmergingaudiosourcesusinganAudioSelectorGroupsinceitdeterminestheorderofchannelsintheresultingoutput.
default_selectionbooleantrueorfalseWhenanAudioDescriptionspecifiesanaudiosourceandnomatchingAudioSelectororAudioSelectorGroupisfoundintheinput,thentheaudioselectormarkedas"default"willbeused.
Ifnonearemarkedasdefault,silencewillbeinsertedforthedurationoftheinput.
selector_typestringpid,track,language_codeSpecifiesthetypeoftheaudioselector.
piddecimalinteger>0SelectsaspecificPIDfromwithinanaudiosource(e.
g.
257selectsPID0*101).
trackstringCommaseparatedstringofintegers>0(Default:firstEnglishtrackorfirsttrackifnonearemarkedEnglish).
IdentifythechannelpairtoincludeinthisselectorbyenteringthetrackIDofthepair.
Eachpairofaudiochannelsismappedtoonetrack(channels1and2=track1,channels3and4=track2,andsoon).
Tocombineseveralchannelpairs,enteracomma-separatedlistoftracks,e.
g.
"1,2,3"fortracks1-3(channels1-6).
Toselectonlyonemonochannelfromapair,youmustselectthepair(thetrack)andaudioremixtomutetheunwantedmonochannel.
offsetintegerintegerMillisecondstooffsettheaudiofromthevideo.
0meansnooffset.
Apositivenumbershiftsthetimestampoftheaudiolaterintimerelativetothetimestampofthevideo.
Anegativenumbershiftsitearlierrelativetothetimestampofthevideo.
Fornon-filevideoinputs,therangeis-49toinfinite.
Forafilevideoinput,therearenorangerestrictions.
strict_language_selectionbooleantrueoffalseWhencheckedthetransportstreamdemuxstrictlyidentifiesaudiostreamsbytheirlanguagedescriptor.
IfaPMTupdateoccurssuchthatanaudiostreammatchingtheinitiallyselectedlanguageisnolongerpresentthenmutewillbeencodeduntilthelanguagereturns.
IfnotcheckedthenonaPMTupdatethedemuxwillchooseanotheraudiostreamintheprogramwiththesamestreamtypeifitcan'tfindonewiththesamelanguage.
ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary70/169NAMETYPERANGEDESCRIPTIONstrict_pid_optionstringSystemwilllookforthespecifiedPIDbeforeeventstart.
Ifabsent,PIDmustbepresentininputwillpreventtheeventfromstarting,andPIDmaybemissingfrominputallowstheeventtostartwithmutedaudiofortheselector.
unwrap_smpte337booleanfalseortrueWhenchecked,SMPTE-337-wrappedDolby-EaudiostreamsintheselectorwillbeunwrappedanddecodedbytheDolbydecoder.
Ifunchecked,suchstreamswillbetreatedasrawPCMaudio.
AUDIOSELECTORGROUPAnaudioselectorgroupisusedtospecifyasetofaudiodatasourceswithinaninputthatwillbecombined.
Eachaudioselectorgroupmustbegivenaname,andeveryaudioselectorwithinagroupmustsharethesameoffsetvalue.
Multipleaudioselectorscanbeincludedinagroupbyspecifyingmultipleaudio_selector_names.
Agroup'scombinedaudiocanthenbeusedinanyAudioDescriptionbyspecifyingthegroupnameintheaudio_source_name.
NAMETYPERANGEDESCRIPTIONnamestringnon-emptystringAnameforthegroupingofaudioselectors.
ThenameisusedwhenspecifyinganaudiosourceinanAudioDescription.
audio_selector_namestringnon-emptystringNameofanAudioSelectorwithinthesameinputtoincludeinthegroup.
Audioselectornamesarestandardized,basedontheirorderwithintheinput(e.
g.
"AudioSelector1").
Theaudio_selector_nameparametercanberepeatedtoaddanynumberofaudioselectorstothegroup.
CAPTIONSELECTORACaptionSelectorisusedtoextractaspecifictypeofcaptiondatafromasingleinput.
WhenCaptionSelectorsaredefinedintheinputs,aCaptionDescriptioncanthenspecifyacaption_source_nameinordertoextractspecificcaptiondataacrossmultipleinputs.
EachinputmustcontainthesamenumberofCaptionSelectors,andaspecialNullCaptionSelectorcanbeusedtoskipextractionfromaninput.
NAMETYPERANGEDESCRIPTIONsource_typestringEmbedded,SCTE-20,SCC,Teletext,DVB-Sub,Ancillary,ARIB,TTML,SCTE-27,STL,SRT,SMI,NullSelectthestyleofthecaptions.
Youmustspecifythestyle:thedecodercannotauto-detectthecaptionstyle.
Seetheinformationon"SupportedCaptionFormats–InputandOutput"intheWorkingwithCaptionsguideontheElementalUserCommunity.
https://community.
elementaltechnologies.
com/docs/DOC-1125source_settingsSourceSettingsancillary_source_settings,embedded_source_settings,file_source_settings,teletext_source_settings,dvb_sub_source_settings,scte27_source_settingsSpecificsettingsrequiredbythespecificsourcetype.
Note:replacesourcewiththesourcetypeyouareusingintheXMLtag.
IfusingSCCsource_type,thenusethefile_source_settings.
orderinteger>0Requiredwhenaninputhasmultiplecaptionselectors.
ANCILLARYSOURCESETTINGSNAMETYPERANGEDESCRIPTIONsource_ancillary_channel_numberinteger1to4Specifiesthe608channelnumberintheancillarydatatrackfromwhichtoextractcaptions.
Unusedforpassthrough.
ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary71/169EMBEDDEDSOURCESETTINGSNAMETYPERANGEDESCRIPTIONsource_608_track_numberinteger1Specifiesthevideotrackindexusedforextractingcaptions.
Thesystemonlysupportsoneinputvideotrack,sothisshouldalwaysbesetto'1'.
source_608_channel_numberinteger1–4Specifiesthe608/708channelnumberwithinthevideotrackfromwhichtoextractcaptions.
Unusedforpassthrough.
upconvert_608_to_708booleantrueorfalseIftrue,608dataisbothpassedthroughviathe"608compatibilitybytes"fieldsofthe708wrapperaswellastranslatedinto708.
708datapresentinthesourcecontentwillbediscarded.
autodetect_scte20booleantrueorfalseChecktohandlestreamswithintermittentand/ornon-alignedSCTE-20andEmbeddedcaptions.
FILESOURCESETTINGSNAMETYPERANGEDESCRIPTIONsource_fileLocationExternalcaptionfileusedforloadingcaptions.
Acceptedfileextensionsarescc,ttml,dfxp,stl,srt,andsmi.
time_deltaintegerSpecifiesatimedeltainsecondstooffsetthecaptionsfromthesourcefile.
upconvert_608_to_708booleantrueorfalseIftrue,608dataisbothpassedthroughviathe"608compatibilitybytes"fieldsofthe708wrapperaswellastranslatedinto708.
708datapresentinthesourcecontentwillbediscarded.
TELETEXTSOURCESETTINGSNAMETYPERANGEDESCRIPTIONpage_number100to8FFSpecifiestheteletextpagenumberwithinthedatastreamfromwhichtoextractcaptions.
Mustbeathree-digithexadecimalstring.
Unusedforpassthrough.
smpte_2031trueorfalseWhenchecked,OP-47inSMPTE2031isusedasinputcaption.
Whennotchecked,OP-47isused.
OptionavailableforSDI,orfornetwork/filesourceswhen"PreferSMPTE2038"isselectedembedded_caption_delayinteger0to3000Specifiesatimeinmillisecondstodelaythecaptionsfromthesourcevideo.
OnlyappliestoSDIinputs.
DVBSUBSOURCESETTINGSNAMETYPERANGEDESCRIPTIONpiddecimalinteger>0WhenusingDVB-SubwithBurn-InorSMPTE-TT,usethisPIDforthesourcecontent.
UnusedforDVB-Subpassthrough.
AllDVB-Subcontentispassedthrough,regardlessofselectors.
ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary72/169SCTE-27SOURCESETTINGSNAMETYPERANGEDESCRIPTIONpiddecimalinteger>0Thespecificlanguagetoextractfromthesource:SpecifyPIDandLanguage:ExtractscaptionsfromthatPID;thelanguageis"informational".
SpecifyPIDandomitLanguage:ExtractsthespecifiedPID.
OmitPIDandspecifyLanguage:Extractsthespecifiedlanguage,whicheverPIDthathappenstobe.
OmitPIDandomitLanguage:ValidonlyifsourceisDVB-Subthatisbeingpassedthrough;alllanguageswillbepassedthrough.
INPUTCLIPPINGNAMETYPERANGEDESCRIPTIONstart_timecodestringvalidtimecodeSpecifiesthetimecodeatwhichvideoprocessingshouldbegin.
ThegivenvalueisinterpretedusingthetimecodesourceconfiguredfortheLiveevent,whichshouldbesettoeitherembeddedorzero-basedwhenusinginputclipping.
TimecodevaluesmustbeoftheformatNN:NN:NN:NN,andareinterpretedashours:minutes:seconds:frames.
Anoptionalsuffixcanbeprovided,specifyingthebaseframeratethetimecodeisrelativeto.
Whenabaseframerateisspecified,Livenormalizesthegiventimecodefromthatbasetotheinput'sframerate.
Asampletimecodeincludingtheoptionalsuffixis01:02:03:04/59.
94.
Suffixvaluesarerestrictedtothefollowingset{23.
976,24,25,29.
97,30,50,59.
94,60}.
Thestart_timecodefield'ssuffixtakesprecedenceovertheend_timecodefield'ssuffix.
Whennoend_timecodeisspecified,Liveprocessallframesfromtheconfiguredstart_timecodetotheendofthemedia.
end_timecodestringvalidtimecodeSpecifiesthetimecodeatwhichvideoprocessingshouldend.
ThegivenvalueisinterpretedusingthetimecodesourceconfiguredfortheLiveevent,whichshouldbesettoeitherembeddedorzero-basedwhenusinginputclipping.
TimecodevaluesmustbeoftheformatNN:NN:NN:NN,andareinterpretedashours:minutes:seconds:frames.
Anoptionalsuffixcanbeprovided,specifyingthebaseframeratethetimecodeisrelativeto.
Whenabaseframerateisspecified,Livenormalizesthegiventimecodefromthatbasetotheinput'sframerate.
Asampletimecodeincludingtheoptionalsuffixis01:02:03:04/59.
94.
Suffixvaluesarerestrictedtothefollowingset{23.
976,24,25,29.
97,30,50,59.
94,60}.
Thestart_timecodefield'ssuffixtakesprecedenceovertheend_timecodefield'ssuffix.
Whennostart_timecodeisspecified,Livewillprocessallframesfromthebeginningofthemediatotheconfiguredend_timecode.
IMAGEINSERTERTheimageinserteroverlaysa32-bitWindowsBMP,PNGorTGAfileontheoutputvideo.
Theresolutionoftheimagetobeinsertedmustbesmallerthantheoutputresolution.
WhenusingPhotoshoptooutput32bit.
bmpfiles,besuretosetittooutputthealphachannel.
That'swhatkeepsthelogofromappearinginsideablackorwhitebox.
Anexampleimagecanbefoundin/opt/elemental_se/web/public/example_files/Elemental_logo.
png.
NAMETYPERANGEDESCRIPTIONenable_restbooleantrueorfalseIndicatesthatRESTcommandswillbeusedtosendimageinsertioncommands.
Ifused,nootherfieldsareneeded.
insertable_imageInsertableImageImagetoinsert.
Mustbe32bitwindowsBMP,PNG,orTGAfile.
Mustnotbelargerthantheoutputframes.
ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary73/169INSERTABLEIMAGENAMETYPERANGEDESCRIPTIONimage_inserter_inputLocationImagetoinsert.
Mustbe32bitwindowsBMP,PNGorTGA.
Mustnotbelargerthantheoutputframes.
layerinteger0–7TheZorderoftheinsertedimage.
Imageswithhighervaluesoflayerwillbeinsertedontopofimageswithlowervaluesoflayer.
image_xintegerPlacementofimageonthehorizontalaxisinpixels.
0istheleftedgeoftheframe.
RequiredforBMP,PNGandTGAinput.
image_yintegerPlacementofimageontheverticalaxisinpixels.
0isthetopedgeoftheframe.
RequiredforBMP,PNGandTGAinput.
opacityinteger0–100(Default:50)Opacityofimage.
0istransparent.
100isfullyopaque.
RequiredforBMP,PNGandTGAinput.
widthintegerThewidthoftheimagewheninsertedinthevideo.
Leaveblanktousethenativewidthoftheimage.
heightintegerTheheightoftheimagewheninsertedinthevideo.
Leaveblanktousethenativeheightoftheimage.
start_timestringThestarttimefortheimage.
Maybeintimecode(HH:MM:SS:FF)orISO8601UTCTimestamp(20150102T030405.
678Z)format.
durationintegerThetimeinmillisecondsfortheimagetoremaininthevideo.
fade_inintegerThetimeinmillisecondsfortheimagetofadein.
fade_outintegerThetimeinmillisecondsfortheimagetofadeout.
TIMECODECONFIGNAMETYPERANGEDESCRIPTIONsourcestringembedded,systemclock,systemclock_local,zerobased,specifiedstart,referenceIdentifiesthesourceofthetimethatwillbeassociatedwiththeevent.
Timeintheeventrunsonaclock(notonatimer).
Regardlessofthesource,thetimewillbein24-hourformathh:mm:ss:ffandwillrolloveratmidnight.
Embedded(embedded):Usethetimecodeinthesourcevideo.
Ifnoembeddedtimecodeisdetectedinthesource,thesystemfallsbacktousing"Startat0"(zerobased).
SystemClock(systemclock):UsetheUTCtime.
LocalSystemClock(systemclock_local):UsetheUTCtime,adjustedforthetimezonespecifiedonthehardwareunitwhereElementalLiveisrunning.
Startat0(zerobased):Thetimeofthefirstframeoftheeventwillbe00:00:00:00.
SpecifiedStart(specifiedstart):Thetimeofthefirstframeoftheeventwillbethetimespecifiedinthestartparameter.
ExternalReferenceConnector(reference):UsethetimeintheexternalLTCsource.
ChoosethisoptiononlyifyouareusingSDIasaninputsourceandhaveatimecodesourceconnectedtoyourAJAcard.
IfthereismorethanoneAJAcardonthehardwareunit,thefirstcardisused.
startstringvalidtimecodeDeterminesstartingtimecodewhensourcehasvaluespecifiedstart.
ThetimecodemustbeoftheformatNN:NN:NN:NNwithvalueshour:minute:second:frame.
Ifananchorvalueispresent,thenthestartisusedinconjunctionwiththeanchortocalculateaninitialtimecodefortheoutput.
Ifnoanchorvalueispresent,thenthestartisusedastheinitialtimecodefortheoutput.
Startingtimecodeisalsousedforinputclipping.
anchorstringvalidtimecodeDeterminestimecodeofframeusedforanchoring.
Thatframe(oninput)willhavethesametimecodeonoutput,evenifrateconversionisineffect.
Ifsourceisspecifiedstart,thenthatisassumedtothetimecodeofthefirstinputframe.
Ifsourceiszerobased,thenthetimecodeofthefirstinputframewillbeassumedtobe00:00:00:00.
Ifsourceisembedded,thenthetimecodevalueonthefirstinputframewillbeused.
require_initial_timecodebooleanEventwon'tstartiftimecodesourceislostatthestarttime.
ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary74/169NAMETYPERANGEDESCRIPTIONoverride_timecode_datebooleantrueorfalseWhenchecked,usetimestamp_offsettoindicatethedesireddate(aswellasthetime)inthoseoutputs,suchasHLS,thatsupportprogramdates(datestamps).
Whenunchecked,usetheencodedateastheprogramdate.
sync_thresholdinteger1–1000000ornilThresholdinframesbeyondwhichoutputtimecodeisresynchronizedtotheinputtimecode.
Discrepanciesbelowthisthresholdarepermittedtoavoidunnecessarydiscontinuitiesintheoutputtimecode.
Notimecodesyncwhenthisisnotspecified.
Ifjamsyncisalsodefined,discrepanciesbeyondthisthresholdwouldnotcauseresyncbutonlytriggeralerts.
jam_sync_enablebooleanWhenchecked,timecodeisonlysyncedattimewindowspecifiedbyJamSyncTimecode.
jam_sync_timecodestringvalidtimecodeSpecifiesthetimeofdayatwhichajamsyncisexpected.
ThetimemustbeoftheformatNN:NN:NN:NNwithvalueshour:minute:second:frame.
Duringthejamsyncwindow,ifthedifferenceisgreaterthan1frameandlessthan15framesthenadiscontinuitywillbeintroducedintotheoutputtimecodetoresynchronizeitwiththeinputtimecode.
Jamsyncdoesnothappenifnovalueprovided.
NIELSENCONFIGURATIONNAMETYPERANGEDESCRIPTIONenabledbooleanEnablesNielsenPCMtoID3taggingdistributor_idstringDistributionID.
EntertheDistributionIDassignedtoyourorganizationbyNielsenFAILOVERCONDITIONNAMETYPERANGEDESCRIPTIONorderintegerOptionalparameterusedtodefineorderoffailoverconditions.
Useifyouwishtoexplicitlyspecifytheorder,otherwisenaturalorderwillbeused.
descriptionstringaudio_silence,continuity_counter_error,fec_input_correction,input_loss,rtp_packet_loss,transport_error_indicator,video_loss,video_black,video_freezeThetypeofconditiontopromptafailover.
durationintegerinputloss>100;videoloss>500;audio_silence>=1000;video_black>1000;video_freeze>1000Theamountoftimeinmillisecondsforafailoverconditiontoexistpriortofailover.
Theminimumtimefortheinputlossconditionis100ms.
Theminimumtimeforthevideolossconditionis500ms.
Theminimumtimefortheaudiosilenceconditionis1000ms.
Theminimumtimeforthevideoblackconditionis1000ms.
Theminimumtimeforthevideofreezeconditionis1000ms.
ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary75/169NAMETYPERANGEDESCRIPTIONthresholdfloat0.
0to1.
0Adecimalvalueintherange[0.
0,1.
0].
Thisvalueisusedtocalculateapixeldifferencethresholdforblackandfreezedetection.
ForBlackdetectionthebrightestpixelmustbebelowthethresholdfortheinputtobeinthe"black"state.
ForFreezedetectionthelargestcorrespondingpixeldifferencebetweentwoframesmustbelowerthanthethresholdtobeinthe"frozen"state.
BlackDetectExample:SDI10-bitvideoinput(0*000to0*3FF),Blackdetectthresholdsetto0.
1(pixelvalueof102.
3=102).
Allpixelscomeinatvalue0*040(64decimal),sothethresholdistriggered.
FrozenDetectExample:SDI10-bitvideoinput(0*000to0*3FF),Frozendetectthresholdsetto0.
01(pixeldifferencevalueof10.
23=10).
Thelargestframetoframepixeldifferencesareapproximately532,sothethresholdisNOTtriggered.
Atalaterpoint,theSDIinputtrulyfreezes,andthelargestframetoframepixeldifferencefallsto0.
Theconditionisnowtriggered.
selector_orderAudioSelector>0Specifiesaparticularaudiostreamwithinaninputsource.
Aninputmayhavemultipleaudioselectors.
error_secondsinteger1-3600Thenumberofoccurrencesofoneormoreofthiserrortypeinasecondacross"WindowSeconds"timeperiod.
window_secondsinteger1-3600ThetimeperiodacrosswhichthenumberofErrorSecondsoccurstodetermineifthefailoverconditionhasbeenmet.
FAILURERULENAMETYPERANGEDESCRIPTIONpriorityinteger1–100(Default:50)FailoverpriorityforthisLiveEvent.
Higherprioritywillfillavailablenodesfirst.
100ishighestpriority.
backup_rule'all','none',abackupgroupname,node_id,or[node_id,device_id]NodesorBackupGroupinaConductorclustertobeusedasbackupforthisLiveEvent.
Nodesshouldhavethesameinputsforproperfailover.
restart_on_failurebooleantrueorfalseRestartthisLiveEventautomaticallyifithasanerror.
Forinstance,ifaconnectiontoaCDNtimesoutaftertheallottedretries.
backoff_timeinteger30secondsNumberofsecondstowaituntilrestarting.
Thisismultipliedbythenumberofpreviousfailurestopreventrapidrestarts.
max_failuresinteger3Maximumnumberoftimestorestartonfailure.
PROCESSORSNOTIFICATIONNotificationobjectsallowElementalLivetonotifyauserviaemailoranautomatedworkflowsystembyHTTPPOSTofthestatusofaLiveEvent.
NAMETYPERANGEDESCRIPTIONemailstringAlistofvalidemailaddresses,commaseparatedEmailaddress(es)tosendnotifications.
web_callback_urlstringAvalidHTTPURLURLtocallfornotifications.
LiveEventstatusXMLwillbePOSTedtothisaddresswhentheselectedeventsoccur.
on_startedbooleantrueorfalseSendnotificationwhenLiveEventstarts.
on_completebooleantrueorfalseSendnotificationwhenLiveEventisstopped.
on_errorbooleantrueorfalseSendnotificationwhenLiveEventencountersanerror.
on_warningbooleantrueorfalseSendnotificationwhenLiveEventencountersawarning.
ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary76/169NAMETYPERANGEDESCRIPTIONon_alertbooleantrueorfalseSendnotificationwhenanalertoccurswhileLiveEventisrunning.
Forexample,whenanoutputstreamdropsbelowrealtimeanalertwillbeissued.
on_clearbooleantrueorfalseSendnotificationwhenanalertiscleared.
PRE-PROCESSNAMETYPERANGEDESCRIPTIONscriptLocationScripttorunbeforeLiveEventstarts.
POST-PROCESSNAMETYPERANGEDESCRIPTIONscriptLocationScripttorunaftertheLiveEventcompletes.
TIMINGNAMETYPERANGEDESCRIPTIONstart_typestringstart_at,manualIndicateswhetherthistiminghasascheduledstartpoint,orwillbestartedmanually.
Ifmanual,anend_typeofend_atordurationmustbeset.
start_atdatetimeDateandtimetostart.
Thisvalueisrequiredifstart_typeissettostart_at.
end_typestringend_at,duration,manualIndicateswhetherthistiminghasascheduledendpointornot.
Iftheend_typeissettoend_at(using"On"fromtheinterface),thentheend_atparameterisrequired.
Iftheend_typeissettoduration(using"After"fromtheinterface),thenthedurationparameterisrequired.
end_atdatetimeDateandtimetoend.
Thisvalueisrequiredifend_typeissettoend_at.
durationinteger>0Thenumberofminutestoremainactive.
Thisvalueisrequiredifend_typeissettoduration,andwillmanuallycalculatetheend_atparametergiventhestart_atparameter.
AVAILBLANKINGNAMETYPERANGEDESCRIPTIONenabledbooleantrueorfalseIndicatesvideo,audioandcaptionswillbeblankedwheninsertionmetadataisadded.
avail_blanking_imageLocationBlankingimagetobeused.
Leaveemptyforsolidblack.
Onlybmpandpngimagesaresupported.
BLACKOUTSLATENAMETYPERANGEDESCRIPTIONenabledbooleantrueorfalseIndicatesvideo,audioandcaptionswillbeblankedwhenindicatedbyprogrammetadata.
blackout_slate_imageLocationBlackoutslateimagetobeused.
Leaveemptyforsolidblack.
Onlybmpandpngimagesaresupported.
ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary77/169NAMETYPERANGEDESCRIPTIONenable_network_end_blackoutbooleantrueorfalseEnablingthiscausestheencodertoblackoutthevideo,audio,andcaptions,andraisethe"NetworkBlackoutImage"slatewhenanSCTE104/35NetworkEndSegmentationDescriptorisencountered.
TheblackoutwillbeliftedwhentheNetworkStartSegmentationDescriptorisencountered.
TheNetworkEndandNetworkStartdescriptorsmustcontainanetworkIDthatmatchesthevalueenteredin"NetworkID".
network_idstringnilProvidesNetworkIDthatmatchesEIDRIDformat(e.
g.
,"10.
XXXX/XXXX-XXXX-XXXX-XXXX-XXXX-C").
network_end_blackout_imagestringnilPathtolocalfiletouseasNetworkEndBlackoutimage.
Imagewillbescaledtofilltheentireoutputraster.
ESAMNAMETYPERANGEDESCRIPTIONscc_uriLocationURLoftheSignalConditionerendpoint.
ifused,shouldcontainaURL.
Usedtoprocesssignalconditioninginformation,whichiswhenandwheretoinsertIDR's.
alternate_scc_uriLocationURLofanAlternateSignalConditionerendpoint.
OnlyusediftheprimarySignalConditionerendpointisnotavailable.
mcc_uriLocationURLoftheManifestConditionerendpoint.
ifused,shouldcontainaURL.
Usedtoprocessmanifestconditioninginformation,whichishowtomanipulatethemanifest(onlyappliestoHLSoutputs).
Ifempty,nomanifestmanipulationisperformed.
alternate_mcc_uriLocationURLofanAlternateManifestConditionerendpoint.
OnlyusediftheprimaryManifestConditionerendpointisnotavailable.
acquisition_point_idstringAsystem-wideuniquestringidentifyingthetranscoder/packagerataspecificsiteonaspecificchannel/networkfeed.
asset_uri_idstringAnidentifieroftheassetbeingprocessedthatispassedtotheSignalConditioneraspartoftheUriProcessingRequestmessage.
response_signal_prerollinteger0–30000SpecifiesthestreamdistancebetweentheplacementofPOISsuppliedSCTE35messagesandthesplicepointsthattheyreferto.
Ifthereisinsufficientnotificationtimetohonortheentirepre-roll,thentheSCTE35messagewillbeplacedimmediately.
OUTPUTLOCKINGNAMETYPERANGEDESCRIPTIONenabledbooleantrueorfalseIndicatesLiveEventwillbeenabledforoutputlockingwithanotherencoder.
epoch_lockingstringdisabledorenabledThisfeatureisawaytoguaranteethatmultipleeventscanproducevideooutputsthatareframe-accuratewitheachother.
protocolstringmulticastorunicastThisfeatureisawaytoguaranteethatmultipleeventscanproducevideooutputsthatareframe-accuratewitheachother.
Forthisfeaturetowork,alltheeventsmustcommunicatewitheachotherviaanetworkaddress.
Specifywhethertheaddressismulticast(inwhichcaseyoucanlockanynumberofevents)orunicast(inwhichcaseyoucanlocktogetheronlytwoevents).
ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary78/169XDSMANIPULATIONIndicatesXDSManipulationwillbeenabled.
NAMETYPERANGEDESCRIPTIONenabledbooleantrueorfalsevchip_actionstringPassthrough,Rewrite,Insert,StripContentAdvisoryaction.
vchip_byte1stringCharacter1valueoftheContentAdvisory,asperCEA-608Line2.
1DataServices,section9.
5.
1.
5Type=0*05.
Entryshouldbeanintegerbyteinhexadecimal.
vchip_byte2stringCharacter2valueoftheContentAdvisory,asperCEA-608Line2.
1DataServices,section9.
5.
1.
5Type=0*05.
Entryshouldbeanintegerbyteinhexadecimal.
copy_protection_actionstringPassthrough,Rewrite,Insert,StripCopyandRedistributionControlPacketaction.
copy_protection_byte1stringCharacter1valueoftheCGMS-AservicesandAnalogProtectionServices(APS),asperCEA-608Line2.
1DataServices,section9.
5.
1.
8Type=0*05.
Entryshouldbeanintegerbyteinhexadecimal.
copy_protection_byte2stringCharacter2valueoftheCGMS-AservicesandAnalogProtectionServices(APS),asperCEA-608Line2.
1DataServices,section9.
5.
1.
8Type=0*05.
Entryshouldbeanintegerbyteinhexadecimal.
IMAGEINSERTERTheimageinserteroverlaysa32-bitWindowsBMP,PNGorTGAfileontheoutputvideo.
Theresolutionoftheimagetobeinsertedmustbesmallerthantheoutputresolution.
WhenusingPhotoshoptooutput32bit.
bmpfiles,besuretosetittooutputthealphachannel.
That'swhatkeepsthelogofromappearinginsideablackorwhitebox.
Anexampleimagecanbefoundin/opt/elemental_se/web/public/example_files/Elemental_logo.
png.
NAMETYPERANGEDESCRIPTIONenable_restbooleantrueorfalseIndicatesthatRESTcommandswillbeusedtosendimageinsertioncommands.
Ifused,nootherfieldsareneeded.
insertable_imageInsertableImageImagetoinsert.
Mustbe32bitwindowsBMP,PNG,orTGAfile.
Mustnotbelargerthantheoutputframes.
INSERTABLEIMAGENAMETYPERANGEDESCRIPTIONimage_inserter_inputLocationImagetoinsert.
Mustbe32bitwindowsBMP,PNGorTGA.
Mustnotbelargerthantheoutputframes.
layerinteger0–7TheZorderoftheinsertedimage.
Imageswithhighervaluesoflayerwillbeinsertedontopofimageswithlowervaluesoflayer.
image_xintegerPlacementofimageonthehorizontalaxisinpixels.
0istheleftedgeoftheframe.
RequiredforBMP,PNGandTGAinput.
image_yintegerPlacementofimageontheverticalaxisinpixels.
0isthetopedgeoftheframe.
RequiredforBMP,PNGandTGAinput.
opacityinteger0–100(Default:50)Opacityofimage.
0istransparent.
100isfullyopaque.
RequiredforBMP,PNGandTGAinput.
widthintegerThewidthoftheimagewheninsertedinthevideo.
Leaveblanktousethenativewidthoftheimage.
heightintegerTheheightoftheimagewheninsertedinthevideo.
Leaveblanktousethenativeheightoftheimage.
ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary79/169NAMETYPERANGEDESCRIPTIONstart_timestringThestarttimefortheimage.
Maybeintimecode(HH:MM:SS:FF)orISO8601UTCTimestamp(20150102T030405.
678Z)format.
durationintegerThetimeinmillisecondsfortheimagetoremaininthevideo.
fade_inintegerThetimeinmillisecondsfortheimagetofadein.
fade_outintegerThetimeinmillisecondsfortheimagetofadeout.
MOTIONIMAGEINSERTERAMotionImageInserterimplementsaprocessingstagethatconsumespicturesfromaFIFOandproducespicturesintoadownstreamFIFOafteroptionallymergingthepicturewithmultiplegraphicslayers.
WhenusingREST,youcanomitallfields.
NAMETYPERANGEDESCRIPTIONinsertion_modestringmov,png,swfMOV,PNGorSWF.
motion_image_inserter_inputMotionImageInserterInputMotionimage/imagesequencetoinsert.
MustbeMOV,PNGorSWF.
image_xintegerXoffsettoplaceimage,fromtop-leftcornerofvideo.
Incompatiblewithfull_frame,requiredotherwise.
image_yintegerYoffsettoplaceimage,fromtop-leftcornerofvideo.
Incompatiblewithfull_frame,requiredotherwise.
enable_restbooleantrueorfalseIndicatesthatRESTcommandswillbeusedtosendimageinsertioncommands.
Ifused,nootherfieldsareneeded.
CannotbesetviaREST.
loop_inputbooleantrueorfalseRepeatplaybackofinputorplayonlyonce.
activebooleantrueorfalsefull_framebooleantrueorfalseExpandtofitframe.
Preservesaspectratioofimages.
framerate_numeratorintegerRequiredwithPNGmode.
Framerateratiomustbebetween1and120.
framerate_denominatorintegerRequiredwithPNGmode.
Framerateratiomustbebetween1and120.
action_timestringMaybeintimecode(HH:MM:SS:FF)orISO8601UTCTimestamp(20150101T120000.
1283)format,nodashesorcolons.
Leaveoutorleaveemptyforimmediateactivation.
durationintegerThetimeinmillisecondsfortheimagetoremaininthevideo.
Ifleftblank,thedurationofthefileisused.
swf_argumentsstringSWFargumentsinsimpleJSONname/valueformatOUTPUTGROUPNAMETYPERANGEDESCRIPTIONtypestringarchive_group_settings,apple_live_group_settings,ms_smooth_group_settings,rtmp_group_settings,udp_group_settings,reliable_ts_group_settings,dash_iso_group_settingsOutputgroupsettingstype–definesthetypeofthisoutputgroup.
namestringorderinteger>0Requiredformultipleoutputgroups.
Specifiestheordertheoutputgroupsshouldbelistedin.
output_group_settingsGroupSettingsarchive_group_settings,apple_live_group_settings,dash_iso_group_settings,ms_smooth_group_settings,rtmp_group_settings,udp_group_settings,reliable_ts_group_settingsOutputgrouptype-specificsettings.
Note:replaceoutput_groupwiththegrouptypeyouareusingintheXMLtag.
ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary80/169NAMETYPERANGEDESCRIPTIONoutputOutputOutputsettings.
Therecanbemultipleoutputswithinagroup.
externaloutputExternalOutputExternaloutputsareoutputssourcedfromanexternallocation.
Canbeusedtodefinebackupstreamsinmeta.
m3u8playlist.
OnlyvalidforAppleHLSoutputgroupswithgenerate_meta_fileenabled.
custom_namestringCustomgroupnametobedefinedbyuser.
Onlyletters,numbersandtheunderscorecharacterallowed;only16charactersallowed.
ARCHIVEGROUPSETTINGSNAMETYPERANGEDESCRIPTIONdestinationLocationAdirectoryandbasefilenamewherearchivefilesshouldbewritten.
DestinationURIfieldsacceptFormatIdentifiers.
IfthebasefilenameportionoftheURIisleftblank,thebasefilenameofthefirstinputwillbeautomaticallyinserted.
SeeUriTypesforsupportedprotocols.
rollover_intervalinteger>1Numberofsecondstowritetoarchivefilebeforeclosingandstartinganewone.
Leaveblanktodisablearchiverollover.
APPLELIVEGROUPSETTINGSNAMETYPERANGEDESCRIPTIONdestinationLocationAdirectoryorHTTPdestinationfortheHLSsegments,manifestfiles,andencryptionkeys(ifenabled).
ToenableHTTPPush,alsoselectan'HTTPPushDialect'optionbelow.
SeeUriTypesforsupportedprotocols.
IftheschemaisS3,queryparametersendpointandregionmaybeincludedtoexplicitlydefinetheS3endpointandregion.
interfacestringIPaddressornameOptionallyspecifythenetworkinterfacetouse.
CanbeenteredastheinterfaceIPaddress("10.
11.
12.
13")orasaninterfacename("eth2"or"bond0.
45").
Ifleftblank,thesystemroutingtablewillbeusedtoselectaninterface.
base_url_contentstringApartialURIprefixthatwillbeprependedtoeachoutputinthemedia.
m3u8file.
CanbeusedifbasemanifestisdeliveredfromadifferentURLthanthemain.
m3u8file.
base_url_manifeststringApartialURIprefixthatwillbeprependedtoeachoutputinthemedia.
m3u8file.
CanbeusedifbasemanifestisdeliveredfromadifferentURLthanthemain.
m3u8file.
segment_lengthinteger>=1(Default:10)LengthofMPEG-2TransportStreamsegmentstocreate(inseconds).
Notethatsegmentswillendonthenextkeyframeafterthisnumberofseconds,soactualsegmentlengthmaybelonger.
min_segment_lengthinteger0–segment_length(Default:0)Whenset,MinimumSegmentSizeisenforcedbylookingaheadandbackwithinthespecifiedrangeforanearbyavailandextendingthesegmentsizeifneeded.
floating_point_manifestbooleantrueorfalseIndicateswhethertheoutputmanifestshouldusefloatingpointvaluesforsegmentduration.
include_resolutionbooleantrueorfalseIncludeRESOLUTIONattributeforvideoinEXT-X-STREAM-INFtagofvariantmanifest.
compress_manifestsbooleantrueorfalseCompressesHLSplaylistwithgzipwhenenabled.
generate_meta_filebooleantrueorfalseGeneratesthe.
m3u8playlistfileforthisHLSoutputgroup.
Uncheckingthisoptionwilloutputsegmentswithoutthe.
m3u8file.
vod_modebooleantrueorfalseKeepsandindexesallsegmentsstartingwiththefirstsegment.
PlayerswillstartplaybackatthebeginningastheywouldwithVOD.
emit_single_filebooleantrueorfalseEmitsprogramasasinglemediaresource(.
ts)file,uses#EXT-X-BYTERANGEtagstoindexsegmentforplayback.
PlaybackofVODmodecontentduringeventisnotguaranteedduetoHTTPservercachingproblems.
ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary81/169NAMETYPERANGEDESCRIPTIONkeep_segmentsinteger>=1(Default:21)Numberofsegmentstoretaininthedestinationdirectory.
vod_modemustbefalseforthissettingtohaveaneffect.
index_n_segmentsinteger>=1(Default:10)Numberofsegmentstokeepintheplaylist(.
m3u8)file.
vod_modemustbefalseforthissettingtohaveaneffect,andthisnumbershouldbelessthanorequaltokeep_segments.
use_subdirectoriesbooleantrueorfalsePlacesegmentsinsubdirectories.
segments_per_subdirectoryinteger>=1Numberofsegmentstowritetoasubdirectorybeforestartinganewone.
use_subdirectoriesmustbetrueforthissettingtohaveaneffect.
insert_program_date_timebooleantrueorfalseInsertsEXT-X-PROGRAM-DATE-TIMEtagin.
m3u8manifestfiles.
Thevalueiscalculatedasfollows:eithertheprogramdateandtimeareinitializedusingtheinputtimecodesource,orthetimeisinitializedusingtheinputtimecodesourceandthedateisinitializedusingthetimestamp_offset.
timed_metadata_id3_periodintegerTimedMetadataintervalinseconds.
timed_metadata_id3_framestringNone,PRIV,TDRLIndicatesID3framethathasthetimecode.
program_date_time_periodinteger0–3600seconds(onehour)PeriodofinsertionofEXT-X-PROGRAM-DATE-TIMEentry,inseconds.
timestamp_delta_millisecondsintegerProvidesanextramilliseconddeltaoffsettofinetunethetimestamps.
cdnstringNone,Basic_PUT,Akamai,WebDAV,AWSElementalMediaStoreTypeofHTTPcommunicationtouseforpushingtooriginserver:1)None–notallowedforHTTPdestinations2)Basic_PUT–HTTPPUTwithnon-chunkedencoding.
Nodeletionofoldfilesandnocreationoffolders.
3)WebDAV–HTTPPUT,PROPFIND,MKCOL,DELETE.
ChunkedEncoding.
Createsfoldersasneededanddeletesoldfiles.
4)Akamai–compatibilitywithAkamaiCDNinputs.
5)AWSElementalMediaStore–HTTPSPUTwithnon-chunkedencoding.
Createsfoldersasneededanddeletesoldfiles.
EntertheAccessKeyIDintheUsernamefield.
EntertheSecretAccessKeyinthePasswordfield.
connection_retry_intervalinteger>=0(Default:2)NumberofsecondstowaitbeforeretryingconnectiontotheCDNiftheconnectionislost.
num_retriesinteger>=0(Default:10)NumberofretryattemptsthatwillbemadebeforetheLiveEventisputintoanerrorstate.
filecache_durationinteger0–600Sizeinsecondsoffilecacheforstreamingoutputs.
restart_delayinteger>=0(Default:15)Ifastreamingoutputfails,numberofsecondstowaituntilarestartisinitiated.
Avalueof0meansneverrestart.
tokenstringTokenparameterforauthenticatedAkamai.
Ifnotspecified,gdaisused.
saltstringSaltforauthenticatedAkamai.
log_uploadsbooleantrueorfalseLoguploadstoCDNinafilecalled/opt/elemental_se/web/log/job_/upload_.
csv.
ArowisgeneratedforeachfilePOST(created)andeachfileDELETE.
chunked_transferbooleantrueorfalseUsechunkedtransferencodingtoAkamaiorWebDAV.
UsershouldcontactAkamaitoenablethisfeature.
alternate_manifest_destinationAlternateManifestDestinationTheset-levelandstream-levelmanifestswillbeadditionallypushedtothislocation.
Filenameswillbeidenticaltothosepushedtotheprimarylocation.
Eachfilewillbepushedimmediatelyafterasuccessfulpushtotheprimarylocation.
Thisdestinationtype(Local,HTTP,etc.
)mustmatchtheprimarylocation.
Donotspecifyadestinationbasename.
Thelocationmustendwithatrailingforwardslash.
encryption_seedstringSpecifysometextthatwillbehashedtocreatethe128bitContentEncryptionKeyforthisoutput.
SynchronizingthistextinmultipleEventswillcausethesamekeytobegeneratedinbothEvents.
Thisisrecommendedpracticeforfailoverscenarios.
encryption_typestringAES-128,SAMPLE-AESEncryptsthesegmentswiththegivenencryptionscheme.
Leaveblanktodisable.
Selecting'Disabled'inthewebinterfacealsodisablesencryption.
ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary82/169NAMETYPERANGEDESCRIPTIONcaption_language_settingstringinsert,omit,noneAppliesonlyto608Embeddedoutputcaptions.
Insert:IncludeCLOSED-CAPTIONSlinesinthemanifest.
SpecifyatleastonelanguageintheCC1LanguageCodefield.
OneCLOSED-CAPTIONlineisaddedforeachLanguageCodeyouspecify.
Makesuretospecifythelanguagesintheorderinwhichtheyappearintheoriginalsource(ifthesourceisembeddedformat)ortheorderofthecaptionselectors(ifthesourceisotherthanembedded).
Otherwise,languagesinthemanifestwillnotmatchupproperlywiththeoutputcaptions.
None:IncludeCLOSED-CAPTIONS=NONElineinthemanifest.
Omit:OmitanyCLOSED-CAPTIONSlinefromthemanifest.
key_rotation_countinteger>=0(Default:3)Forusewithencryption_type.
TheAESencryptionkeywillrotateafterthismanysegments.
Setto0tousethesamekeythroughouttheentireencodingsession.
ThisparameterwillbeignoredwhenthekeyproviderisConaxorIrdeto.
show_ivbooleantrueorfalseForusewithencryption_type.
TheIV(InitializationVector)isa128-bitnumberusedinconjunctionwiththekeyforencryptingblocks.
Ifthissettingisenabled,IVislistedinthemanifest.
Ifdisabled,IVisnotlisted.
iv_follows_segment_numberbooleantrueorfalseForusewithencryption_type.
TheIV(InitializationVector)isa128-bitnumberusedinconjunctionwiththekeyforencryptingblocks.
Ifthissettingisenabled,itwillcausetheIVtochangeeverysegment(tomatchthesegmentnumber).
Ifthisissettofalse,youmustenteraconstant_ivvalue.
constant_ivhexadecimalstringForusewithencryption_type.
Thisisa128-bit,16-bytehexvaluerepresentedbya32-charactertextstring.
Ifiv_follows_segment_numberissettofalsethenthisparameterisrequiredandisusedastheIVforencryption.
key_provider_settingsKeyProviderSettingsself_generated_settings,static_key_settings,verimatrix_settings,secure_media_settings,irdeto_settings,conax_settings,generic_keyprovider_settings,piksel_settings,inside_secure_settings,one_mainstream_settings,cisco_settings,the_platform_settings,spekeKeyProvider-specificsettings.
key_formatstringidentity,com.
example.
fooIfleftempty'identity'isimplied.
AreverseDNSstringcanalsobegiven.
key_format_versionsstring1,1/2/3,1/3Eitherasinglepositiveintegerversionvalueoraslashdelimitedlistofversionvalues(1/2/3).
key_save_locationLocationThelocationwherekeyfileswillbesaved.
Valueisacceptedonlywhennokeyprovider(self-generated)isspecified.
key_prefixstringApartialURIprefixthatwillbeprependedtothekeyfilenamesintheoutputmanifest.
Theprefixshouldpointtothefinalpublishingdestinationforthekeys.
Valueisacceptedonlywhennokeyprovider(self-generated)isspecified.
ad_markersstringadobe,elemental,elemental-scte35,daterangeChooseoneormoreadmarkertypestopassSCTE35signalsthroughtothisgroupofAppleHLSoutputs.
disable_cachebooleantrueorfalseWhentrue,sets#EXT-X-ALLOW-CACHE:notag,whichpreventsclientfromsavingmediasegmentsforlaterreplay.
use_pantos_7_codecsbooleantrueorfalseWhentrue,usesRFC-6381insteadofthedefaultRFC-4281duringm3u8playlistgeneration.
policy_fileLocationAfilewhichcontainstherulesandrestrictionsthatdeterminehow,when,andwhereprotectedcontentcanbeviewedbyconsumers.
swf_identifiers_fileLocationSpecifiesafileofhashesofSWFplayersthatareapprovedplayersforthiscontent.
UsetheAdobeMediaServerwhitelisttooltogeneratethesefiles.
ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary83/169NAMETYPERANGEDESCRIPTIONon_input_lossstringemit_output,pause_outputSpecifieshowtheoutputshouldbehandledifinputislost.
PauseOutput(pause_output):FollowthebehaviorfortherepeatfieldintheInputLossBehaviorsetoffields.
Then,ifthattimeexpires,stopoutputforthisoutputgroup.
EmitContent(emit_output):Followthebehaviorcontrolledbytherepeat,black,andcolor/slatefieldsintheInputLossBehaviorsetoffields.
Withthisoption,Livecontinuestoproduceoutput.
MICROSOFTSMOOTHSTREAMINGGROUPSETTINGSNAMETYPERANGEDESCRIPTIONpublish_pointLocationAdirectoryandbasenametosaveasan.
ismvarchive.
Alternately,anHTTPdestinationforstreamingtoaSmoothpublishingpoint.
Ifthebasefilenameisleftblank,thebasefilenameofthefirstinputwillbeinserted.
check_server_certificatesbooleantrueortrueVerifythehttpscertificatechaintoatrustedCertificateAuthority(CA).
Thiswillcausehttpsoutputstoself-signedcertificatestofailunlessthosecertificatesaremanuallyaddedtotheOStrustedkeystore.
interfacestringIPaddressornameOptionallyspecifythenetworkinterfacetouse.
CanbeenteredastheinterfaceIPaddress("10.
11.
12.
13")orasaninterfacename("eth2"or"bond0.
45").
Ifleftblank,thesystemroutingtablewillbeusedtoselectaninterface.
fragment_lengthinteger>=1(Default:2)Lengthofmp4fragmentstogenerate(inseconds).
FragmentlengthmustbecompatiblewithGOPsizeandframerate.
connection_retry_intervalintegerDefault:2NumberofsecondstowaitbeforeretryingconnectiontotheIISserveriftheconnectionislost.
ContentwillbecachedduringthistimeandthecachewillbebedeliveredtotheIISserveroncetheconnectionisre-established.
num_retriesintegerDefault:10Numberofretryattempts.
use_event_idbooleantrueorfalseIftrue,thespecifiedorgeneratedeventIDwillbepassedtotheIISServer.
IffalseandthesameLiveEventisusedwithoutchangingthepublishingpoint,clientsmightseecachedvideofromthepreviousrun.
event_idstringEventIDtopasstotheIISserver.
Ifnotset,atimestampwillbeusedforthisvalue,sorestartswillnotreplaycachedcontent.
Ifset,contentwillbeappendedtothespecifiedeventidforthegivenpublishpointacrossLiveEventrestarts.
send_eosbooleantrueorfalseIftrue,theendofstreamsignalwillbesenttotheIISServerwhentheLiveEventstops.
Iffalse,theendofstreamsignalwillnotbesent.
send_stream_manifestbooleantrueorfalseSendstreammanifestsopublishingpointdoesn'tstartuntilallstreamsstart.
timestamp_offset_todaybooleanOffsetSmoothStreamingtimestampsfrommidnightonthedaytheLiveEventstarted.
NOTE:Thisfielddependsonthetimecode_passthroughparameterinindividualstreamsthatmakeupthisoutputgroup.
Whentimecode_passthroughisfalse,SmoothStreamingtimestampswillstartat0andthisparameterhasnoeffect.
Whentimecode_passthroughistrue,timestampswillstartattheLiveEvent'stimecodesourceinitialvalue.
Avalueofsystemclockisrecommendedfortimecodesource.
timestamp_offsetdateStartdatetooffsetSmoothStreamingtimestamps.
Onlyappliesiftimestamp_offset_todayisfalse.
NOTE:Thisfielddependsonthetimecode_passthroughparameterinindividualstreamsthatmakeupthisoutputgroup.
Whentimecode_passthroughisfalse,SmoothStreamingtimestampswillstartat0andthisparameterhasnoeffect.
Whentimecode_passthroughistrue,timestampswillstartattheLiveEvent'stimecodesourceinitialvalueplusthisoffset.
Avalueofsystemclockisrecommendedfortimecodesource.
timestamp_delta_secondsintegerAdditionalsecondsofoffsettobeaddedtothetimestamp_offsetdate.
ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary84/169NAMETYPERANGEDESCRIPTIONtimestamp_delta_millisecondsintegerAdditionalmillisecondsofoffsettobeaddedtothetimestamp_offsetdate.
enable_sparse_trackbooleannilUseincomingSCTE-35messagestogenerateasparsetrackinthisgroupofMS-Smoothoutputs.
acquisition_point_idstringnilThevalueofthe"AcquisitionPointIdentity"elementusedineachmessageplacedinthesparsetrack.
Onlyenabledif"EnableSparseTrack"ischecked.
collapse_identical_audio_streamsbooleanWhenchecked,audiostreamswiththesamesettingsareremovedfromallbutoneofthevideostreams.
drm_systemstringnilorplayreadyAvalueofplayreadyenablesMicrosoftPlayreadyDRM.
Playreadyrequireskey_idandeitherkey_seedorcontent_key.
encryption_typestringnilorAES-128-CTREncryptsthefragmentswiththegivenencryptionschemewhenusingMicrosoftPlayreadyDRM.
Onlyusedwhendrm_systemissettoplayready,andwhenplayreadyisenabledthedefaultisAES-128-CTR.
iv_sizeinteger64NumberofbitstouseintheIV.
initial_ivintegerDefault:1InitialvalueofIV.
key_idstringGUIDSpecifiesakeyIDtouseforPlayreadyDRM,mustbeavalidGUID.
key_seedstringbase64encodedContainsabase64-encodedkeyseed.
Onlyrequiredifcontent_keyisnotspecified.
content_keystringbase64encodedContainsabase64-encodedcontentkey.
Ifexists,key_seedisnotrequiredandignored.
license_urlstringContainstheURLforthelicenseacquisitionWebservice.
ui_license_urlstringContainstheURLforanon-silentlicenseacquisitionWebpage.
custom_attributesstringThecontentauthorcanaddarbitrarycustomattributesinsidethiselement.
Microsoftcodedoesnotactonanydatacontainedinsidethiselement.
filecache_durationinteger0–600Sizeinsecondsoffilecacheforstreamingoutputs.
restart_delayinteger>=0(Default:15)Numberofsecondsbeforeinitiatingarestartduetooutputfailure,duetoexhaustingthenum_retriesononesegment,orexceedingfilecache_duration.
log_uploadsbooleantrueorfalseLoguploadstoCDNinafilecalled/opt/elemental_se/web/log/job_/upload_.
csv.
ArowisgeneratedforeachfilePOST(created)andeachfileDELETE.
key_provider_settingsKeyProviderSettingsirdeto_settings,seachange_settings,conax_settings,piksel_settings,inside_secure_settingsKeyProvider-specificsettings.
send_delay_msinteger0.
.
10000Outputsthatare"outputlocked"canusethisdelay.
Assignadelaytotheoutputthatis"secondary".
Donotassignadelaytothe"primary"output.
Thedelaymeansthattheprimaryoutputwillalwaysreachthedownstreamsystembeforethesecondary,whichhelpsensurethatthedownstreamsystemalwaysusestheprimaryoutput.
(Iftherewerenodelay,thedownstreamsystemmightflip-flopbetweenwhicheveroutputhappenstoarrivefirst.
)Iftheprimaryfails,thedownstreamsystemwillswitchtothesecondaryoutput.
Whentheprimaryisrestarted,thedownstreamsystemwillswitchbacktotheprimary(becauseonceagainitisalwaysarrivingfirst)on_input_lossstringemit_output,pause_outputSpecifieshowtheoutputshouldbehandledifinputislost.
PauseOutput(pause_output):FollowthebehaviorfortherepeatfieldintheInputLossBehaviorsetoffields.
Then,ifthattimeexpires,stopoutputforthisoutputgroup.
EmitContent(emit_output):Followthebehaviorcontrolledbytherepeat,black,andcolor/slatefieldsintheInputLossBehaviorsetoffields.
Withthisoption,Livecontinuestoproduceoutput.
ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary85/169DASHISOGROUPSETTINGSNAMETYPERANGEDESCRIPTIONdestinationLocationAdirectoryorHTTPdestinationforDASHstreaming.
WhenMediaContentDestinationisspecified,onlyMPDandinitializationsegmentaresenthere.
SeeUriTypesforsupportedprotocols.
interfacestringIPaddressornameOptionallyspecifythenetworkinterfacetouse.
CanbeenteredastheinterfaceIPaddress("10.
11.
12.
13")orasaninterfacename("eth2"or"bond0.
45").
Ifleftblank,thesystemroutingtablewillbeusedtoselectaninterface.
fragment_lengthinteger>=1(Default:2)Lengthoffragmentstogenerate(inseconds).
FragmentlengthmustbecompatiblewithGOPsizeandFramerate.
Notethatfragmentswillendonthenextkeyframeafterthisnumberofseconds,soactualfragmentlengthmaybelonger.
segment_lengthinteger>=1(Default:30)Lengthofmpdsegmentstocreate(inseconds).
Notethatsegmentswillendonthenextkeyframeafterthisnumberofseconds,soactualsegmentlengthmaybelonger.
base_urlstringApartialURIprefixthatwillbeputinthemanifest(.
mpd)fileatthetoplevelBaseURLelement.
CanbeusedifstreamsaredeliveredfromadifferentURLthanthemanifestfile.
vod_modebooleantrueorfalseIfchecked,generatessingleoutputfilethatcontainsallsegments.
Ifnotchecked,generatesindividualfilesof'SegmentLength'anddeletessegmentsolderthan'KeepSegments'.
keep_segmentsinteger>=1(Default:21)Numberofsegmentstoretaininthedestinationdirectory.
vod_modemustbefalseforthissettingtohaveaneffect.
index_n_segmentsinteger>=1(Default:10)Numberofsegmentstokeepinthemanifest(.
mpd)file.
vod_modemustbefalseforthissettingtohaveaneffect,andthisnumbershouldbelessthanorequaltokeep_segments.
use_subdirectoriesbooleantrueorfalsePlacesegmentsinsubdirectories.
vod_modemustbefalseforthissettingtohaveaneffect.
segments_per_subdirectoryinteger>=1Numberofsegmentstowritetoasubdirectorybeforestartinganewone.
use_subdirectoriesmustbetrueforthissettingtohaveaneffect.
live_to_vodbooleanfalseortrueWhenliveeventends,convertthemanifest(.
mpd)filetoastatictypewithaneventduration.
vod_modemustbefalseforthissettingtohaveaneffect.
hbbtv_enabledbooleantrueorfalseSupportsHbbTVspecificationversion1.
5cdnstringNone,Akamai,Basic_PUT,WebDAV,AWSElementalMediaStoreTypeofHTTPcommunicationtouseforpushingtooriginserver:1)None–notallowedforHTTPdestinations2)Akamai–compatibilitywithAkamaiCDNinputs3)Basic_PUT–HTTPPUTwithnon-chunkedencoding.
Nodeletionofoldfilesandnocreationoffolders.
4)WebDAV–HTTPPUT,PROPFIND,MKCOL,DELETE.
ChunkedEncoding.
Createsfoldersasneededanddeletesoldfiles.
5)AWSElementalMediaStore–HTTPSPUTwithnon-chunkedencoding.
Createsfoldersasneededanddeletesoldfiles.
EntertheAccessKeyIDintheUsernamefield.
EntertheSecretAccessKeyinthePasswordfield.
connection_retry_intervalinteger>=0(Default:2)NumberofsecondstowaitbeforeretryingconnectiontotheCDNiftheconnectionislost.
num_retriesinteger>=0(Default:10)media_content_destinationLocationWhenspecified,mediasegmentsaresenttothisdestination,separatingfromMPDandinitializationsegment.
SeeUriTypesforsupportedprotocols.
ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary86/169NAMETYPERANGEDESCRIPTIONmedia_content_cdnstringNone,Akamai,Basic_PUT,WebDAV,AWSElementalMediaStoreTypeofHTTPcommunicationtouseforpushingtooriginserver:1)None–notallowedforHTTPdestinations2)Akamai–compatibilitywithAkamaiCDNinputs3)Basic_PUT–HTTPPUTwithnon-chunkedencoding.
Nodeletionofoldfilesandnocreationoffolders.
4)WebDAV–HTTPPUT,PROPFIND,MKCOL,DELETE.
ChunkedEncoding.
Createsfoldersasneededanddeletesoldfiles.
5)AWSElementalMediaStore–HTTPSPUTwithnon-chunkedencoding.
Createsfoldersasneededanddeletesoldfiles.
EntertheAccessKeyIDintheUsernamefield.
EntertheSecretAccessKeyinthePasswordfield.
media_content_connection_retry_intervalinteger>=0(Default:2)NumberofsecondstowaitbeforeretryingconnectiontotheCDNiftheconnectionislost.
media_content_num_retriesinteger>=0(Default:10)filecache_durationinteger0–600Sizeinsecondsoffilecacheforstreamingoutputs.
restart_delayinteger>=0Ifastreamingoutputfails,numberofsecondstowaituntilarestartisinitiated.
Avalueof0meansneverrestart.
log_uploadsbooleantrueorfalseLoguploadstoCDNinafilecalled/opt/elemental_se/web/log/job_/upload_.
csv.
ArowisgeneratedforeachfilePOST(created)andeachfileDELETE.
minimum_update_periodinteger>=0SmallestperiodbetweenpotentialchangestotheMPD.
min_buffer_timeinteger>=0Minimumtimeofinitiallybufferedmediathatisneededtoensuresmoothplayout.
suggested_presentation_delayinteger>0WhennotsetinUI,maximumof20sand2xSegmentLengthandminBufferTimeisused.
media_available_timedatetimeThisupdatesavailabilityStartTimetaginDASHMPD,indicatingthelivecontentwillbeavailableatthespecifiedtime.
Ifnotprovided,availabilityStartTimeissettotheearliestavailabilitytimeforthefirstmediasegment.
Formatisyyyy-MM-ddTHH:mm:ssZforUTC.
WhenZisnotincluded,timecodeinputistreatedaslocaltimeandconvertedtoUTC.
drm_systemstringnil,widevine,playready,ormultidrmSpecifiesDRMsystemusedforDASHoutputs.
Nonebydefault.
key_provider_settingsKeyProviderSettingspiksel_settings,generic_cenc_settings,playready_cenc_settings,speke_settingsKeyProvider-specificsettings.
ForDASHISO,thisisconstrainedbytheDRMSystemselection.
key_rotation_countintegerForusewithencryption_type.
TheAESencryptionkeywillrotateafterthismanysegments.
Setto0tousethesamekeythroughouttheentireencodingsession.
ThisparameterwillbeignoredwhenthekeyproviderisConaxorIrdeto.
ADOBERTMPGROUPSETTINGSNAMETYPERANGEDESCRIPTIONcdnstringNone,Akamai,Limelight,Level3,Edgecast,Internap,WowzaCDNtoauthenticateforthisgroupofAdobeRTMPoutputs.
cache_lengthinteger>=30Cachelength,inseconds,isusedtocalculatebuffersize.
restart_delayinteger>=0(Default:15)Ifastreamingoutputfails,numberofsecondstowaituntilarestartisinitiated.
Avalueof0meansneverrestart.
ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary87/169NAMETYPERANGEDESCRIPTIONdisconnect_immediatelybooleantrueorfalseControlsbehaviorwhencontentcachefillsup.
IfremoteoriginserverstallstheRTMPconnectionanddoesnotacceptcontentfastenoughthe'MediaCache'willfillup.
Whenthecachereachesthelengthspecifiedin'CacheLength'thecachewillstopacceptingnewcontent.
Ifthisboxischecked,theRTMPoutputwillforceadisconnect.
Clearthemediacache,andreconnectafter'RestartDelay'seconds.
Iftheboxisunchecked,theRTMPoutputwillwaitupto5minutestoallowtheoriginservertobeginacceptingdataagain.
ad_markersstringonAkamaiAdPod,onCuePoint,onCuePointMSec,onCuePointSCTE35,onUserDataEventChooseoneormoreadmarkertypestopassSCTE35signalsthroughtothisgroupofAdobeRTMPoutputs.
caption_datastringall,608_field1_and_field2,608_field1ControlsthetypesofdatathatpassestoOnCaptionoutputs.
Ifsetto'all'then608and708carriedDTVCCdatawillbepassed.
Ifsetto'608_field1_and_field2'thenDTVCCdatawillbestrippedout,but608datafrombothfieldswillbepassed.
Ifsetto'608_field1'thenonlythedatacarriedin608fromfield1videowillbepassed.
enable_oncuepoint_broadcast_timebooleantrueorfalseWhenenabledtheencoderwilltransmitanOnCuePointmessageevery5secondswithatimestampofthespecificencodingtime.
TheencodingtimeisdenotedinsecondssincetheUNIXEpoch(Jan1st,1970).
broadcast_time_offsetintegerOffsetinmillisecondstoapplytoenable_oncuepoint_broadcast_time.
onfi_timecode_frequencyinteger>=0(Default:1)onFItimecodeoutputfrequency.
MustbesettomultiplesofGOPsize.
Defaultis1xGOP.
0meansnoonFI.
UDPGROUPSETTINGSNAMETYPERANGEDESCRIPTIONnamestringUDPorRTPoutputgroupsrequireanameandnootherparameters;thisisaknownissuethatwillbeaddressedinafuturerelease.
on_input_lossstringdrop_program,drop_ts,emit_programSpecifieshowtheoutputshouldbehandledifinputislost.
StoptransmittingTS(drop_ts):Default.
FollowthebehaviorfortherepeatfieldintheInputLossBehaviorsetoffields.
Then,ifthattimeexpires,stopthetransportstream.
EmitContent(emit_program):Withthisoption,Livecontinuestoproduceoutput.
ThevideoPIDforthisprogramwillcontaincontentbasedonthebehaviorcontrolledbytherepeat,black,andcolor/slatefieldsintheInputLossBehaviorsetoffields.
TheaudioPIDwillconsistofsilence.
TherewillbenoPIDforthecaptions.
DropprogramfromTS(drop_program):FollowthebehaviorfortherepeatfieldintheInputLossBehaviorsetoffields.
Then,ifthattimeexpires,omitthisprogramfromthetransportstream.
OmitreferencetothisprogramfromthePAT.
OmitthePMTforthisprogram.
OmitthePIDsforthisprogram.
ThetransportstreamwillconsistofthePATandtheNULLPID.
csp_settingsCspSettingsTheStreamIDemittedintheCrossStreamingPreventionmessages.
timed_metadata_id3_periodintegerTimedMetadataintervalinseconds.
timed_metadata_id3_framestringNone,PRIV,TDRLIndicatesID3framethathasthetimecode.
RELIABLETSGROUPSETTINGSNAMETYPERANGEDESCRIPTIONnamestringAReliableTSoutputgrouprequiresaname.
ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary88/169NAMETYPERANGEDESCRIPTIONon_input_lossstringdrop_program,drop_ts,emit_programSpecifiesbehavioroflastresortwhenInputVideoislost,andnomorebackupinputsareavailable.
TheEntireTransportStreamcanbeshutdown,ortheprogramcanbedroppedfromthestream(andreplacedwithNullPacketstomeetTSbitraterequirement),orthelastgoodpicturecanberepeatedindefinitely.
CSPSETTINGSNAMETYPERANGEDESCRIPTIONstream_idstringTheStreamIDemittedintheCrossStreamingPreventionmessages.
AURIstringforsegmentation_upid().
Intervalinteger100–10000TheperiodbetweenCrossStreamPreventionmessageinsertions.
Unitsareinmilliseconds.
ALTERNATEMANIFESTDESTINATIONNAMETYPERANGEDESCRIPTIONdestinationLocationTheset-levelandstream-levelmanifestswillbeadditionallypushedtothislocation.
Filenameswillbeidenticaltothosepushedtotheprimarylocation.
Eachfilewillbepushedimmediatelyafterasuccessfulpushtotheprimarylocation.
Donotspecifyadestinationbasename.
Thelocationmustendwithatrailingforwardslash.
cdnstringNone,Basic_PUT,Akamai,WebDAV,AWSElementalMediaStoreTypeofHTTPcommunicationtouseforpushingtooriginserver:1)None–notallowedforHTTPdestinations2)Basic_PUT–HTTPPUTwithnon-chunkedencoding.
Nodeletionofoldfilesandnocreationoffolders.
3)WebDAV–HTTPPUT,PROPFIND,MKCOL,DELETE.
ChunkedEncoding.
Createsfoldersasneededanddeletesoldfiles.
4)Akamai–compatibilitywithAkamaiCDNinputs.
5)AWSElementalMediaStore–HTTPSPUTwithnon-chunkedencoding.
Createsfoldersasneededanddeletesoldfiles.
EntertheAccessKeyIDintheUsernamefield.
EntertheSecretAccessKeyinthePasswordfield.
connection_retry_intervalinteger>=0(Default:2)NumberofsecondstowaitbeforeretryingconnectiontotheCDNiftheconnectionislost.
num_retriesinteger>=0(Default:10)VERIMATRIXSETTINGSNAMETYPERANGEDESCRIPTIONresourceidstringVerimatrixResourceID.
verimatrix_serverLocationTheVerimatrixserverthatwillprovidethekeys.
reuse_last_keybooleantrueorfalseIfchecked,thestreamwillbeencryptedusingthelastkeyobtainedfromtheVerimatrixServerintheeventthatserverbecomesunreachable.
SECUREMEDIASETTINGSNAMETYPERANGEDESCRIPTIONresourceidinteger0–4294967295SecureMediaResourceID.
secure_media_serverLocationTheSecureMediaserverthatwillprovidethekeys.
reuse_last_keybooleantrueorfalseIfchecked,thestreamwillbeencryptedusingthelastkeyobtainedfromtheSecureMediaserverintheeventthattheserverbecomesunreachable.
ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary89/169IRDETOSETTINGSNAMETYPERANGEDESCRIPTIONservice_urlLocationURLwithlogincredentialsSpecifiestheLocationoftheIrdetoserver.
BothaURLandlogincredentialsarerequired.
account_idstringUsedtoidentifytheaccountontheIrdetoControlserver.
content_idstringUsedtoidentifythecontentinIrdetoControlsothatthecontentkeycanbeassociated.
content_keystringgenerate_new_keyoruse_last_keyDeterminesifanewkeyshouldbegeneratedatthestartofencodingoriftheencodingsessionshouldusethelastkey.
use_httpsbooleantrueorfalseSpecifieswhetherrequeststotheLicenseAcquisitionURLshoulduseHTTPSorbasicHTTP.
sub_content_typestringdefault,SSPlayReady,HLSPlayReadyorothercustomersupportedvalues.
Specifiesthesubcontenttypetobeassociatedwiththeoutputgroup.
use_rotating_keysbooleanprogram_identifierstringprogram_identifierLocationprogram_identifierLocationprogram_identifierLocationCONAXSETTINGSNAMETYPERANGEDESCRIPTIONserverLocationURLwithlogincredentialsSpecifiestheLocationoftheConaxServer.
BothaURLandlogincredentialsarerequired.
content_idstringUsedtoidentifythecontentontheConaxServer.
GENERICKEYPROVIDERSETTINGSNAMETYPERANGEDESCRIPTIONserverLocationSpecifiestheLocationoftheGenericKeyproviderserver.
AvalidURIisrequired.
Optionalusernameandpasswordareusedifthekeyproviderrequiresauthentication.
resourceidstringUsedbytheGenericKeyprovidertoidentifythecontent.
reuse_last_keybooleantrueorfalseIfchecked,thestreamwillbeencryptedusingthelastkeyobtainedfromthekeyproviderintheeventthatthekeyproviderbecomesunreachable.
STATICKEYSETTINGSNAMETYPERANGEDESCRIPTIONstatic_key_valuestringStaticKeyvalue.
keyprovider_serverLocationTheURLofthelicenseserverusedforprotectingcontent.
SELF-GENERATEDSETTINGSNAMETYPERANGEDESCRIPTIONcommon_keybooleantrueorfalseWhenenabled,generatesthesamekeyforeachoutputwithinthisoutputgroup.
ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary90/169NAMETYPERANGEDESCRIPTIONkey_prefixstringApartialURIprefixthatwillbeprependedtothekeyfilenamesintheoutputmanifest.
Theprefixshouldpointtothefinalpublishingdestinationforthekeys.
key_save_locationLocationThelocationwherekeyfileswillbesaved.
PIKSELSETTINGSNAMETYPERANGEDESCRIPTIONserverLocationSpecifiestheLocationofthePikselServer.
Optionalusernameandpasswordareusedifthekeyproviderrequiresauthentication.
content_idstringUsedtoidentifythecontentonthePikselServer.
INSIDESECURESETTINGSNAMETYPERANGEDESCRIPTIONkey_provisioning_serverLocationSpecifiestheLocationoftheInsideSecure(Authentec)KeyProvisioningserver.
la_serverLocationSpecifiesthelocationoftheLicenseAcquisitionserver.
ONEMAINSTREAMSETTINGSNAMETYPERANGEDESCRIPTIONchannel_secretstringStringusedtosignencryptionrequests.
Providedby1Mainstream.
content_idstringVideoid.
channel_codestringChannelcode.
base_urlLocationTheURLofthelicenseserverusedforprotectingcontent.
CISCOSETTINGSNAMETYPERANGEDESCRIPTIONkey_idstringExpectedtobeinGUIDformat.
key_seedstringExpectedtobebase64encoded.
la_urlLocationTheURLofthelicenseserverusedforprotectingcontent.
THEPLATFORMSETTINGSNAMETYPERANGEDESCRIPTIONserverstringThecontentkeyID.
key_valuestringThevalueoftheAES-128encryptionkey.
Specifiedinhexwithno0xprefix.
target_clientenuminside_secure,irdeto,microsoftTargetclient.
la_urlLocationThelicenseacquisitionURL.
ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary91/169SEACHANGESETTINGSNAMETYPERANGEDESCRIPTIONLicenseAcquisitionURLLocationTheURLofthelicenseserverusedforprotectingcontent.
KeyServerLocationClientCertificateLocationProvidethepathandfilenamefortheclientcertificate.
program_identifierstringOUTPUTAnoutputobjectdescribesthesettingsforasingleoutputfileorstreaminanoutputgroup.
NAMETYPERANGEDESCRIPTIONdescriptionstringDescription.
orderinteger>0Requiredformultipleoutputswithinanoutputgroup.
Specifiestheorderinwhichtheoutputshouldbelistedwithintheoutputgroup.
Outputsandexternaloutputsareorderedtogether.
stream_assembly_namestringNameofthestreamtoattachtothisoutput.
Thisfieldisnotsaved,itisreplacedwithanidfieldoncetheLiveEventissaved.
SeenamefieldinStreamAssembly.
name_modifierstringStringconcatenatedtotheendofthedestinationfilename.
OnlyapplicabletoArchive,AppleHLS,MSSmoothandDASHISOoutputs.
Requiredformultipleoutputsofthesametype.
AcceptsFormatIdentifiers.
ForDASHISOoutputs,iftheformatidentifiers$Number$or$Time$areusedinoneoutput,theymustbeusedacrossalloutputswithinthegroup.
extensionstringOutputfileextension.
Appliestoarchiveoutputs.
Ifempty,thiswillbeauto-selectedfromthecontainertype.
containerenummp4,f4v,raw,m2ts,m3u8,ismv,rtmp,mov,uvu,3gp,mxfContainerforthisoutput.
SeeContainersforsupportedoutputcontainers.
Canbeauto-detectedfromextensionfield.
Certaincontainersrequireacontainer_settingsobject.
Ifnotspecified,thedefaultobjectwillbecreated.
output_settingsOutputSettingsapple_live_settings,rtmp_settings,udp_settings,reliable_ts_settingsSpecificsettingsforthistypeofoutput.
RequiredforoutputswithinAdobeRTMP,UDPorReliableTSgroup.
container_settingsContainerSettingsmov_settings,uvu_settings,m2ts_settings,raw_settings,mp4_settings,f4v_settingsContainerspecificsettings.
Note:replacecontainerwiththecontaineryouareusingintheXMLtag(e.
g.
).
scte35_passthroughbooleantrueorfalseIftrue,passesanySCTE-35signalsfromtheinputsourcetothisoutput.
Onlyavailableforcertaincontainers.
ForHLSoutputsSCTE-35isautomaticallyenabledwhenadmarkersassociatedwiththeAppleHLSgroupareenabled.
insert_scte35_esambooleantrueorfalseIftrue,updateanySCTE-35signalsfromESAMPOIStothisoutput.
Onlyavailableform2tscontainers.
klv_passthroughbooleantrueorfalseIftrue,passesanyKLVdatafromtheinputsourcetothisoutput.
Onlyavailableforcertaincontainers.
ebif_passthroughbooleantrueorfalseIftrue,passesanyEBIFdatafromtheinputsourcetothisoutput.
Onlyavailableforcertaincontainers.
timed_metadata_passthroughbooleantrueorfalseEnablespassthroughoftimedmetadatafrominputtooutput.
nielsen_id3_passthroughbooleantrueorfalseIftrue,NielseninaudibletonesformediatrackingwillbedetectedintheinputaudioandanequivalentID3tagwillbeinsertedintheoutput.
Onlyavailableforcertaincontainers.
insert_timed_metadatabooleantrueorfalseIftrue,insertsID3timedmetadatafromthetimed_metadataRESTcommandintothisoutput.
Onlyavailableforcertaincontainers.
insert_private_metadatabooleantrueorfalseIftrue,insertsprivatemetadatafromtheprivate_metadataRESTcommandintothisoutput.
Onlyavailableforcertaincontainers.
start_pausedbooleantrueorfalseIftrue,outputwillstartinthepausedstate.
ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary92/169NAMETYPERANGEDESCRIPTIONlog_edit_pointsbooleantrueorfalseGeneratesanXMLfileinthelogdirectorywithinitialtimecode,timecodeofinputswitches,andfinaltimecode.
Thiscanbeusedtoforlatereditingofthisoutput.
arib_captions_passthroughbooleantrueorfalseIftrue,passesanyARIBCaptionsdatafromtheinputsourcetothisoutput.
Onlyavailableforcertaincontainersundercertainconditions.
insert_amf_metadatabooleanIftrue,insertsmetadatainAMFformatfromtheamf_metadataRESTcommandintoRTMPoutput,onspecifiedAdMarker.
write_hvc1_for_h265booleanIftrue,outputthatisH.
265willbemarkedasHVC1andadheretotheISO-IECJTC1-SC29_N13798_Text_ISOIEC_FDIS_14496-15_3rd_EspecwhichstatesthatparametersetNALunitswillbestoredinthesampleheadersbutnotinthesamplesdirectly.
Ifthisisunchecked,false,thenH.
265willbemarkedasHEV1andparametersetNALunitswillbewrittenintothesamples.
(ThisisignoredwhengeneratingDOlbyVisionoutput.
)APPLELIVESETTINGSNAMETYPERANGEDESCRIPTIONsegment_typestringTSorfMP4SpecifyifthisoutputshouldproduceTSorfMP4segments.
segment_modifierstringStringconcatenatedtoendofsegmentfilenames.
AcceptsFormatIdentifiers.
audio_only_imageLocationForusewithanaudioonlyStream.
Mustbea.
jpgor.
pngfile.
Ifgiven,thisimagewillbeusedasthecover-artfortheaudioonlyoutput.
Ideally,itshouldbeformattedforaniPhonescreenfortworeasons.
TheiPhonedoesnotresizetheimage,itcropsacenteredimageonthetop/bottomandleft/right.
Additionally,thisimagefilegetssavedbit-for-bitintoevery10-secondsegmentfile,sowillincreasebandwidthby{imagefilesize}*{segmentcount}*{usercount.
}.
audio_track_typestringalternate_audio_auto_select_default,alternate_audio_auto_select,alternate_audio_not_auto_select,audio_only_variant_streamFourtypesofaudio-onlytracksaresupported:Audio-OnlyVariantStreamTheclientcanplaybackthisaudio-onlystreaminsteadofvideoinlow-bandwidthscenarios.
RepresentedasanEXT-X-STREAM-INFintheHLSmanifest.
AlternateAudio,AutoSelect,DefaultAlternaterenditionthattheclientshouldtrytoplaybackbydefault.
RepresentedasanEXT-X-MEDIAintheHLSmanifestwithDEFAULT=YES,AUTOSELECT=YESAlternateAudio,AutoSelect,NotDefaultAlternaterenditionthattheclientmaytrytoplaybackbydefault.
RepresentedasanEXT-X-MEDIAintheHLSmanifestwithDEFAULT=NO,AUTOSELECT=YESAlternateAudio,notAutoSelectAlternaterenditionthattheclientwillnottrytoplaybackbydefault.
RepresentedasanEXT-X-MEDIAintheHLSmanifestwithDEFAULT=NO,AUTOSELECT=NOiframe_only_manifestsbooleantrueorfalseAddsI-FrameOnlyManifestinadditiontotheHLSmanifestaudio_rendition_setsstringListalltheaudiogroupsthatareusedwiththevideooutputstream.
InputalltheaudioGROUP-IDsthatareassociatedtothevideo,separateby','.
audio_group_idstringSpecifiesthegrouptowhichtheaudioRenditionbelongs.
ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary93/169MP4SETTINGSNAMETYPERANGEDESCRIPTIONmp4_major_brandstringOverridesthe"MajorBrand"fieldintheoutputfile.
Usuallynotnecessarytospecify.
include_cslgbooleantrueorfalseWhencheckedfilecompositiontimeswillstartatzero,compositiontimesinthe'ctts'(compositiontimetosample)boxforB-frameswillbenegative,anda'cslg'(compositionshiftleastgreatest)boxwillbeincludedper14496-1amendment1.
ThisimprovescompatibilitywithAppleplayersandtools.
insert_freeboxbooleantrueorfalseInsertsafree-spaceboximmediatelyafterthemoovboxADOBERTMPSETTINGSNAMETYPERANGEDESCRIPTIONrtmp_endpointLocationEndpointforFlashMediaServer.
ForconnectiontoAkamai,ausernameandpasswordmustbesuppliedinrtmp_endpoint.
EndpointURIfieldsacceptFormatIdentifiers.
stream_namestringStreamnameforFlashMediaServer.
AcceptsFormatIdentifiers.
connection_retry_intervalintegerDefault:2NumberofsecondstowaitbeforeretryingaconnectiontotheFlashMediaserveriftheconnectionislost.
num_retriesintegerDefault:10Numberofretryattempts.
UDPSETTINGSNAMETYPERANGEDESCRIPTIONdestinationLocationAppliesonlyifmpts_membershipisnoneorremote.
DestinationaddressandportnumberforTransportStreampackets.
Canbeunicastormulticast.
Ifmpts_membershipisnone,canbeUDPorRTP.
Ifmpts_membershipisremoteandsecondary_destinationwillnotbespecified,canbeUDPorRTP.
Ifmpts_membershipisremoteandsecondary_destinationwillbespecified,canonlybeRTP.
Forexample,udp://239.
10.
10.
10:5001orrtp://10.
100.
100.
100:5002.
secondary_destinationLocationAppliesonlyifmpts_membershipisnoneorremote.
AdditionaldestinationaddressandportnumberforTransportStreampackets.
Canbeunicastormulticast.
Ifmpts_membershipisnone,canbeUDPorRTP;Ifmpts_membershipisremote,canonlybeRTP.
Forexample,udp://239.
10.
10.
10:5001orrtp://10.
100.
100.
100:5002.
interfacestringIPaddressornameOptionallyspecifythenetworkinterfacetouse.
CanbeenteredastheinterfaceIPaddress("10.
11.
12.
13")orasaninterfacename("eth2"or"bond0.
45").
Ifleftblank,thesystemroutingtablewillbeusedtoselectaninterface.
buffer_msecinteger0–10000(10seconds)UDPoutputbufferinginmilliseconds.
Largervaluesincreaselatencythroughthetranscoderbutsimultaneouslyassistthetranscoderinmaintainingaconstant,low-jitterUDP/RTPoutputwhileaccommodatingclockrecovery,inputswitching,inputdisruptions,picturereordering,etc.
mpts_membershipstringNone,Local,RemoteSpecifiesthelocationofthemultiplexerusedwiththisencode.
If"None",nomultiplexingwilloccur.
If"Local"theonboardMPTSprocesswillbeusedandallcommunicationwillbeautomaticallyhandledonlocalinterfaces.
If"Remote",theLiveEncoderwillsenddatatoaremotemultiplexerusingthespecifiedaddresses.
ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary94/169NAMETYPERANGEDESCRIPTIONcomplexity_transmit_destinationstringMulticastdestinationforcomplexityestimatesfromencodertostatmux.
OnlyrequiredforusewithElementalStatmux(separatemultiplexer).
secondary_complexity_transmit_destinationstringOptional.
Additionalmulticastdestinationforcomplexityestimatesfromencodertostatmux.
OnlyrequiredforusewithElementalStatmux(separatemultiplexer).
MustbereceivedbythesamestatmuxasthePrimaryComplexityTransmitDestination.
Typicalusecaseistoenablemultiplenetworkpathredundancy(twointerfacesandtwoswitches)fromencodertostatmux.
allocation_receipt_destinationstringMulticastdestinationforbitrateallocationsfromstatmuxtoencoder.
OnlyrequiredforusewithElementalStatmux(separatemultiplexer).
secondary_allocation_receipt_destinationstringOptional.
Additionalmulticastdestinationforbitrateallocationsfromstatmuxtoencoder.
OnlyrequiredforusewithElementalStatmux(separatemultiplexer).
MustbereceivedbythesameencoderasthePrimaryBitrateAllocationDestination.
Typicalusecaseistoenablemultiplenetworkpathredundancy(twointerfacesandtwoswitches)fromstatmuxtoencoder.
max_ts_packet_countinteger1–7SetsthenumberofMPEGTSpacketstobesentineachIPpacket.
Lowervaluesslightlyreducelatency,atthecostofnetworkoverhead.
RELIABLETSSETTINGSNAMETYPERANGEDESCRIPTIONDeliveryProtocolstringmediaconnectorzixiIndicatesthetypeofReliableTSprotocoltocarrytheTransportStream.
Currentoptionsare'AWSElementalMediaConnect'and'Zixi'.
Destination/AmazonResourceNamestringDestinationspecificationforaReliableTransportStreamoutput.
ForanoutputoftypeAWSElementalMediaConnect,thedestinationisanAmazonResourceName(ARN).
Foranoutputoftypezixi,thedestinationisanIPaddress:portnumberandmuststartwiththeprefix:zixi://Forexample:zixi://10.
11.
42.
42:2088interfacestringIPaddressornameOptionallyspecifythenetworkinterfacetouse.
CanbeenteredastheinterfaceIPaddress("10.
11.
12.
13")orasaninterfacename("eth2"or"bond0.
45").
Ifleftblank,thesystemroutingtablewillbeusedtoselectaninterface.
FECOUTPUTSETTINGSNAMETYPERANGEDESCRIPTIONinclude_column_fecbooleantrueEnablescolumn-basedFEC;mustbeenabled.
include_row_fecbooleantrueorfalseEnablesrow-basedFEC;enabledbydefault.
column_depthinteger4-20ParameterDfromSMPTE2022-1.
TheheightoftheFECprotectionmatrix.
Thenumberoftransportstreampacketspercolumnerrorcorrectionpacket.
Mustbebetween4and20,inclusiverow_lengthinteger1-20ParameterLfromSMPTE2022-1.
ThewidthoftheFECprotectionmatrix.
Mustbebetween1and20,inclusive.
IfonlyColumnFECisused,thenlargervaluesincreaserobustness.
IfRowFECisused,thenthisisthenumberoftransportstreampacketsperrowerrorcorrectionpacket,andthevaluemustbebetween4and20inclusive.
ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary95/169MOVSETTINGSNAMETYPERANGEDESCRIPTIONreferencestringself_containedorexternalAvalueof'external'createsseparatemediafilesandthewrapperfile(.
mov)containsreferencestothesemediafiles.
Avalueof'self_contained'createsonlyawrapper(.
mov)fileandthisfilecontainsallofthemedia.
include_clapbooleantrueorfalseInclude'clap'atomifappropriateforthevideooutputsettings.
include_cslgbooleantrueorfalseWhencheckedfilecompositiontimeswillstartatzero,compositiontimesinthe'ctts'(compositiontimetosample)boxforB-frameswillbenegative,anda'cslg'(compositionshiftleastgreatest)boxwillbeincludedper14496-1amendment1.
ThisimprovescompatibilitywithAppleplayersandtools.
growing_referencebooleantrueorfalseIfcheckedtheQuicktimeexternalreferencefilewillbewrittenoutevery30seconds,withpointerstothemediafilecontentuptothatmoment.
Ifunchecked,noreferencefilewillbewrittenuntiltheEventcompletes.
EnablingthisfeatureallowsloadingthecontentintoanNLEprogramandtobeginusingitbeforetheEventcompletes.
OnlyvalidwithExternalreference.
write_xdcambooleanfalseortrueEnableXDCAMforAppleeditorsandplayers;Uncheckthisboxtosupportotherplayers.
omneon_paddingbooleantrueorfalseInsertOmneon-compatiblepaddingUVUSETTINGSNAMETYPERANGEDESCRIPTIONmetadatastringXMLformattedmetadata.
Anexternalfileofmetadatainformationcanalsobesuppliedbyspecifyingthefilelocationinsideofafilenode(e.
g.
/data/server/path/to/metadata.
xml).
apidstringApplicationIdentifierbase_locationstringBaseLocation,limitedto256characterspurchase_locationstringPurchaseLocation,limitedto256charactersencryptedbooleantrueorfalseIndicateswhethertheUltravioletoutputsshoulduseCFFCommonEncryption.
iv_sizeinteger64,128NumberofbitstouseintheIV.
video_content_keyhexadecimalstringThecontentkeytouseforvideoencryption.
Ifleftblank,acontentkeywillbeautogenerated.
video_key_idhexadecimalstringThekeyIDtouseforvideoencryption.
Ifleftblank,akeyIDwillbeautogenerated.
use_same_keysbooleanUsethesamecontentkeyandkeyidforbothaudioandvideo.
audio_content_keyhexadecimalstringThecontentkeytouseforaudioencryption.
Ifleftblank,acontentkeywillbeautogenerated.
audio_key_idhexadecimalstringThekeyIDtouseforaudioencryption.
Ifleftblank,akeyIDwillbeautogenerated.
content_keyhexadecimalstringIfspecified,thiscontentkeywillbeusedforbothvideoandaudioencryptionkey_idhexadecimalstringIfspecified,thiskeyIDwillbeusedforbothvideoandaudioencryption.
frame_heightinteger32–3112(Default:sourcevideoheight)Outputframeheight(inpixels).
Leaveblanktousesourcevideoheight.
frame_widthinteger32–4096(Default:sourcevideowidth)Outputframewidth(inpixels).
Leaveblanktousesourcevideowidth.
fragment_lengthfloat1–3.
003Lengthoffragmentstogenerate(inseconds).
FragmentlengthmustbecompatiblewithGOPsizeandframerate.
ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary96/169NAMETYPERANGEDESCRIPTIONkdf_templateLocationLocationofanexternalKeyDescriptionFile.
Ifnotspecified,thedefaultKDFtemplatelocatedat/opt/elemental_se/config/template-kdf.
xmlwillbeused.
UVUSETTINGSMETADATAFORMATThemetadatafieldacceptsanXMLstring.
Theacceptedfieldsaredocumentedbelow.
Thefollowingfieldsareautomaticallygenerated:ContentID:ContentidentifierAPID:ApplicationidentifierPublisher:PublisherReleaseYear:Yearofmediasrelease(Required)TitleDisplay19:Title,limitedto19charactersTitleDisplay60:Title,limitedto60charactersTitleSortable:SortabletitlekeywordsseparatedbycommasSummary190:Descriptionofmedia,limitedto190charactersDescriptionLanguage:LanguagecodeusedforthismetadataAdditionalsettingsavailable,butarenotrequiredare:ReleaseDate:Month,day,yearandtimeofrelease(timeisoptional)Summary400:Descriptionofmedia,limitedto400charactersCopyrightLine:DisplayablecopyrightlineWorkType:TypeofworkSequenceInfo:Sequenceinformation(requiredforsomeworktypes)Parent:Metadataforparentitems(requiredforsomeworktypes)AltIdentifier:OtheridentifiersforthiscontentRatingSet:ContentratingsetPictureColorType:PicturecolortypePictureFormat:PictureformatBaseLocation:Baselocation,limitedto256charactersPurchaseLocation:Purchaselocation,limitedto256charactersChapter[@index]:Chaptermarkeratthismanyseconds(indexisazero-basedattributecountingeachchapter)M2TSSETTINGSNAMETYPERANGEDESCRIPTIONbitrateintegerDefault:0Theoutputbitrateofthetransportstreaminbitspersecond.
Settingto0letsthemuxerautomaticallydeterminetheappropriatebitrate.
Othercommonvaluesare3750000,7500000,and15000000.
cc_in_pmtbooleantrueorfalseWhenenabled,generatescaption_service_descriptorinPMT.
program_numinteger0–65535(Default1)ThevalueoftheprogramnumberfieldintheProgramMapTable.
pat_intervalinteger0,10–1000(Default:100)Thenumberofmillisecondsbetweeninstancesofthistableintheoutputtransportstream.
pmt_intervalinteger0,10–1000(Default:100)Thenumberofmillisecondsbetweeninstancesofthistableintheoutputtransportstream.
pcr_every_pesbooleantrueorfalseWhentrue,aProgramClockReferencevalueisinsertedforeveryPacketizedElementaryStream(PES)header.
ThisparameteriseffectiveonlywhenthePCRPIDisthesameasthevideooraudioelementarystream.
pcr_periodinteger0–500MaximumtimeinmillisecondsbetweenProgramClockReferences(PCRs)insertedintothetransportstream.
transport_stream_idinteger0–65535ThevalueofthetransportstreamIDfieldintheProgramMapTable.
ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary97/169NAMETYPERANGEDESCRIPTIONuse_buffer_modelbooleantrueorfalseUsemultiplexbuffermodelforaccurateinterleaving.
Disablinguse_buffer_modelcanleadtolowerlatency,butlow-memorydevicesmaynotbeabletoplaybackthestreamwithoutinterruptions.
vbrbooleantrueorfalseWhentrue,doesnotinsertnullpacketsintotransportstreamtofillspecifiedbitrate.
Thebitratesettingactsasthemaximumbitratewhenvbrenabled.
iframe_onlybooleantrueorfalseWhentrue,outputonlykeyframeswhiledroppingallotherframes.
VBRmodewillbeenabledandBufferModelwillnotbeemployed.
dvbbooleantrueorfalseWhentrue,usesDVBbuffermodelforDolbyDigitalaudio.
Whenfalse,theATSCmodelisused.
use_atsc_stream_typebooleantrueorfalseWhenchecked,usesstreamtype=0*81forAC3andstreamtype=0*87forEAC3.
Otherwiseusesstreamtype=0*06.
null_packet_bitratefloat>=0Valueinbitspersecondofextranullpacketstoinsertintothetransportstream.
Thiscanbeusedifadownstreamencryptionsystemrequiresperiodicnullpackets.
audio_frames_per_pesinteger>=0(Default:2)ThenumberofaudioframestoinsertforeachPESpacket.
segmentation_timefloat>0Thelengthinsecondsofeachsegment.
Requiredunlessmarkersissettonone.
segmentation_stylestringmaintain_cadence,reset_cadenceThesegmentationstyleparametercontrolshowsegmentationmarkersareinsertedintothetransportstream.
Withavails,itispossiblethatsegmentsmaybetruncated,whichcaninfluencewherefuturesegmentationmarkersareinserted.
Whenasegmentationstyleof"reset_cadence"isselectedandasegmentistruncatedduetoanavail,wewillresetthesegmentationcadence.
Thismeansthesubsequentsegmentwillhaveadurationofof$segmentation_timeseconds.
Whenasegmentationstyleof"maintain_cadence"isselectedandasegmentistruncatedduetoanavail,wewillnotresetthesegmentationcadence.
Thismeansthesubsequentsegmentwilllikelybetruncatedaswell.
However,allsegmentsafterthatwillhaveadurationof$segmentation_timeseconds.
NotethatEBPlookaheadisaslightexceptiontothisrule.
fragment_timefloat>=0Thelengthinsecondsofeachfragment.
OnlyusedwithEBPmarkers.
segmentation_markersstringnone,rai_segstart,rai_adapt,psi_segstart,ebp,ebp_legacyInsertssegmentationmarkersateachsegmentation_timeperiod.
rai_segstartsetstheRandomAccessIndicatorbitintheadaptationfield.
rai_adaptsetstheRAIbitandaddsthecurrenttimecodeintheprivatedatabytes.
psi_segstartinsertsPATandPMTtablesatthestartofsegments.
ebpaddsEncoderBoundaryPointinformationtotheadaptationfieldasperOpenCablespecificationOC-SP-EBP-I01-130118.
ebp_legacyaddsEncoderBoundaryPointinformationtotheadaptationfieldusingalegacyproprietaryformat.
ebp_lookahead_msinteger0–10000millisecondsWhenset,enforcesthatEncoderBoundaryPointsdonotcomewithinthespecifiedtimeintervalofeachotherbylookingaheadatinputvideo.
IfanotherEBPisgoingtocomeinwithinthespecifiedtimeinterval,thecurrentEBPisnotemitted,andthesegmentis"stretched"tothenextmarker.
Thelookaheadvaluedoesnotaddlatencytothesystem.
TheLiveEventmustbeconfiguredelsewheretocreatesufficientlatencytomakethelookaheadaccurate.
ebp_on_audiobooleanControlsplacementofEBPonAudioPIDs.
Ifchecked,EBPmarkerswillbeplacedonthevideoPIDandallaudioPIDs.
Ifunchecked,EBPmarkerswillbeplacedononlythevideoPID.
fixed_ebp_audio_intervalbooleanWhenthisoptionischecked,audioEBPmarkerswillbeaddedtopartitions3and4.
Theintervalbetweentheseadditionalmarkerswillbefixed,andwillbeslightlyshorterthanthevideoEBPmarkerinterval.
OnlyavailablewhenEBPCablelabssegmentationmarkersareselected.
es_ratebooleantrueorfalseIncludetheESRatefieldinthePESheader.
aribbooleantrueorfalseEnablesARIB-compliantfieldmuxingandremovesvideodescriptor.
ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary98/169NAMETYPERANGEDESCRIPTIONdrop_absent_streamsbooleantrueorfalseWhenchecked(true)outputaudiostreamswillberemovedfromtheprogramiftheselectedinputaudiostreamisremovedfromtheinput.
Thisallowstheoutputaudioconfigurationtodynamicallychangebasedoninputconfiguration.
Ifthisboxisnotchecked(false),alloutputaudiostreamswilloutputencodedsilencewhennotconnectedtoanactiveinputstream.
dvb_nit_settingsDVBNetworkInformationTable(NIT)dvb_nit_settingsInsertsDVBNetworkInformationTable(NIT)atthespecifiedtablerepetitioninterval.
dvb_sdt_settingsDVBServiceDescriptionTable(SDT)dvb_sdt_settingsInsertsDVBServiceDescriptionTable(NIT)atthespecifiedtablerepetitioninterval.
dvb_tdt_settingsDVBTimeandDateTable(TDT)dvb_tdt_settingsInsertsDVBTimeandDateTable(TDT)atthespecifiedtablerepetitioninterval.
pmt_pidstring32–8182(Default:480)PacketIdentifier(PID)fortheProgramMapTable(PMT)inthetransportstream.
Canbeenteredasadecimalorhexadecimalvalue.
pcr_pidstring32–8182PacketIdentifier(PID)oftheProgramClockReference(PCR)inthetransportstream.
Whennovalueisgiven,theencoderwillassignthesamevalueastheVideoPID.
Canbeenteredasadecimalorhexadecimalvalue.
video_pidstring32–8182(Default:481)PacketIdentifier(PID)oftheelementaryvideostreaminthetransportstream.
Canbeenteredasadecimalorhexadecimalvalue.
audio_pidsstring32–8182(Default:482-498)PacketIdentifier(PID)oftheelementaryaudiostream(s)inthetransportstream.
Multiplevaluesareaccepted,andcanbeenteredinrangesand/orbycommaseparation.
Canbeenteredasdecimalorhexadecimalvalues.
dvb_teletext_pidstring32–8182(Default:499)PacketIdentifier(PID)forinputsourceDVBTeletextdatatothisoutput.
Canbeenteredasadecimalorhexadecimalvalue.
dvb_sub_pidsinteger32–8182(Default:460-479)PacketIdentifier(PID)forinputsourceDVBSubtitledatatothisoutput.
Multiplevaluesareaccepted,andcanbeenteredinrangesand/orbycommaseparation.
Canbeenteredasdecimalorhexadecimalvalues.
scte27_pidsstring32–8182(Default:450-459)PacketIdentifier(PID)forinputsourceSCTE-27datatothisoutput.
Multiplevaluesareaccepted,andcanbeenteredinrangesand/orbycommaseparation.
Canbeenteredasdecimalorhexadecimalvalues.
scte35_pidstring32–8182(Default:500)PacketIdentifier(PID)oftheSCTE-35streaminthetransportstream.
Canbeenteredasadecimalorhexadecimalvalue.
Enter"detect"tohavePIDdetectedfromtheinput.
scte35_esam_pidstring32–8182(Default:508)PacketIdentifier(PID)oftheSCTE-35streaminthetransportstreamgeneratedbytheESAMPOIS.
Canbeenteredasadecimalorhexadecimalvalue.
scte35_pullupinteger0–8000milliseconds(Default:0)Pre-rolldelayforSCTE-35insertioninmilliseconds.
Onlycompatiblewithnon-VBRSDIinputs.
Zeromeansnodelay.
klv_data_pidsstring32–8182(Default:501)PacketIdentifier(PID)forinputsourceKLVdatatothisoutput.
Multiplevaluesareaccepted,andcanbeenteredinrangesand/orbycommaseparation.
Canbeenteredasdecimalorhexadecimalvalues.
timed_metadata_pidstring32–8182(Default:502)PacketIdentifier(PID)ofthetimedmetadatastreaminthetransportstream.
Canbeenteredasadecimalorhexadecimalvalue.
private_metadata_pidstring32–8182(Default:503)PacketIdentifier(PID)oftheprivatemetadatastreaminthetransportstream.
Canbeenteredasadecimalorhexadecimalvalue.
etv_platform_pidstring32–8182(Default:504)PacketIdentifier(PID)forinputsourceETVPlatformdatatothisoutput.
Canbeenteredasadecimalorhexadecimalvalue.
etv_signal_pidstring32–8182(Default:505)PacketIdentifier(PID)forinputsourceETVSignaldatatothisoutput.
Canbeenteredasadecimalorhexadecimalvalue.
ecm_pidstring32–8182(Default:506)PacketIdentifier(PID)forECMinthetransportstream.
OnlyenabledwhenSimulcryptisenabled.
Canbeenteredasadecimalorhexadecimalvalue.
arib_captions_pidstring32–8182PacketIdentifier(PID)forARIBCaptionsinthetransportstream.
Canbeenteredasadecimalorhexadecimalvalue.
ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary99/169NAMETYPERANGEDESCRIPTIONzixi_latencyinteger0–16000millisecondsTheZixiMAXLATENCYvalue.
ThisdefinesthemaximumlatencyallowedbytheZixiprotocol.
zixi_streamidstringOptionalZixiStreamIDzixi_encryptionstringTheZixiEncryptionlevel.
Validvaluesare:NO_ENCRYPTION,AES-128,AES-192,AES-256zixi_keyvaluestringAZixiKeyValueisastringofhexadecimalvalueswhichcoincidewiththespecifiedZixiencryptionlevel.
Validvaluesforeachencryptiontypeareasfollows:AES-128:32characterstringof16hexadecimalbytesAES-192:48characterstringof24hexadecimalbytesAES-256:64characterstringof32hexadecimalbytesDVBNETWORKINFORMATIONTABLE(NIT)NAMETYPERANGEDESCRIPTIONrep_intervalinteger25–10000Thenumberofmillisecondsbetweeninstancesofthistableintheoutputtransportstream.
network_idinteger0–65535ThenumericvalueplacedintheNetworkInformationTable(NIT).
network_namestring1–256charactersThenetworknametextplacedinthenetwork_name_descriptorinsidetheNetworkInformationTable.
Maximumlengthis256characters.
DVBSERVICEDESCRIPTIONTABLE(SDT)NAMETYPERANGEDESCRIPTIONoutput_sdtstringsdt_follow,sdt_follow_if_present,sdt_manual,sdt_noneSelectsmethodofinsertingSDTinformationintooutputstream.
"FollowinputSDT"copiesSDTinformationfrominputstreamtooutputstream.
"FollowinputSDTifpresent"copiesSDTinformationfrominputstreamtooutputstreamifSDTinformationispresentintheinput,otherwiseitwillfallbackontheuser-definedvalues.
Enter"SDTManually"meansuserwillentertheSDTinformation.
"NoSDT"meansoutputstreamwillnotcontainSDTinformation.
rep_intervalinteger25–2000Thenumberofmillisecondsbetweeninstancesofthistableintheoutputtransportstream.
service_provider_namestring1–256charactersTheserviceprovidernameplacedintheservice_descriptorintheServiceDescriptionTable.
Maximumlengthis256characters.
service_namestring1–256charactersTheservicenameplacedintheservice_descriptorintheServiceDescriptionTable.
Maximumlengthis256characters.
DVBTIMEANDDATETABLE(SDT)NAMETYPERANGEDESCRIPTIONrep_intervalinteger1000–30000Thenumberofmillisecondsbetweeninstancesofthistableintheoutputtransportstream.
SIMULCRYPTAESSETTINGSNAMETYPERANGEDESCRIPTIONchannel_idinteger>=0IntegervaluefortheVerimatrixchannelID.
Required.
ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary100/169NAMETYPERANGEDESCRIPTIONecmgLocationHostnameorIPaddressforVeramatrixserver,withouttcpprotocoldetails,andanoptionalport.
Examples:tcp://12.
34.
56.
78:1234,tcp://12.
34.
56.
78,tcp://ecmg_host_name:1234,tcp://ecmg_host_namerecommended_cp_durationinteger>=0Desiredminimumcrypto-duration.
MaybeoverriddenbythelowerboundattheECMGserver.
M3U8SETTINGSNAMETYPERANGEDESCRIPTIONpmt_pidstring32–8182(Default:480)PacketIdentifier(PID)fortheProgramMapTable(PMT)inthetransportstream.
Canbeenteredasadecimalorhexadecimalvalue.
video_pidstring32–8182(Default:481)PacketIdentifier(PID)oftheelementaryvideostreaminthetransportstream.
Canbeenteredasadecimalorhexadecimalvalue.
audio_pidsstring32–8182(Default:482-498)PacketIdentifier(PID)oftheelementaryaudiostream(s)inthetransportstream.
Multiplevaluesareaccepted,andcanbeenteredinrangesand/orbycommaseparation.
Canbeenteredasdecimalorhexadecimalvalues.
scte35_pidstring32–8182(Default:500)PacketIdentifier(PID)oftheSCTE-35streaminthetransportstream.
Canbeenteredasadecimalorhexadecimalvalue.
timed_metadata_pidstring32–8182(Default:502)PacketIdentifier(PID)ofthetimedmetadatastreaminthetransportstream.
Canbeenteredasadecimalorhexadecimalvalue.
private_metadata_pidstring32–8182(Default:503)PacketIdentifier(PID)oftheprivatemetadatastreaminthetransportstream.
Canbeenteredasadecimalorhexadecimalvalue.
program_numinteger0–65535(Default1)ThevalueoftheprogramnumberfieldintheProgramMapTable.
pat_intervalinteger0,10–1000(Default:0)Thenumberofmillisecondsbetweeninstancesofthistableintheoutputtransportstream.
Avalueof"0"writesoutthePAToncepersegmentfile.
pmt_intervalinteger0,10–1000(Default:0)Thenumberofmillisecondsbetweeninstancesofthistableintheoutputtransportstream.
Avalueof"0"writesoutthePMToncepersegmentfile.
pcr_every_pesbooleantrueorfalseWhentrue,aProgramClockReferencevalueisinsertedforeveryPacketizedElementaryStream(PES)header.
ThisparameteriseffectiveonlywhenthePCRPIDisthesameasthevideooraudioelementarystream.
pcr_periodinteger0–500MaximumtimeinmillisecondsbetweenProgramClockReferences(PCRs)insertedintothetransportstream.
pcr_pidstring32–8182PacketIdentifier(PID)oftheProgramClockReference(PCR)inthetransportstream.
Whennovalueisgiven,theencoderwillassignthesamevalueastheVideoPID.
Canbeenteredasadecimalorhexadecimalvalue.
transport_stream_idinteger0–65535ThevalueofthetransportstreamIDfieldintheProgramMapTable.
audio_frames_per_pesinteger>=0(Default:4)ThenumberofaudioframestoinsertforeachPESpacket.
ecm_pidstringThePlatform-protectedtransportstreamsusing'microsoft'asTargetClientincludeanECMstream.
ThisECMstreamcontainsthesize,IV,andPTSofeverysampleinthetransportstream.
ThisstreamPIDisspecifiedhere.
ThisPIDhasnoeffectonnonThePlatform-protectedstreams.
EXTERNALOUTPUTSAllowsanoutputnotbeingproducedinthisoutputgrouptobeaddedtothevariantplaylist.
Canbeusedtogeneratean.
m3u8playlistwithbackupstreamsfromanexternalencoder,ortosharestreamsbetweenmultipleoutputgroups.
NAMETYPERANGEDESCRIPTIONorderinteger>0Requiredformultipleoutputswithinanoutputgroup.
Specifiestheorderinwhichtheoutputshouldbelistedwithintheoutputgrexternaloutputsareorderedtogether.
ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary101/169NAMETYPERANGEDESCRIPTIONexternaluristringTheexternaloutputfeatureletsyouincludeareferencetothevariantmanifestfromanotheroutputgroup(onthisoranotherLivmastermanifestforthisoutputgroup.
Forexample,thisoutputgroupproducescurling.
m3u8,curling_high.
m3u8,andthecorresandpublishesthemtothedestinationhttps://example.
com/sports.
Anotheroutputgroupproducesbackup_curling.
m3u8,backuandthecorresponding.
tssegmentsandpublishesthemtothedestinationhttps://example2.
com/sports.
Youcansetupsothatonhttps://example.
com/sportsincludesreferencestocurling_high.
m3u8(asusual)andtobackup_curling_high.
m3u8.
Enterthemanifest.
Forexample,https://example2.
com/backup_curling.
m3u8.
(Or,ifthedestinationisthesameforbothoutputgroups,ebackup_curling.
m3u8)stream_attributesstringEntertheinformationtoincludeinthemastermanifest,intheEXT-X-STREAM-INFlineforthisvariant.
BANDWIDTHisrequirespecification,otherfieldsareoptionalanddependonwhatyourdownstreamsystemsexpect.
Forexample,BANDWIDTH=690800,AVERAGE-BANDWIDTH=690800,CODECS="avc1.
4d4015,mp4a.
40.
2",RESOLUTION=480*270,AUDIOToensurecompliancewiththeHLSstandard,becarefulwiththesyntaxforexample,notethelackofspaces,notetheuseofadoublequotesaroundlistsandstrings.
STREAMASSEMBLYAstreamassemblydescribestheaudioandvideosettingsforanoutputstreamNAMETYPERANGEDESCRIPTIONnamestringStreamname.
Thisisusedtoattachstreamstooutputs.
Thisfieldisnotsaved,itisreplacedwithanidfieldoncetheLiveEventissaved.
Seestream_assembly_nameunderOutput.
video_descriptionVideoDescriptionVideosettingsforthisstream.
audio_descriptionAudioDescriptionAudiosettingsforthisstream.
Therecanbemultipleaudiosettingsinasinglestream.
caption_descriptionCaptionDescriptionCaptionsettingsforthisstream.
Therecanbemultiplecaptionsettingsinasinglestream.
presetstringAvalidPresetIDornamePresetvaluestouseforthisstream.
Ifthisisincluded,nofurtherparametersareneeded.
Ifvideo,audio,orcaptionparametersareincludedinthestreamassembly,theywilloverridethePresetvalue.
AvalidIDornamemustbeprovided,specifyingbypermalinkisnotsupported.
ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary102/169VIDEODESCRIPTIONVideodescriptioncontainsthesettingsneededforavideostreaminanoutputmedia.
Thefollowingpictureshowshowcrop,positionandwidthandheightrelatetoeachother.
Ifcroporpositionisnotgiven,thesoftwarewillensurethedisplayaspectratioispreservedintheresolutionspecifiedbyheightandwidth.
NAMETYPERANGEDESCRIPTIONcodecenumh.
264,h.
265,mpeg2,framecapture,uncompressed,proresVideocodec.
SeeVideoCodecsforsupportedoutputcodecs.
codec_settingsCodecSettingsh264_settings,h265_settings,mpeg2_settings,frame_capture_settings,uncompressed_settings,prores_settingsCodecspecificsettings.
Note:replacecodecwiththecodecyouareusingintheXMLtag(e.
g.
).
widthinteger32–4096(Default:sourcevideowidth)Outputvideowidth(inpixels).
Leaveblanktousesourcevideowidth.
Displayaspectratioisalwayspreservedbyletterboxingorpillarboxingwhennecessary.
heightinteger32–3112(Default:sourcevideoheight)Outputvideoheight(inpixels).
Leaveblanktousesourcevideoheight.
stretch_to_outputbooleantrueorfalseAutomaticallyconfigurestheoutputpositionRectangletostretchthevideotothespecifiedoutputresolution.
Thisoptionwilloverrideanypositionvalue.
sharpnessinteger0:Softest–100:SharpestChangesthestrengthoftheanti-aliasfilterusedforscaling.
0isthesoftestsetting,100isthesharpest.
Asettingof50isrecommendedformostcontent.
anti_aliasbooleantrueorfalseUsetheanti-aliasingscaler.
Thisshouldbeusedwithlargedownscalingratios.
vbi_passthroughbooleantrueorfalsePassesuserdatafieldsfrominputsourcetooutputsource.
Thisincludes608&708closedcaptiondata.
FrameratemustbesettoFollowSourceormustbe50fpsorgreater.
timecode_passthroughbooleantrueorfalseAvalueoftruepassesthroughtheselectedtimecodesourcevalue(inTimecodeConfig).
Thisisonlyrecommendedwhenyouarecertainthatinputframerateisidenticaltooutputframerate.
Falseremovesthetimecodefromtheoutput.
drop_frame_timecodebooleantrueorfalseInstructstimecodeinsertiontousedrop-frametimecodesfor29.
97fpsoutputs.
Ifitisnotpossibletousedrop-frametimecodes,thesystemwillfallbackonnon-drop-frameandnotethediscrepancyinthelogs.
cropRectangleCropinputtorectangle.
Aspectratiopreservationisdisabledwhenthisparameterisused.
ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary103/169NAMETYPERANGEDESCRIPTIONpositionRectanglePositionoutputinrectangle.
Aspectratiopreservationisdisabledwhenthisparameterisused.
video_preprocessorsVideoPreprocessorsVideopreprocessingtoapplytothisoutput.
respond_to_afdstringNone,Respond,PassthroughIndicateshowtorespondtotheAFDvaluesintheinputstream.
Respondcausesinputvideotobeclipped,dependingonAFDvalue,inputdisplayaspectratioandoutputdisplayaspectratio.
afd_signalingstringNone,Auto,FixedIndicatesthatAFDvalueswillbewrittenintotheoutputstream.
Inthecasewhererespond_to_afdisAuto,thesystemwilltrytopreservetheinputAFDvalue(incaseswheremultipleAFDvaluesarevalid).
OnlyvalidforH.
264andMPEG2outputs.
fixed_afdinteger0–15FourbitAFDvaluetowriteonallframesofvideointheoutputstream.
Onlyvalidwhenafd_signalingissetto'Fixed'.
insert_color_metadatabooleanfalseortrueIncludescolorspacemetadataintheoutput.
selected_gpustringAuto(blank),commaseparatedlistofvalues0,1,2,3GPUstoencodethisstreamon.
LeavingthisblankwillcauseElementalLivetodecidethebestGPU.
IftheoperatorrunsmultipleLiveEventsatthesametime,theycanmanuallybalancetheLiveEventGPUsforoptimalperformance.
StreamswithvideousingtheHEVC(h.
265)codeccandesignatetwoormoreGPUs,oriflefttoauto,additionalGPUswillbeassignedautomatically.
GPUsexcludedatthesystemsettingswillbeignored.
force_cpu_encodebooleanSettingthiscontrolinstructsthesystemtouseaCPUencoderforthisparticularstream.
RECTANGLENAMETYPERANGEDESCRIPTIONxintegerLeftofrectangle.
yintegerTopofrectangle.
widthintegerWidthofrectangleinpixels.
heightintegerHeightofrectangleinpixels.
H.
264SETTINGSNAMETYPERANGEDESCRIPTIONprofileenumBaseline,Main,High,High10-bit,High4:2:2,High4:2:210-bitH.
264Profile.
High4:2:2and10-bitprofilesareonlyavailablewiththeAVC-ILicense.
levelenumAuto,1,1.
1,1.
2,1.
3,2,2.
1,2.
2,3,3.
1,3.
2,4,4.
1,4.
2,5,5.
1,5.
2H.
264Level.
rate_control_modeenumVBR,CBR,CQ,ABR,Statmux,QVBRRatecontrolmode.
CQusesconstantquantizer(qp),ABR(averagebitrate)doesnotwriteHRDparameters.
StatmuxallowsforstatisticalmultiplexingonoutputswithanMPTSMembership.
QVBR:Setsabitratethatmeetsthedesiredquality(specifiedintheQualityLevelfield).
ThebitratewillnotexceedMaxBitrateandwillnotfallbelowthebitraterequiredtomeetthedesiredquality.
bitrateinteger>=1000(Default:5000000)Averagebitrateinbits/second.
RequiredforVBR,CBR,andABR.
Fivemegabitscanbeenteredas5000000or5m.
Fivehundredkilobitscanbeenteredas500000or0.
5m.
ForMSSmoothoutputs,bitratesmustbeuniquewhenroundeddowntothenearestmultipleof1000.
ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary104/169NAMETYPERANGEDESCRIPTIONmax_bitrateintegerMaximumbitrateinbits/second.
ApplicableonlytoVBRandQVBRmodes.
Fivemegabitscanbeenteredas5000000or5m.
Fivehundredkilobitscanbeenteredas500000or0.
5m.
RequiredforQVBR.
min_bitrateintegerOptional.
Ifspecified,setsanexplicitlowerlimitonthestatmuxedinstantaneousbitrateforthischannel.
Ifnotspecified,theminimumwillbeautomaticallysetbythesystem.
quality_levelinteger1–10(Default:7)Targetqualityvalue.
ApplicableonlytoQVBRmode.
1isthelowestqualityand10isthehighestandapproacheslossless.
Typicallevelsforcontentdistributionarebetween6and8.
buf_sizeintegerSizeofbuffer(HRDbuffermodel).
Fivemegabitscanbeenteredas5000000or5m.
Fivehundredkilobitscanbeenteredas500000or0.
5m.
Ifblank,valueisBitratex2.
min_buf_occinteger>=0tobuf_sizeMinimumoccupancyofVBV/HRDbufferinbits.
Ifblank,valueis0.
buf_fill_pctinteger0–100Percentageofthebufferthatshouldinitiallybefilled(HRDbuffermodel).
Ifblank,valueis90.
framerate_numeratorintegerFrameratenumerator–framerateisafraction,e.
g.
24000/1001=23.
976fps.
IfFramerateisFollowsource,canbeleftblank:defaultstoframerateofsource.
ForotherFramerateoptions,mustbespecified.
framerate_denominatorintegerFrameratedenominator.
IfFramerateisFollowsource,canbeleftblank:defaultstoframerateofsource.
ForotherFramerateoptions,mustbespecified.
framerate_follow_sourcebooleantrueorfalseNoframerateconversionfromsource.
interpolate_frcbooleantrueorfalseInterpolatesduringaframerateconversion.
Producessmoothermotionduringaframeratechange.
telecinestringNone,Soft,orHardThisfieldappliesonlyiftheStreams>Advanced>Framerate(framerate)fieldissetto29.
970.
ThisfieldworkswiththeStreams>Advanced>Preprocessors>Deinterlacerfield(deinterlace_mode)andtheStreams>Advanced>InterlacedModefield(interlace_mode)toidentifythescantypefortheoutput:Progressive,Interlaced,HardTelecineorSoftTelecine.
SeeScanTypesforinformation.
-Hard:produces29.
97ioutputfrom23.
976input.
-Soft:produces23.
976;theplayerconvertsthisoutputto29.
97i.
-HardTelecineisonlyvalidwithinterlacemodesof"TopFieldFirst"and"BottomFieldFirst";SoftTelecineisonlyvalidwiththe"Progressive"interlacemode.
slow_palbooleantrueorfalseEnablesSlowPALrateconversion.
23.
976fpsand24fpsinputisrelabeledas25fps,andaudioisspedupcorrespondingly.
interlace_modeenumprogressive,top_field,bottom_field,follow_top_field,follow_bottom_fieldThisfieldworkswiththeStreams>Advanced>Preprocessors>Deinterlacerfield(deinterlace_mode)andtheStreams>Advanced>Telecinefield(telecine)toidentifythescantypefortheoutput:Progressive,Interlaced,HardTelecineorSoftTelecine.
SeeScanTypesforinformation.
ThedifferencesbetweentheTop,Bottom,andFollowvaluesare:-TopFieldFirstorBottomFieldFirstproduceinterlacedwiththeentireoutputhavingthesamefieldpolarity(toporbottomfirst).
-Follow(DefaultTop)andFollow(DefaultBottom)usethesamefieldpolarityasthesource.
ThereforefortheFollowoptions:-Ifthesourceisinterlaced,theoutputwillbeinterlacedwiththesamepolarityasthesource(itwillfollowthesource).
Theoutputcouldthereforebeamixoftopfieldfirstandbottomfieldfirst.
-Ifthesourceisprogressive,theoutputwillbeinterlacedwithtopfieldfirstorbottomfieldfirstpolarity,dependingonwhichoftheFollowoptionsyouchose.
gop_sizefloat>0(Default:90)GOPLength(keyframeinterval)inframesorseconds.
Mustbegreaterthanzero.
gop_size_unitsstringframesorsecondsIndicatesiftheGOPSizeisspecifiedinframesorseconds.
IfsecondsthesystemwillconverttheGOPSizeintoaframecountatruntime.
gop_num_b_framesinteger0–7(Default:2)NumberofB-framesbetweenreferenceframes.
ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary105/169NAMETYPERANGEDESCRIPTIONprogressive_referencesbooleantrueorfalseAdjustpositionofPandBframeswithinaGOPsothatprogressive-scanreferenceframesareusedwheneverpossible.
Improvescompressionefficiencyofmixedprogressive&interlacecontent,particularlyhardtelecinecodecfilmcontent.
repeat_ppsbooleantrueorfalsePlacesaPPSheaderoneachencodedpicture,evenifrepeated.
gop_closed_cadenceinteger>=0(Default:1)FrequencyofclosedGOPs.
Instreamingapplications,itisrecommendedthatthisbesetto1soadecoderjoiningmid-streamwillreceiveanIDRframeasquicklyaspossible.
Settingthisvalueto0willbreakoutputsegmenting.
min_i_intervalinteger0–30(Default:0)Appliesonlywhenscd_modeisOnorTransitionDetection.
InastreamthatbelongstoanoutputgroupthatisdefininganABRstack,alwayssetthisfieldto0.
InastreamthatisnotpartofanABRstack,enteravaluethatforcesaminimumseparationbetweenrepeated(cadence)I-framesandI-framesinsertedbyscenechangedetection(SCD).
Enterthevalueasanumberofframes.
-IfanSCDI-frameiswithinthespecifiedintervalbeforeacadenceI-frame,thentheSCDI-frameisinsertedbuttheplannedcadenceI-frameisnotinserted.
ThecurrentGOPisshrunk.
ThenormalGOPcadencethenresumes.
-IfanSCDI-frameiswithinthespecifiedintervalafteracadenceI-frame,thentheplannedcadenceI-frameisnotinsertedandinsteadthecurrentGOPisstretchedtotheSCDI-frame.
ThenormalGOPcadencethenresumes.
ThemaximumGOPstretch=GOPsize+Min-I-interval"1.
adaptive_quantizationstringoff,low,medium,high,higher,maxAdaptivequantization.
Allowsintra-framequantizerstovarytoimprovevisualquality.
spatial_aqbooleantrueorfalseAdjustquantizationwithineachframebasedonspatialvariationofcontentcomplexity.
temporal_aqbooleantrueorfalseAdjustquantizationwithineachframebasedontemporalvariationofcontentcomplexity.
flicker_aqbooleantrueorfalseAdjustquantizationwithineachframetoreduceflickeror'pop'onI-frames.
cabacbooleantrueorfalseEnableCABAC(mustbeinMainorHighprofile).
softnessinteger0=default,1=JVT,16-128=planarinterpolationSoftness.
Selectsquantizermatrix,largervaluesreducehigh-frequencycontentintheencodedimage.
Ifblank,featureisoff.
qpinteger1–51Quantizationparameter–fixedforCQratecontrolmode,orstartingQPforratecontroller.
Ifblank,fieldisignored.
max_qpinteger1–51MaximumQPforratecontroller.
Ifblank,fieldisignored.
min_qpinteger1–51MinimumQPforratecontroller.
Ifblank,fieldisignored.
par_follow_sourcebooleantrueorfalseNopixelaspectratioconversionfromsource.
par_numeratorintegerPixelAspectRationumerator.
IfPixelAspectRatioisFollowsource,canbeleftblank:defaultstoaspectratioofsource.
ForotherPixelAspectRatiooptions,mustbespecified.
par_denominatorintegerPixelAspectRatiodenominator.
IfPixelAspectRatioisFollowsource,canbeleftblank:defaultstoaspectratioofsource.
ForotherPixelAspectRatiooptions,mustbespecified.
slicesinteger1–32Numberofslicesperpicture.
Mustbelessthanorequaltothenumberofmacroblockrowsforprogressivepictures,andlessthanorequaltohalfthenumberofmacroblockrowsforinterlacedpictures.
scd_modeenumoff,onortransition_detectionOn:insertsI-frameswhenscenechangeisdetected.
Off:doesnotforceanI-framewhenscenechangeisdetected.
TransitionDetection:recommendedwhenRateControlMode(rate_control_mode)isQVBR.
InastreamthatbelongstoanoutputgroupthatisdefininganABRstack,setallstreamstoOnorTransitionDetection,orsetallstreamstoOff.
look_ahead_rate_controlstringlow,medium,highAmountoflookahead.
Avalueoflowcandecreaselatencyandmemoryusage,whilehighcanproducebetterqualityforcertaincontent.
ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary106/169NAMETYPERANGEDESCRIPTIONnum_ref_framesinteger1–6Minimumnumberofreferenceframestouse.
Theactualnumberofreferenceframesusedbytheencoderforagiveneventisthemaximumofthefollowingnumbers:ThenumberofReferenceFramesspecifiedintheeventIfGOPReferenceB-FrameistrueandMotionVectorDirectModeisSpatial:4IfGOPReferenceB-FrameistrueandMotionVectorDirectModeisnotpresentorisnotSpatial:5IfBFramesis0andInterlaceModeisProgressive:1IfBFramesis0andInterlaceModeisnotProgressive:2IfBFramesisnot0:2force_field_picturesbooleantrueorfalseDisablesPAFF/MBAFFencodingforinterlacedoutputs.
When'ForceFieldPictures'isnotenabled,theencodermayuseeitherPAFForMBAFFfield/frameadaptation.
gop_markersbooleantrueorfalseInsertsaRecoveryPointSEImessageforopenGOPs,orstartsanewsequenceforclosedGOPs.
dynamic_sub_gopbooleantrueorfalseAdjustnumberofb-framespersub-GOPbasedonmotion,uptomaximumspecifiedfor'BFrames'.
Highermotionusesfewerb-frames.
Improvessubjectivevideoqualityforhigh-motioncontent.
gop_b_referencebooleantrueorfalseEnableuseofreferenceBframesforGOPstructuresthathaveBframes>1.
svqinteger-2HigherQuality,-1,0,1,2,3:HigherDensitySelectsencodingfeaturesbasedonperformance.
Highervaluesusefewersystemresourcessomayallowmorestreamstobeencoded.
sei_timecodebooleantrueorfalseInsertstimecodeforeachframeas4bytesofanunregisteredSEImessage.
rp2027_syntaxbooleanProducesabitstreamcompliantwithSMPTERP-2027.
passesinteger1or2Numberofencodingpasses.
motion_vector_direct_modestringSpecifiesthemodetousefortheB-frame'sDirectmodemotion-vectorprediction.
AppliesonlywhenthecodecisH.
264(AVC)andaCPUencoderisapplied,orwhenthecodecisH.
264andaGPUencoderisusedandDensityvsQuality(svq)issetto-2:HigherQuality(-2).
Foranyotherscenario,theDirectmodemotionvectortypeisalways"temporal".
Defaultisspatial.
SpatialDirectmodeisrecommendedingeneral.
TemporalDirectmodemayprovidebettersubjectivevideoqualitywhentherearemorecleanlinearmotions.
Automodeapplieseitherspatialortemporalprediction,dependingonwhichonegivesbetterpredictedmotionvectorsforthegivenB-frame.
H.
265SETTINGSNAMETYPERANGEDESCRIPTIONprofileenumMain/Main,Main/High,Main10/Main,Main10/High,Main4:2:28-bit/Main,Main4:2:28-bit/High,Main4:2:210-bit/Main,Main4:2:210-bit/HighRepresentstheProfileandTier,pertheHEVC(H.
265)specification.
Selectionsaregroupedas[Profile]/[Tier],so"Main/High"representsMainProfilewithHighTier.
4:2:2profilesareonlyavailablewiththeHEVC4:2:2License.
levelenumAuto,1,1.
1,2,2.
1,3,3.
1,4,4.
1,5,5.
1,5.
2,6,6.
1,6.
2H.
265Level.
rate_control_modeenumVBR,CBR,CQ,ABR,Statmux,QVBRRatecontrolmode.
CQusesconstantquantizer(qp),ABR(averagebitrate)doesnotwriteHRDparameters.
StatmuxallowsforstatisticalmultiplexingonoutputswithanMPTSMembership.
QVBR:Setsabitratethatmeetsthedesiredquality(specifiedintheQualityLevelfield).
ThebitratewillnotexceedMaxBitrateandwillnotfallbelowthebitraterequiredtomeetthedesiredquality.
ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary107/169NAMETYPERANGEDESCRIPTIONbitrateinteger>=1000(Default:5000000)Averagebitrateinbits/second.
RequiredforVBR,CBR,andABR.
Fivemegabitscanbeenteredas5000000or5m.
Fivehundredkilobitscanbeenteredas500000or0.
5m.
ForMSSmoothoutputs,bitratesmustbeuniquewhenroundeddowntothenearestmultipleof1000.
max_bitrateintegerMaximumbitrateinbits/second.
ApplicableonlytoVBRandQVBRmodes.
Fivemegabitscanbeenteredas5000000or5m.
Fivehundredkilobitscanbeenteredas500000or0.
5m.
RequiredforQVBR.
min_bitrateintegerOptional.
Ifspecified,setsanexplicitlowerlimitonthestatmuxedinstantaneousbitrateforthischannel.
Ifnotspecified,theminimumwillbeautomaticallysetbythesystem.
quality_levelinteger1–10(Default:7)Targetqualityvalue.
ApplicableonlytoQVBRmode.
1isthelowestqualityand10isthehighestandapproacheslossless.
Typicallevelsforcontentdistributionarebetween6and8.
buf_sizeintegerSizeofbuffer(HRDbuffermodel).
Fivemegabitscanbeenteredas5000000or5m.
Fivehundredkilobitscanbeenteredas500000or0.
5m.
Ifblank,valueisBitratex2.
buf_fill_pctinteger0–100Percentageofthebufferthatshouldinitiallybefilled(HRDbuffermodel).
Ifblank,valueis90.
min_i_intervalinteger0–30(Default:0)Appliesonlywhenscd_modeisOnorTransitionDetection.
InastreamthatbelongstoanoutputgroupthatisdefininganABRstack,alwayssetthisfieldto0.
InastreamthatisnotpartofanABRstack,enteravaluethatforcesaminimumseparationbetweenrepeated(cadence)I-framesandI-framesinsertedbyscenechangedetection(SCD).
Enterthevalueasanumberofframes.
-IfanSCDI-frameiswithinthespecifiedintervalbeforeacadenceI-frame,thentheSCDI-frameisinsertedbuttheplannedcadenceI-frameisnotinserted.
ThecurrentGOPisshrunk.
ThenormalGOPcadencethenresumes.
-IfanSCDI-frameiswithinthespecifiedintervalafteracadenceI-frame,thentheplannedcadenceI-frameisnotinsertedandinsteadthecurrentGOPisstretchedtotheSCDI-frame.
ThenormalGOPcadencethenresumes.
ThemaximumGOPstretch=GOPsize+Min-I-interval"1.
framerate_numeratorintegerFrameratenumerator–framerateisafraction,e.
g.
24000/1001=23.
976fps.
IfFramerateisFollowsource,canbeleftblank:defaultstoframerateofsource.
ForotherFramerateoptions,mustbespecified.
framerate_denominatorintegerFrameratedenominator.
IfFramerateisFollowsource,canbeleftblank:defaultstoframerateofsource.
ForotherFramerateoptions,mustbespecified.
framerate_follow_sourcebooleantrueorfalseNoframerateconversionfromsource.
num_ref_framesinteger1–6Minimumnumberofreferenceframestouse.
Theactualnumberofreferenceframesusedbytheencoderforagiveneventisthemaximumofthefollowingnumbers:ThenumberofReferenceFramesspecifiedintheeventIfGOPReferenceB-FrameistrueandMotionVectorDirectModeisSpatial:4IfGOPReferenceB-FrameistrueandMotionVectorDirectModeisnotpresentorisnotSpatial:5IfBFramesis0andInterlaceModeisProgressive:1IfBFramesis0andInterlaceModeisnotProgressive:2IfBFramesisnot0:2interpolate_frcbooleantrueorfalseInterpolatesduringaframerateconversion.
Producessmoothermotionduringaframeratechange.
gop_sizefloat>0(Default:90)GOPLength(keyframeinterval)inframesorseconds.
Mustbegreaterthanzero.
ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary108/169NAMETYPERANGEDESCRIPTIONgop_size_unitsstringframesorsecondsIndicatesiftheGOPSizeisspecifiedinframesorseconds.
IfsecondsthesystemwillconverttheGOPSizeintoaframecountatruntime.
gop_num_b_framesinteger0–7(Default:2)NumberofB-framesbetweenreferenceframes.
slow_palbooleantrueorfalseEnablesSlowPALrateconversion.
23.
976fpsand24fpsinputisrelabeledas25fps,andaudioisspedupcorrespondingly.
repeat_ppsbooleantrueorfalsePlacesaPPSheaderoneachencodedpicture,evenifrepeated.
dynamic_sub_gopbooleantrueorfalseAdjustnumberofb-framespersub-GOPbasedonmotion,uptomaximumspecifiedfor'BFrames'.
Highermotionusesfewerb-frames.
Improvessubjectivevideoqualityforhigh-motioncontent.
gop_b_referencebooleantrueorfalseEnableuseofreferenceBframesforGOPstructuresthathaveBframes>1.
gop_closed_cadenceinteger>=0(Default:1)FrequencyofclosedGOPs.
Instreamingapplications,itisrecommendedthatthisbesetto1soadecoderjoiningmid-streamwillreceiveanIDRframeasquicklyaspossible.
Settingthisvalueto0willbreakoutputsegmenting.
qpinteger1–51Quantizationparameter–fixedforCQratecontrolmode,orstartingQPforratecontroller.
Ifblank,fieldisignored.
min_qpinteger1–51MinimumQPforratecontroller.
Ifblank,fieldisignored.
max_qpinteger1–51MaximumQPforratecontroller.
Ifblank,fieldisignored.
par_follow_sourcebooleantrueorfalseNopixelaspectratioconversionfromsource.
par_numeratorintegerPixelAspectRationumerator.
IfPixelAspectRatioisFollowsource,canbeleftblank:defaultstoaspectratioofsource.
ForotherPixelAspectRatiooptions,mustbespecified.
par_denominatorintegerPixelAspectRatiodenominator.
IfPixelAspectRatioisFollowsource,canbeleftblank:defaultstoaspectratioofsource.
ForotherPixelAspectRatiooptions,mustbespecified.
slicesinteger1–32Numberofslicesperpicture.
Mustbelessthanorequaltothenumberofmacroblockrowsforprogressivepictures,andlessthanorequaltohalfthenumberofmacroblockrowsforinterlacedpictures.
tilesbooleantrueorfalseEnableuseoftiles,allowinghorizontalaswellasverticalsubdivisionoftheencodedpictures.
adaptive_quantizationstringoff,low,medium,highAdaptivequantization.
Allowsintra-framequantizerstovarytoimprovevisualquality.
spatial_aqbooleantrueorfalseAdjustquantizationwithineachframebasedonspatialvariationofcontentcomplexity.
temporal_aqbooleantrueorfalseAdjustquantizationwithineachframebasedontemporalvariationofcontentcomplexity.
flicker_aqbooleantrueorfalseAdjustquantizationwithineachframetoreduceflickeror'pop'onI-frames.
scd_modeenumoff,onortransition_detectionOn:insertsI-frameswhenscenechangeisdetected.
Off:doesnotforceanI-framewhenscenechangeisdetected.
TransitionDetection:recommendedwhenRateControlMode(rate_control_mode)isQVBR.
InastreamthatbelongstoanoutputgroupthatisdefininganABRstack,setallstreamstoOnorTransitionDetection,orsetallstreamstoOff.
look_ahead_rate_controlstringlow,medium,highAmountoflookahead.
Avalueoflowcandecreaselatencyandmemoryusage,whilehighcanproducebetterqualityforcertaincontent.
svqfloat-2:HigherQuality,-1,0,0.
5,1,2,3:HigherDensitySelectsencodingfeaturesbasedonperformance.
Highervaluesusefewersystemresourcessomayallowmorestreamstobeencoded.
0isthelowestsettingthatwillencodeinrealtimeforHDresolutions.
adaptive_saostringdefault,adaptive,offSpecifySampleAdaptiveOffset(SAO)filterstrength.
Adaptivemodedynamicallyselectsbeststrengthbasedoncontentsei_timecodebooleantrueorfalseInsertstimecodeforeachframeas4bytesofanunregisteredSEImessage.
alt_xfer_func_seibooleantrueorfalseEnablesAlternateTransferFunctionSEImessageforoutputsusingHybridLogGamma(HLG)Electro-OpticalTransferFunction(EOTF).
ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary109/169NAMETYPERANGEDESCRIPTIONinterlace_modeenumprogressive,top_field,bottom_field,follow_top_field,follow_bottom_fieldThisfieldworkswiththeStreams>Advanced>Preprocessors>Deinterlacerfield(deinterlace_mode)andtheStreams>Advanced>Telecinefield(telecine)toidentifythescantypefortheoutput:Progressive,Interlaced,HardTelecineorSoftTelecine.
SeeScanTypesforinformation.
ThedifferencesbetweentheTop,Bottom,andFollowvaluesare:-TopFieldFirstorBottomFieldFirstproduceinterlacedwiththeentireoutputhavingthesamefieldpolarity(toporbottomfirst).
-Follow(DefaultTop)andFollow(DefaultBottom)usethesamefieldpolarityasthesource.
ThereforefortheFollowoptions:-Ifthesourceisinterlaced,theoutputwillbeinterlacedwiththesamepolarityasthesource(itwillfollowthesource).
Theoutputcouldthereforebeamixoftopfieldfirstandbottomfieldfirst.
-Ifthesourceisprogressive,theoutputwillbeinterlacedwithtopfieldfirstorbottomfieldfirstpolarity,dependingonwhichoftheFollowoptionsyouchose.
telecinestringNone,Soft,orHardThisfieldappliesonlyiftheStreams>Advanced>Framerate(framerate)fieldissetto29.
970.
ThisfieldworkswiththeStreams>Advanced>Preprocessors>Deinterlacerfield(deinterlace_mode)andtheStreams>Advanced>InterlacedModefield(interlace_mode)toidentifythescantypefortheoutput:Progressive,Interlaced,HardTelecineorSoftTelecine.
SeeScanTypesforinformation.
-Hard:produces29.
97ioutputfrom23.
976input.
-Soft:produces23.
976;theplayerconvertsthisoutputto29.
97i.
-HardTelecineisonlyvalidwithinterlacemodesof"TopFieldFirst"and"BottomFieldFirst";SoftTelecineisonlyvalidwiththe"Progressive"interlacemode.
temporal_idsbooleantrueorfalseEnablestemporallayeridentifiersintheencodedbitstream.
Upto3layersaresupporteddependingonGOPstructure:I-andP-framesformonelayer,referenceB-framescanformasecondlayerandnon-referenceb-framescanformathirdlayer.
Decoderscanoptionallydecodeonlythelowertemporallayerstogeneratealowerframerateoutput.
Forexample,givenabitstreamwithtemporalIDsandwithb-frames=1(i.
e.
IbPbPbdisplayorder),adecodercoulddecodealltheframesforfullframerateoutputoronlytheIandPframes(lowesttemporallayer)forahalfframerateoutput.
MPEG-2SETTINGSNAMETYPERANGEDESCRIPTIONprofileenumMain,4:2:2MPEG-2Profile.
levelenumAuto,Low,Main,High1440,HighMPEG-2Level.
rate_control_modeenumVBR,CBR,CQ,ABR,Statmux,QVBRRatecontrolmode.
CQusesconstantquantizer(qp),ABR(averagebitrate)doesnotwriteHRDparameters.
StatmuxallowsforstatisticalmultiplexingonoutputswithanMPTSMembership.
QVBR:Setsabitratethatmeetsthedesiredquality(specifiedintheQualityLevelfield).
ThebitratewillnotexceedMaxBitrateandwillnotfallbelowthebitraterequiredtomeetthedesiredquality.
bitrateinteger>=1000(Default:5000000)Averagebitrateinbits/second.
RequiredforVBR,CBR,andABR.
Fivemegabitscanbeenteredas5000000or5m.
Fivehundredkilobitscanbeenteredas500000or0.
5m.
ForMSSmoothoutputs,bitratesmustbeuniquewhenroundeddowntothenearestmultipleof1000.
intra_dc_precisionenumauto,8,9,10,11Selectquantizationprecisionforintra-blockDCcoefficients.
Autoselectsprecisionbasedonper-framecompressionratio,otherselectionssetprecisiontoafixedvalue.
max_bitrateintegerMaximumbitrateinbits/second.
ApplicableonlytoVBRandQVBRmodes.
Fivemegabitscanbeenteredas5000000or5m.
Fivehundredkilobitscanbeenteredas500000or0.
5m.
ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary110/169NAMETYPERANGEDESCRIPTIONmin_bitrateintegerOptional.
Ifspecified,setsanexplicitlowerlimitonthestatmuxedinstantaneousbitrateforthischannel.
Ifnotspecified,theminimumwillbeautomaticallysetbythesystem.
buf_sizeintegerSizeofbuffer(HRDbuffermodel).
Fivemegabitscanbeenteredas5000000or5m.
Fivehundredkilobitscanbeenteredas500000or0.
5m.
Ifblank,valueisBitratex2.
buf_fill_pctinteger0–100Percentageofthebufferthatshouldinitiallybefilled(HRDbuffermodel).
Ifblank,valueis90.
framerate_numeratorintegerFrameratenumerator–framerateisafraction,e.
g.
24000/1001=23.
976fps.
IfFramerateisFollowsource,canbeleftblank:defaultstoframerateofsource.
ForotherFramerateoptions,mustbespecified.
framerate_denominatorintegerFrameratedenominator.
IfFramerateisFollowsource,canbeleftblank:defaultstoframerateofsource.
ForotherFramerateoptions,mustbespecified.
framerate_follow_sourcebooleantrueorfalseNoframerateconversionfromsource.
interpolate_frcbooleantrueorfalseInterpolatesduringaframerateconversion.
Producessmoothermotionduringaframeratechange.
telecinestringNone,Soft,orHardThisfieldappliesonlyiftheStreams>Advanced>Framerate(framerate)fieldissetto29.
970.
ThisfieldworkswiththeStreams>Advanced>Preprocessors>Deinterlacerfield(deinterlace_mode)andtheStreams>Advanced>InterlacedModefield(interlace_mode)toidentifythescantypefortheoutput:Progressive,Interlaced,HardTelecineorSoftTelecine.
SeeScanTypesforinformation.
-Hard:produces29.
97ioutputfrom23.
976input.
-Soft:produces23.
976;theplayerconvertsthisoutputto29.
97i.
dynamic_sub_gopbooleantrueorfalseAdjustnumberofb-framespersub-GOPbasedonmotion,uptomaximumspecifiedfor'BFrames'.
Highermotionusesfewerb-frames.
Improvessubjectivevideoqualityforhigh-motioncontent.
slow_palbooleantrueorfalseEnablesSlowPALrateconversion.
23.
976fpsand24fpsinputisrelabeledas25fps,andaudioisspedupcorrespondingly.
interlace_modeenumprogressive,top_field,bottom_field,follow_top_field,follow_bottom_fieldThisfieldworkswiththeStreams>Advanced>Preprocessors>Deinterlacerfield(deinterlace_mode)andtheStreams>Advanced>Telecinefield(telecine)toidentifythescantypefortheoutput:Progressive,Interlaced,HardTelecineorSoftTelecine.
SeeScanTypesforinformation.
ThedifferencesbetweentheTop,Bottom,andFollowvaluesare:-TopFieldFirstorBottomFieldFirstproduceinterlacedwiththeentireoutputhavingthesamefieldpolarity(toporbottomfirst).
-Follow(DefaultTop)andFollow(DefaultBottom)usethesamefieldpolarityasthesource.
ThereforefortheFollowoptions:-Ifthesourceisinterlaced,theoutputwillbeinterlacedwiththesamepolarityasthesource(itwillfollowthesource).
Theoutputcouldthereforebeamixoftopfieldfirstandbottomfieldfirst.
-Ifthesourceisprogressive,theoutputwillbeinterlacedwithtopfieldfirstorbottomfieldfirstpolarity,dependingonwhichoftheFollowoptionsyouchose.
gop_sizefloat>0(Default:12)GOPLength(keyframeinterval)inframesorseconds.
Mustbegreaterthanzero.
gop_size_unitsstringframesorsecondsIndicatesiftheGOPSizeisspecifiedinframesorseconds.
IfsecondsthesystemwillconverttheGOPSizeintoaframecountatruntime.
gop_num_b_framesinteger0–7(Default:2)NumberofB-framesbetweenreferenceframes.
gop_closed_cadenceinteger>=0(Default:1)FrequencyofclosedGOPs.
Instreamingapplications,itisrecommendedthatthisbesetto1soadecoderjoiningmid-streamwillreceiveanIDRframeasquicklyaspossible.
Settingthisvalueto0willbreakoutputsegmenting.
progressive_referencesbooleantrueorfalseAdjustpositionofPandBframeswithinaGOPsothatprogressive-scanreferenceframesareusedwheneverpossible.
Improvescompressionefficiencyofmixedprogressive&interlacecontent,particularlyhardtelecinecodecfilmcontent.
ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary111/169NAMETYPERANGEDESCRIPTIONmin_i_intervalinteger0–30(Default:0)Appliesonlywhenscd_modeisOnorTransitionDetection.
InastreamthatbelongstoanoutputgroupthatisdefininganABRstack,alwayssetthisfieldto0.
InastreamthatisnotpartofanABRstack,enteravaluethatforcesaminimumseparationbetweenrepeated(cadence)I-framesandI-framesinsertedbyscenechangedetection(SCD).
Enterthevalueasanumberofframes.
-IfanSCDI-frameiswithinthespecifiedintervalbeforeacadenceI-frame,thentheSCDI-frameisinsertedbuttheplannedcadenceI-frameisnotinserted.
ThecurrentGOPisshrunk.
ThenormalGOPcadencethenresumes.
-IfanSCDI-frameiswithinthespecifiedintervalafteracadenceI-frame,thentheplannedcadenceI-frameisnotinsertedandinsteadthecurrentGOPisstretchedtotheSCDI-frame.
ThenormalGOPcadencethenresumes.
ThemaximumGOPstretch=GOPsize+Min-I-interval"1.
adaptive_quantizationstringoff,low,medium,highAdaptivequantization.
Allowsintra-framequantizerstovarytoimprovevisualquality.
spatial_aqbooleantrueorfalseAdjustquantizationwithineachframebasedonspatialvariationofcontentcomplexity.
temporal_aqbooleantrueorfalseAdjustquantizationwithineachframebasedontemporalvariationofcontentcomplexity.
framing_aqbooleantrueorfalseDecreaseinter-framequantizationinthecenteroftheframe,increaseneartheedges.
softnessinteger0=default,16-128=planarinterpolationSoftness.
Selectsquantizermatrix,largervaluesreducehigh-frequencycontentintheencodedimage.
Ifblank,featureisoff.
qpinteger1–112Quantizationparameter–fixedforCQratecontrolmode,orstartingQPforratecontroller.
Ifblank,fieldisignored.
max_qpinteger1–112MaximumQPforratecontroller.
Ifblank,fieldisignored.
min_qpinteger1–112MinimumQPforratecontroller.
Ifblank,fieldisignored.
par_numeratorintegerPixelAspectRationumerator.
IfPixelAspectRatioisFollowsource,canbeleftblank:defaultstoaspectratioofsource.
ForotherPixelAspectRatiooptions,mustbespecified.
par_denominatorintegerPixelAspectRatiodenominator.
IfPixelAspectRatioisFollowsource,canbeleftblank:defaultstoaspectratioofsource.
ForotherPixelAspectRatiooptions,mustbespecified.
par_follow_sourcebooleantrueorfalseNopixelaspectratioconversionfromsource.
scd_modeenumoff,onortransition_detectionOn:insertsI-frameswhenscenechangeisdetected.
Off:doesnotforceanI-framewhenscenechangeisdetected.
TransitionDetection:recommendedwhenRateControlMode(rate_control_mode)isQVBR.
InastreamthatbelongstoanoutputgroupthatisdefininganABRstack,setallstreamstoOnorTransitionDetection,orsetallstreamstoOff.
look_ahead_rate_controlstringlow,medium,highAmountoflookahead.
Avalueoflowcandecreaselatencyandmemoryusage,whilehighcanproducebetterqualityforcertaincontent.
d10_syntaxbooleantrueorfalseProducesaTypeD-10compatiblebitstream(SMPTE356M-2001).
min_buf_occinteger>=0tobuf_sizeMinimumoccupancyofVBV/HRDbufferinbits.
Ifblank,valueis0.
PRORESSETTINGSNAMETYPERANGEDESCRIPTIONframerate_numeratorintegerFrameratenumerator–framerateisafraction,e.
g.
24000/1001=23.
976fps.
IfFramerateisFollowsource,canbeleftblank:defaultstoframerateofsource.
ForotherFramerateoptions,mustbespecified.
ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary112/169NAMETYPERANGEDESCRIPTIONframerate_denominatorintegerFrameratedenominator.
IfFramerateisFollowsource,canbeleftblank:defaultstoframerateofsource.
ForotherFramerateoptions,mustbespecified.
framerate_follow_sourcebooleantrueorfalseNoframerateconversionfromsource.
par_follow_sourcebooleantrueorfalseNopixelaspectratioconversionfromsource.
par_numeratorintegerPixelAspectRationumerator.
IfPixelAspectRatioisFollowsource,canbeleftblank:defaultstoaspectratioofsource.
ForotherPixelAspectRatiooptions,mustbespecified.
par_denominatorintegerPixelAspectRatiodenominator.
IfPixelAspectRatioisFollowsource,canbeleftblank:defaultstoaspectratioofsource.
ForotherPixelAspectRatiooptions,mustbespecified.
interpolate_frcbooleantrueorfalseInterpolatesduringaframerateconversion.
Producessmoothermotionduringaframeratechange.
interlace_modeenumprogressive,top_field,bottom_field,follow_top_field,follow_bottom_fieldThisfieldworkswiththeStreams>Advanced>Preprocessors>Deinterlacerfield(deinterlace_mode)andtheStreams>Advanced>Telecinefield(telecine)toidentifythescantypefortheoutput:Progressive,Interlaced,HardTelecineorSoftTelecine.
SeeScanTypesforinformation.
ThedifferencesbetweentheTop,Bottom,andFollowvaluesare:-TopFieldFirstorBottomFieldFirstproduceinterlacedwiththeentireoutputhavingthesamefieldpolarity(toporbottomfirst).
-Follow(DefaultTop)andFollow(DefaultBottom)usethesamefieldpolarityasthesource.
ThereforefortheFollowoptions:-Ifthesourceisinterlaced,theoutputwillbeinterlacedwiththesamepolarityasthesource(itwillfollowthesource).
Theoutputcouldthereforebeamixoftopfieldfirstandbottomfieldfirst.
-Ifthesourceisprogressive,theoutputwillbeinterlacedwithtopfieldfirstorbottomfieldfirstpolarity,dependingonwhichoftheFollowoptionsyouchose.
profileenumAppleProRes422,AppleProRes422(HQ),AppleProRes422(LT),AppleProRes422(Proxy)AppleProResProfile.
telecinestringNoneorHardThisfieldappliesonlyiftheStreams>Advanced>Framerate(framerate)fieldissetto29.
970.
ThisfieldworkswiththeStreams>Advanced>Preprocessors>Deinterlacerfield(deinterlace_mode)andtheStreams>Advanced>InterlacedModefield(interlace_mode)toidentifythescantypefortheoutput:Progressive,Interlaced,HardTelecineorSoftTelecine.
SeeScanTypesforinformation.
-Hard:produces29.
97ioutputfrom23.
976input.
-Soft:produces23.
976;theplayerconvertsthisoutputto29.
97i.
slow_palbooleantrueorfalseEnablesSlowPALrateconversion.
23.
976inputisrelabeledas25andaudioisspedupcorrespondingly.
FRAMECAPTURESETTINGSNAMETYPERANGEDESCRIPTIONqualityinteger1–100(Default:80)JPEGQuality–ahighervalueequalshigherquality.
instruction_dropdownenumEvery5seconds,Middleframe,At20secondsorfallbacktomiddle,Custom.
Choosefromarangeofpredefinedcommonframecapturetiminginstructions.
instructionstringDefault:"at5s"Instructionsintheform"(every|at)(number)(s|%|f)",suchas"every5s"and"at10%".
Unitsare's'forseconds,'%'forpercent,and'f'forframenumber.
Impossiblerequestssuchas"every0f"and"at105%"areerrors.
Instructionscanbecombinedwith'or',suchas'at10sorat5s'.
Ifthefirstinstructioncannotbesatisfied(forexample,theclipis7slong),thenthesecondinstructionwillbeused.
Instructionscannotbecombinedwith'and'.
CreatemultipleFrameCaptureoutputsinstead.
ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary113/169NAMETYPERANGEDESCRIPTIONappend_sequence_numberbooleanAppendsasequencenumbertoframecapturefiles.
Uncheckingthisboxwilloverwritetheoutputfile,whichcanbeusedtomonitortranscodeprogress.
UNCOMPRESSEDSETTINGSNAMETYPERANGEDESCRIPTIONframerate_numeratorintegerFrameratenumerator–framerateisafraction,e.
g.
24000/1001=23.
976fps.
IfFramerateisFollowsource,canbeleftblank:defaultstoframerateofsource.
ForotherFramerateoptions,mustbespecified.
framerate_denominatorintegerFrameratedenominator.
IfFramerateisFollowsource,canbeleftblank:defaultstoframerateofsource.
ForotherFramerateoptions,mustbespecified.
framerate_follow_sourcebooleantrueorfalseNoframerateconversionfromsource.
interpolate_frcbooleantrueorfalseInterpolatesduringaframerateconversion.
Producessmoothermotionduringaframeratechange.
slow_palbooleantrueorfalseEnablesSlowPALrateconversion.
23.
976inputisrelabeledas25andaudioisspedupcorrespondingly.
fourccstringChoosetheFourCCcodethatisappropriatefortheintendeddownstreamclientplayer.
NotethatsomeclientplayersmaynotplayvideoiftheFourCCcodeusedisnotoneofthesupportedcodesofthatplayer.
VIDEOPREPROCESSORSNAMETYPERANGEDESCRIPTIONcolor_correctorColorCorrectorSettingsforthecolorcorrector.
image_inserterImageInserterSettingsfortheimageinserter.
Whenaddedhere,appliestoonlythisvideostream.
deinterlacerDeinterlacerSettingsfordeinterlacer.
noise_reducerNoiseReducerSettingsfornoise_reducer.
watermarkingWatermarkingEmbedsauniqueandindelibledigitalwatermarkintheoutput.
COLORCORRECTORNAMETYPERANGEDESCRIPTIONbrightnessinteger1–100(Default:50)Brightnesslevel.
contrastinteger1–100(Default:50)Contrastlevel.
hueinteger-180–180(Default:0)Hueindegrees.
saturationinteger1–100(Default:50)Saturationlevel.
full_swingbooleantrueorfalseTrueexpandstheinputcolorspacetofull-swingencoding,Falseallowstheinputencodingtopassthrough.
ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary114/169NAMETYPERANGEDESCRIPTIONcolor_space_conversionstringnone,force_601,force_709,force_sdr_2020,force_hdr10,force_hlg_2020,force_dv_5,force_dv_8_1Determinesifcolorspaceconversionwillbeperformed.
IfsettoNone,noconversionwillbeperformed.
IfanyoftheForceoptionsareselected,theinputwillbeconvertedtothespecifiedcolorspace.
Aninput'scolorspacecanbespecifiedexplicitlyintheVideoSelectorifnecessary.
Select601toenabletransferfunctionandcolorgamutperITUBT.
601-7.
Select709toenabletransferfunctionandcolorgamutperITUBT.
709-6.
SelectSDR2020toenabletransferfunctionandcolorgamutperITUBT.
2020-2.
SelectHDR10toenablePQtransferfunctionandnon-constantluminancecolorgamutperITUBT.
2100-1.
SelectHLG2020toenableHLGtransferfunctionandnon-constantluminancecolorgamutperITUBT.
2100-1.
SelectDolbyVisionProfile5toenableIPTcolorspaceandDolbyVisionmetadata.
RequiresVideoRangetobeFullSwing.
SelectDolbyVisionProfile8.
1toenablePQtransferfunctionandnon-constantluminancecolorgamutperITUBT.
2100-1andDolbyVisionmetadata.
IMAGEINSERTERTheimageinserteroverlaysa32-bitWindowsBMP,PNGorTGAfileontheoutputvideo.
Theresolutionoftheimagetobeinsertedmustbesmallerthantheoutputresolution.
WhenusingPhotoshoptooutput32bit.
bmpfiles,besuretosetittooutputthealphachannel.
That'swhatkeepsthelogofromappearinginsideablackorwhitebox.
Anexampleimagecanbefoundin/opt/elemental_se/web/public/example_files/Elemental_logo.
png.
NAMETYPERANGEDESCRIPTIONenable_restbooleantrueorfalseIndicatesthatRESTcommandswillbeusedtosendimageinsertioncommands.
Ifused,nootherfieldsareneeded.
insertable_imageInsertableImageImagetoinsert.
Mustbe32bitwindowsBMP,PNG,orTGAfile.
Mustnotbelargerthantheoutputframes.
INSERTABLEIMAGENAMETYPERANGEDESCRIPTIONimage_inserter_inputLocationImagetoinsert.
Mustbe32bitwindowsBMP,PNGorTGA.
Mustnotbelargerthantheoutputframes.
layerinteger0–7TheZorderoftheinsertedimage.
Imageswithhighervaluesoflayerwillbeinsertedontopofimageswithlowervaluesoflayer.
image_xintegerPlacementofimageonthehorizontalaxisinpixels.
0istheleftedgeoftheframe.
RequiredforBMP,PNGandTGAinput.
image_yintegerPlacementofimageontheverticalaxisinpixels.
0isthetopedgeoftheframe.
RequiredforBMP,PNGandTGAinput.
opacityinteger0–100(Default:50)Opacityofimage.
0istransparent.
100isfullyopaque.
RequiredforBMP,PNGandTGAinput.
widthintegerThewidthoftheimagewheninsertedinthevideo.
Leaveblanktousethenativewidthoftheimage.
heightintegerTheheightoftheimagewheninsertedinthevideo.
Leaveblanktousethenativeheightoftheimage.
start_timestringThestarttimefortheimage.
Maybeintimecode(HH:MM:SS:FF)orISO8601UTCTimestamp(20150102T030405.
678Z)format.
durationintegerThetimeinmillisecondsfortheimagetoremaininthevideo.
fade_inintegerThetimeinmillisecondsfortheimagetofadein.
fade_outintegerThetimeinmillisecondsfortheimagetofadeout.
ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary115/169DEINTERLACERNAMETYPERANGEDESCRIPTIONdeinterlace_modestringDeinterlace,InverseTelecine,AdaptiveThisfieldworkswiththeStreams>Advanced>Telecinefield(telecine)andtheStreams>Advanced>InterlacedModefield(interlace_mode)toidentifythescantypefortheoutput:Progressive,Interlaced,HardTelecineorSoftTelecine.
SeeScanTypesforinformation.
-Deinterlaceconvertsinterlacedtoprogressive.
-InverseTelecineconvertsHardTelecine29.
97itoprogressive23.
976p.
-Adaptiveauto-detectsandconvertstoprogressive.
algorithmenuminterpolate,blend,low_latencyDeinterlacealgorithm(hasnoeffectifdeinterlace_modeisInverseTelecine).
Motionadaptiveinterpolateproducessharperpictures,whileblendproducessmoothermotion.
Low-latencyisalinearinterpolationoverasinglepicture.
forcebooleantrueorfalseThisfieldappearsonlywhenStreams>Advanced>Preprocessors>Deinterlacerfield(deinterlace_mode)isenabled:-WhenForceModeisoff(default),theprocessordoesnotconvertframesthataretaggedinmetadataasprogressive.
Itwillonlyconvertthosethataretaggedassomeothertype.
-WhenForceModeison,theprocessorconvertseveryframetoprogressive"eventhosethatarealreadytaggedasprogressive.
TurnForcemodeononlyifthereisagoodchancethatthemetadatahastaggedframesasprogressivewhentheyarenotprogressive.
Donotturnonotherwise;processingframesthatarealreadyprogressiveintoprogressivewillprobablyresultinlowerqualityvideo.
NOISEREDUCERTheNoiseReducerfilterscanhelpoutputqualityifthecontentwillbecompressedheavily.
Todeterminethebestoption,testthedifferentfiltersontheexpectedsourcecontent.
NAMETYPERANGEDESCRIPTIONfilterstringBilateral,Mean,Gaussian,Lanczos,Sharpen,Conserve,Spatial,TemporalMean/Gaussian/Lanczos:Allofthesealgorithmsallowforvaryingblurstrengths.
Meanisthestrongestfilter(itoperatesonasmallergroupofpixels),whileLanczosisthemildest(itoperatesonalargergroupofpixels).
Sharpen:Sharpenstheedgesinsteadofsofteningthem.
Conserve:Limitsthepixelvaluestowithintheminimumandmaximumvaluesoftheneighboringpixelvalues.
Itisdesignedtoreducespecklenoiseorcamerasensornoise.
Itcanbeusefulforoldfilmstockwithexcessivefilmgrainnoise.
Bilateral:Thisalgorithmpreservesstrongedgesbutflattenssubtletextures.
Itisusefulforbitratereductionwithsomeblurringofdetails.
Athighstrengthsitproducesacel-shadedlook.
Spatial:Ahumanperception-basedfilterthatremovesinputcontentcomplexityintheorderofnoticeabilitybythehumaneye.
Itismorecomputationallyexpensivethanotherfilters.
Itfilterspicturesadaptivelybasedonfrequencyandcontrastmasking,sodetailisremovedwheredifferencesarenotperceptible.
Lowerstrengthsreducethecomplexityofthepicturewithnoperceptiblelossofdetail.
Athigherstrengths,theimagewillbevisuallysimplifiedbutthecriticaldetailispreserved.
Temporal:UsesthesamefrequencyandcontrastmaskingasSpatial,plusmotionmasking.
strengthinteger0-16forSpatialandTemporalfilters,0-3forotherfiltersRelativestrengthoffiltering(higherproducesstrongerfiltering).
speedinteger-2to3forSpatial;-1to3forTemporal.
AppliesonlytotheSpatialorTemporalfilter.
Thespeedofthefilter(highernumberisfaster).
Lowsettingreducesbitrateatthecostofdensity,highsettingimprovesdensityatthecostofbitrate.
ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary116/169NAMETYPERANGEDESCRIPTIONpost_filter_sharpen_strengthinteger0to3AppliesonlytotheSpatialfilter.
Thestrengthofpost-noise-reductionsharpeningfilter,with0disablingthefilterand3enablingitatmaximumstrength.
aggressive_modeinteger0to4AppliesonlytoTemporalfilter.
Therelativestrengthofmotionmasking(higherproducesstrongerfiltering).
SetAggressiveModetohighervaluewhenoperatingatlowerCBRbitratesorVBRmaxbitratestofilterhighcomplexityscenesmoreaggressively.
0-2forcomplexityreductionwithminimalsharpnessloss;3-8forcomplexityreductionwithimagepreservation;9-16forreducednoisecombinedwithhighcomplexityreduction.
WATERMARKINGDigitalwatermarkingembedsauniqueandindelibleidentifierwithinavideothatisrecognizablebysoftwarebutimperceptibletotheeye.
Contentproviderscanusewatermarkstotracktheirmediaafteritisdistributed.
NAMETYPERANGEDESCRIPTIONproviderstringCivolutionSpecifiesa3rdpartywatermarkingprovider.
Currently,onlyCivolutionissupported.
payloadintegerTheuniquewatermarkingintegeridentifiertoembedinthevideo.
strengthinteger1–5Specifiesthestrengthofthewatermarkingalgorithm.
Strongerwatermarkingincreasesthechanceofvisibleartifacts,butmakesthewatermarkmoreresilienttore-encoding.
TIMECODEBURN-INNAMETYPERANGEDESCRIPTIONprefixstringASCIIstringSpecifiestheprefixbeforetheburned-intimecode.
PrefixesacceptASCIIcharactersfrom0*20to0*7e(inclusive).
Theprefixwillbeinserteddirectlybeforethetimecode.
Forexample,aprefixof"EZ-"willresultinthefollowingtimecode,"EZ-00:00:00:00").
font_sizeinteger10,16,32,48Determinesthefontsizeinpixelsoftheburned-intimecode.
positionstringtop_center,top_left,top_right,middle_left,middle_center,middle_right,bottom_left,bottom_center,bottom_rightDeterminespositionoftheburned-intimecoderelativetotheoutput.
AUDIODESCRIPTIONNAMETYPERANGEDESCRIPTIONcodecenumaac,mp2,wav,aiff,ac3,ec3,passthrough,dtseAudiocodec.
SeeAudioCodecsforsupportedoutputcodecs.
codec_settingsCodecSettingsaac_settings,wav_settings,aiff_settings,pass_through_settings,mp2_settings,ac3_settings,eac3_settings,dtse_settingsCodecspecificsettings.
Note:replacecodecwiththecodecyouareusingintheXMLtag(e.
g.
).
orderinteger>0Requiredformultipleaudio.
Specifiestheordertheaudiodescriptionsshouldbelistedin.
ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary117/169NAMETYPERANGEDESCRIPTIONlanguage_codestringIETF-RFC5646LanguageTagcodewhichisasupersetofISO639-2three-digitcodeIndicatestheIETF-RFC5646LanguageTagoftheaudiooutputtrack.
This'LanguageCode'iscomposedofoneormoresubtags,eachofwhichrefinesornarrowstherangeoflanguageidentifiedbytheoveralltag.
ForthepurposeoftheLiveSoftware,theIETF-RFC5646LanguageTagisidentifiedasthe'LanguageCode'.
The'LanguageCode'enteredherewillbeassociatedwiththespecifiedaudiostreamwhen'FollowInputLanguageCode'isNOTselectedorwhen'FollowInputLanguageCode'isselectedbutthereisNOlanguagecodespecifiedbytheinput.
follow_input_language_codebooleanChoosingFollowInputLanguageCodewillcausethe'LanguageCode'oftheoutputtofollowthe'LanguageCode'oftheinput.
Thelanguagespecifiedinthe'LanguageCode'fieldwillbeusedwhen'FollowInputLanguageCode'isnotselectedorwhen'FollowInputLanguageCode'isselectedbutthereisno'LanguageCode'specifiedbytheinput.
audio_typeintegerAppliesonlyifFollowInputAudioTypeisunchecked(false).
Anumberbetween0and255.
ThefollowingaredefinedinISO-IEC13818-1:0=Undefined,1=CleanEffects,2=HearingImpaired,3=VisuallyImpairedCommentary,4-255=Reserved.
follow_input_audio_typebooleanChecked(settotrue):IftheinputcontainsanISO639audio_type,thenthatvalueispassedthroughtotheoutput.
IftheinputcontainsnoISO639audio_type,thevalueinAudioTypeisincludedintheoutput.
Unchecked(settofalse):ThevalueinAudioTypeisincludedintheoutput.
NotethatthisfieldandAudioTypearebothignoredifSetBroadcasterMixDescriptorischecked(true).
stream_namestringAlphanumericcharacters,spaces,andunderscoreUsedforMSSmoothandAppleHLSoutputs.
Indicatesthenamedisplayedbytheplayer(eg.
English,orDirectorCommentary).
remix_settingsRemixSettingsAdvancedaudioremixingsettings.
audio_source_namestringSpecifieswhichaudiodatatousefromeachinput.
Inthesimplestcase,specifyanAudioSelectorbynamebasedonitsorderwithineachinput.
Forexampleifyouspecify"AudioSelector3",thenthethirdaudioselectorwillbeusedfromeachinput.
Ifaninputdoesnothavean"AudioSelector3",thentheaudioselectormarkedas"default"inthatinputwillbeused.
Ifthereisnoaudioselectormarkedas"default",silencewillbeinsertedforthedurationofthatinput.
Alternatively,anAudioSelectorGroupnamemaybespecified,withsimilardefault/silencebehavior.
Ifnoaudio_source_nameisspecified,then"AudioSelector1"willbechosenautomatically.
audio_normalization_settingsAudioNormalizationSettingsAdvancedaudionormalizationsettings.
arib_dynamic_audio_trackinteger1,2Whenenabled,inputaudiochannelselectionandAACsettingswillbedynamicallyupdatedbasedontheencodingof'audiomode'foundinARIBSTDB-39VANC.
timecode_passthroughbooleanIfenabledforanaudio-onlyMSSmoothoutput,thefragmentabsolutetimewillbesettothecurrenttimecode.
Thisoptiondoesnotwritetimecodestotheaudioelementarystream.
nielsen_rtvod_watermarkstringc3,c7InsertC3/C7tagintoastreamthatalreadyhasNAESIIwatermarkspresent.
AACSETTINGSNAMETYPERANGEDESCRIPTIONbitrateintegerAveragebitrateinbits/second.
Validvaluesdependonratecontrolmodeandprofile.
sample_rateintegerSamplerateinhz.
Validvaluesdependonratecontrolmodeandprofile.
ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary118/169NAMETYPERANGEDESCRIPTIONcoding_modestring1_0,1_1,ad_receiver_mix,2_0,5_1Mono(AudioDescription),Mono,Stereo,or5.
1channellayout.
Validvaluesdependonratecontrolmodeandprofile.
"1.
0–AudioDescription(ReceiverMix)"settingreceivesastereodescriptionpluscontroltrackandemitsamonoAACencodeofthedescriptiontrack,withcontroldataemittedinthePESheaderasperETSITS101154AnnexE.
rate_control_modeenumCBR,VBRRateControlMode.
profileenumLC,HEV1,HEV2AACProfile.
latm_loasbooleantrueorfalseEnablesLATM/LOASAACoutputforrawcontainers.
mpeg2booleantrueorfalseUseMPEG-2AACaudioinsteadofMPEG-4AACaudioforraworMPEG-2TransportStreamcontainers.
ad_broadcaster_mixbooleantrueorfalseCheck(settotrue)wheninputcontainspre-mixedmainaudio+AD(narration)asastereopair.
TheAudioTypefield(audio_type)willbesetto3,whichsignalstodownstreamsystemsthatthisstreamcontains"broadcastermixedAD".
Notethattheinputreceivedbytheencodermustcontainpre-mixedaudio;theencoderdoesnotperformthemixing.
ThevaluesinFollowAudioInputTypeandAudioTypeareignored.
Leaveunchecked(settofalse)wheninputdoesnotcontainpre-mixedaudio+AD.
Inthiscase,completeFollowAudioInputTypeandAudioTypeasdesired.
vbr_qualityenumLOW1,LOW2,LOW3,MEDIUM1,MEDIUM2,MEDIUM3,HIGH1,HIGH2,HIGH3VBRQualityLevel–Onlyusedifrate_control_modeisVBR.
WAVSETTINGSNAMETYPERANGEDESCRIPTIONsample_rateinteger8000–192000(Default:44100)Samplerateinhz.
channelsinteger1,2,4,8Mono,Stereo,4-Channel,or8-Channel.
bit_depthinteger16or24Bitspersample.
AIFFSETTINGSNAMETYPERANGEDESCRIPTIONsample_rateinteger8000–192000(Default:44100)Samplerateinhz.
channelsinteger1,2MonoorStereo.
bit_depthinteger16or24Bitspersample.
MPEG-1LAYERIISETTINGSNAMETYPERANGEDESCRIPTIONbitrateinteger32000–384000(Default:192000)Averagebitrateinbits/second.
sample_rateinteger32000–48000Samplerateinhz.
channelsinteger1,2MonoorStereo.
ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary119/169DOLBYDIGITALAUDIOSETTINGSRequireslicenseNAMETYPERANGEDESCRIPTIONbitrateinteger64000–640000(Default:192000)Averagebitrateinbits/second.
Validbitratesdependonthecodingmode.
sample_rateintegerSamplerateisalways48000Samplerateinhz.
bitstream_modestringcomplete_main,commentary,dialogue,emergency,hearing_impaired,music_and_effects,visually_impaired,voice_overSpecifiesthe"BitstreamMode"(bsmod)fortheemittedAC-3stream.
SeeATSCA/52-2012forbackgroundonthesevalues.
coding_modestring1_0,1_1,2_0,3_2_LFEDolbyDigitalcodingmode.
Determinesnumberofchannels.
dynamic_range_compressionbooleantrueorfalseAddsdynamicrangecompressionsignalingtotheoutputbitstreamasdefinedintheDolbyDigitalspecification.
lfe_filterbooleantrueorfalseAppliesa120HzlowpassfiltertotheLFEchannelpriortoencoding.
Onlyvalidin3_2_LFEmode.
dialnorminteger1–31Setsthedialnormfortheoutput.
IfblankandinputaudioisDolbyDigital,dialnormwillbepassedthrough.
follow_input_metadatabooleantrueorfalseWhentrue,EncodermetadatawillbesourcedfromtheDD,DD+,orDolbyEdecoderthatsuppliedthisaudiodata.
Ifaudiowasnotsuppliedfromoneofthesestreams,thentheabovestaticmetadatasettingswillbeused.
DOLBYDIGITALPLUSAUDIOSETTINGSRequireslicenseNAMETYPERANGEDESCRIPTIONbitrateinteger64000–640000(Default:192000)Averagebitrateinbits/second.
Validbitratesdependonthecodingmode.
sample_rateintegerSamplerateisalways48000Samplerateinhz.
bitstream_modestringcomplete_main,commentary,emergency,hearing_impaired,visually_impairedSpecifiesthe"BitstreamMode"(bsmod)fortheemittedE-AC-3stream.
SeeATSCA/52-2012(AnnexE)forbackgroundonthesevalues.
coding_modestring1_0,2_0,3_2DolbyDigitalPluscodingmode.
Determinesnumberofchannels.
lfe_filterbooleantrueorfalseAppliesa120HzlowpassfiltertotheLFEchannelpriortoencoding.
Onlyvalidwith3_2codingmode.
dialnorminteger1–31Setsthedialnormfortheoutput.
IfblankandinputaudioisDolbyDigitalPlus,dialnormwillbepassedthrough.
dc_filterbooleantrueorfalseActivatesaDChighpassfilterforallinputchannels.
drc_linestringnone,film_standard,film_light,music_standard,music_light,speechEnablesDynamicRangeCompressionthatrestrictstheabsolutepeaklevelforasignal.
drc_rfstringnone,film_standard,film_light,music_standard,music_light,speechEnablesHeavyDynamicRangeCompression,ensuresthattheinstantaneoussignalpeaksdonotexceedspecifiedlevels.
surround_modestringnot_indicated,enabled,disabledWhenencoding2/0audio,setswhetherDolbySurroundismatrixencodedintothetwochannels.
lfebooleantrueorfalseWhenencoding3/2audio,enablestheLFEchannelsurround_ex_modestringnot_indicated,enabled,disabledWhenencoding3/2audio,setswhetheranextracenterbacksurroundchannelismatrixencodedintotheleftandrightsurroundchannels.
ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary120/169NAMETYPERANGEDESCRIPTIONstereo_downmixstringnot_indicated,lo_ro,lt_rt,dpl2Stereodownmixpreference.
Onlyusedfor3/2codingmode.
lt_rt_center_mix_levelfloat3.
0,1.
5,0.
0,-1.
5,-3.
0,-4.
5,-6.
0,-60Lefttotal/Righttotalcentermixlevel.
Onlyusedfor3/2codingmode.
lt_rt_surround_mix_levelfloat-1.
5,-3.
0,-4.
5,-6.
0,-60Lefttotal/Righttotalsurroundmixlevel.
Onlyusedfor3/2codingmode.
lo_ro_center_mix_levelfloat3.
0,1.
5,0.
0,-1.
5,-3.
0,-4.
5,-6.
0,-60Leftonly/Rightonlycentermixlevel.
Onlyusedfor3/2codingmode.
lo_ro_surround_mix_levelfloat-1.
5,-3.
0,-4.
5,-6.
0,-60Leftonly/Rightonlysurroundmixlevel.
Onlyusedfor3/2codingmode.
phase_shift_90_degreebooleantrueorfalseAppliesa90-degreephaseshifttothesurroundchannels.
Onlyusedfor3/2codingmode.
attenuate_3_dbbooleantrueorfalseAppliesa3dBattenuationtothesurroundchannels.
Onlyusedfor3/2codingmode.
follow_input_metadatabooleantrueorfalseWhentrue,EncodermetadatawillbesourcedfromtheDD,DD+,orDolbyEdecoderthatsuppliedthisaudiodata.
Ifaudiowasnotsuppliedfromoneofthesestreams,thentheabovestaticmetadatasettingswillbeused.
passthrough_when_possiblebooleantrueorfalseWhenchecked,inputDD+audiowillbepassedthroughifitispresentontheinput.
Thisdetectionisdynamicoverthelifeofthetranscode.
InputsthatalternatebetweenDD+andnon-DD+contentwillhaveaconsistentDD+outputasthesystemalternatesbetweenpassthroughandencoding.
DTSEXPRESSSETTINGSRequireslicenseNAMETYPERANGEDESCRIPTIONbitrateinteger48000–768000(Default:192000)Averagebitrateinbits/secondsample_rateinteger44100,48000Samplerateinhz.
Only48000issupportedinUltravioletcontainers.
bit_depthinteger16or24Bitspersample.
channel_layoutstringC,L_R,L_R_C_LFE_Ls_RsDTSchannellayout.
Determinesnumberofchannels.
dynamic_range_compressionbooleantrueorfalseAddsdynamicrangecompressionsignalingtotheoutputbitstreamasdefinedintheDTSspecification.
dialnorminteger1–31Setsthedialnormfortheoutput.
IfblankandinputaudioisDTSExpress,dialnormwillbepassedthrough.
PASSTHROUGHSETTINGSNAMETYPERANGEDESCRIPTIONnamestringPassthroughsettingsrequireanameandnootherparameters;thisisaknownissuethatwillbeaddressedinafuturerelease.
REMIXSETTINGSNAMETYPERANGEDESCRIPTIONchannels_ininteger1to16Numberofinputchannelstobeused.
channels_outinteger1,2,4,6,8Numberofoutputchannelstobeproduced.
channel_mappingXMLRemixingvaluestouse.
UnitsareindBandacceptablevaluesarewithintherangefrom-60(mute)and6dB.
Seeexample.
presetintegerRemixSettingsPresetID.
Ifthisisincluded,donotincludeanyotherparameters.
ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary121/169ThechannelmappingparametertakesavariableXMLstructurethatrepresentsthearrayofinputchannelstooutputchannels.
UnitsareindBandacceptablevaluesarewithintherangefrom-60(mute)and6dB.
Anexamplefordefaultstereoisdisplayedbelow:0-60-600.
.
.
AUDIONORMALIZATIONSETTINGSRequireslicenseNAMETYPERANGEDESCRIPTIONalgorithmstring1770-1or1770-2Audionormalizationalgorithmtouse.
1770-1conformstotheCALMActspecification,1770-2conformstotheEBUR-128specification.
correct_audiobooleantrueorfalseWhenenabledtheoutputaudioiscorrectedusingthechosenalgorithm.
Ifdisabled,theaudiowillbemeasuredbutnotadjusted.
target_lkfsfloat-59to0TargetLKFStoadjustvolumeto.
Ifnovalueisentered,adefaultvaluewillbeusedaccordingtothechosenalgorithm.
TheCALMAct(1770-1)recommendsatargetof-24LKFS.
TheEBUR-128specification(1770-2)recommendsatargetof-23LKFS.
log_loudnessbooleantrueorfalseLogeachoutput'saudiotrackloudnesstoaCSVfile.
truepeakbooleantrueorfalseCalculateandlogtheTruePeakforeachoutput'saudiotrackloudness.
CAPTIONDESCRIPTIONNAMETYPERANGEDESCRIPTIONorderinteger>0Requiredformultiplecaptions.
Specifiestheorderthecaptiondescriptionsshouldbelistedin.
caption_source_namestringSpecifieswhichCaptionSelectortousefromeachinputwhengeneratingcaptions.
Thenameshouldbeoftheformat"CaptionSelector",whichdenotesthattheNthCaptionSelectorwillbeusedfromeachinput.
destination_typestringARIB,Burn-In,CFF-TT,DVB-Sub,EBU-TT-D,Embedded,Embedded+SCTE-20,SCTE-20+Embedded,RTMPCaptionInfo,RTMPCuePoint,SCC,SMI,SMPTE-TT,SRT,Teletext,TTML,WebVTT,SCTE-27Destinationformatforcaptions.
Captionswithanexternalfiledestinationmustbespecifiedusingaseparatecaption-onlyoutput.
EmbeddedcaptionsinaQuicktimecontainerresultinacaptiontrack.
destination_settingsDestinationSettingsburnin_destination_settings,scc_destination_settings,dvb_sub_destination_settingsSpecificsettingsrequiredbydestinationtype.
Notethatburnin_destination_settingsarenotavailableifthesourceofthecaptiondataisEmbeddedorTeletext.
style_passthroughbooleantrueorfalseApplieswhenoutputisTTML,CFF-TT,orEBU-TT-DandsourcecaptionsareTeletext,TTML,SMPTE-TT,CCF-TT,embedded,oranembeddedcombination,orwhenoutputisWebVTTandsourcecaptionsareTeletext,embedded,oranembeddedcombination.
(Forotherinput/outputcombinations,thestyleisalwayssimplified,whichmeansthatthedownstreamplayerdeterminesthestyle.
)Check(true)topassthestyleinformationfromthesourcetotheoutputcaptions.
Uncheck(false)tousesimplifiedstyle.
ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary122/169NAMETYPERANGEDESCRIPTIONlanguage_codestringISO639-2three-digitcodeIndicatesthelanguageofthecaptionoutputtrack.
language_descriptionstringAlphanumericcharacters,spaces,andunderscoreHumanreadableinformationtoindicatecaptionsavailableforplayers(eg.
English,orSpanish).
id3_as_caption_contentbooleantrueorfalseWhenenabled,ID3textpacketsareinsertedintothecaptiontrackascontent.
OnlyavailablewithTTMLdestinationsandMSSmoothoutputs.
captions_subtypestringExactlyfourcapitalletters(A-Z)Whenspecified,overridesthedefault"CAPT"valueforthesubtypeattributeintheMSSmoothmanifest.
OnlyavailablewithTTMLdestinationsandMSSmoothoutputs.
dvb_sub_to_sdbooleantrueorfalseCheck(true)toresizethecaptionsdowntoSD(720*576).
ThisfieldisusefulwhenHDcaptionimagescannotbehandledbythevideoplayer.
Uncheck(false)toleavecaptionsintheiroriginalsize.
ApplicableonlyifboththeinputandoutputcaptionsareDVB-Sub.
Valueisignoredforallothercombinations.
MSSMOOTHTTMLTEMPLATESTherearetwotemplatefilesusedbyElementalLivetogenerateTTML.
Theycontainthestyleinformationappliedtosubtitlesthattheplayerwillthenrender.
Thetwofilesare:/opt/elemental_se/config/template-ttml-head.
txt/opt/elemental_se/config/template-ttml-foot.
txtThetwofilesinisolationcanbeconsideredtextfiles.
Oneistheheader,whichcontainstheactualCSSdefinitions.
Theotheristhefooter,whichcontainsjustafewclosingtagsandwhichgenerallywouldneverneedtobemodified.
Whenconcatenated,theyshouldproducewell-formattedXML.
ThespecificcaptiontextXMLofavideowillbeinjectedinbetweenthetwotemplatefiles.
YourtemplateXMLmustbewell-formed,otherwisethesystemwillfallbacktoaninternalXMLtemplate.
Noadditionalvalidationbeyondwell-formednessisperformed.
BURN-INDESTINATIONSETTINGSNAMETYPERANGEDESCRIPTIONfontLocationExternalfontfileusedforcaptionburn-in.
Fileextensionmustbe'ttf'or'tte'.
Althoughtheusercanselectoutputfontsformanydifferenttypesofinputcaptions,embedded,STLandteletextsourcesuseastrictgridsystem.
Usingexternalfontswiththesecaptionsourcescouldcauseunexpecteddisplayofproportionalfonts.
Allburn-inandDVB-Subfontsettingsmustmatch.
Anyitalics,bold,orbold-italicsversionsofthesefontsmustbeplacedinthesamedirectoryasthemainexternalfont.
Theymustalsobenamedasfollows:normal=>fontname.
ttfitalics=>fontname-Oblique.
ttforfontnameOblique.
ttfbold=>fontname-Bold.
ttforfontnameBold.
ttfbold+italics=>fontname-BoldOblique.
ttforfontnameBoldOblique.
ttffont_sizestringauto,orapositiveintegerWhensettoauto,font_sizewillscaledependingonthesizeoftheoutput.
Givingapositiveintegerwillspecifytheexactfontsizeinpoints.
Allburn-inandDVB-Subfontsettingsmustmatch.
font_resolutioninteger96–600FontresolutioninDPI(dotsperinch);defaultis96dpi.
Allburn-inandDVB-Subfontsettingsmustmatch.
ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary123/169NAMETYPERANGEDESCRIPTIONalignmentstringcentered,left,smartIfnoexplicitx_positionory_positionisprovided,settingalignmenttocenteredwillplacethecaptionsatthebottomcenteroftheoutput.
Similarly,settingaleftalignmentwillaligncaptionstothebottomleftoftheoutput.
Ifxandypositionsaregiveninconjunctionwiththealignmentparameter,thefontwillbejustified(eitherleftorcentered)relativetothosecoordinates.
Selecting"smart"justificationwillleft-justifylivesubtitlesandcenter-justifypre-recordedsubtitles.
Allburn-inandDVB-Subfontsettingsmustmatch.
x_positionintegerintegervaluegreaterthanorequalto0Specifiesthehorizontalpositionofthecaptionrelativetotheleftsideoftheoutputinpixels.
Avalueof10wouldresultinthecaptionsstarting10pixelsfromtheleftoftheoutput.
Ifnoexplicitx_positionisprovided,thehorizontalcaptionpositionwillbedeterminedbythealignmentparameter.
Allburn-inandDVB-Subfontsettingsmustmatch.
y_positionintegerintegervaluegreaterthanorequalto0Specifiestheverticalpositionofthecaptionrelativetothetopoftheoutputinpixels.
Avalueof10wouldresultinthecaptionsstarting10pixelsfromthetopoftheoutput.
Ifnoexplicity_positionisprovided,thecaptionwillbepositionedtowardsthebottomoftheoutput.
Allburn-inandDVB-Subfontsettingsmustmatch.
teletext_fixed_gridbooleantrue,falseControlswhetherafixedgridsizewillbeusedtogeneratetheoutputsubtitlesbitmap.
OnlyapplicableforTeletextinputsandDVB-Sub/Burn-inoutputs.
font_colorstringwhite,black,yellow,red,green,blue,blackSpecifiesthecoloroftheburned-incaptions.
ThisoptionisnotvalidforsourcecaptionsthatareSTL,608/embeddedorteletext.
Thesesourcesettingsarealreadypre-definedbythecaptionstream.
Allburn-inandDVB-Subfontsettingsmustmatch.
font_opacityinteger0–255Specifiestheopacityoftheburned-incaptions.
255isopaque;0istransparent.
Allburn-inandDVB-Subfontsettingsmustmatch.
background_colorstringnone,black,whiteSpecifiesthecoloroftherectanglebehindthecaptions.
Allburn-inandDVB-Subfontsettingsmustmatch.
background_opacityinteger0–255Specifiestheopacityofthebackgroundrectangle.
255isopaque;0istransparent.
Leavingthisparameterblankisequivalenttosettingitto0(transparent).
Allburn-inandDVB-Subfontsettingsmustmatch.
outline_sizeinteger0–10Specifiesfontoutlinesizeinpixels.
Thisoptionisnotvalidforsourcecaptionsthatareeither608/embeddedorteletext.
Thesesourcesettingsarealreadypre-definedbythecaptionstream.
Allburn-inandDVB-Subfontsettingsmustmatch.
outline_colorstringblack,white,yellow,red,green,blueSpecifiesfontoutlinecolor.
Thisoptionisnotvalidforsourcecaptionsthatareeither608/embeddedorteletext.
Thesesourcesettingsarealreadypre-definedbythecaptionstream.
Allburn-inandDVB-Subfontsettingsmustmatch.
shadow_colorstringnone,black,whiteSpecifiesthecoloroftheshadowcastbythecaptions.
Allburn-inandDVB-Subfontsettingsmustmatch.
shadow_opacityinteger0–255Specifiestheopacityoftheshadow.
255isopaque;0istransparent.
Leavingthisparameterblankisequivalenttosettingitto0(transparent).
Allburn-inandDVB-Subfontsettingsmustmatch.
shadow_x_offsetintegerintegervalueSpecifiesthehorizontaloffsetoftheshadowrelativetothecaptionsinpixels.
Avalueof-2wouldresultinashadowoffset2pixelstotheleft.
Allburn-inandDVB-Subfontsettingsmustmatch.
shadow_y_offsetintegerintegervalueSpecifiestheverticaloffsetoftheshadowrelativetothecaptionsinpixels.
Avalueof-2wouldresultinashadowoffset2pixelsabovethetext.
Allburn-inandDVB-Subfontsettingsmustmatch.
ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary124/169SCCDESTINATIONSETTINGSNAMETYPERANGEDESCRIPTIONframeratestring23.
97,24,29.
97dropframe,29.
97non-dropframeCompletethisfieldtoensurethatthecaptionsandthevideoaresynchronizedintheoutput.
Specifyaframeratethatmatchestheframerateoftheassociatedvideo.
Ifthevideoframerateis29.
97,choose29.
97dropframeonlyifthevideohasvideo_insertion=trueanddrop_frame_timecodetrue;otherwise,choose29.
97non-dropframe.
PRESETNAMETYPERANGEDESCRIPTIONnamestringNameforPreset.
descriptionstringDescriptionforPreset.
permalinkstringAlphanumericcharactersandunderscores,cannotbeaninteger.
AshortuniqueidentifierusedtorefertothisPreset.
Forexample,ifthepermalinkis"my_preset",itcanbeaccessedathttp://server/presets/my_preset.
Ifleftblank,apermalinkwillbegeneratedbasedonthePresetname.
log_edit_pointsbooleantrueorfalseGeneratesanXMLfileintheeventlogdirectorywithinitialtimecode,timecodeofinputswitches,andfinaltimecode.
Thiscanbeusedtoforlatereditingofthisoutput.
preset_categoryintegerorstringNameorIDofPresetCategory.
containerenumContainerforthisoutput.
SeeContainersforsupportedoutputcontainers.
Canbeauto-detectedfromextensionfield.
Certaincontainersrequireacontainer_settingsobject.
Ifnotspecified,thedefaultobjectwillbecreated.
container_settingsContainerSettingsmov_settings,uvu_settings,m2ts_settingsContainerspecificsettings.
Note:replacecontainerwiththecontaineryouareusingintheXMLtag(e.
g.
).
video_descriptionVideoDescriptionVideosettingsforthisPreset.
audio_descriptionAudioDescriptionAudiosettingsforthisPreset.
TherecanbemultipleaudiosettingsinasinglePreset.
caption_descriptionCaptionDescriptionCaptionsettingsforthisPreset.
TherecanbemultiplecaptionsettingsinasinglePreset.
arib_captions_passthroughbooleantrueorfalseIftrue,passesanyARIBCaptionsdatafromtheinputsourcetothisoutput.
Onlyavailableforcertaincontainersundercertainconditions.
scte35_passthroughbooleantrueorfalseIftrue,passesanySCTE-35signalsfromtheinputsourcetothisoutput.
Onlyavailableforcertaincontainers.
insert_scte35_esambooleantrueorfalseIftrue,updateanySCTE-35signalsfromESAMPOIStothisoutput.
Onlyavailableform2tscontainers.
PRESETCATEGORYNAMETYPERANGEDESCRIPTIONnamestringNameforPresetCategory.
REMIXSETTINGSPRESETNAMETYPERANGEDESCRIPTIONnamestringNameforremixsettingspreset.
channels_ininteger1–16Numberofinputchannelstobeused.
channels_outinteger1,2,6Numberofoutputchannelstobeproduced.
ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary125/169NAMETYPERANGEDESCRIPTIONchannel_mappingXMLRemixingvaluestouse.
Seeexample.
LIVEEVENTPROFILENAMETYPERANGEDESCRIPTIONnamestringNameforProfile.
descriptionstringDescriptionforProfile.
permalinkstringAlphanumericcharactersandunderscores,cannotbeaninteger.
AshortuniqueidentifierusedtorefertothisLiveEventProfile.
Forexample,ifthepermalinkis"my_profile",itcanbeaccessedathttp://server/live_event_profiles/my_profile.
Ifleftblank,apermalinkwillbegeneratedbasedontheLiveEventProfilename.
inputInputInputparameters.
TherecanbemultipleinputsinasingleProfile.
timecode_configTimecodeConfigContainssettingsusedtoacquireandadjusttimecodeinformationfrominputs.
loop_all_inputsbooleantrueorfalseProcesslistofinputssequentiallyandloopfromthefirstinputwhencomplete.
ad_triggerstringscte35_splice_insert,scte35_time_signal_aposControlswhichtypesofSCTEsignalssignalAdAvails.
Adscanbesignaledwith"SpliceInsert"messages,whichistraditional,orwith"TimeSignal"messages,carrying"AdPlacementOpportunityStart"segmentationmessages(type_id0*35).
SeeSCTE352013formoreinformation.
ignore_web_delivery_allowed_flagbooleantrueorfalseWhenenabled,SegmentDescriptorswithweb_delivery_allowed_flagsetto0willnolongertriggerblackoutsorAdAvailslatesignore_no_regional_blackout_flagbooleantrueorfalseWhenenabled,SegmentDescriptorswithno_regional_blackout_flagsetto0willnolongertriggerblackoutsorAdAvailslatesinitial_audio_gaininteger-60to60dB(Default:0dB)ValuetosettheinitialaudiogainfortheLiveEvent.
ThisisalsoeditablewhiletheLiveEventisrunning.
notificationNotificationSettingsfornotificationonstatuschanges.
avsync_enablebooleantrueorfalseEnablesA/Vsync.
avsync_pad_trim_audiobooleantrueorfalseEnablesA/Vsynctrimaudio.
pre_processPre-ProcessSettingsforpreprocessingsteps.
post_processPost-ProcessSettingsforpostprocessingsteps.
failure_ruleFailureRuleSettingsforfailurerules.
image_inserterImageInserterSettingsfortheimageinserter.
Whenattachedtoaprofile,insertsimagesintothedecodedinputandappearsineveryoutput.
avail_blankingAvailBlankingSettingsforadavailblanking.
blackout_slateBlackoutSlateSettingsforblackoutslate.
output_lockOutputLockSettingsforoutputlocking.
input_end_actionstringswitch_input,ornoneIndicatestheactiontotakewhenaninputcompletes(e.
g.
end-of-file.
)Optionsincludeimmediatelyswitchingtothenextsequentialinput(via"switch_input")ortranscodingblack/color/slateimagesperthe"InputLossBehavior"configurationuntilanactivate_inputRESTcommandisreceived(via"none").
output_timing_sourcestringinput_clock,orsystem_clockIndicateswhethertherateofframesemittedbytheLiveencodershouldbepacedbyitssystemclock(whichoptionallymaybelockedtoanothersourceviaNTP)orshouldbelockedtotheclockofthesourcethatisprovidingtheinputstream.
input_buffer_sizeinteger4–300(Default:60)Numberofframestobufferatinput.
Highervalueswillallowlessdroppedframes,butusemorememory.
Lowervaluescanimprovestreaminglatency.
ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary126/169NAMETYPERANGEDESCRIPTIONresource_reservationstringnoneor4k_decodeWhen4KDecodeisselected,thesystemreservesadditionalresourcestoprovidereal-time4Kdecodeofasecondnetworkinput.
Thisoptionallowsthesystemtoreserveresourcesfor4Kseamlessinputswitchingor4KHot-Hotredundancywhennetwork(IP)sourcesareused.
ResourcereservationisnotrequiredwhenusingQuadSDIsourcesfor4Kencoding.
Note–thisoptiononlyhaseffectfor4KworkflowshostedontheAWSElementalLiveL700AEseries(orgreater)when4Kencodingisconfigured.
TheRESTparametercontrolledbythischeckboxisresource_reservation.
Itsupportsvaluesofnoneand4k_decode.
low_framerate_inputbooleantrueorfalseAdjustsvideoinputbufferforstreamswithverylowvideoframerates.
Thisiscommonlyusedformusicchannelswithlessthanonevideoframepersecond.
low_latency_modebooleantrueorfalseReduceslatencyofaudio/videosync.
ThisreducesoveralllatencyofLiveEvent,butmayresultinmoredroppedaudiopacketsoninputtimestampdiscontinuities.
ParametervaluessuchasBFrameandMin-IIntervalmaystillincreaselatencywhileLowLatencyisset,buttheneteffectisanoverallreduction.
stream_assemblyStreamAssemblyStreamassembliesforthisProfile.
AProfilecanhaveseveralstreamassemblieswhichdefineoutputcodecsettings.
nielsen_configurationNielsenConfigurationNielsenconfigurationsettingsoutput_groupOutputGroupOutputgroupsforthisProfile.
Outputgroupscontaininformationaboutwherestreamsshouldbedistributedto.
ad_avail_offsetinteger-1000–1000(Default:0)Whenspecified,thisoffset(inmilliseconds)isaddedtotheinputAdAvailPTStime.
user_datastringUser-defineddatatobeattachedtotheLiveEvent.
ThisdataisavailablewithLiveEventstatusrequestsviatheAPI.
extract_sdtbooleantrueorfalseExtractsSDTinformationfrominputstream.
DisplaysServiceProviderandServiceNamesduringrunningstate.
SCHEDULENAMETYPERANGEDESCRIPTIONnamestringNameoftheschedule.
profileintegerorstringValidProfileIDornameTheProfiletobeusedtocreatethescheduledLiveEvents.
AvalidIDornamemustbeprovided,specifyingbypermalinkisnotsupported.
nodeintegerorstringValidnodeIDorhostnameorIPAddressNodeonwhichtorunthescheduledLiveEvents.
failure_ruleFailureRuleScheduledLiveEventfailureparameters.
inputInputInputparameterstousewhencreatingscheduledLiveEvents.
IftheProfilebeingusedhasinputparameters,thenthismaybeleftblankandtheinputparametersoftheProfilewillbeused.
start_typestringstart_timeIndicateswhichfieldspecifiesthescheduledLiveEventstarttimes.
start_timedatetimeDateandtimetostartthefirstscheduledLiveEvent.
Thisvalueisrequiredifstart_typeissettostart_time.
end_typestringend_time,durationIndicateswhichfieldspecifiesthescheduledEventendtimes.
Iftheend_typeissettoend_time,thentheend_timeparameterisrequired.
Iftheend_typeissettoduration,thenthedurationparameterisrequired.
end_timedatetimeDateandtimetoendthefirstscheduledLiveEvent.
Thisvalueisrequiredifend_typeissettoend_time.
durationintegerThenumberofminutestoremainactive.
Thisvalueisrequiredifend_typeissettoduration.
untilstringforever,end_dateIndicateshowlongthisscheduleissettorepeat.
Ifthevalueisend_date,thentheend_dateparameterisrequired.
ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary127/169NAMETYPERANGEDESCRIPTIONend_datedatetimeDatethatthisrepeatingscheduleends.
Requirediftheuntilparameterissettoend_date.
schedule_typestringdaily,weekly,monthlyIndicatesthetypeofrepeatingschedule.
Onlytheparametersthatstartwithwillbefollowed.
daily_xinteger1–30Indicatesthenumberofdaysonwhichtorepeat.
Ifvalueis2,schedulewillrepeatevery2days,startingwiththedayindicatedbythestart_timing.
Thisvalueisrequiredifschedule_typeparameterissettodaily.
Defaultvalueis1,whichindicatesaschedulethatrepeatseveryday.
weekly_sundaybooleantrueorfalseIndicatesthatthisschedulewillrepeateverySunday.
Onlyavailableifscheduletypeparameterissettoweekly.
weekly_mondaybooleantrueorfalseIndicatesthatthisschedulewillrepeateveryMonday.
Onlyavailableifscheduletypeparameterissettoweekly.
weekly_tuesdaybooleantrueorfalseIndicatesthatthisschedulewillrepeateveryTuesday.
Onlyavailableifscheduletypeparameterissettoweekly.
weekly_wednesdaybooleantrueorfalseIndicatesthatthisschedulewillrepeateveryWednesday.
Onlyavailableifscheduletypeparameterissettoweekly.
weekly_thursdaybooleantrueorfalseIndicatesthatthisschedulewillrepeateveryThursday.
Onlyavailableifscheduletypeparameterissettoweekly.
weekly_fridaybooleantrueorfalseIndicatesthatthisschedulewillrepeateveryFriday.
Onlyavailableifscheduletypeparameterissettoweekly.
weekly_saturdaybooleantrueorfalseIndicatesthatthisschedulewillrepeateverySaturday.
Onlyavailableifscheduletypeparameterissettoweekly.
monthly_xinteger1–12Indicatesthenumberofmonthsonwhichtorepeat.
Ifvalueis2,schedulewillrepeatevery2months,startingwiththemonthindicatedbythestart_timing.
Thisvalueisrequiredifschedule_typeparameterissettomonthly.
Defaultvalueis1,whichindicatesaschedulethatrepeatseverymonth.
monthly_bystringday,weekIndicatesthetypeofrepeatingmonthlyschedule.
Avalueofdayrequiresthemonthly_day_of_monthparametertobeset.
Avalueofweekrequiresthemonthly_day_of_weekandthemonthly_week_of_monthparameterstobeset.
monthly_day_of_monthinteger1–31Indicateswhichdayofthemonthtorepeaton.
Avalueof15willrepeatonthe15thdayofthemonth.
Requiredifmonthly_byparameterissettoday.
monthly_day_of_weekstringSunday–SaturdayIndicateswhichdayoftheweektorepeaton.
Combineswithmonthly_week_of_monthtodeterminewhichdaytorepeatoneachmonth.
Requiredifmonthly_byparameterissettoweek.
monthly_week_of_monthstringFirst,Second,Third,Fourth,LastIndicateswhichweekofthemonthtorepeaton.
Combineswithmonthly_day_of_weektodeterminewhichdaytorepeatoneachmonth.
Requiredifmonthly_byparameterissettoweek.
Forexample,ifmonthly_day_of_weekisSunday,andmonthly_week_of_monthisLast,thenitwillrepeatontheLastSundayofthemonth.
CUEPOINTPARAMETERSTRIGGERINGANAVAILNAMETYPERANGEDESCRIPTIONevent_idintegerASCTE-35eventIDisrequiredforthisevent.
Thisallowsforcancelinglater.
Typically,eachAvailwillhaveitsownuniqueeventID.
IfnoeventIDisgiven,onewillbegeneratedandreturnedintheresponse.
AutogeneratedIDstartsfrom0xf0000001andcontinuestoincrement.
Itwrapsaroundto0xf0000001after0xffffffff.
splice_time/hoursintegerThetimeatwhichtostarttheavail.
Preroll+Durationshouldbelessthan13hours15minutes.
splice_time/minutesintegerTheminuteatwhichtostarttheavail.
ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary128/169NAMETYPERANGEDESCRIPTIONsplice_time/secondsintegerThesecondatwhichtostarttheavail.
splice_time/framesintegerTheframe(withinhour+minute+second)atwhichtostarttheavail.
splice_offsetintegerThenumberofmillisecondstowait(alsoknownas"preroll")beforetriggeringthisavail.
durationintegerReturnfromavailafterthismanyseconds.
Eitherasplice_time(basedonthetimecode_sourceoftheLiveEvent)orsplice_offset(prerollmilliseconds)mustbegiven.
Examples:10000302800030Notethatcue_pointtimesareinthelocaltimezonewhenthetimecode_sourceissystemclock.
ToqueryforthecurrenttimeofthestreamwhiletheLiveEventisrunning,issuethefollowingcommand:curl-H"Accept:application/xml"-H"Content-type:application/xml"\-d"1"\http:///api/live_events/4/cue_pointThiscommandreturnsasplicepointtimeyoucanbasefuturecuepointsonasfollows:102023PTS[00:00:02.
969].
CurrentNTP[16:21:23.
573].
0cue_pointRETURNINGFROMANAVAILNAMETYPERANGEDESCRIPTIONreturn_offsetintegerThenumberofmillisecondstowait(alsoknownas"preroll")beforereturning.
Example:0ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary129/169CANCELINGANAVAILNAMETYPERANGEDESCRIPTIONcancel_event_idintegerTheeventIDofanupcomingavailtocancel.
Example:4CUEPOINTCOMMANDRESPONSENAMETYPERANGEDESCRIPTIONevent_idintegerTheeventIDofthenewevent(eitherwhatyoupassedin,orauto-generated).
splice_time/hoursintegerThehourwhentheavailstarts.
splice_time/minutesintegerTheminutewhentheavailstarts.
splice_time/secondsintegerThesecondwhentheavailstarts.
splice_time/framesintegerTheframe(withinhour+minute+second)whentheavailstarts.
splice_offsetintegerTheoffsetfromnow(preroll,inmilliseconds)atwhichthiseventoccurs.
messagestringAmoredetailedhuman-readablelogmessage.
errors/error/codeintegerErrorcodereturnedbythiscommand.
errors/error/messagestringAmoredetailedhuman-readableerrormessage.
Examplesofsuccessandfailure:800008000InsertedatPTS[1234].
Availtime[00:00:05.
000]PTS[2345],duration[30].
91040PrerolltimemustbepositiveintegerElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary130/169TIMESIGNALPARAMETERSINSERTINGATIMESIGNALNAMETYPERANGEDESCRIPTIONtime/hoursintegerThehour(inlocaltime)whenthetimesignaloccurs.
Timesignalsscheduledlaterthan6hoursinthefuturearenotsupported.
time/minutesintegerTheminute(inlocaltime)whenthetimesignaloccurs.
time/secondsintegerThesecond(inlocaltime)whenthetimesignaloccurs.
time/framesintegerTheframe(withinhour+minute+second)whenthetimesignaloccurs.
descriptorsstringAhexadecimalstringcontainingtimesignaldescriptordata(optional).
TIMESIGNALCOMMANDRESPONSENAMETYPERANGEDESCRIPTIONsignal_time/hoursintegerThehour(inlocaltime)whenthetimesignaloccurs.
signal_time/minutesintegerTheminute(inlocaltime)whenthetimesignaloccurs.
signal_time/secondsintegerThesecond(inlocaltime)whenthetimesignaloccurs.
messagestringAmoredetailedhuman-readablelogmessage.
errors/error/codeintegerErrorcodereturnedbythiscommand.
errors/error/messagestringAmoredetailedhuman-readableerrormessage.
Asplice_time(basedontimecode_source)mustbegiven.
Example:0000021B43554549000000027FBF030C54564E413130303030303031300000Adetailedviewofthedescriptordataprovidedintheexample:descriptor_loop_lengthwillbesetto29(numberofhexbytes)scte35_descriptor_tag:2descriptor_length:27identifier:segmentation_event_id:2segmentation_event_cancel:0reserved:127program_segmentation_flag:1segmentation_duration_flag:0reserved:63segmentation_upid_type:3(Ad-ID)segmentation_upid_length:12segmentation_upid:segmentation_type_id:48(ProviderAdvertisementStart)segment_num:0segments_expected:0Examplesofsuccessandfailure:ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary131/169Insertedtimesignalateventtime[1234],PTS[1234].
Signaltime[1234]PTS[1234].
100011040InvalidtimesignalmessageMETADATAINSERTIONPARAMETERSINSERTINGTIMEDMETADATANAMETYPERANGEDESCRIPTIONtime/hoursintegerThehour(inlocaltime)toinsertmetadata.
If…isomitted,insertionisimmediate.
time/minutesintegerTheminute(inlocaltime)toinsertmetadata.
time/secondsintegerThesecond(inlocaltime)toinsertmetadata.
time/framesintegerTheframetoinsertmetadata.
id3BinaryID3dataTheID3datatoinsertintothestream.
Ingeneral,eachsetofID3datamustbeprecededbytheID3framedescriptor,suchasID3TIT2forTitleinformationorID3TCOPforCopyrightinformation.
AvailableID3framesdescriptorsareavailableintheID3specification.
Theresultingstringshouldthenbeprovidedinbase64encoding,specifiedby(base64encodedcontent).
cancelbooleanCancelsallpendinginsertioncommands.
INSERTINGPRIVATEMETADATANAMETYPERANGEDESCRIPTIONtime/hoursintegerThehour(inlocaltime)toinsertmetadata.
If…isomitted,insertionisimmediate.
time/minutesintegerTheminute(inlocaltime)toinsertmetadata.
time/secondsintegerThesecond(inlocaltime)toinsertmetadata.
time/framesintegerTheframetoinsertmetadata.
namestringNameforthismetadataentry.
parameterslistofparametersListofelementsmakingupthismetadataentry.
parameter/namestringNameofparameter.
parameter/typeenumstring,numberTypeofparameter.
parameter/valuestringValueofparameter.
Thiscanbeprovidedinbase64encoding,specifiedby(base64encodedcontent).
ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary132/169NAMETYPERANGEDESCRIPTIONcancelbooleanCancelsallpendingprivatemetadatainsertioncommands.
ExamplecommandforinsertingPrivateMetadata:curl-H"content-type:application/xml"-H"accept:application/xml"-d@private_metadata_example.
xml-XCorrespondingXMLrequestbody:firstadbeginString30commercial_flagNumber1ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary133/169AVAILIMAGEPARAMETERSAVAILIMAGEPARAMETERSNAMETYPERANGEDESCRIPTIONuristringThelocalpathorremoteURLoftheavailimageusernamestringTheusernameforURL/S3authenticationpasswordstringThepasswordforURL/S3authenticationAnavail_imagemustbegiven.
Example:http://example.
com/protected/blanking1.
pngbriansecret123Examplesofsuccessandfailure:3Cachedandsetavailblankingimageto[http://example.
com/protected/blanking1.
png]avail_image15002Unabletofetch[http://example.
com/protected/blanking1.
png]duringlocalcaching.
avail_imageElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary134/169BLACKOUTIMAGEPARAMETERSBLACKOUTIMAGEPARAMETERSNAMETYPERANGEDESCRIPTIONuristringThelocalpathorremoteURLoftheblackoutimageAblackout_imagemustbegiven.
Example:/opt/elemental_se/web/public/example_files/Elemental_logo.
pngExamplesofsuccessandfailure:3Setblackoutimageto[/opt/elemental_se/web/public/example_files/Elemental_logo.
png]blackout_image11040Blackoutimageinsertionisnotenabledforthisevent.
blackout_imageDEVICENAMETYPERANGEDESCRIPTIONnamestringAnametoidentifythedevice.
ROUTERNAMETYPERANGEDESCRIPTIONnamestringstringAnametoidentifytherouter.
ipstringValidIPaddressSpecifiestheIPaddressoftherouter.
max_inputsinteger>=1Specifiesthetotalnumberofinputsfortherouter.
router_input_deviceRouterInputDeviceSpecifiesaparticularrouterinputdevice.
Arouterhasmanyrouterinputdevices(equaltothemax_inputs).
max_outputsinteger>=1Specifiesthetotalnumberofoutputsfortherouter.
router_outputRouterOutputSpecifiesaparticularrouteroutput.
Aroutermayhavemanyrouteroutputs(uptothemax_outputs).
router_typestringblackmagic_videohub,harris_panacea,miranda_nvisionDesignatestheroutertype.
router_settingsRouterSettingsharris_panacea_settings',miranda_nvision_settings'Routersettingsrequiredbythespecifiedroutertype.
Note:replacerouterwiththeroutertypeyouareusingintheXMLtag.
ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary135/169ROUTERINPUTNAMETYPERANGEDESCRIPTIONrouter_ipstringValidIPaddressIPaddressoftherouter.
router_typestringblackmagic_videohub,harris_panacea,miranda_nvision,snell_aurora,imagine_xypassthrough,imagine_lrcDesignatestheroutertype.
router_settingsRouterSettingsharris_panacea_settings',miranda_nvision_settings'Routersettingsrequiredbythespecifiedroutertype.
Note:replacerouterwiththeroutertypeyouareusingintheXMLtag.
input_numberinteger>=1DesiredSDIinputfromtherouter.
ROUTEROUTPUTNAMETYPERANGEDESCRIPTIONoutput_numberinteger>=1Outputnumberoftherouterthatisconnectedtothedevice.
device_idintegerDeviceIDofHD-SDIinputcardthatisconnectedtotherouter.
MPTSNAMETYPERANGEDESCRIPTIONnamestringAnamefortheMPTSbitrateinteger>=1ThetotalbitrateoftheMPTSinbits/secondvideo_allocationinteger>=1Thebitrateallocatedforvideotrafficinbits/secondtransport_stream_idinteger0"65535ThevalueofthetransportstreamIDfieldintheProgramMapTable.
buffer_msecinteger0–10000UDPoutputbufferinginmilliseconds.
Largervaluesincreaselatencythroughthetranscoderbutsimultaneouslyassistthetranscoderinmaintainingaconstant,low-jitterUDP/RTPoutputwhileaccommodatingclockrecovery,inputswitching,inputdisruptions,picturereordering,etc.
output_listeningbooleantrueorfalseWhencheckedthespecifiedmulticastdestinationaddressesaremonitored(joined)andreceivedpacketsareexamined.
Ifthesedestinationsareservedbyothersenders,thentheUDPtransmissionfromthiseventtothataddressissuppressed.
Ifnopacketsfromtheothersendersaredetectedforaperiodofoutput_listening_intervalthenthetransmissionfromthiseventisnolongersuppressed.
Whentrafficfromanothersenderisre-detected,thetransmissionfromthiseventisimmediatelysuppressedagain.
Thisfeaturesupportsveryfastacting1:1failoverscenarios.
output_listening_intervalintegerThespecifieddetectionintervalforOutputListeningfeature,inmilliseconds.
Ifnopacketsaredetectedintheinterval,localtransmissionisactivated.
Detectionintervalonlyspecifiesactivationtime.
Deactivationtimeisimmediate.
pat_intervalinteger10"1000(Default:100)ThePATintervalinmsdestinationLocationTheprimarydestinationfortheMPTSoutput.
CanbeaUDPorRTPlocation.
secondary_destinationLocationThesecondarydestinationfortheMPTSoutput.
CanbeaUDPorRTPlocation.
fec_output_settingsFECOutputSettingsFECsettingsfortheMPTSoutputmpts_membersArrayofMPTSMembersAnarrayofMPTSmemberchannelsElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary136/169LOCALMPTSMEMBERNAMETYPERANGEDESCRIPTIONtypestringlocalSpecifiesthetypeofMPTSmember.
TocreateaLocalMPTSmember,use"local".
program_numberinteger1"65535TheprogramnumbertouseforthisMPTSmemberpid_mapHashPIDassignmentstouseforthismemberintheMPTSoutput.
Ifnovaluesareprovided,PIDswillbeassignedautomatically.
SupportsbothPIDkeyswithsinglevalues(pmt_pid,video_pid,pcr_pid,scte35_pid,klv_data_pids,dvb_teletext_pid,etv_platform_pid,etv_signal_pid,timed_metadata_pid,private_metadata_pid)andthosewithmultiplevalues(audio_pids,dvb_sub_pids,scte27_pids).
Seebelowforformatexample.
live_event_idintegerTheIDofanyMPTS-eligibleLiveEventTheIDoftheLiveEventrepresentedbythisMPTSmemberchannelREMOTEMPTSMEMBERNAMETYPERANGEDESCRIPTIONtypestringremoteSpecifiesthetypeofMPTSmember.
TocreateaRemoteMPTSmember,use"remote".
program_numberinteger1"65535TheprogramnumbertouseforthisMPTSmemberpid_mapHashPIDassignmentstouseforthismemberintheMPTSoutput.
Ifnovaluesareprovided,PIDswillbeassignedautomatically.
SupportsbothPIDkeyswithsinglevalues(pmt_pid,video_pid,pcr_pid,scte35_pid,klv_data_pids,dvb_teletext_pid,etv_platform_pid,etv_signal_pid,timed_metadata_pid,private_metadata_pid)andthosewithmultiplevalues(audio_pids,dvb_sub_pids,scte27_pids).
Seebelowforformatexample.
inputLocationTheprimaryinputforthischannel'svideocontent.
CanbeaUDPorRTPlocation;mustbeRTPifasecondaryinputisalsoprovided.
secondary_inputLocationThesecondaryinputforthischannel'svideocontent.
MustbeanRTPlocation.
complexity_receipt_destinationLocationPrimarymulticastdestinationforcomplexityestimatesfromencodertoMPTS.
secondary_complexity_receipt_destinationLocationAdditionalmulticastdestinationforcomplexityestimatesfromencodertostatmux.
Typicalusecaseistoenablemultiplenetworkpathredundancy(twointerfacesandtwoswitches)fromencodertoMPTS.
allocation_transmit_destinationLocationMulticastdestinationforbitrateallocationsfromMPTStoencoder.
secondary_allocation_transmit_destinationLocationAdditionalmulticastdestinationforbitrateallocationsfromMPTStoencoder.
Typicalusecaseistoenablemultiplenetworkpathredundancy(twointerfacesandtwoswitches)fromencodertoMPTS.
PIDMAPEXAMPLE888240241ElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary137/169SEQUENCERCONFIGNAMETYPERANGEDESCRIPTIONuse_cpu_sizeintegerOffloadsasmalltasktotheCPUifitsoutputresolution(width*height)islessthanorequaltothisvalueanduse_cpu_rateconditionsaremetuse_cpu_rateintegerOffloadsasmalltasktotheCPUifitstargetbitrateislessthanorequaltothisvalueanduse_cpu_sizeconditionsaremetcpu_load_factorintegerThemaximumnumberofthreadstoutilizeperCPU.
ThisaffectsthemaximumamountofworkthesystemwillexecuteontheCPUsimultaneously.
use_cpu_saturatedbooleanAllowsoffloadingadditionaltaskstotheCPUiftheGPUissaturatedcopy_local_dirstringWhenthecopy_localflagissetforajob,allofitsfileinputswillbecopiedintothisworkingdirectorybeforethetranscodebegins.
Non-streamingnetworkfileinputs(seeURItypes)arealwaysdownloadedhereregardlessofthecopy_localflag.
exclude_gpu_0booleanPreventsjobsfromrunningonGPU0exclude_gpu_1booleanPreventsjobsfromrunningonGPU1exclude_gpu_2booleanPreventsjobsfromrunningonGPU2exclude_gpu_3booleanPreventsjobsfromrunningonGPU3rtmp_inputbooleanEnablesRTMPinputrtmp_input_portintegerSetstheinputRTMPinputportnumbermedia_info_timeoutintegerNumberofsecondsbeforeelemental_sequitstryingtodetermineaninput'smediainfoduringpreprocessingdisable_profiles_and_levels_messagingbooleanShow[ProfilesandLevels]typemessagingduringprocessing.
RetrievingmessagesviaRESTisnotaffectedbythissetting.
ingest_parser_enabledbooleanIfchecked,monitorsandparsesSDIingestinformationandissuesalertswhennecessary.
FORMATIDENTIFIERPARAMETERSCertainfieldsallowforformatidentifierstobespecifiedthatwillmodifytheoutputvalue.
Notethatwhenformatidentifiersareusedinanoutputpath,thevalidationspreventingduplicateoutputpathswillbedisabled.
IftheexpandedformatidentifierscreateduplicateoutputpathstheLiveEventwillerroronceitisstarted.
IDENTIFIERFORMATDESCRIPTION$dt$YYYYMMDDTHHMMSSUTCdatetimeofthestarttimeoftheLiveEvent.
NOTE:HLSoutputswillusethecurrentdatetimeforeachsegment.
$d$YYYYMMDDUTCdateofthestarttimeoftheLiveEvent.
NOTE:HLSoutputswillusethecurrentdateforeachsegment.
$t$HHMMSSUTCtimeofthestarttimeoftheLiveEvent.
NOTE:HLSoutputswillusethecurrenttimeforeachsegment.
$rv$KbVideobitrate,exceptwhenRateControlModeissettoQVBR,inwhichcasethisfieldresolvestothevalueinMaxBitrate.
$ra$KbTotalofallaudiobitrates$rc$KbContainerbitrate,orthesumofvideoandallaudiobitratesifcontainerbitrateisnotspecified.
$w$PixelsHorizontalresolution$h$PixelsVerticalresolution$f$IntegerFPSFrameratewithoutdecimalplaces$fn$FilenameNameofinputfile(excludingtheextension).
$ex$ExtensionExtensionoftheoutputfileElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary138/169IDENTIFIERFORMATDESCRIPTION$job$JobIDIDoftheserverjob.
Usedtoensureuniqueoutputdestinations.
$event$EventIDIDoftheliveevent.
Usedtoensureuniqueoutputdestinations.
$$$Escaped$Fieldsthatacceptformatidentifierfieldsinclude:DestinationURI(Archive,AppleHLSandDASHISOOutputGroups)(TimestampandFilenameidentifiersonly)AdobeRTMPEndpointURI(TimestampandFilenameidentifiersonly)MSSmoothPublishPointURI(TimestampandFilenameidentifiersonly)NameModifier(Archive,AppleHLS,MSSmoothandDASHISOoutputs)AdobeRTMPStreamNameNameModifiersforDASHISOoutputsacceptthreeformatidentifiers:$Number$,$Time$,and$Bandwidth$.
Inthemanifest,$Number$allowsSegmentTemplatetocontain"duration"and"startNumber".
Alternately,$Time$givesthemanifestaSegmentTimeline.
WIDTHSPECIFIERPARAMETERFormatidentifiersmaybemodifiedwithawidthparameter:%0[width]Inthecasewherethevalueislessthanthespecifiedwidth,thevaluewillbeprefixedwithzerostoensurethevalueisequaltothewidthspecified.
Ifthevalueisgreaterthanthespecifiedwidththenthefullvaluewillbedisplayed(notruncation).
Thefollowingexampleshowswhathappenswhenusingthewidthspecifieronaverticalresolutionattributeof1280:$h%05$=>01280$h%03$=>1280SCANTYPESThistabledescribeshowtoconvertprogressive,interlace,ortelecineinputtoadifferentscantypeintheoutput.
INPUTANDDESIREDOUTPUTHOWTOGETTHEREINPUTOUTPUTPREPROCESSORFIELDFORCEMODEFIELD(FORCE)INTERLACEMODEFIELDTELECINEMODEFIELDProgressiveProgressiveOffn/aProgressiveNoneInterlacedProgressiveDeinterlaceOn:ifyouknowthatmetadataistaggedasprogressivewheninfactitisnotprogressive.
Off:ifframesarecorrectlytagged.
ProgressiveNoneInterlacedProgressiveAdaptiveOffProgressiveNoneHardtelecineProgressiveInversetelecineOn:ifyouknowthatmetadataistaggedasprogressivewheninfactitisnotprogressive.
Off:ifframesarecorrectlytagged.
ProgressiveNoneHardtelecineProgressiveAdaptiveOffProgressiveNoneSofttelecineProgressiveOffn/aProgressiveNoneMixedProgressiveAdaptiveOffProgressiveNoneProgressiveHardtelecineOffn/aInterlaceHardtelecineHardtelecineHardtelecineOffn/aInterlaceNoneElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary139/169INPUTANDDESIREDOUTPUTHOWTOGETTHEREINPUTOUTPUTPREPROCESSORFIELDFORCEMODEFIELD(FORCE)INTERLACEMODEFIELDTELECINEMODEFIELDSofttelecineHardtelecineOffn/aInterlaceHardtelecineMixedHardtelecineOffn/aInterlaceHardtelecineInterlacedInterlacedOffn/aInterlaceNoneMixedInterlacedOffn/aInterlaceNoneProgressiveSofttelecineOffn/aInterlaceSofttelecineHardtelecineSofttelecineInversetelecineOn:ifyouknowthatmetadataistaggedasprogressivewheninfactitisnotprogressive.
Off:ifframesarecorrectlytagged.
InterlaceSofttelecineHardtelecineSofttelecineAdaptiveOffInterlaceSofttelecineSofttelecineSofttelecineOffn/aInterlaceSofttelecineMixedSofttelecineAdaptiveOffInterlaceSofttelecineElementalLiveAPIandUserGuideLiveEventParameters09/04/19ElementalTechnologiesConfidentialandProprietary140/169SNMPINTERFACETheElementalLivesystemcanbemonitoredandcontrolledthroughSimpleNetworkManagementProtocol(SNMP).
Ifconfiguredtodoso,thesystemwillgenerateSNMPtrapsforcertaineventslikeAlertsorLiveEventerrors.
Ausercaninteractwiththesystemusingavarietyofnetworkmanagementsystems.
ElementalLiveincludestheNet-SNMP(http://www.
net-snmp.
org/)command-linetoolstoaccesstheSNMPinterfacewhileloggedintothesystemoverSSH.
Examplesinthisdocumentaregivenusingnet-snmpcommands.
SNMPBasicsOperationsBaseSNMPOperationsLiveEventOperationsSNMPTrapsSNMPBASICSExternalaccesstotheSNMPinterfacecanbeenabledintheSettings->SNMPtab.
ThissettingwillopentheSNMPportonthefirewall.
Ifthefirewallisdisabled,thenexternalSNMPaccesswillbeenabled.
TheSNMPinterfaceisalwaysavailableforlocalrequestsfromanSSHsession.
TheSNMPinterfacecanbequeriedusingSNMPGetandGetNextrequests,alongwithanobjectidentifier(OID).
OIDsdefineahierarchyofvariablesthatcanbereturned;therootoftheElementalOIDhierarchyis1.
3.
6.
1.
4.
1.
37086.
SNMPrequestsshoulduseversion2c,andthereisaread-onlycommunitycalledelemental_snmpthathasaccesstotheElementalsubtreeaswellasalargenumberofotherSNMPvariablesprovidedbytheNet-SNMPagent.
Thereisawritablecommunitycalledelemental_snmp_writethatprovideswriteaccesstotheElementalsubtree.
Anexamplerequesttocheckthestatusoftheelemental_seserviceisasfollows:snmpget-celemental_snmp-v2clocalhost1.
3.
6.
1.
4.
1.
37086.
1.
0returnsSNMPv2-SMI::enterprises.
37086.
1.
0=INTEGER:1ElementalprovidesManagementInformationBases(MIBs)thatgivedescriptivenamestoOIDsanddefinesrelationshipsbetweenthem.
TherearetwoMIBsincluded:http:///mib/ELEMENTAL_MIB.
txt-BaseMIBforallElementalproductshttp:///mib/ELEMENTAL_LIVE_MIB.
txt-ObjectsspecifictoElementalLivenodesTheseMIBsareinstalledonthesystembydefault,andcanbeusedwiththenet-snmptoolstogetthesamevalueastheaboveexample:snmpget-celemental_snmp-v2c-mELEMENTAL-MIBlocalhostserviceStatusreturnsELEMENTAL-MIB::serviceStatus.
0=INTEGER:1SNMPOPERATIONSThefollowingvariablesfromthebaseELEMENTAL-MIBcanbeGetorSetviaSNMP:VARIABLETYPEGETVALUESSETVALUESELEMENTAL-MIB::serviceStatusInteger0iftheelemental_seserviceisnotrunning,1iftheserviceisrunning0stopstheelemental_seservice.
1startstheservice,and2restartstheserviceELEMENTAL-MIB::firewallStatusInteger0ifthesystem'sfirewallisoff,1ifon1willloadnewfirewallsettings.
FirewallsettingsareconfiguredintheElementalwebinterface.
ElementalLiveAPIandUserGuideSNMPInterface09/04/19ElementalTechnologiesConfidentialandProprietary141/169VARIABLETYPEGETVALUESSETVALUESELEMENTAL-MIB::networkSettingsIntegerWillalwaysreturn1.
Requiredforsomenetworkmanagementsystems1willloadnewnetworksettings.
NetworksettingsareconfiguredintheElementalwebinterface.
ELEMENTAL-MIB::mountPointsIntegerNumberofuser-mountedfilesystemsin/mnt1willloadnewmountsettings.
FilesystemmountsettingsareconfiguredintheElementalwebinterface.
ELEMENTAL-MIB::versionStringProductversionELEMENTAL-MIB::httpdStatusInteger0ifthehttpdserviceisnotrunning,1iftheserviceisrunning0stopsthehttpdservice.
1startstheservice,and2restartstheserviceELEMENTAL-MIB::databaseBackupInteger1ifwrites(startingbackups)areallowed.
0ifwritesarenotallowed1startsadatabasebackup,anyothervalueinaSETcommandisanerror.
SNMPLIVEEVENTOPERATIONSLiveEventsarecontrolledusingtheliveEventsTablefromtheELEMENTAL-LIVE-MIB.
TheliveEventsTableprovidesthefollowingvariables:VARIABLETYPEGETVALUESSETVALUESELEMENTAL-LIVE-MIB::eventIdIntegerLiveEventID(UsedastheindextotheliveEventsTable)ELEMENTAL-LIVE-MIB::eventNameStringNameofLiveEventELEMENTAL-LIVE-MIB::eventRunningInteger1iftheLiveEventiscurrentlyrunning,0otherwise0willstopaLiveEventthatiscurrentlyrunning,1willstartaLiveEventthatisnotcurrentlyrunningandnotinanarchivedstate.
ELEMENTAL-LIVE-MIB::eventErrorInteger1iftheLiveEventisintheerrorstate,0otherwiseELEMENTAL-LIVE-MIB::eventStatusStringStatusinformationabouttheLiveEvent,inXMLformatELEMENTAL-LIVE-MIB::nodeIdStringThenumericalIDofthenodethejobisrunningonTheusershouldusethewebinterfaceorRESTinterfacetocreateLiveEventsinadvancewiththedesiredparameters.
TheLiveEventcanbestartedviaSNMPasfollows(eventIdis2):snmpset-celemental_snmp_write-v2c-mELEMENTAL-MIB:ELEMENTAL-LIVE-MIB\localhosteventRunning.
2i1SNMPTRAPSTheElementalLivesystemcangenerateSNMPv2Trapswhencertaineventsoccur.
ThisfunctionalitycanbeenabledintheSettings->SNMPtabbyfillinginthehost,port,andcommunityofthemanagementsystemthatwillbereceivingSNMPtraps.
SNMPTrapsaregeneratedforthefollowingevents:NOTIFICATIONEVENTCONTENTSELEMENTAL-MIB::alertAnyalertgeneratedbythesystemELEMENTAL-MIB::alertSet:1ifthealertisbeingset,0ifthealertisbeingclearedELEMENTAL-MIB::alertMessage:MessagedescribingthealertthatwassetorclearedELEMENTAL-MIB::alertCompleteNotes:CompletenotesforthealertthatwassetorclearedELEMENTAL-MIB::alertNodeId:ThenumericalIDofthenodegeneratingthealert.
ELEMENTAL-MIB::alertRunnableId:ThenumericalIDoftheJob,LiveEvent,orChannelgeneratingthealert,ifapplicable.
ELEMENTAL-MIB::alertCode:Thenumericalcodeofthealert,ifapplicable.
ELEMENTAL-MIB::alertSeverity:Theseverityofthealert,ifapplicable.
ELEMENTAL-MIB::alertNodeHostname:Thehostnameofthenodegeneratingthealert,ifapplicable.
ELEMENTAL-MIB::alertRunnableType:Thetypeofrunnableobjectgeneratingthealert,ifapplicable.
ELEMENTAL-MIB::alertRunnableName:ThenameoftheJob,LiveEvent,orChannelgeneratingthealert,ifapplicable.
ElementalLiveAPIandUserGuideSNMPInterface09/04/19ElementalTechnologiesConfidentialandProprietary142/169AUTHENTICATIONConfiguringAuthenticationManagingRolesManagingUsersUserProfileAuthenticationandRESTTheElementalLivesystemcanbeenabledtorequireuserauthenticationtoaccesstheUIandRESTinterface.
Userscanbeconfiguredtohaveavarietyofdifferentlevelsofaccesstothesystem,fromread-onlyaccesstofullaccess.
CONFIGURINGAUTHENTICATIONAuthenticationcanonlybeenabledbyrunningtheconfigurescriptwithaspecialflag.
Runningtheconfigurescriptinthismodewillnotaffectanysystemsettingsbesidesauthenticationsettings.
cd/opt/elemental_sesudo.
/configure--config-authThiswilllaunchtheAuthenticationConfigurationscript.
Thisscriptcanbeusedtoenableordisableauthentication,andtoupdatetheadminuser'sinformation.
Whenenablingauthentication,thescriptwillaskforthedesiredadminlogin,emailandpassword,andcreatetheadminuser.
TheadminuserhasfullaccesstotheentireElementalLivesystem,includingUserandRolemanagement.
Ifauthenticationisalreadyenabled,runningthescriptcanbeusedtoupdatetheadminuser'sinformation,includingtheadminuser'spassword,ortocreatenewadminusers.
Onceauthenticationisenabled,avarietyofauthentication-specificsettingswillbeavailableviatheAuthenticationSettingspage.
TheNumberoffailedloginattemptsallowedfieldspecifiesthenumberofloginattemptsallowedforasingleuserloginbeforetriggeringalogintimeoutforthatuserlogin.
ThisallowstheElementalLivesystemtoprotectagainstbrute-forceattacks.
Settingthisvalueto0willdisablebrute-forceprotection.
TheLengthoftimetobanuserafterfailedloginattemptspecifiesthelogintimeoutlengthforauserthathastriggeredthemaximumnumberofloginattempts.
Settingthisvalueto0willenactapermanentbanforthatuserandisnotrecommended.
IfauserisinactiveforthenumberofminutesspecifiedintheInactivitytimeoutfield,thentheuserwillbeautomaticallyloggedoutofthesystem.
Settingthisvalueto0disablesthisfeature.
Passwordscanbesettoautomaticallyexpireaftersomelengthoftime,afterwhichtheuserwillbeaskedtoresettheirpassword.
CheckingEnablePasswordExpirationenablesthisfeature.
Ifpasswordexpirationisenabled,thePasswordsExpireAfterfieldspecifiesthenumberofdaysbetweenpasswordresets.
Notethatthisvalueappliestoeachuserindividually,andiscalculatedfromthetimetheuserlastresettheirpassword.
MANAGINGROLESAuserisassignedaspecificrolethatdefinesthesetofactionsthatusercanperform.
TheRolespagecanbefoundinthedropdownmenuunderSettings,anddisplaysalistofexistingroles,thenumberofusersassignedtoeachrole,andthefulllistofactionsthatroleallowsordisallows.
TheElementalLivesystemcomeswithasetofpredefinedRoles:Admin:TheAdminrolehasaccesstotheentireElementalLivesystemManager:TheManagerrolecancreateandeditLiveEvents,PresetsandProfiles,andcancontrolLiveEventsOperator:TheOperatorrolecanonlycontrolLiveEvents(Start,Stop,Reset,Archive,etc.
)Viewer:TheViewerrolehasread-onlyaccesstotheElementalLivesystemElementalLiveAPIandUserGuideAuthentication09/04/19ElementalTechnologiesConfidentialandProprietary143/169CREATINGNEWROLESInordertofacilitatecreatingusersthatshareaspecificsetofpermissions,customRolesmaybecreated.
Onlyadminuserscancreateoreditroles.
Rolesarecreatedbyspecifyingwhatactionstheroleisallowedtoaccess.
Actionsaregroupedintoafewlargecategories.
ManageLiveEvents:AllowsusertocreateandeditLiveEventsControlLiveEvents:AllowsusertocontrolthestateofLiveEvents(Start,Stop,Reset,Archive,etc)ManagePresets:AllowsusertocreateandeditPresets,PresetCategories,andAudioRemixingPresetsManageProfiles:AllowsusertocreateandeditProfilesManageSchedules:AllowsusertocreateandeditSchedulesManageSystemSettings:AllowsusertoupdatetheElementalLivesystemsettingsManageAlerts:AllowsusertoupdatealertthresholdsandtoupdatealertnotificationsettingsMANAGINGUSERSTheAdminusercancreateandmanageusersontheUserspage,whichcanbefoundinthedropdownmenuunderSettings.
CREATINGNEWUSERSTocreateauser,theadminusermustfillouttheLogin,PasswordandPasswordConfirmationfields,aswellasselecttheuser'sRole.
ThePasswordExpiresfieldallowsausertobecreatedwithapasswordthatwillautomaticallyexpireafterasetperiodoftime.
TheForcePasswordResetcheckboxwillforcetheusertoresettheirpasswordthefirsttimetheylogin.
Adminusersmayalsoeditexistingusers,aswellasresettheirAPIkeys,deactivatetheiraccess,anddeletethementirely.
EditingauserandcheckingtheForcePasswordResetwillforcethatusertoresettheirpasswordthenexttimetheylogin.
AdeactivatedusermaybereactivatedbyeditingtheuserandselectinganyoptionbesidesExpiredunderthePasswordExpiresdropdown.
USERPROFILEEachlogged-inuserhasaccesstotheirUserProfilepage,whichcanbefoundinthedropdownmenuunderSettings.
TheUserProfilepagedisplaystheuser'slogin,role,andAPIkey(whichisusedforRESTAuthentication).
Theusermayedittheiremail,resettheirpassword,andupdatetheirAPIkeyfromthispageaswell.
Inaddition,afulllistoftheactionstheymayandmaynotperformisdisplayed.
AUTHENTICATIONANDRESTInformationonhowtousetheRESTinterfacewithauthenticationenabledcanbefoundhere.
ElementalLiveAPIandUserGuideAuthentication09/04/19ElementalTechnologiesConfidentialandProprietary144/169REFERENCESupportedCodecsandContainersSupportedHLSPlayerVersionsSupportedCaptionFormatsSUPPORTEDCODECSANDCONTAINERSNOTESCODECORCONTAINERDIRECTIONSTATEMENTMXFinputcontainerforvideoInputCompletelistofsupportedcontainersis:AS-02,OP-1a;OP-1b;OP-1c;OP-2a;OP-2b;OP-2c;OP-3c.
AppleProResvideocodecInputCompletelistofsupportedcodecsis:AppleProres444(allprofiles);AppleProres4444(allprofiles);AppleProres422(allprofiles).
AppleProres444and4444willbeconvertedtoAppleProres422duringinputhandling.
MPEG-2videocodecInputCompletelistofsupportedcodecsis:MPEG-2;ATSC(A/53).
AACaudiocodecInputCompletelistofsupportedprofilesis:LC-AAC,HE-AACv1andHE-AACv2.
DolbyDigitalaudiocodecInputDolbyDigitalisalsoknownasAC-3DolbyDigitalisalicensedcodec;however,nolicenseisrequiredtodecodethiscodecininput.
DolbyDigitalPlusaudiocodecInputDolbyDigitalPlusisalsoknownasEnhancedAC-3andisfrequentlyabbreviatedasDD+orEC-3andE-AC-3DecodingofDolbyDigitalPlusrequirestheElementalAudioDecodePackagelicenseoption.
DolbyEframescarriedinPCMaudiostreamsInputDecodingofDolbyEinPCMstreamrequirestheElementalAudioDecodePackagelicenseoptionMPEGAudiocodecInputCompletelistofsupportedcodecsis:MPEG-1AudioLayerII;MPEG-2AudioLayerII(alsoknownasMP2);MPEG-1AudioLayerIII(alsoknownasMP3).
AppleProResvideocodecinoutputOutputCompletelistofsupportedcodecsis:AppleProres422(allprofiles).
DolbyDigitalaudiocodecOutputEncodingwithDolbyDigitalrequirestheElementalAdvancedAudioPackagelicenseoption.
DolbyDigitalPlusaudiocodecOutputEncodingwithDolbyDigitalPlusrequirestheElementalAdvancedAudioPackagelicenseoption.
DolbyEpass-throughOutputSeethelastpageofthisdocument.
DTSExpressOutputEncodingwithDTSExpressrequirestheElementalAdvancedAudioPackagelicenseoption.
CONTAINERSANDCODECSFORFILEINPUTSCONTAINERMEDIATYPEEXTENSIONSVIDEOCODECSAUDIOCODECSNoContainer.
m2v,.
m1vDV/DVCPROH.
264HEVC(H.
265)MPEG-1MPEG-2AppleHTTPLiveStreamingHLS.
m3u8H.
264HEVC(H.
265)AACElementalLiveAPIandUserGuideReference09/04/19ElementalTechnologiesConfidentialandProprietary145/169CONTAINERMEDIATYPEEXTENSIONSVIDEOCODECSAUDIOCODECSAudioVideoInterleaveAVI.
avi,.
divx,.
xvidUncompressedDivX/XvidDV/DVCPRODolbyDigitalDolbyDigitalPlusDolbyEframescarriedinPCMstreamsMPEGAudioPCMAdobeFlashF4V.
f4v,.
flvFlash9FileH.
263H.
264AACMatroskaMKV.
mkvH.
264MPEG-2MPEG-4part2VC-1AACDolbyDigitalDolbyDigitalPlusWMA,WMA2MPEGTransportStreamsMPEGTS.
m2ts,.
m2t,.
mts,.
ts,.
trp,.
mpegH.
264HEVC(H.
265)MPEG-2VC-1AACAIFFDolbyDigitalDolbyDigitalPlusDolbyEframescarriedinPCMstreamsMPEGAudioPCMWMA,WMA2MPEG-1SystemStreamsMPEGSS.
mpg,.
mpegMPEG-1MPEG-2AACAIFFDolbyDigitalDolbyDigitalPlusMPEGAudioPCMMPEG-4MPEG-4.
mp4,.
m4v,.
f4vUncompressedAVCIntra50/100DivX/XvidH.
261H.
262H.
263H.
264JPEG2000MJPEGMPEG-2MPEG-4part2VC-1AACDolbyDigitalDolbyDigitalPlusPCMWMA,WMA2MXFMXF.
mxfUncompressedAVCIntra50/100DNxHDDV/DVCPRODV25DV50DVCProHDH.
264JPEG2000MPEG-2PanasonicP2SonyXDCam,SonyXDCamMPEG-4ProxyAACAIFFDolbyEframescarriedinPCMstreamsMPEGAudioPCMElementalLiveAPIandUserGuideReference09/04/19ElementalTechnologiesConfidentialandProprietary146/169CONTAINERMEDIATYPEEXTENSIONSVIDEOCODECSAUDIOCODECSQuickTime.
movUncompressedAppleProResAVCIntra50/100DivX/XvidDV/DVCPROH.
261H.
262H.
263H.
264JPEG2000MJPEGMPEG-2MPEG-4part2AACVideoObjectFilesVOB.
vobMPEG-2AACMPEGAudioPCMWMV/ASFWMV/ASF.
wmv,.
asfVC-1WMA,WMA2CONTAINERSANDCODECSFORREAL-TIMEINPUTSMEDIATYPEVIDEOCODECSAUDIOCODECSSDIUncompressedDolbyDigitalPCMDolbyDigitalPlusDolbyEframescarriedinPCMstreamsUDP/RTPMPEGTSH.
264HEVC(H.
265)MPEG-2AACDolbyDigitalDolbyDigitalPlusDolbyEframescarriedinPCMstreamsMPEGAudioPCMASIMPEGTSH.
264HEVC(H.
265)MPEG-2AACDolbyDigitalDolbyDigitalPlusDolbyEframescarriedinPCMstreamsMPEGAudioPCMHTTPHLSH.
264HEVC(H.
265)AACRTMPH.
264AACCONTAINERSANDCODECSFORFILEOUTPUTCONTAINERVIDEOCODECSAUDIOCODECSRaw(Nocontainer)FrameCapture(MJPEG)H.
264HEVC(H.
265)MJPEGMPEG2YUV(uncompressed)AACAIFFDolbyDigitalDolbyDigitalPlusDTSExpressMPEGAudioWAVAppleHTTPLiveStreamingH.
264HEVC(H.
265)AACDolbyDigitalDolbyDigitalPlus3GPPH.
264AACElementalLiveAPIandUserGuideReference09/04/19ElementalTechnologiesConfidentialandProprietary147/169CONTAINERVIDEOCODECSAUDIOCODECSISMVforMSSH.
264AACDolbyDigitalDolbyDigitalPlusMPEGDASHISOH.
264HEVC(H.
265)AACDolbyDigitalDolbyDigitalPlusMPEG-2TransportStreamH.
264HEVC(H.
265)MPEG2AACDolbyDigitalDolbyDigitalPlusMPEGAudioMPEG-4H.
264HEVC(H.
265)AACDolbyDigitalDolbyDigitalPlusDTSExpressMPEG-4FlashH.
264AACQuickTimeH.
264MPEG2AppleProResYUV(uncompressed)AACAIFFDolbyDigitalDolbyDigitalPlusWAVUltravioletH.
264AACDolbyDigitalDolbyDigitalPlusDTSExpressMXFMPEG2WAVCONTAINERSANDCODECSFORREAL-TIMEOUTPUTSVIDEOCODECSAUDIOCODECSAppleHTTPLiveStreamingH.
264HEVC(H.
265)AACDolbyDigitalDolbyDigitalPlusDASH-ISOH.
264HEVC(H.
265)AACDolbyDigitalDolbyDigitalPlusISMVforMSSH.
264AACDolbyDigitalDolbyDigitalPlusRTMPH.
264AACUDPH.
264HEVC(H.
265)MPEG2AACDolbyDigitalDolbyDigitalPlusAUDIOCODECPASS-THROUGHSUPPORTPass-throughissupportedwithDolbyEframescarriedinPCMstreams.
Toobtainthispass-through,specifyUncompressedAIFForUncompressedWAVastheoutputcodec.
TheElementalsoftwarewilldetectDolbyEframescarriedinPCMframesandwillpass-throughratherthandecodetheinputaudio.
Pass-throughofDolbyEframescarriedinPCMstreamsdoesnotrequiretheElementalAudioDecodePackagelicenseoption.
ElementalLiveAPIandUserGuideReference09/04/19ElementalTechnologiesConfidentialandProprietary148/169Forpass-throughthefollowingparametersaresupported:CHANNELSCODINGMODESAMPLERATESBITRATES(KBPS)11_032k,44.
1k,48k56,64,80,96,112,128,160,19222_032k,44.
1k,48k96,112,128,160,192,224,256,320,38463_2+LFE32k,44.
1k,48k224,256,320,384,448,512,576,640SUPPORTEDHLSPLAYERVERSIONSGenerally,allLivefeaturesworkwithversion2oraboveofanHLSplayer.
Thistablelistsfeaturesthatrequireahigherplayerversion.
Thefirstcolumnspecifiesthefeature;thesecondcolumnspecifiesthefeaturesetupthatrequiresahigherversionandthesetupthatworksonversion2;thethirdcolumnspecifiestheversion.
FEATUREDESCRIPTIONREQUIRESTHISEXT-X-VERSIONORHIGHERIntegerDurationsHLSoutputgroup>Advanced>FloatingPointManifest=checked3HLSoutputgroup>Advanced>FloatingPointManifest=unchecked2SampleAESEncryptionHLSoutputgroup>Advanced>AlternateManifestDestination>Encryption=SAMPLE-AES5HLSoutputgroup>Advanced>AlternateManifestDestination>Encryption=valueotherthanSAMPLE-AES2Audio-onlystreamwithanalternateaudioUseaninputfilewithmultipleaudiotracksandcreatetwoaudioselectors:track1andtrack2(AddInputbuttonattopofprofile)InHLSOutput,createonestreamwithaudio+video,andcreateanotherwithonlyaudioAssociateonestreamwithoneHLSoutputandassociatetheotherstreamwithasecondHLSoutput.
Ontheaudio-onlyHLSoutput>Advanced>Alternateaudiotrack=checked.
4Ontheaudio-onlyHLSoutput>Advanced>Alternateaudiotrack=unchecked.
2EmitsinglefileHLSoutputgroup>Advanced>VODMode=checked.
ThenEmitSingleFilefieldappears.
EmitSingleFilefield=checked4EmitSingleFilefield=checked.
2I-frameonlymanifestHLSOutputgroup>Output>AddI-frameOnlyManifest=checked4HLSOutputgroup>Output>AddI-frameOnlyManifest=unchecked2Sample-basedencryptionwithKeyformatandKeyformatversionsattributesHLSoutputgroup>Advanced>AlternateManifestDestination>Encryption=valueotherthan1Mainstream5HLSoutputgroup>Advanced>AlternateManifestDestination>Encryption=1Mainstream2SUPPORTEDCAPTIONFORMATSThetablesonthefollowingpagescombineinformationabouttheinputcontainerandcaptionsandoutputcontainers.
Tousethisinformation,findthetablethatcorrespondstothetypeofoutputyouareproducing.
Withineachtable,findthecontainer(firstcolumn)andcaptionformat(secondcolumn)oftheoriginalinput.
Theninthethirdcolumn,findthecaptionformatsthatcanbeproduced.
Formoreinformationoncaptions,includinginformationonpass-through,onstrippingoutcaptionsandonsettingupforcaptions,see"WorkingwithCaptions-QuickGuide",availableontheElementalTechnologiesKnowledgeBase.
ElementalLiveAPIandUserGuideReference09/04/19ElementalTechnologiesConfidentialandProprietary149/169DASHISO,MICROSOFTSMOOTHOUTPUT-SUPPORTEDOUTPUTCAPTIONFORMATSORIGINALINPUTCONTAINERORIGINALCAPTIONFORMATSUPPORTEDOUTPUTCAPTIONFORMATSEmbeddedBurn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedSMPTE-TTTTMLHLSContainerinFileInputSCTE-20Burn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedSMPTE-TTTTMLEmbeddedBurn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedSMPTE-TTTTMLMP4ContainerinFileInputSCTE-20Burn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedSMPTE-TTTTMLDVB-SubBurn-inSCTE-27Burn-inDVB-SubMPEGTransportStreamsinFileInputTeletextBurn-inSMPTE-TTTTMLAncillaryDataBurn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedSMPTE-TTTTMLMXFContainerinFileInputEmbeddedBurn-inEmbeddedEmbedded+SCTE-20RTMPCaptionInfoRTMPCuePointSCTE-20+EmbeddedAncillaryDataBurn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedSMPTE-TTTTMLQuickTimeContainerinFileInputEmbeddedBurn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedSMPTE-TTTTMLElementalLiveAPIandUserGuideReference09/04/19ElementalTechnologiesConfidentialandProprietary150/169SCTE-20Burn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedSMPTE-TTTTMLSCCBurn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedSMPTE-TTTTMLSMIBurn-inSMPTE-TTTTMLSMTPE-TTBurn-inSMPTE-TTTTMLSRTBurn-inSMPTE-TTTTMLSTLBurn-inSMPTE-TTTTMLRaw(NoContainer)inFileInputTTMLBurn-inSMPTE-TTTTMLARIBEmbeddedBurn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedSMPTE-TTTTMLSCTE-20Burn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedSMPTE-TTTTMLSDIStreamInputTeletextBurn-inSMPTE-TTTTMLEmbeddedBurn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedSMPTE-TTTTMLTransportStreaminFileInputSCTE-20Burn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedSMPTE-TTTTMLUDP/RTPStreamInputDVB-SubBurn-inElementalLiveAPIandUserGuideReference09/04/19ElementalTechnologiesConfidentialandProprietary151/169EmbeddedBurn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedSMPTE-TTTTMLSCTE-20Burn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedSMPTE-TTTTMLSCTE-27Burn-inDVB-SubTeletextBurn-inSMPTE-TTTTMLAPPLEHLSOUTPUTSUPPORTEDOUTPUTCAPTIONFORMATSORIGINALINPUTCONTAINERORIGINALCAPTIONFORMATSUPPORTEDOUTPUTCAPTIONFORMATSEmbeddedBurn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedWebVTTHLSContainerinFileInputSCTE-20Burn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedWebVTTEmbeddedBurn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedWebVTTMP4ContainerinFileInputSCTE-20Burn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedWebVTTDVB-SubBurn-inSCTE-27Burn-inDVB-SubMPEGTransportStreamsinFileInputTeletextBurn-inWebVTTAncillaryDataBurn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedWebVTTMXFContainerinFileInputEmbeddedBurn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedWebVTTElementalLiveAPIandUserGuideReference09/04/19ElementalTechnologiesConfidentialandProprietary152/169AncillaryDataBurn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedWebVTTEmbeddedBurn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedWebVTTQuickTimeContainerinFileInputSCTE-20Burn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedWebVTTSCCBurn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedWebVTTSMIBurn-inWebVTTSMTPE-TTBurn-inWebVTTSRTBurn-inWebVTTSTLBurn-inWebVTTRaw(NoContainer)inFileInputTTMLBurn-inWebVTTEmbeddedBurn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedWebVTTSDIStreamInputSCTE-20Burn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedWebVTTSDIStreamInputTeletextBurn-inWebVTTEmbeddedBurn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedWebVTTTransportStreaminFileInputSCTE-20Burn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedWebVTTDVB-SubBurn-inUDP/RTPStreamInputEmbeddedBurn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedWebVTTElementalLiveAPIandUserGuideReference09/04/19ElementalTechnologiesConfidentialandProprietary153/169SCTE-20Burn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedWebVTTSCTE-27Burn-inDVB-SubTeletextBurn-inWebVTTMP4OR3GPPOUTPUT-SUPPORTEDOUTPUTCAPTIONFORMATSORIGINALINPUTCONTAINERORIGINALCAPTIONFORMATSUPPORTEDOUTPUTCAPTIONFORMATSSCTE-20Burn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedHLSContainerinFileInputEmbeddedBurn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedSCTE-20Burn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedMP4ContainerinFileInputEmbeddedBurn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedDVB-SubBurn-inSCTE-27Burn-inDVB-SubTeletextBurn-inMPEGTransportStreamsinFileInputTTMLBurn-inAncillaryDataBurn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedMXFContainerinFileInputEmbeddedBurn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedSCTE-20Burn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedEmbeddedBurn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedQuickTimeContainerinFileInputAncillaryDataBurn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedRaw(NoContainer)inFileInputSCCBurn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedElementalLiveAPIandUserGuideReference09/04/19ElementalTechnologiesConfidentialandProprietary154/169SMIBurn-inSMTPE-TTBurn-inSRTBurn-inSTLBurn-inTTMLBurn-inSCTE-20Burn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedEmbeddedBurn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedSDIStreamInputTeletextBurn-inSCTE-20Burn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedTransportStreaminFileInputEmbeddedBurn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedSCTE-20Burn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedEmbeddedBurn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedDVB-SubBurn-inSCTE-27Burn-inDVB-SubUDP/RTPStreamInputTeletextBurn-inQUICKTIMEOUTPUT-SUPPORTEDOUTPUTCAPTIONFORMATSORIGINALINPUTCONTAINERORIGINALCAPTIONFORMATSUPPORTEDOUTPUTCAPTIONFORMATSEmbeddedBurn-inEmbeddedEmbedded+AncillaryDataEmbedded+SCTE-20SCTE-20+EmbeddedHLSContainerinFileInputSCTE-20Burn-inEmbeddedEmbedded+AncillaryDataEmbedded+SCTE-20SCTE-20+EmbeddedMP4ContainerinFileInputEmbeddedBurn-inEmbeddedEmbedded+AncillaryDataEmbedded+SCTE-20SCTE-20+EmbeddedElementalLiveAPIandUserGuideReference09/04/19ElementalTechnologiesConfidentialandProprietary155/169SCTE-20Burn-inEmbeddedEmbedded+AncillaryDataEmbedded+SCTE-20SCTE-20+EmbeddedDVB-SubBurn-inSCTE-27Burn-inDVB-SubMPEGTransportStreamsinFileInputTeletextBurn-inAncillaryDataBurn-inEmbeddedEmbedded+AncillaryDataEmbedded+SCTE-20SCTE-20+EmbeddedMXFContainerinFileInputEmbeddedBurn-inEmbeddedEmbedded+AncillaryDataEmbedded+SCTE-20SCTE-20+EmbeddedAncillaryDataBurn-inEmbeddedEmbedded+AncillaryDataEmbedded+SCTE-20SCTE-20+EmbeddedEmbeddedBurn-inEmbeddedEmbedded+AncillaryDataEmbedded+SCTE-20SCTE-20+EmbeddedQuickTimeContainerinFileInputSCTE-20Burn-inEmbeddedEmbedded+AncillaryDataEmbedded+SCTE-20SCTE-20+EmbeddedSCCBurn-inEmbeddedEmbedded+AncillaryDataEmbedded+SCTE-20SCTE-20+EmbeddedSMIBurn-inSMTPE-TTBurn-inSRTBurn-inSTLBurn-inRaw(NoContainer)inFileInputTTMLBurn-inEmbeddedBurn-inEmbeddedEmbedded+AncillaryDataEmbedded+SCTE-20SCTE-20+EmbeddedSCTE-20Burn-inEmbeddedEmbedded+AncillaryDataEmbedded+SCTE-20SCTE-20+EmbeddedSDIStreamInputTeletextBurn-inElementalLiveAPIandUserGuideReference09/04/19ElementalTechnologiesConfidentialandProprietary156/169EmbeddedBurn-inEmbeddedEmbedded+AncillaryDataEmbedded+SCTE-20SCTE-20+EmbeddedTransportStreaminFileInputSCTE-20Burn-inEmbeddedEmbedded+AncillaryDataEmbedded+SCTE-20SCTE-20+EmbeddedDVB-SubBurn-inEmbeddedBurn-inEmbeddedEmbedded+AncillaryDataEmbedded+SCTE-20SCTE-20+EmbeddedSCTE-20Burn-inEmbeddedEmbedded+AncillaryDataEmbedded+SCTE-20SCTE-20+EmbeddedSCTE-27Burn-inDVB-SubUDP/RTPStreamInputTeletextBurn-inRAW(NOCONTAINER)OUTPUT-SUPPORTEDOUTPUTCAPTIONFORMATSORIGINALINPUTCONTAINERORIGINALCAPTIONFORMATSUPPORTEDOUTPUTCAPTIONFORMATSSCTE-20Burn-inEmbeddedEmbedded+SCTE-20SCCSCTE-20+EmbeddedSMISMPTE-TTTTMLSRTWebVTTHLSContainerinFileInputEmbeddedBurn-inEmbeddedEmbedded+SCTE-20SCCSCTE-20+EmbeddedSMISMPTE-TTTTMLSRTWebVTTMP4ContainerinFileInputSCTE-20Burn-inEmbeddedEmbedded+SCTE-20SCCSCTE-20+EmbeddedSMISMPTE-TTTTMLSRTWebVTTElementalLiveAPIandUserGuideReference09/04/19ElementalTechnologiesConfidentialandProprietary157/169EmbeddedBurn-inEmbeddedEmbedded+SCTE-20SCCSCTE-20+EmbeddedSMISMPTE-TTTTMLSRTWebVTTDVB-SubBurn-inSMPTE-TTSCTE-27Burn-inDVB-SubSMPTE-TTMPEGTransportStreamsinFileInputTeletextBurn-inSMISMPTE-TTTTMLSRTWebVTTAncillaryDataBurn-inEmbeddedEmbedded+SCTE-20SCCSCTE-20+EmbeddedSMISMPTE-TTTTMLSRTWebVTTMXFContainerinFileInputEmbeddedBurn-inEmbeddedEmbedded+SCTE-20SCCSCTE-20+EmbeddedSMISMPTE-TTTTMLSRTWebVTTSCTE-20Burn-inEmbeddedEmbedded+SCTE-20SCCSCTE-20+EmbeddedSMISMPTE-TTTTMLSRTWebVTTQuickTimeContainerinFileInputEmbeddedBurn-inEmbeddedEmbedded+SCTE-20SCCSCTE-20+EmbeddedSMISMPTE-TTTTMLSRTWebVTTElementalLiveAPIandUserGuideReference09/04/19ElementalTechnologiesConfidentialandProprietary158/169AncillaryDataBurn-inEmbeddedEmbedded+SCTE-20SCCSCTE-20+EmbeddedSMISMPTE-TTTTMLSRTWebVTTSCCBurn-inEmbeddedEmbedded+SCTE-20SCCSCTE-20+EmbeddedSMISMPTE-TTTTMLSRTWebVTTSMIBurn-inSMISMPTE-TTTTMLSRTWebVTTSMTPE-TTBurn-inSMISMPTE-TTTTMLSRTWebVTTSRTBurn-inSMISMPTE-TTTTMLSRTWebVTTSTLBurn-inSMISMPTE-TTTTMLSRTWebVTTRaw(NoContainer)inFileInputTTMLBurn-inSMISMPTE-TTTTMLSRTWebVTTSDIStreamInputSCTE-20Burn-inEmbeddedEmbedded+SCTE-20SCCSCTE-20+EmbeddedSMISMPTE-TTTTMLSRTWebVTTElementalLiveAPIandUserGuideReference09/04/19ElementalTechnologiesConfidentialandProprietary159/169EmbeddedBurn-inEmbeddedEmbedded+SCTE-20SCCSCTE-20+EmbeddedSMISMPTE-TTTTMLSRTWebVTTARIBTeletextBurn-inSMISMPTE-TTTTMLSRTWebVTTSCTE-20Burn-inEmbeddedEmbedded+SCTE-20SCCSCTE-20+EmbeddedSMISMPTE-TTTTMLSRTWebVTTTransportStreaminFileInputEmbeddedBurn-inEmbeddedEmbedded+SCTE-20SCCSCTE-20+EmbeddedSMISMPTE-TTTTMLSRTWebVTTSCTE-20Burn-inEmbeddedEmbedded+SCTE-20SCCSCTE-20+EmbeddedSMISMPTE-TTTTMLSRTWebVTTEmbeddedBurn-inEmbeddedEmbedded+SCTE-20SCCSCTE-20+EmbeddedSMISMPTE-TTTTMLSRTWebVTTDVB-SubBurn-inSMPTE-TTUDP/RTPStreamInputSCTE-27Burn-inDVB-SubSMPTE-TTElementalLiveAPIandUserGuideReference09/04/19ElementalTechnologiesConfidentialandProprietary160/169TeletextBurn-inSMISMPTE-TTTTMLSRTWebVTTRTMPOUTPUT-SUPPORTEDOUTPUTCAPTIONFORMATSORIGINALINPUTCONTAINERORIGINALCAPTIONFORMATSUPPORTEDOUTPUTCAPTIONFORMATSEmbeddedBurn-inEmbeddedEmbedded+SCTE-20RTMPCaptionInfoRTMPCuePointSCTE-20+EmbeddedHLSContainerinFileInputSCTE-20Burn-inEmbeddedEmbedded+SCTE-20RTMPCaptionInfoRTMPCuePointSCTE-20+EmbeddedEmbeddedBurn-inEmbeddedEmbedded+SCTE-20RTMPCaptionInfoRTMPCuePointSCTE-20+EmbeddedMP4ContainerinFileInputSCTE-20Burn-inEmbeddedEmbedded+SCTE-20RTMPCaptionInfoRTMPCuePointSCTE-20+EmbeddedDVB-SubBurn-inSCTE-27Burn-inDVB-SubMPEGTransportStreamsinFileInputTeletextBurn-inRTMPCuePointAncillaryDataBurn-inEmbeddedEmbedded+SCTE-20RTMPCaptionInfoRTMPCuePointSCTE-20+EmbeddedMXFContainerinFileInputEmbeddedBurn-inEmbeddedEmbedded+SCTE-20RTMPCaptionInfoRTMPCuePointSCTE-20+EmbeddedQuickTimeContainerinFileInputAncillaryDataBurn-inEmbeddedEmbedded+SCTE-20RTMPCaptionInfoRTMPCuePointSCTE-20+EmbeddedElementalLiveAPIandUserGuideReference09/04/19ElementalTechnologiesConfidentialandProprietary161/169EmbeddedBurn-inEmbeddedEmbedded+SCTE-20RTMPCaptionInfoRTMPCuePointSCTE-20+EmbeddedSCTE-20Burn-inEmbeddedEmbedded+SCTE-20RTMPCaptionInfoRTMPCuePointSCTE-20+EmbeddedSCCBurn-inEmbeddedEmbedded+SCTE-20RTMPCaptionInfoRTMPCuePointSCTE-20+EmbeddedSMIBurn-inRTMPCuePointSMTPE-TTBurn-inRTMPCuePointSRTBurn-inRTMPCuePointSTLBurn-inRTMPCuePointRaw(NoContainer)inFileInputTTMLBurn-inRTMPCuePointARIBEmbeddedBurn-inEmbeddedEmbedded+SCTE-20RTMPCaptionInfoRTMPCuePointSCTE-20+EmbeddedSCTE-20Burn-inEmbeddedEmbedded+SCTE-20RTMPCaptionInfoRTMPCuePointSCTE-20+EmbeddedSDIStreamInputTeletextBurn-inRTMPCuePointEmbeddedBurn-inEmbeddedEmbedded+SCTE-20RTMPCaptionInfoRTMPCuePointSCTE-20+EmbeddedTransportStreaminFileInputSCTE-20Burn-inEmbeddedEmbedded+SCTE-20RTMPCaptionInfoRTMPCuePointSCTE-20+EmbeddedUDP/RTPStreamInputDVB-SubBurn-inElementalLiveAPIandUserGuideReference09/04/19ElementalTechnologiesConfidentialandProprietary162/169EmbeddedBurn-inEmbeddedEmbedded+SCTE-20RTMPCaptionInfoRTMPCuePointSCTE-20+EmbeddedSCTE-27Burn-inDVB-SubTeletextBurn-inRTMPCuePointSCTE-20Burn-inEmbeddedEmbedded+SCTE-20RTMPCaptionInfoRTMPCuePointSCTE-20+EmbeddedUDP/TRANSPORTSTREAMOUTPUT-SUPPORTEDOUTPUTCAPTIONFORMATSORIGINALINPUTCONTAINERORIGINALCAPTIONFORMATSUPPORTEDOUTPUTCAPTIONFORMATSSCTE-20Burn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedHLSContainerinFileInputEmbeddedBurn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedSCTE-20Burn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedMP4ContainerinFileInputEmbeddedBurn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedDVB-SubBurn-inDVB-SubSCTE-27Burn-inDVB-SubSMPTE-TTMPEGTransportStreamsinFileInputTeletextBurn-inDVB-SubAncillaryDataBurn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedMXFContainerinFileInputEmbeddedBurn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedQuickTimeContainerinFileInputSCTE-20Burn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedElementalLiveAPIandUserGuideReference09/04/19ElementalTechnologiesConfidentialandProprietary163/169EmbeddedBurn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedAncillaryDataBurn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedSCCBurn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedSMIBurn-inSMTPE-TTBurn-inSRTBurn-inSTLBurn-inRaw(NoContainer)inFileInputTTMLBurn-inSCTE-20Burn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedEmbeddedBurn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedARIBARIBSDIStreamInputTeletextBurn-inSCTE-20Burn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedTransportStreaminFileInputEmbeddedBurn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedSCTE-20Burn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedEmbeddedBurn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedDVB-SubBurn-inSCTE-27Burn-inDVB-SubUDP/RTPStreamInputTeletextBurn-inTRANSPORTSTREAMARCHIVEOUTPUT-SUPPORTEDOUTPUTCAPTIONFORMATSORIGINALINPUTCONTAINERORIGINALCAPTIONFORMATSUPPORTEDOUTPUTCAPTIONFORMATSHLSContainerinFileInputSCTE-20Burn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedElementalLiveAPIandUserGuideReference09/04/19ElementalTechnologiesConfidentialandProprietary164/169EmbeddedBurn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedSCTE-20Burn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedMP4ContainerinFileInputEmbeddedBurn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedDVB-SubBurn-inDVB-SubSCTE-27Burn-inDVB-SubSMPTE-TTMPEGTransportStreamsinFileInputTeletextBurn-inDVB-SubAncillaryDataBurn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedMXFContainerinFileInputEmbeddedBurn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedSCTE-20Burn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedEmbeddedBurn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedQuickTimeContainerinFileInputAncillaryDataBurn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedSCCBurn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedSMIBurn-inSMTPE-TTBurn-inSRTBurn-inSTLBurn-inRaw(NoContainer)inFileInputTTMLBurn-inSCTE-20Burn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedEmbeddedBurn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedARIBARIBSDIStreamInputTeletextBurn-inElementalLiveAPIandUserGuideReference09/04/19ElementalTechnologiesConfidentialandProprietary165/169SCTE-20Burn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedTransportStreaminFileInputEmbeddedBurn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedSCTE-20Burn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedEmbeddedBurn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedDVB-SubBurn-inSCTE-27Burn-inDVB-SubUDP/RTPStreamInputTeletextBurn-inULTRAVIOLETFORMATOUTPUT-SUPPORTEDOUTPUTCAPTIONFORMATSORIGINALINPUTCONTAINERORIGINALCAPTIONFORMATSUPPORTEDOUTPUTCAPTIONFORMATSEmbeddedBurn-inCFF-TTEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedHLSContainerinFileInputSCTE-20Burn-inCFF-TTEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedEmbeddedBurn-inCFF-TTEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedMP4ContainerinFileInputSCTE-20Burn-inCFF-TTEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedDVB-SubBurn-inSCTE-27Burn-inDVB-SubMPEGTransportStreamsinFileInputTeletextBurn-inCFF-TTMXFContainerinFileInputAncillaryDataBurn-inCFF-TTEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedElementalLiveAPIandUserGuideReference09/04/19ElementalTechnologiesConfidentialandProprietary166/169EmbeddedBurn-inCFF-TTEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedAncillaryDataBurn-inCFF-TTEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedEmbeddedBurn-inCFF-TTEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedQuickTimeContainerinFileInputSCTE-20Burn-inCFF-TTEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedSCCBurn-inCFF-TTEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedSMIBurn-inCFF-TTSMTPE-TTBurn-inCFF-TTSRTBurn-inCFF-TTSTLBurn-inCFF-TTRaw(NoContainer)inFileInputTTMLBurn-inCFF-TTEmbeddedBurn-inCFF-TTEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedSCTE-20Burn-inCFF-TTEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedSDIStreamInputTeletextBurn-inCFF-TTEmbeddedBurn-inCFF-TTEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedTransportStreaminFileInputSCTE-20Burn-inCFF-TTEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedUDP/RTPStreamInputDVB-SubBurn-inElementalLiveAPIandUserGuideReference09/04/19ElementalTechnologiesConfidentialandProprietary167/169EmbeddedBurn-inCFF-TTEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedSCTE-20Burn-inCFF-TTEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedSCTE-27Burn-inDVB-SubTeletextBurn-inCFF-TTXDCAMOUTPUTSUPPORTEDOUTPUTCAPTIONFORMATSORIGINALINPUTCONTAINERORIGINALCAPTIONFORMATSUPPORTEDOUTPUTCAPTIONFORMATSHLSContainerinFileInputEmbeddedBurn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedSCTE-20Burn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedMP4ContainerinFileInputEmbeddedBurn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedSCTE-20Burn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedMPEGTransportStreaminFileInputDVB-SubBurn-inDVB-SubSCTE-27Burn-inTeletextBurn-inTeletextMXFContainerinFileInputAncillaryDataBurn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedQuickTimeContainerinFileInputAncillaryDataBurn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedEmbeddedBurn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedSCTE-20Burn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedElementalLiveAPIandUserGuideReference09/04/19ElementalTechnologiesConfidentialandProprietary168/169Raw(Nocontainer)inFileInputSCCBurn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedSMIBurn-inSMPTE-TTBurn-inSRTBurn-inSTLBurn-inTTMLBurn-inSDIStreamInputEmbeddedBurn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedSCTE-20Burn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedTeletextBurn-inTeletextTransportStreaminFileInputEmbeddedBurn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedSCTE-20Burn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedUDP/RTPStreamInputEmbeddedBurn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedDVB-SubBurn-inDVB-SubSCTE-20Burn-inEmbeddedEmbedded+SCTE-20SCTE-20+EmbeddedSCTE-27Burn-inTeletextBurn-inTeletextElementalLiveAPIandUserGuideReference09/04/19ElementalTechnologiesConfidentialandProprietary169/169