GeViScope SDK Dokumentation |Documentation |Documentation |Documentatión Version04.2013 --- Page 1 --- GeViScope Software Development Kit(SDK) Introduction TheGeViScope SDKconsistsofacollectionoffreesoftwareinterfaces forthe GEUTEBRÜCK DVRsGeViScope andRePorter. Itcanbeusedtointegratethesedevices incustomapplications andalthoughforlinkingnotyetsupported peripherals. Theinterfaces arebasedonnativeWin32DLLs.Sotheycanbeusedwithvariousdevel- opmentplatformsoftheWindowsOS. Tosupportthe.NETtechnology theSDKexamples containwrapperclassesbasedon C++/CLI.Thesewrapperexamples canbefreelyused,modifiedandextendedbytheSDK users.TheC#examples includedintheSDKdemonstrate, howthewrapperscanbeused bycustomapplications. Contents Filesanddirectory structure oftheSDK Settingupavirtualtestenvironment Remote controlGSCView Overview oftheinterfaces intheSDK Supported development platforms Guidelines andhints GSCView datafilterplugins Examples overview Actiondocumentation Documentation- HistoryVersion3.9/PME Filesanddirectory structure oftheSDK Duringtheinstallation oftheSDKtheenvironment variable%GSCSDKPATH% which pointstotherootdirectoryoftheSDKisset.Thisreferencepathisusedinallexamples. %GSCSDKPATH%\Bin Containsalldynamiclinklibrariesandisthetargetdirectoryforthe compiledexamples %GSCSDKPATH%\include ContainsallDelphiimportunits,C++headerandcppfiles %GSCSDKPATH%\lib ContainsalllibfilesforBorlandC++BuilderandMicrosoftVisualC++ ThematchinginterfaceunitsbetweenC++andDelphihavethesamenamebutcompiler specificfileextensions. --- Page 2 --- Settingupavirtualtestenvironment Introduction Allrequiredcomponents forsettingupavirtualGeViScope deviceareincludedintheSDK. Soanindependent development ofcustomsolutionscanbeachievedwithoutanyspecial hardwarerequired. AfterstartinguptheGeViScopeserver (partofthevirtualGeViScope device)GeViScope softwarecanbeusedwithfullfunctionfortwohours.Afterthattimethefunctionality islim- ited.Afterstopandrestartoftheserverfullfunctionality isofferedfortwohoursagain. Stepbystep Afterthesuccessful installation oftheSDKallnecessary filesexistintheinstallation folder (normally“%HOMEPATH%\My Documents\GeViScopeSDK”). Step1:Assignlocalpolicy“Lockpagesinmemory” TorunGeViScopeserver onyourlocalmachine,alocalpolicyneedstobeassignedtothe useraccountunderwhichGeViScope servershouldwork. Pleaseopenthe“LocalSecurityPolicy”dialoginthecontrolpanel–Administrative Tools. With“SecuritySettings/LocalPolicies/UserRightsAssignment” theprivilege“Lock pagesinmemory”hastobeassignedtotheuseraccountunderwhichGeViScope server shouldrun. TheuserhastobeamemberofthelocalAdministrators group. Theuserhastologoutandloginagaintoletthesettingtakeeffect. --- Page 3 --- Step2:unpackthetestfiles Unpackthefile“\BIN\GeViScope.Database.zip” totherootdirectoryofyoursystemdrive (normally“C:”). Afterwards thefile“C:\GeViScope.Database” shouldexist.Pleasenotethat thefileisnotseeninthewindowsexplorerifhiddenfilesandfoldersaremaskedout. Unpackthefile“\BIN\DatabaseBackup.zip” tothesubfolder“\BIN”oftheGeViScope SDK basedirectory(normally“%HOMEPATH%\My Documents\GeViScopeSDK”). Afterthat thefile“\BIN\DatabaseBackup.gpf“, whichcontainsatestbackupfileinGBFformat (“GEUTEBRÜCK BackupFile”)shouldexist. Step3:starttheGeViScopeserver Starttheserverbydoubleclickingonfile“\BIN\GSCServer.exe“. Nowaconsoleapplication shouldstart. Step4:importthetestsetup StarttheGSCSetupsoftware (file“\BIN\GSCSetup.exe“  )andestablishaconnection tothe localserver.Usethefollowinglogininformation: Username =sysadmin Password =masterkey Sendthesetuponcetotheserverbyusingthemenuentry“Sendsetuptoserver“. Thetestsetup“\BIN\GeViScopeSDKSetup.set “ canbeimportedintotheserverwiththehelp ofthemenuentry“Importsetupfromfile“.Afterwards itshouldbesendtotheserveronce again. Step5:viewlivevideoandbackupvideoinGSCView Nowthecorrectsetupofthetestenvironment shouldbetested.Forthatpurposethe GSCViewsoftware (file“\BIN\GSCView.exe”) canbestartedandagainaconnection tothe localservershouldbeestablished. After asuccessful connection mediachannelsareavail- ableandcanbeviewed. Simply dragthemediachannelsontheviewersofGSCView. --- Page 4 --- Themenuentry“Openbackupfile…”allowsopeningthetestbackupfile“\BIN\Data - baseBackup.gpf“, whichalsocontainsmediachannelsthatcanbedisplayed. Pleasecheck thecorrectfunctionofthebackupbyplaybackthevideomaterial. Step6:Useoftool“\BIN\GSCPLCSimulator.exe” Thesoftware“\BIN\GSCPLCSimulator.exe” servesasamonitoring toolforallmessages (actions)andeventsthataretransported insidethecompletesystem.Furthermore actions canbetriggeredandeventscanbestartedandstopped. Afterbuildingupaconnection tothelocalserverallactiontrafficisdisplayedinalist. Thistoolisextremely helpfulfortestingofcustomapplications basedontheSDKandfor analyzingmessageflowinthecompletesystem. Background information Toprovideatestenvironment withfullfunctionality theGeViScope mediaplugin“MCS” (MediaChannelSimulator) isused.Itsimulates realvideomediachannelsbychanneling testpicturesintotheGeViScopeserver. 16mediachannelscanbeusedaslivechannelsor canberecordedintothetestdatabase. Furthermore thechannelscreatemessages (actions)thatallowusingthemasbasefordeveloping videoanalysissoftware. Themediaplugin“MCS” ispartoftheSDKincludingsourcecode(development platformBor- landC++Builder6)anddocumentation (pleaseseetopic“Examples overview” formore information). Overview oftheinterfaces intheSDK Introduction Thisdocument givesashortoverviewofthedifferentinterfaces thatbelongtotheSDK. Pleasenote,thatallinterfaces includeclassdeclarations toaccesstheexportedfunctions ofthedynamiclinklibraries.TousetheminC++,thematchingcppfilesandthelibfilescor- responding totheDLLshavetobeaddedtothecustomproject. --- Page 5 --- Building blocksoffunctionality DBI lLowlevelserveranddatabaseinterface lConnection handling,GBFaccess,rawdatabaseaccess(novideodisplay!),media exportfunctionality, backupfunctions, accesstorawlivemedia(novideodisplay!), setupdataaccess lSupportsbasicfunctionality forbuildingblocks“PLC”and“MediaPlayer” lMainbinaryfile:GSCDBI.DLL lMainincludefiles(C++):GSCDBI.h, GSCDBI.cpp lMainincludefiles(Pascal):GSCDBI.pas PLC lComplexnotification, actionandeventprocessing lListento,dispatch,createandsendactions lListentoeventsandsystemnotifications lAllowscontrolling andmonitoring thesystem lMainbinaryfile:GSCActions.DLL lMainincludefiles(C++):GSCActions.h lMainincludefiles(Pascal):GSCActions.pas TACI lTelnetActionCommand Interface lSimpleASCII-Formatcommunication basedonTelnet lAllowscontrolling andmonitoring thesystem lReceivedactionsneedtobeparsed --- Page 6 --- lTousethatinterface,themediaplugin“GSCTelnetActionCommand” needstobe installed MediaPlayer lHighlevelserveranddatabaseinterfaceincludingmediapresentation lDisplayvideo,playaudio(liveandbackup) lIntegrated exportfunctionality (GBF,MPEG,Video-DVD,Singlepicture) lSearchmediadatabytimeorcorresponding toeventdata lMainbinaryfile:GSCMediaPlayer.DLL lMainincludefiles(C++):GSCMediaPlayer.h, GSCMediaPlayer.cpp lMainincludefiles(Pascal):GSCMediaPlayer.pas OffscreenViewer lPartofbuildingblock“MediaPlayer” lSamefunctionality asMediaPlayer, but:norendering, onlydecompressing lClassTGSCOffscreenViewer canbeusedanalogous toTGSCViewer Mediaplugin(GeViScope serverplugins) lGeViScope serverpluginsallowintegrating customperipherals inGeViScope sys- tems lChanneling ofvideoand/oraudiomediaintotheserver lIncludingfullaccesstoPLC lPluginsrunasIn-Process-DLLsinGeViScope serversoftware GSCViewdatafilterplugin lGSCView pluginsallowintegrating customdatafilterfrontendsinGSCView soft- ware lPluginsrunasIn-Process-DLLsinGSCView software GSCViewdatapresentation plugin lGSCView pluginsallowcustomized presentation ofeventdatainGSCView soft- ware,especially ofeventdatapresented inviewedpictures lPluginsrunasIn-Process-DLLsinGSCView software Remote controlGSCView byactions Introduction ThesimplestapproachtoviewandbrowseliveandrecordedvideoofoneormoreGeViS- copesistoremotecontrolGSCView outofcustomsolutions. GSCView canbeusedinaspecialmodesothatitcanbecontrolled byactionsthataresent fromaGeViScope server.Theactionscanbechanneled intothesystemusingtheSDK (GSCDBI.DLL andGSCActions.DLL) incustomapplications. Asanalternative theactions canbesenttotheTACIinterfaceoftheGeViScope server.TheTACIinterfaceisamedia pluginoftheGeViScope server,whichcanreceiveactionsasASCIItextcommands similar toaTELNETcommunication. TheTACIpluginhastobelicensed. --- Page 7 --- Stepbystep Thefollowingstepbystepinstructions showhowtoconfigureasimplesystemtodemon- strateremotecontrolling GSCView. Thevirtualtestenvironment includedintheSDKshould besuccessfully installedandsetupbeforefollowingtheseinstructions (seetopicSettingup avirtualtestenvironment ). Step1:starttheGeViScope server Starttheserverbydoubleclickingonfile“\BIN\GSCServer.exe“. Nowaconsoleapplication shouldstart. --- Page 8 --- Step2:startGSCView StarttheGSCView software(file“\BIN\GSCView.exe”). Step3:starttheprofilemanager Themenuentry“Options–Profilemanager…” startstheinternalprofilemanagerof GSCView. Theprofilmanagerallowsconfiguring allGSCView settings. --- Page 9 --- Step4:declarelocalconnection as“connectautomatically” Byselecting“Connections” inthesection“Resources” thelocalconnection canbedeclared asaconnection thatisautomatically builtupafterstartingGSCView. Additional theoption “Reconnect automatically” shouldbeactivated. --- Page 10 --- Iftheconnection isopeninGSCView orGSCSetup, thesettingsoftheconnection cannot bechanged.Closealllocalconnections atfirsttobeabletochangetheconnection settings. Step5:configure GSCViewtobeabletoremotecontrolitby actions Theentry“Optionsprofile”inthesection“Profiles”showsatabcontrolwithalotofdifferent GSCView settings.TobeabletoremotecontrolGSCView theoption“Remotecontrol”on the“Actions”tabhastobeset. --- Page 11 --- The“Viewerclientnumber”shouldbesettoaarbitraryglobalnumberthatisuniqueinthe wholesystem.Thisglobal“Viewerclientnumber”identifiesthisspecialinstanceof GSCView inthewholenetwork.Thenumberisusedindifferentactionstoremotecontrol GSCView. Bycontrastthe“globalnumber”ofaviewerinacustomsceneidentifiesaspecialviewerin auserdefinedscene.Detailsaboutuserdefinedsceneswillbetopicofthenextstep. Step6:userdefinedscenes TodefineuserdefinedscenesinGSCView theentry“Scenes”insection“Resources” shouldbeselected.Byrightclickingononeofthepredefined scenesnewuserdefined scenescanbecreated.Forthisstepbystepexampletwonewsceneswiththenames “MyStartScene” and“MyScene” havetobeadded.Withthebutton“Editscene”theglobal numbersoftheviewersofthesceneandthevideochannelsthatshouldbedisplayedcanbe set. The“MyStartScene” shouldbebasedonthe“Matrix4x4”.Theviewersshouldhavethe globalnumbers1001to1016.Eachviewershoulddisplaylivepicturesofavideochannelof thelocalconnection. Thevideochannelscanbesetviadrag&dropwhileeditingthescene. --- Page 12 --- The“MyScene” shouldbebasedonthe“Matrix2x2”andtheviewersshouldhavetheglobal numbers1101to1104.Theviewersshouldnotautomatically displayanyvideochannel. Theywillbeusedbyspecialactionstodisplayvideochannels. --- Page 13 --- Step7:modifytheappearance ofGSCView Theappearance ofGSCView canbecontrolled bydifferentsettingsintheentry“Optionspro- file”ofthesection“Profiles”. Forthistestscenario,GSCView shouldappearasastupid videowallwithoutanyusercontrolsdirectlyvisibleintheGSCView application window.To achievethis,thefollowingoptionsonthe“Application” tabhavetobeset: --- Page 14 --- Pleasekeepinmind,thatiftheoption“Sensitive areaenabled”isnotsetandifall“Hide…” optionsareset,themainmenuofGSCView onlycanbeaccessed bypressingF10! Step8:saveallsettings Allsettingsshouldbesavedbyselectingthemenuentry“File–Save”. Step9:testthesystemwithGSCPLCSimulator AfterrestartingGSCView itshouldappearinfullmodewith16viewersdisplaying livepic- turesofthevideochannelsofthelocalconnection. --- Page 15 --- Nowstartthesoftware“\BIN\GSCPLCSimulator.exe” totestthesystem.The GSCPLCSimulator servesasamonitoring toolforallmessages (actions)andeventsthat aretransported insidethecompletesystem.Furthermore actionscanbetriggeredand eventscanbestartedandstopped. Afteritsstarttheconnection tothelocalservershouldbebuildupautomatically andall actiontrafficisdisplayedinalist. --- Page 16 --- Withthebutton“Dialog”anactioncanbeselectedandwiththebutton“Send”thisactioncan besendtotheGeViScope server.Fortestingthesystemfirstselecttheaction“VCchange scenebyname”inthecategory“Vieweractions”todisplay“MyScene” ontheGSCView withtheglobal“Viewerclientnumber”1000. --- Page 17 --- Aftersendingtheaction,GSCView shoulddisplayan“empty”“MyScene”. --- Page 18 --- Todisplayvideochannelsintheviewersof“MyScene” theaction“Viewerconnectlive”can beused.Theparameter “viewer”nowmeanstheglobalnumberofaviewerof“MyScene”, e.g.1102.Theparameter “channel”shouldbesettotheglobalnumberofthevideochannel thatshouldbedisplayed, e.g.2. --- Page 19 --- Aftersendingtheaction,GSCView displayslivevideoofthevideochannel2ontheupper leftviewerinGSCView. --- Page 20 --- Background information InGeViScope systemsactionsareusedtocommunicate betweentheGeViScope server andanyclientapplication. Allavailableactionscanbedividedintothreegroups: Notification actions(forexample“UserLogin”),command actions(forexample“Viewercon- nectlive”)andlogicalactions(theseactionsarenotdirectlycreatedbytheGeViScope serverandtheydon’tdirectlyresultinanyreactionintheGeViScope server,forexample “Customaction”). Allactionsaregroupedindifferentcategories. Thecategory“Vieweractions”containsall actionsthatarerelevantforremotecontrolling GSCView. Togetnotifications aboutGSCView activities, oneoftheoptions“Sendnotification actions” intheprofilemanagerofGSCView hastobeset.Allpossiblenotification actionsarecol- lectedintheactioncategory“Viewernotifications”. --- Page 21 --- Moredetailedinformation aboutallavailableactionscanbefoundinthetopic“Actiondoc- umentation” (especially VieweractionsandViewernotifications ). PleasebeawareofthefactthatGSCView isworkinginanasynchronous mode.Ifacustom application sendsanaction,thatdependsontheresultoftheprevioussentactiontheremay betheneedforinsertingapausetimebeforesendingthesecondaction(e.g.sendaction “Viewerconnectlive”,waitonesecond,sendaction“Viewerprintpicture”).GSCView does nothaveaninputqueueforremotecontrolactions. Supported development platforms TheSDKisdesignedandtestedtobeusedwiththefollowingdevelopment environments: lCodeGear C++Builder6© lCodeGear C++Builder2009© lCodeGear Delphi7© lCodeGear Delphi2005© lCodeGear Delphi2009© lMicrosoftVisualStudio2005,C++,MFC© lMicrosoftVisualStudio2008,C++,MFC© lMicrosoftVisualStudio2005,C++/CLI© lMicrosoft.NET ©(wrapperclassesarecontained inthe“Examples” folder) --- Page 22 --- Guidelines andhints Introduction Itisrecommended tobefamiliarwiththeGeViScope systemandthepossibilities ofmodern videosurveillance systemsandvideomanagement systems.Beforestartingprogramming yourcustomGeViScope clientyoushouldknowbasicsofvideoformats,videocom- pression,GeViScope events,GeViScope actionsandtheprinciplesofaclient-servernet- workcommunication. Thefollowingsectionssupportyouwithsomesuggestions andhintsaboutusingtheSDK interfaces. General hints Ifyourapplication needstolistentoeventsandactionspleaseusetheapplication PLCSim- ulator.exe thatyoucanfindonYourGeViScope device.Thissoftwareallowsyoutostart actionsandeventswhichmightbeusedbyyourprogram. YoushouldworkanddosometestswitharealGeViScope deviceorwiththevirtualtest environment belongingtotheSDK.Createsomeeventsandactions,startthemwith PLCSimulator.exe. StartingthesetupsoftwareGSCSetup.exe withthecommand lineparameter /utilitieswill offeryouthepossibility toopenDBITesttodiscoverthedatabasestructureandtoevaluate andtestselectstatements againstthedatabase. Additionally thistooloffersyouthepos- sibilitytostarttheregistryeditortoevaluatetheinternalstructureoftheGeViScope setup. MakesuretodeleteallobjectsthatarecreatedinsideofDLLs.Theobjects themselves shouldalwaysofferaDestroy()orFree()methodforthat. Callbackfunctions, whicharecalledoutoftheSDKDLLs,arecalledfromthreads,which werecreatedinsidetheDLLs.Variablesandpointersthatarepassedasarguments ofthe callbackmaynotbeusedoutsidethecallbackcontext.Theyareonlyvalidfortheduration ofthecallbackcall. Structures thatareusedasarguments forSDKfunctionsshouldalwaysbeinitializedbythe functionmemset().Aftersettingallthestructureelementstozero,thesizeorstructsize ele- menthastobeinitializedwiththesizeof()function. MPEG-2filesthatwerecreatedbySDKfunctionscanpossiblynotbeplayedwiththewin- dowsmediaplayer.ThereasonisamissingMPEG-2decoder.Werecommend usingDVD playersoftwarelikePowerDVD ortheVCLMediaPlayersoftware. Working withhandles andinstances IntegralpartoftheSDKareunitsthatgivetheuseracomfortable accesstotheplainfunc- tionsoftheDLL,e.g.GSCDBI.h/.cpp/.pas. Intheseunitsclassesencapsulate accessto instances ofobjectswhicharecreatedinsidetheDLL.Tohaveaccessfromoutsidethe DLL(customapplication) totheinsideresidinginstances, handlesareused.Theunitshave tobeaddedtotheprojectrespectively tothesolutiontoavoidlinkererrors. --- Page 23 --- Afterworkwithinstances isfinished,theinstances havetobedeletedbycallingtheirdes- troy()orfree()method.Otherwise therewillbememoryleaksleft. UsingtheplainexportedfunctionsoftheDLLisnotrecommended. Togetaccesstofull functionality youshouldusetheunitsinstead(pasfilesorh/cppfiles). Thefollowingexample(inpseudocode)shouldillustratetheabovefacts:  //defineahandletoaserverobject  HGscServer MyServer; //createaserverobjectinstanceinsidetheDLLand  //getahandletoit  MyServer =DBICreateRemoteserver ();  ... //workwiththeobjectinstancewiththehelpofthehandle  MyServer- >Connect();  ...  //defineahandletoaPLCobject  HGscPLC PLC;   //createaPLCobjectinstanceinsidetheDLLand  //getahandletoit  PLC=MyServer.CreatePLC ();  ... //workwiththeobjectinstancewiththehelpofthehandle  PLC->OpenPushCallback (...);  ... //destroyPLCobject  PLC->Destroy();  ...  //destroyserverobject  MyServer- >Destroy(); Interaction between DBIandMediaPlayer TheDBIinterfacegivesaccesstoGeViScope serverfunctionality. Aftercreatingan instancewiththefunctionDBICreateRemoteserver ()aconnection totheservercanbe established bycallingthemethodConnect()oftheserverobjectinstance. Thefollowingmethodsofaserverobjectinstancecanbecalledtogetaccesstodifferent kindsoffunctions(notacompletelist): --- Page 24 --- Method Function CreateDataSet (), CreateDataPacket ()Fetchdatafromserverdatabase CreateLiveStream () Fetchlivedatafromserver CreateRegistry () Fetchsetupdatafromserver(mediachannelinformation, event information, …) CreatePLC() Listento,createandsendactions Theexample(inpseudocode)ofthepreviouschaptershouldillustratetheabovefacts. TheMediaPlayer interfaceofferssimpletouseobjectstodisplayliveandrecordedvideoin windowscontrols.Aviewerobjectinstanceneedstobecreatedbycalling GMPCreateViewer ().Theviewerneedsahandletoawindowscontrolandahandletoa serverobjectinstance.Ithandlesfetchingdata,decompressing dataanddisplaying videoin thelinkedwindowscontrolbyitself. Thefollowingmethodsofaviewerobjectinstancecanbecalledtogetaccesstodifferent kindsoffunctions(notacompletelist): Method Function ConnectDB()Fetchvideodatafromthedatabaseanddisplayitinanyplaymoderequired. Filterandsearchcriteriacanoptionallybedefined. SetPlayMode (pmPlayNextEvent)Displaythenextavailableeventpictures Thefollowingexample(inpseudocode)showshowtocreateavieweranduseitafter- wards: //defineahandletoaviewerobject  HGscViewer MyViewer; //createaviewerobjectinstanceinsidetheDLLand //getahandletoit  MyViewer =GMPCreateViewer (WindowHandle, ...); //defineastructurewithdataneededtolink //theviewertoamediachannelintheserver  TMPConnectData MyViewerConnectData;   //handletotheserverobjectinstance  MyViewerConnectData.Connection =MyServer;  MyViewerConnectData.ServerType =ctGSCServer;  MyViewerConnectData.MediaType =mtServer;  //IDofthemediachannelthatshouldbedisplayed  MyViewerConnectData.MediaChID =... //linktheviewertoamediachannelanddisplaylivedata  MyViewer- >ConnectDB (MyViewerConnectData, pmPlayStream, ...);  //destroyviewerobject   MyViewer- >Destroy(); BesidetheviewerobjectclassthereisanotherclassintheMediaPlayer interface:Theoff- screenviewerobjectclass.Ifyouwanttodecompress media,whichshouldnotbe --- Page 25 --- displayedwiththehelpoftheviewerobject,youcanusetheoffscreenviewerobject.An instancecanbecreatedwiththefunctionGMPCreateOffscreenViewer ().Theoffscreen viewerobjectinstanceprovidesnearlythesamefunctionality astheviewerobjectclass does.Thevideofootageisnotrenderedinawindow,itisdecompressed inaspecialDecom- pBufferobjectinstance.Afterthedecompression isdoneinsidetheoffscreenviewer,the hostingapplication canbenotifiedwiththehelpofacallbackfunction.Insidethecallback thedecompressed imagecanbeaccessed. TheDecompBuffer classencapsulates specialfunctionsforeffectivedecompressing. Soit isrecommend touseit.Creatinganinstanceofthebuffercanbereachedbycallingthefunc- tionGMPCreateDecompBuffer ().Theinstancecanbeusedforasmanydecompressions asneeded.ThemethodGetBufPointer ()givesaccesstotherawpicturedatainsidethebuf- fer. Hereisashortexample(inpseudocode)howtoworkwithanoffscreenviewerobject:  //defineahandletoaDecompBuffer object  HGscDecompBuffer MyDecompBuffer;  //createaDecompBuffer objectinstanceinsidetheDLLand  //getahandletoit  MyDecompBuffer =GMPCreateDecompBuffer ();  //defineahandletoaoffscreenviewerobject  HGscViewer MyOffscreenViewer;  //createanoffscreenviewerobjectinstanceinsidetheDLLand  //getahandletoit  MyOffscreenViewer =GMPCreateOffscreenViewer (MyDecompBuffer);  //setcallbackoftheoffscreenviewerobject  MyOffscreenViewer.SetNewOffscreenImageCallBack (NewOff- screenImageCallback);  //defineastructurewithdataneededtolink  //theoffscreenviewertoamediachannelintheserver  TMPConnectData MyOffscreenViewerConnectData; //handletotheserverobjectinstance  MyOffscreenViewerConnectData.Connection =MyServer;  MyOffscreenViewerConnectData.ServerType =ctGSCServer;  MyOffscreenViewerConnectData.MediaType =mtServer;  //IDofthemediachannelthatshouldbedecompressed  MyOffscreenViewerConnectData.MediaChID =... //linktheoffscreenviewertoamediachannelanddecompress livedata  MyOffscreenViewer- >ConnectDB (MyOffscreenViewerConnectData, pmPlayStream, ...);  ...  //destroyoffscreenviewerobject  MyOffscreenViewer- >Destroy();  //destroyDecompBuffer object --- Page 26 ---  MyDecompBuffer- >Destroy();  ...  //callbackfunction,thatiscalledafterimageshavebeendecompressed  ...  //getarawpointertothepictureintheDecompBuffer  //object  MyDecompBuffer- >GetBufPointer (BufferPointer, ...);  //copythepictureintoawindowsbitmapresource  //forexample  SetDIBits (...,BitmapHandle, ...,BufferPointer, ...,DIB_RGB_COLORS);  ... Enumeration ofsetupdata GeViScope Serverresources canbeenumerated bycustomapplications. Thesetupobject, whichcanbeinstantiated bycallingtheservermethodCreateRegistry (),offersfunctionality forthis. Enumeration ofresources normallyisdoneinfoursteps: 1.DefineanarrayoftypeGSCSetupReadRequest withtheonlyelement“/”.This causesthemethodReadNodes ()totransferthewholesetupfromtheservertothe customapplication. 2.CallthemethodReadNodes ()ofthesetupobjecttogetthewholesetupfromthe server. 3.CalloneoftheGet…()methodsofthesetupobjecttogetanarrayofGUIDsrep- resentingthelistofresources. TherearedifferentGet…()methods,e.g.GetMe- diaChannels ()orGetEvents (). 4.UsetheGUIDarraytoreceivetheresources databycallingGet…Settings ()meth- ods,e.g.GetMediaChannelSettings ()orGetEventSettings (). Hereisanexample(inpseudocode),thatshowshowtoenumerate themediachannels:  ... //connecttotheserver  MyServer- >Connect();  ... //defineahandletoasetupobject  HGscRegistry MySetup;  //createasetupobjectinstanceinsidetheDLLand  //getahandletoit  MySetup=MyServer- >CreateRegistry (); //defineaarrayforthesetupreadrequest  GscSetupReadRequest SetupReadRequest [1];  SetupReadRequest [0].NodeName ="/"; --- Page 27 --- //readthesetupdatafromtheserver  MySetup- >ReadNodes (&SetupReadRequest, ...);  //defineaGUIDarrayfortheGUIDsofthe  //existingmediachannels  GuidDynArray MediaChannels; //gettheGUIDarrayoutofthesetupdata  MySetup- >GetMediaChannels (MediaChannels); //getthedataofeachsinglemediachannel foreachMediaChannelGUID inMediaChannels  MySetup- >GetMediaChannelSettings (MediaChannelGUID,  MediaChannelID,   GlobalNumber,  ...);  ... //destroysetupobject  MySetup- >Destroy(); //destroyserverobject  MyServer- >Destroy();   ... Pleasenotethatespecially themediachannelscanbeenumerated byusingtheglobalfunc- tionGMPQueryMediaChannelList ()oftheMediaPlayer interfaceaswell. PLC,actionsandevents ThePLC(PrcessLogicControl)objectsupportsyouwithfunctionality forhandlingnoti- fications,actionsandevents.ThemethodCreatePLC ()oftheserverobjectclasscreatesa handletoaPLCobjectinsidetheDBIDLL. ThefollowingmethodsofaPLCobjectinstancecanbecalledtogetaccesstodifferent kindsoffunctions(notacompletelist): Method Function SendAction() Sendanactiontotheconnectedserver StartEvent() Startaneventoftheconnectedserver SubscribeActions ()Subscribealistofactionsthatshouldbenotifiedbyaregisteredcallback function OpenPushCallback ()Registeracallbackfunction,thatiscalledifannotificationarrivesora eventstarts/stops orifoneofthesubscribedactionsarrives ToreceiveNotifications andactionsacallbackfunctioncanberegistered withthemethod OpenPushCallback ().Afterreceivinganaction,theactionshouldbedecodedanddis- patchedbytheaninstanceoftheclassGSCActionDispatcher. Theactiondispatcher gives youasimplewaytoreactonspecificactions.Hereisashortexample(inpseudocode): --- Page 28 ---  //initialization code:  ...  //connecttotheserver  MyServer- >Connect();  ... //defineahandletoaPLCobject  HGSCPLC PLC;  //createaPLCobjectinstanceinsidetheDLLand  //getahandletoit  PLC=MyServer.CreatePLC ();   ...  //linkyourcallbackfunctionforacustomaction  //totheactiondispatcher, sothatthecallbackfunction  //iscalledautomatically ifacutsomactionarrives  ActionDispatcher- >OnCustomAction =this->MyCustomActionHandler;  //registeracallbackfunctionfornotifications,  //eventsandactions(thiscallbackfunctiondispatches  //allreceivedactionswiththehelpofthe  //GSCActionDispatcher)  PLC->OpenPushCallback (...);  ... //destroyPLCobject  PLC->Destroy();  ... //destroyserverobject  MyServer- >Destroy();  //callbackfunctionforallnotifications, eventsand  //subscribed actions:  ...  //dispatchthereceivedactiontothelinked  //callbackfunctions  ActionDispatcher- >Dispatch (ActionHandle);  ... Mediachannel IDs TheexistingmediachannelscanbedisplayedbytheviewerobjectsoftheMediaPlayer interface.NormallythisisdonewiththemethodConnectDB ().Thismethodneedsthe --- Page 29 --- mediachannelIDtoidentifythemediachannel(camera)thatshouldbedisplayed. ThemediachannelIDsaregenerated automatically bytheGeViScope server.Everycre- atedmediachannelgetsanIDthatisalwaysunique.Soifyouremovemediachannelsfrom thesetupandaddthemagain,theywillsurereceivesomenewIDs. Forthatreasonmediachannelsshouldnotbeaccessed byconstantIDs.Itisrecommend usingglobalnumbersinstead,becausetheycanbechangedinthesetup.Tofindthefitting mediachannelIDforagivenglobalnumber,themediachannelsshouldbeenumerated from theserversetup.Pleaserefertochapter“Enumeration ofsetupdata”inthisdocument to seehowthisisdone. Thereisasimilardifficultywithevents,digitalinputsandoutputs.Eventsdon’thaveglobal numbers.Heretheeventnameshouldbeusedinstead. Handling connection collapses ThecallbackOpenPushCallback ()ofthePLCobjectenablestolistentodifferentkindsof notifications fromthePLCobject.Oneisthe“plcnPushCallbackLost” notification. Itisfired ifaconnection isinternallydetectedascollapsed. Asareactiononthiseventyoushould destroyorfreeallobjectsthatwerecreatedinsidetheDLLsandstartaphaseofreconnect tries.Thereconnect triesshouldstartevery30secondsforexample.Additionally your application canlistentoUDPbroadcasts thataresentbytheGeViScope server.Afteryour application receivedthisbroadcast itcandirectlytrytoreconnect totheserver.Pleasebe awareofthefact,thatbroadcasts onlyworkinLAN–routersnormallyblockbroadcasts. UsingMediaPlayer withGeViScope andMULTISCOPE III servers GenerallytheMediaPlayer interfacecanbeusedwithGeViScope aswellasMULTISCOPE IIIservers.Tolinktheserverconnection totheviewerobject,theconnection datastructure hastobedefined.Thetypeofthestructureis“TMPConnectData”. Theelement“Server- Type”identifiesthekindofserverwhosemediashouldbedisplayedintheviewer. Pleasehavealookontheexample(inpseudocode)inthechapter“Interaction betweenDBI andMediaPlayer” inthisdocument. Forcreatingdifferentkindofconnections, differentDLLshavetobeused.ForGeViScope theDLL“GSCDBI.DLL” andforMULTISCOPE IIItheDLL“MscDBI.DLL” hastobe includedintheprojectorsolutionofthecustomapplication. Theycancoexist. Handlingaconnection toaMULTISCOPE IIIserverissimilartoGeViScope. Detailscanbe foundintheMULTISCOPE IIISDKdocumentation. UsingtheSDKwith.NET TomaketheusageofthenativeWin32DLLseasierin.NETlanguages likeC#orVB.NET, theSDKcontainssomewrapperassemblies aroundtheplainSDKDLLs. --- Page 30 --- Thesewrapperassemblies aredeveloped inC++/CLIandpublishedwiththeSDK.The assemblies canbefoundintheGeViScope SDKbinaryfolder“GeViScopeSDK\BIN”. TheSDKprovideswrapperassemblies forthe.NET-Frameworks versions2.0and4.0 whicharenamedasfollows: .NET-Framework 2.0 •GscExceptionsNET_ 2_0.dll •GscActionsNET_ 2_0.dll •GscMediaPlayerNET_ 2_0.dll •GscDBINET_ 2_0.dll .NET-Framework 4.0 •GscExceptionsNET_ 4_0.dll •GscActionsNET_ 4_0.dll •GscMediaPlayerNET_ 4_0.dll •GscDBINET_ 4_0.dll Thesewrapperassemblies canbeusedtogetherwithournativeSDKDLLs(GscAc- tions.DLL, GscDBI.DLL, GscHelper.DLL, GscMediaPlayer.DLL, MscDBI.DLL) tocreate customapplications underany.NETlanguageonawindowsplatform.Theassemblies needtobereferenced bythe.NETprojectandallthefiles(assemblies andnativeDLLs) havetoresideintheapplication folder. --- Page 31 --- Deploying acustomsolution basedonthe.NETwrapper Tosuccessfully deployacustomapplication thatusesthe.NETwrappercontained inthe SDK,thefollowingprerequisites havetobefulfilled: a)Microsoft VisualC++Redistributable Packagehastobe installed Thewrapperassemblies aredeveloped inC++/CLI.Soforexecuting themonanonedevel- opmentmachine,theMicrosoftVisualC++Redistributable Packageisneeded.Thispack- ageexistsinadebugorinareleaseversion.Onproductive machines thereleaseversion needstobeinstalled. Forapplications usingthe.NET-Framework 2.0theVisualC++2008Redistributable Pack- ageisneeded.Incasethattheapplication isdeveloped usingthe.NET-Framework 4.0you needtoinstalltheVisualC++2010Redistributable Package. b).NETFramework Version2.0SP1ornewerhastobe installed Ifupdatingthe.NETFramework onaGEUTEBRÜCK device(GeViScope orre_porter) fails,aspecialMicrosofttoolWindowsInstallerCleanUpUtility(MSICUU2.exe) can improvethesituation.Afterexecuting thistool,updatingtheFramework shouldbepossible. c)Wrapperassemblies ANDnativeSDKDLLsareneeded Besidethecustomapplication alsothewrapperassemblies andthenativeSDKDLLs(lis- tedabove)areneededinthesamefolderasinwhichthecustomapplication resides. Iftheapplication usesthe.NET-Framework 4.0youneedtoreferencetheGeViScope wrap- perDLLswiththeextension _4_0otherwise pleaseusethewrapperassemblies withthe extension _2_0(seeabove). GeViScope REGISTRY UsingtheGscRegistry with.NET Introduction ByusingtheGeViScope registry(GSCREGISTRY) itispossibletomodifyGeViScope/Re_ portersettingsprogrammatically. TheGscRegistry isaproprietary registryformat developed byGEUTEBRÜCK. ThisregistryformatissimilartotheMicrosoftWindows registry. --- Page 32 --- AllneededGeViScope serversettingsarestoredintheGscRegistry database. Thecreation ofownregistrydatabases basedonfilesisalsopossible. TheGEUTEBRÜCK GEVISCOPE SDKprovidesseveralclassesandmethodstoallowa comfortable accesstotheGscRegistry. Requirements Thefollowingrequirements areneededtocreatea.NETapplication thatusestheGscRe- gistryfunctionality: •.NET-Framework 2.0SP1ornewer -.NET-Framework 2.0SP1Wrapper-Assemblies: GscExceptionsNET_ 2_0.dll GscDBINET_ 2_0.dll -.NET-Framework 4.0Wrapper-Assemblies: GscExceptionsNET_ 4_0.dll GscDBINET_ 4_0.dll •NativeWin32-DLLs,usedbythe.NET-Wrapper: -GscActions.dll -GscDBI.dll -GscMediaPlayer.dll -GscHelper.dll -MscDBI.dll •MicrosoftVisualC++Redistributable Package Usingtheregistry Inthefollowing,theusageoftheGscRegistry with.NETisexplainedindetail.Itdiscusses thefollowingsteps: lOpentheregistry lReadvaluesoutofnodes lCreateanode lAddvaluestoanode lSavetheregistry Allnecessary classesandmethodsforusingtheGscRegistry areavailableintheGscDBI namespace. Toincludethisnamespace thefollowingusing-statement isneeded: usingGEUTEBRUECK.GeViScope.Wrapper.DBI; Opentheregistry ToreadormodifyGeViScope/Re_ portersettingsitisnecessary toestablishaconnection tothepreferredGeViScope/Re_ porterserverbefore.Afterthisisdoneyouneedtocreatea newobjectoftheclassGscRegistry andinitializeitbyusingtheCreateRegistry ()method whichiscontained intheGscServer object. C#-Code:Opentheregistry if(_GscServer !=null) { //createanobjectinstance oftheserverregistry GscRegistry GscRegistry =_GscServer.CreateRegistry (); if(GscRegistry !=null) { //defineanarrayforthesetupreadrequest (registry nodepaths toread) --- Page 33 --- GscRegistryReadRequest []ReadRequests =newGscRegistryReadRequest [1]; ReadRequests [0]=newGscRegistryReadRequest ("/",0); //readthenodes(setupdata)outoftheserverregistry GscRegistry.ReadNodes (ReadRequests); } } ThemethodReadNodes ()oftheGscRegistry objectexpectsanarrayofthetypeGscRe- gistryReadRequest whichcontainsallnodepathstobereadoutoftheregistry.Inthe sourcecodesnippetabove,thearraysimplycontainsoneelementwhichrepresents the rootnode(“/”).Byreadingtherootnodetheentireregistrywillbereadout. Readvaluesofnodes Thefollowingsourcecodesnippetshowshowtoreadvaluesoutofnodes: C#-Code:Readvaluesoutofnodes if(GscRegistry !=null) { GscRegNode RegNode =GscRegistry.FindNode ("/System/MediaChannels/" ); for(inti=0;i\a,b,f,n,r,t,v \\\=>\\ \\‘ =>\‘  \“ =>\“  \Xhhor\xhh=>ASCII-character Camera selectcharmode Forinternaluseonly Camera setpresettext Actionname:CameraSetPresetText (PTZHead,position) Category: command Withthisaction,onedefinesthetextthatisassociated withaparticularcameraposition anddisplayedwhenthecameramovestothisposition. Parameter Function PTZhead Camera Globalcameranumber position Position Numberofthecameraforwhichthetextis defined. Camera specfuncUoff Actionname:CameraSpecFuncUOff (PTZHead) Category: command Specialfunctionsaremappedtothisaction. (MBegfunctionsX,Y,UandV). Parameter Function PTZhead Camera Globalcameranumber Camera specfuncUon Actionname:CameraSpecFuncUOn (PTZHead) Category: command --- Page 60 --- Specialfunctionsaremappedtothisaction. (MBegfunctionsX,Y,UandV). Parameter Function PTZhead Camera Globalcameranumber Camera specfuncVoff Actionname:CameraSpecFuncVOff (PTZHead) Category: command Specialfunctionsaremappedtothisaction. (MBegfunctionsX,Y,UandV). Parameter Function PTZhead Camera Globalcameranumber Camera specfuncVon Actionname:CameraSpecFuncVOn (PTZHead) Category: command Specialfunctionsaremappedtothisaction. (MBegfunctionsX,Y,UandV). Parameter Function PTZhead Camera Globalcameranumber Camera specfuncXoff Actionname:CameraSpecFuncXOff (PTZHead) Category: command Specialfunctionsaremappedtothisaction. (MBegfunctionsX,Y,UandV). Parameter Function PTZhead Camera Globalcameranumber Camera specfuncXon Actionname:CameraSpecFuncXOn (PTZHead) Category: command Specialfunctionsaremappedtothisaction. (MBegfunctionsX,Y,UandV). Parameter Function PTZhead Camera Globalcameranumber Camera specfuncYoff Actionname:CameraSpecFuncYOff (PTZHead) Category: command Specialfunctionsaremappedtothisaction. (MBegfunctionsX,Y,UandV). Parameter Function PTZhead Camera Globalcameranumber --- Page 61 --- Camera specfuncYon Actionname:CameraSpecFuncYOn (PTZHead) Category: command Specialfunctionsaremappedtothisaction. (MBegfunctionsX,Y,UandV). Parameter Function PTZhead Camera Globalcameranumber Camera stopall Actionname:CameraStopAll (PTZHead) Category: command Thisactionstopsallmovements ofthecamera. Parameter Function PTZhead Camera Globalcameranumber Camera textoff Actionname:CameraTextOff (PTZHead) Category: command Thisactionturnsoffthetextdisplayofthecamera. Parameter Function PTZhead Camera Globalcameranumber Camera texton Actionname:CameraTextOn (PTZHead) Category: command Thisactionturnsonthetextdisplayofthecamera. Parameter Function PTZhead Camera Globalcameranumber Camera tourstart Actionname:CameraTourStart (PTZHead,tourID,tourname) Category: command Thisactionstartsapre-definedtour. Parameter Function PTZhead Camera Globalcameranumber tourid TourID Tourid. tourname TourName Tourname. Camera tourstop Actionname:CameraTourStop (PTZHead) Category: command Thisactionstopsarunningtour. Parameter Function PTZhead Camera Globalcameranumber --- Page 62 --- Camera versionoff Actionname:CameraVersionOff (PTZHead) Category: command Withthisactionthefirmwareversionofthecamerawillbehidden. Parameter Function PTZhead Camera Globalcameranumber Camera versionon Actionname:CameraVersionOn (PTZHead) Category: command WiththisactionthefirmwareversionofthecamerawillbeshownasOSD. Parameter Function PTZhead Camera Globalcameranumber Camera wash-wipeoff Actionname:CameraWashOff (PTZHead) Category: command Thisactiondisablesthefunctions“wash”and“wipe”. Parameter Function PTZhead Camera Globalcameranumber Camera wash-wipeon CameraWashWhipeOn Actionname:CameraWashOn (PTZHead) Category: command Thisactionenablesthefunctions“wash”and“wipe”. Parameter Function PTZhead Camera Globalcameranumber Movetodefaultposition Actionname:DefaultPosCallUp (Camera) Actioncategory:command ThePTZcameramovesbacktothehomeposition(usuallyposition1). Thereforthehomepositionhastobesetandsavedinadvancebytheaction"SaveDe- faultPosition". Parameter Function PTZhead Camera Globalcameranumber Cleardefaultposition Actionname:ClearDefaultPosition (PTZHead) Category: command Thisactiondeletesthecurrentlydefineddefaultposition. Parameter Function PTZhead Camera Globalcameranumber --- Page 63 --- Clearpresetposition Actionname:CameraPresetPosition (PTZHead,position) Category: command Thisactiondeletesapositionpreviously savedbytheaction“SavePresetPosition”. Parameter Function PTZhead Camera Globalcameranumber position Numberofcamerapositiontobedeleted. Savedefaultposition Actionname:SaveDefaultPosition (PTZHead) Category: command Thisactionsavesthecurrentpositionofthecameraasdefaultposition. Parameter Function PTZhead Camera Globalcameranumber Fastspeedoff Actionname:FastSpeedOff (PTZHead) Category: command Thisactionswitchesfromhigh-speedofthecameratonormalspeedofthecamera. Parameter Function PTZhead Camera Globalcameranumber Fastspeedon Actionname:FastSpeedOn (PTZHead) Category: command Thisactionswitchesfromnormalspeedofthecameratohigh-speedofthecamera. Parameter Function PTZhead Camera Globalcameranumber Focusfar Actionname:FocusFar (Camera,Speed) Actioncategory:command Thecamerafocusadjustsonfar. Parameter Function PTZhead Camera Globalcameranumber speed Speed Dependingontheprotocolofcameraman- ufacturervelocitiesbetween1and255are beingadjustedtothevelocityrangeofthe camera. Focusnear Actionname:FocusNear (Camera,Speed) Actioncategory:command Thecamerafocusadjustsonnear. --- Page 64 --- Parameter Function PTZhead Camera Globalcameranumber speed Speed Dependingontheprotocolofcameraman- ufacturervelocitiesbetween1and255are beingadjustedtothevelocityrangeofthe camera. Focusstop Actionname:FocusStop (Camera) Actioncategory:command Thecamerastopsthefocusingprocess. Parameter Function PTZhead Camera Globalcameranumber Irisclose Actionname:IrisClose (Camera) Actioncategory:command Thecameraclosestheaperture. Parameter Function PTZhead Camera Thecameraclosestheaperture Irisopen Actionname:IrisOpen (Camera) Actioncategory:command Thecameraopenstheaperture. Parameter Function PTZhead Camera Thecameraopenstheaperture Irisstop Actionname:IrisStop (Camera) Actioncategory:command Thecamerastopsclosing/opening aperture. Parameter Function PTZhead Camera Thecamerastops closing/opening aperture Movetoabsolute position Forinternaluseonly Movetobyspeed Forinternaluseonly Movetorelativeposition Forinternaluseonly --- Page 65 --- Panauto Actionname:PanAuto (Camera,Modus) Actioncategory:command Cameraswithoutautomatic endstopturnonandonuntilthisfunctionisstoppedthroughthe action"PanStop". Cameraswithautomatic endstopdostopautomatically aftera360turn. Itdependsonthecameratypeifthisfunctionisevenavailableandincasehowitisgoingto beaccomplished. Parameter Function PTZhead Camera Globalcameranumber modus Modus Dependsoncameratype(modelandman- ufacturer) Panleft Actionname:PanLeft (Camera,Speed) Actioncategory:command Thecamerapanstotheleft. Parameter Function PTZhead Camera Globalcameranumber modus Speed Dependingontheprotocolofcameraman- ufacturervelocitiesbetween1and255are beingadjustedtothevelocityrangeofthe camera. Panright Actionname:PanRight (Camera,Speed) Actioncategory:command Thecamerapanstotheright. Parameter Function PTZhead Camera Globalcameranumber modus Speed Panspeed. Panstop Actionname:PanStop (Camera) Actioncategory:command Thecamerastopspanmovement. Parameter Function PTZhead Camera Globalcameranumber Movetopresetposition Actionname:PrePosCallUp (Camera,Position) Actioncategory:command Thecameramovestoapresetpositiondetermined inadvancethroughtheaction"SavePre- setPosition". Parameter Function PTZhead Camera Globalcameranumber position Position Numberofselectedpresetposition. Theamountofpositionstosavedependson --- Page 66 --- Parameter Function thecameratype(modelandmanufacturer). Clearpresetposition Actionname:PrePosClear (Camera,Position) Actioncategory:command Clearcamerapresetposition. Parameter Function PTZhead Camera Globalcameranumber position Position Presetposition. Savepresetposition Actionname:PrePosSave (Camera,Position) Actioncategory:command SavescurrentpositionofthePTZcameraasapresetposition. Parameter Function PTZhead Camera Globalcameranumber position Position Numberofpresetpositiononwhichthecur- rentpositionofthecamerashouldbesaved. Theamountofpositionstosavedependson thecameratype(modelandmanufacturer). Setcameratext Actionname:SaveCameraText (PTZHead,text) Category: command Thisactionsavesthecameradescription inaccordance withtheparameter “text”. Parameter Function PTZhead Camera Globalcameranumber text Text TexttobedisplayedonthecameraasOSD. Tiltdown Actionname:TiltDown (Camera,Speed) Actioncategory:command Thecameratiltsdown. Parameter Function PTZhead Camera Globalcameranumber speed Speed Dependingontheprotocolofcameraman- ufacturervelocitiesbetween1and255are beingadjustedtothevelocityrangeofthe camera. Tiltstop Actionname:TiltStop (Camera) Actioncategory:command Thecamerastopsthetiltmovement. Parameter Function PTZhead Camera Globalcameranumber --- Page 67 --- Tiltup Actionname:TiltUp (Camera,Speed) Actioncategory:command Thecameratiltsup. Parameter Function PTZhead Camera Globalcameranumber speed Speed Dependingontheprotocolofcameraman- ufacturervelocitiesbetween1and255are beingadjustedtothevelocityrangeofthe camera. Zoomin Actionname:ZoomIn (Camera,Speed) Actioncategory:command TheCamerazoomsin(telerange). Parameter Function PTZhead Camera Globalcameranumber speed Speed Dependingontheprotocolofcameraman- ufacturervelocitiesbetween1and255are beingadjustedtothevelocityrangeofthe camera. Zoomout Actionname:ZoomOut (Camera,Speed) Actioncategory:command Thecamerazoomsout(wide-anglerange). Parameter Function PTZhead Camera Globalcameranumber speed Speed Dependingontheprotocolofcameraman- ufacturervelocitiesbetween1and255are beingadjustedtothevelocityrangeofthe camera. Zoomstop Actionname:ZoomStop (Camera) Actioncategory:command Thecamerastopszoomingprocess. Parameter Function PTZhead Camera Globalcameranumber Cashmanagement actions CashManagement Actionsoffertheexchange ofaccompanying metadatabetweenCash Management SystemsandGeViScope/Re_ porter.Withtheseactionsmoneyhandlingpro- cessescanbedocumented consistently viavideo.Theuseoftheseactionsforstartingand restartingofeventrecordings leadstothedisplayoftheaccompanying videodatainlive --- Page 68 --- streamsofGscViewandthestorageofthoseinthevideodatabase. Thevideosequences recordedbyCashManagement Actionscanlaterberecovered easilyinGscViewbyusing theaccompanying metadataandaspecialdatafilterdialog. Safebag close Actionname:SafebagClose (WorkingPlace, StartTime, StopTime, SafebagNo, Safe- bagInfo,StepID,Debit,Total,Difference, HasDifference, Notes,Coins,Cheques) Actioncategory:logical Safebagclose. Theintegrated CashManagement Systemsendstheactionassoonastheuserhasfin- ishedthecountingofonesafebagandhasconfirmed thattotheCashManagement System . Viatheparameter "workingplace"theaffectedworkingplacewillbeidentified. Thefurther parameter willbeprovidedwithaccompanying videodatabyCashManagement System. Theparameter "StepID"canbeprovidedwithacodefigurebytheCashManagement Sys- temforthecurrentlyrunningprocessstep. Parameter Function working placeWorkingPlace Workingplaceno. starttimeStartTime Timestamp,whenthehandlingofthesafebagbegan. stoptimeStopTime Timestamp,whenthehandlingofthesafebagstopped. safebag no.SafebagNo Alphanumerical identification ofsafebag;searchcriteriainGscView safebag infoSafebagInfo Additionalalphanumerical identification ofsafebag stepidStepID Codefigureforthecurrentlyrunningprocessstep(givenbyCashMan- agementSystemindividually) debit Debit Debitamountofsafebag total Total Effectivetotalamountofsafebagaccordingtocounting(willbeaccu- mulatedbyCashManagement Systemsoncounting) difference Difference Differencebetweentotalamountandresultrespectively progressof counting hasdif- ferenceHasDifference Yes=currenttotalamounthasadifferencetodebitamount No=currenttotalamountisidenticalwithdebitamount notes Notes Denomination ofcountedbanknotes.TheDisplayinGscViewisintable form.Thetablehasmax.2columns.Theindividuallinescanbesep- aratedviainsertionofcontrol'\r'(0x0D).Theseparationofboth columnswithinonelinecanbecarriedoutviainsertionofcontrol'\t' (0x09). coins Coins Denomination ofcountedcoins.TheDisplayinGscViewisintable form.Thetablehasmax.2columns.Theindividuallinescanbesep- aratedviainsertionofcontrol'\r'(0x0D).Theseparationofboth columnswithinonelinecanbecarriedoutviainsertionofcontrol'\t' (0x09). cheques Cheques Denomination ofcountedcheques.TheDisplayinGscViewisintable form.Thetablehasmax.2columns.Theindividuallinescanbesep- aratedviainsertionofcontrol'\r'(0x0D).Theseparationofboth columnswithinonelinecanbecarriedoutviainsertionofcontrol'\t' (0x09). --- Page 69 --- Safebag data Actionname:SafebagData (WorkingPlace, StartTime, SafebagNo, SafebagInfo, StepID, Debit,Total,Difference, HasDifference, Notes,Coins,Cheques) Actioncategory:command Safebagdata. Theintegrated CashManagement Systemsendstheactionassoonastheuserhasfin- ishedcountingonevarietyofnotesorcoinsandhasconfirmed thattothesystem. Viatheparameter "workingplace"theaffectedworkingplacewillbeidentified. Thefurther parameter willbeprovidedwithaccompanying metadatabytheCashManagement Sys- tem. Theparameter "StepID"canbeprovidedwithacodefigurebytheCashManagement Sys- temforthecurrentlyrunningprocessstep. Parameter Function working placeWorkingPlace Workingplaceno. starttimeStartTime Timestamp,whenthehandlingofthesafebagbegan. safebag no.SafebagNo Alphanumerical identification ofsafebag;searchcriteriainGscView safebag infoSafebagInfo Additionalalphanumerical identification ofsafebag stepidStepID Codefigureforthecurrentlyrunningprocessstep(givenbycashman- agementsystemindividually debit Debit Debitamountofsafebag total Total Effectivetotalamountofsafebagaccordingtocounting( willbeaccu- mulatedbytheCashmanagement Systemduringcounting) difference Difference Differencebetweentotalamountandresultrespectively progressof counting hasdif- ferenceHasDifference Yes=currenttotalamounthasadifferencetodebitamount No=currenttotalamountisidenticalwithdebitamount notes Notes Denomination ofcountedbanknotes.TheDisplayinGscViewisintable form.Thetablehasmax.2columns.Theindividuallinescanbesep- aratedviainsertionofcontrol'\r'(0x0D).Theseparationofboth columnswithinonelinecanbecarriedoutviainsertionofcontrol'\t' (0x09). coins Coins Denomination ofcountedcoins.TheDisplayinGscViewisintable form.Thetablehasmax.2columns.Theindividuallinescanbesep- aratedviainsertionofcontrol'\r'(0x0D).Theseparationofboth columnswithinonelinecanbecarriedoutviainsertionofcontrol'\t' (0x09). cheques Cheques Denomination ofcountedcheques.TheDisplayinGscViewisintable form.Thetablehasmax.2columns.Theindividuallinescanbesep- aratedviainsertionofcontrol'\r'(0x0D).Theseparationofboth columnswithinonelinecanbecarriedoutviainsertionofcontrol'\t' (0x09). Safebag open Actionname:SafebagOpen (WorkingPlace, StartTime, SafebagNo, SafebagInfo, StepID) Actioncategory:notification Safebagopen. Theintegrated CashManagement Systemsendstheactionassoonastheuserhasopened thesafebagandconfirmed thatwithanentryintheCashManagement System. --- Page 70 --- TheaffectedWorkingPlacewillbeidentifiedviatheparameter "Workingplace".Further parameters willbefilledwithaccompanying metadataonthepartoftheCashManagement System. TheParameter "StepID"canbeaddressed bytheCashManagement Systemwithacode figureforthecurrentlyrunningprocessstep. Parameter Function working placeWorkingPlace Workingplaceno. starttimeStartTime Timestamp,whenthehandlingofthesafebagbegan. safebag no.SafebagNo Alphanumerical identification ofsafebag;searchcriteriainGscView safebag infoSafebagInfo Additionalalphanumerical identification ofsafebag stepidStepID Codefigureforthecurrentlyrunningprocessstep(givenbycashman- agementsystemindividually Safebag passing ofriskdata Actionname:SafebagPassingOfRiskData (WorkingPlace, StartTime, SafebagNo, Safe- bagInfo,StepID,UserID1,UserID2,TourNumber, TargetWorkingPlace, PassingOfRiskType) Actioncategory:command Theintegrated CashManagement Systemsendstheactioncontinuously foreachsafebag whiletheamountofsafebagsbetweentwoemployees willbetransferred andthiswillbe confirmed totheCashManagement System.Thispartofthemoneyhandlingprocessisa "passingofrisk".Viatheparameter "workingplace"theaffectedtransferplaceandrespect- ivelytheworkingplacewillbeidentified. Thefurtherparameters willbefilledwithaccom- panyingvideodatabytheCashManagement System.Theparameter "StepID"canbe providedwithacodefigurebytheCashManagement Systemforthecurrentlyrunningpro- cessstep. Parameter Function working placeWorkingPlace Workingplaceno. starttime StartTime Timestamp,whenthehandlingofthesafebagbegan. safebagno.SafebagNo Alphanumerical identification ofsafebag;searchcriteriain GscView safebag infoSafebagInfo Additionalalphanumerical identification ofsafebag stepid StepID Codefigureforthecurrentlyrunningprocessstep(givenby cashmanagement systemindividually user1 UserID1 Numberofemployee,transferring thesafebagtoanother employee. user2 UserID2 Numberofemployee,whoreceivesthesafebagfromanother employee. tourno TourNumber Tour-Number(optional) targetwork- ingplaceTargetWorkingPlace Alphanumerical identification ofaplacerespectively aworking placewheresafebagswillbetransferredto(optional) passingof risktypePassingOfRiskType Detailedinformationto"passingofrisk"(optional) --- Page 71 --- Safebag passing ofriskstart Actionname:SafebagPassingOfRiskStart (WorkingPlace, StartTime, SafebagNo, Safe- bagInfo,StepID,UserID1,UserID2,TourNumber, TargetWorkingPlace, PassingOfRiskType) Actioncategory:command Theintegrated CashManagement Systemsendstheactionassoonasanumberofsafe bagswillbetransferred betweentwoemployees andthisisconfirmed totheCashMan- agementSystem.Thispartofthemoneyhandlingprocessisa"passingofrisk".Viathe parameter "workingplace"theaffectedtransferplaceandrespectively theworkingplace willbeidentified. Thefurtherparameters willbefilledwithaccompanying metadatabythe CashManagement System.Theparameter "StepID"canbeprovidedwithacodefigureby theCashManagement Systemforthecurrentlyrunningprocessstep. Parameter Function working placeWorkingPlace Workingplaceno. starttime StartTime Timestamp,whenthehandlingofthesafebagbegan. safebagno.SafebagNo Alphanumerical identification ofsafebag;searchcriteriain GscView safebag infoSafebagInfo Additionalalphanumerical identification ofsafebag stepid StepID Codefigureforthecurrentlyrunningprocessstep(givenby cashmanagement systemindividually user1 UserID1 Numberofemployee,transferring thesafebagtoanother employee. user2 UserID2 Numberofemployee,whoreceivesthesafebagfromanother employee. tourno TourNumber Tour-Number(optional) targetwork- ingplaceTargetWorkingPlace Alphanumerical identification ofaplacerespectively aworking placewheresafebagswillbetransferredto(optional) passingof risktypePassingOfRiskType Detailedinformationto"passingofrisk"(optional) Safebag passing ofriskstop Actionname:SafebagPassingOfRiskStop (WorkingPlace, StartTime, StopTime, Safe- bagNo,SafebagInfo, StepID,UserID1,UserID2,TourNumber, TargetWorkingPlace, PassingOfRiskType) Actioncategory:command Theintegrated CashManagement Systemsendstheactionclosingafterthelastsafebag, whilethenumberofsafebagswillbetransferred betweentwoemployees andthisiscon- firmedtotheCashManagement System.Thispartofthemoneyhandlingprocessisa "passingofrisk".Viatheparameter "Workingplace"theaffectedtransferplacerespective workingplacewillbeidentified. Thefurtherparameters willbefilledwithaccompanying videodatabytheCashManagement System.Theparameter "StepID"canbesuppliedby CashManagement Systemwithacodefigureforacurrentlyrunningprocessstep Parameter Function working placeWorkingPlace Workingplaceno. starttime StartTime Timestamp,whenthehandlingofthesafebagbegan. safebagno.SafebagNo Alphanumerical identification ofsafebag;searchcriteriain --- Page 72 --- Parameter Function GscView safebag infoSafebagInfo Additionalalphanumerical identification ofsafebag stepid StepID Codefigureforthecurrentlyrunningprocessstep(givenby cashmanagement systemindividually user1 UserID1 Numberofemployee,transferring thesafebagtoanother employee. user2 UserID2 Numberofemployee,whoreceivesthesafebagfromanother employee. tourno TourNumber Tour-Number(optional) targetwork- ingplaceTargetWorkingPlace Alphanumerical identification ofaplacerespectively aworking placewheresafebagswillbetransferredto(optional) passingof risktypePassingOfRiskType Detailedinformationto"passingofrisk"(optional) Deviceinformation Allactionsforlow-levelnotification ofthedeviceormediachannelschanges. Devicefound Actionname:DeviceFound (Type,Name,Serial) Actioncategory:logical ThisactionwillbefiredwhentheUSBorNETdeviceisconnected tothesystem.Itisalso firedatstart-upforalldetecteddevices. Parameter Function devicetypeTypeTypeofthedevice. devicenameNameDevicenameifassignedinsetup,emptyotherwise. serialIDSerialSerialIDofthedevice. Newfirmware received Actionname:DeviceNewFirmware (Type,Name,Serial,Firmware) Actioncategory:logical ThisactionwillbefiredwhentheUSBorNETdevicehasgotthenewfirmware. Parameter Function devicetypeTypeTypeofthedevice. devicenameNameDevicenameifassignedinsetup,emptyotherwise. serialIDSerialSerialIDofthedevice. firmwareserialFirmwareSerialIDofthefirmware. Devicepluginerror Actionname:DevicePluginError (Channel, Type,SubType, Name,Serial,ErrorClass, ErrorCode, Description) Actioncategory:logical Thisactionnotifiesdevicepluginerror. Parameter Function channel Channel Channel. devicetypeType Typeofthedevice. devicesubtypeSubType Subtypeofthedevice. --- Page 73 --- Parameter Function devicenameName Devicename. serialIDSerial SerialIDofthedevice. errorclassErrorClass Errorclassoftheerroroccured. errorcodeErrorCode Plugintypespecificerrorcode. description Description Errordescription. Devicepluginstate Actionname:DevicePluginState (Channel, Type,SubType, Name,Serial,State,Intern- alState,Description) Actioncategory:logical Thisactionnotifiesdevicepluginstate. Parameter Function channel Channel Channel. devicetypeType Typeofthedevice. devicesubtypeSubType Subtypeofthedevice. devicenameName Devicename. serialIDSerial SerialIDofthedevice. pluginstateState Newplugindevicestate. internalstateInternalState Plugindevicespecificstate. description Description Statedescription. Devicereattached Actionname:DeviceReattached (Type,Name,Serial) Actioncategory:logical ThisactionwillbefiredwhentheUSBorNETdeviceisreattached tothesystem. Parameter Function devicetypeTypeTypeofthedevice. devicenameNameDevicenameifassignedinsetup,emptyotherwise. serialIDSerialSerialIDofthedevice. Deviceremoved Actionname:DeviceRemoved (Type,Name,Serial) Actioncategory:logical ThisactionwillbefiredwhentheUSBorNETdeviceisdisconnected fromthesystem.Itis alsofiredatthestart-upforallparameterized butnotpresentdevices. Parameter Function devicetypeTypeTypeofthedevice. devicenameNameDevicenameifassignedinsetup,emptyotherwise. serialIDSerialSerialIDofthedevice. Digitalcontacts Allactionsforhandlingdigitalinputsandoutputs. Digitalinput Actionname:DigitalInput (Contact,State) --- Page 74 --- Actioncategory:logical Thisactionwillbefiredwhenthestateofthedigitalinputhaschanged. Parameter Function contactContactContact. stateStateNewstate. IOI43resetmainboard Actionname:IOI43ResetMainboard () Actioncategory:logical Resetmainboard usingIOI43a/ab USBAlarm-I/O. IOI43temperature notification Actionname:IOI43Temperature (ID,Temperature) Actioncategory:logical Temperature notification fromIOI43a/ab USBAlarm-I/O. Parameter Function ID ID IDoftheIOI43module(likeIOI43-00). temperature Temperature Temperature. IOI43watchdog activate Actionname:IOI43WDActivate () Actioncategory:logical Activatewatchdog onIOI43a/ab USBAlarm-I/O. IOI43watchdog deactivate Actionname:IOI43WDDeactivate () Actioncategory:logical Deactivate watchdog onIOI43a/ab USBAlarm-I/O. IOI43watchdog trigger Actionname:IOI43WDTrigger () Actioncategory:logical Triggerwatchdog onIOI43a/ab USBAlarm-I/O. Keypressed Actionname:KeyPressed (Key) Actioncategory:logical ThisactionisnotifiedifoneoftheGEVISCOPE systemkeysispressed. Parameter Function KeyKeySystemkey. Keyreleased Actionname:KeyReleased (Key) Actioncategory:logical ThisactionisnotifiedifoneoftheGEVISCOPE systemkeysisreleased. --- Page 75 --- Parameter Function KeyKeySystemkey. Setdigitaloutput Actionname:SetDigitalOutput (Contact,State) Actioncategory:logical Thisactionisusedtomodifythestateofthedigitaloutputandtonotifythischange. Parameter Function contactContactContact. stateStateNewstate. SetsystemLED Actionname:SetLED (LED,State) Actioncategory:logical ThisactionisusedtoturnthesystemLEDsonoroff. Parameter Function LEDLEDSystemLED. stateStateNewstate. SetsystemLEDtoblink Actionname:SetLEDBlink (LED,LedTimeOnMs, LedTimeOffMs) Actioncategory:logical ThisactionisusedtoblinkthesystemLEDs. Parameter Function LED LED SystemLED. LedtimeONLedTimeOnMs Timeinmilliseconds theLEDwillbeswitchedon. LedtimeOFFLedTimeOffMs Timeinmilliseconds theLEDwillbeswitchedoff. Lenel LenelOnGuardactions. Lenelaccessevent Actionname:LenelAccessEvent (ID,Panel,Device,SecondaryDevice, CardNumber, AccessResult, Type,SubType, Description, SerialNumber, TimeStamp, AreaEnteredID, AreaExitedID, AssetID, CardholderEntered, Duress,ElevatorFloor, FacilityCode, IsRead- ableCard, IssueCode, CommServerHostName, EventText) Actioncategory:logical LenelOnGuardaccessevent. Parameter Function ID ID TheIDthatuniquelyidentifiesthetypeofthisevent. panel Panel Thenameofthepanelwherethiseventoriginated. device Device Thenameofthedevicewherethiseventoriginated. secondary deviceSecondaryDevice TheIDofthesecondarydevicewherethiseventori- ginated. cardnumber CardNumber ThebadgeIDforthecardthatwasread,ifavailable. accessresult AccessResult Thelevelofaccessthatwasgrantedthatresultedfrom readingthecard. --- Page 76 --- Parameter Function type Type Eventtypei.e.,duress,system,etc. subtype SubType Eventsub-typei.e.,granted,doorforcedopen,etc. description Description Ahumanreadable,briefdescriptionofthisevent. serialnumber SerialNumber Anumberthatuniquelyidentifiestheinstanceofthe eventforaparticularpanel. timestamp TimeStamp Timestamp. areaentered AreaEnteredID TheIDoftheareathatwasentered,ifany. areaexited AreaExitedID TheIDoftheareathatwasexited,ifany. assetID AssetID TheIDoftheassetrelatedtothisevent,ifany. cardholder enteredCardholderEntered Whetherentrywasmadebythecardholder. duress Duress Indicateswhetherthiscardaccessindicatesanunder duress/emergency state. elevatorfloorElevatorFloor Theelevatorflooronwhichtheaccesseventwasgen- erated,ifany. facilitycode FacilityCode Thefacilitycodeforthecardthatwasread,ifavailable. readablecardIsReadableCard Whetherthecardcouldberead. issuecode IssueCode Theissuecodeforthecardthatwasread,ifavailable. serverhost CommServerHostName HostnameoftheCommunication serverthroughwhich theeventarrived. eventtext EventText Textassociatedwithevent Lenelfireevent Actionname:LenelFireEvent (ID,Panel,Device,SecondaryDevice, TroubleCode, Type, SubType, Description, SerialNumber, TimeStamp, CommServerHostName, EventText) Actioncategory:logical LenelOnGuardfireevent. Parameter Function ID ID TheIDthatuniquelyidentifiesthetypeofthisevent. panel Panel Thenameofthepanelwherethiseventoriginated. device Device Thenameofthedevicewherethiseventoriginated. secondary deviceSecondaryDevice TheIDofthesecondarydevicewherethiseventori- ginated. troublecodeTroubleCode Atroublecodeassociatedwiththefireevent. type Type Eventtypei.e.,duress,system,etc. subtype SubType Eventsub-typei.e.,granted,doorforcedopen,etc. description Description Ahumanreadable,briefdescriptionofthisevent. serialnum- berSerialNumber Anumberthatuniquelyidentifiestheinstanceoftheevent foraparticularpanel. timestamp TimeStamp Timestamp. serverhostCommServerHostName HostnameoftheCommunication serverthroughwhichthe eventarrived. eventtext EventText Textassociatedwithevent Lenelintercom event Actionname:LenelIntercomEvent (ID,Panel,Device,SecondaryDevice, IntercomData, LineNumber, Type,SubType, Description, SerialNumber, TimeStamp, Com- mServerHostName, EventText) Actioncategory:logical LenelOnGuardintercomevent. --- Page 77 --- Parameter Function ID ID TheIDthatuniquelyidentifiesthetypeofthisevent. panel Panel Thenameofthepanelwherethiseventoriginated. device Device Thenameofthedevicewherethiseventoriginated. secondary deviceSecondaryDevice TheIDofthesecondarydevicewherethiseventori- ginated. intercom dataIntercomData Additionaldatafortheintercomeventthatoccurred. linenumber LineNumber Thelinenumberinvolvedintheintercomevent. type Type Eventtypei.e.,duress,system,etc. subtype SubType Eventsub-typei.e.,granted,doorforcedopen,etc. description Description Ahumanreadable,briefdescriptionofthisevent. serialnum- berSerialNumber Anumberthatuniquelyidentifiestheinstanceoftheevent foraparticularpanel. timestamp TimeStamp Timestamp. serverhostCommServerHostName HostnameoftheCommunication serverthroughwhichthe eventarrived. eventtext EventText Textassociatedwithevent Lenelrawdata Actionname:LenelRawData (TimeStamp, LenelData) Actioncategory:logical LenelOnGuardrawdata. Parameter Function timestampTimeStampTimestamp. data LenelDataLenelOnGuarddata. Lenelrefreshnames Actionname:LenelRefreshNames () Actioncategory:logical LenelOnGuardrefreshnames. Lenelsecurity event Actionname:LenelSecurityEvent (ID,Panel,Device,SecondaryDevice, Type,SubType, Description, SerialNumber, TimeStamp, CommServerHostName, EventText) Actioncategory:logical LenelOnGuardsecurityevent. Parameter Function ID ID TheIDthatuniquelyidentifiesthetypeofthisevent. panel Panel Thenameofthepanelwherethiseventoriginated. device Device Thenameofthedevicewherethiseventoriginated. secondary deviceSecondaryDevice TheIDofthesecondarydevicewherethiseventori- ginated. type Type Eventtypei.e.,duress,system,etc. subtype SubType Eventsub-typei.e.,granted,doorforcedopen,etc. description Description Ahumanreadable,briefdescriptionofthisevent. serialnum- berSerialNumber Anumberthatuniquelyidentifiestheinstanceoftheevent foraparticularpanel. timestamp TimeStamp Timestamp. serverhostCommServerHostName HostnameoftheCommunication serverthroughwhichthe eventarrived. --- Page 78 --- Parameter Function eventtext EventText Textassociatedwithevent Lenelvideoevent Actionname:LenelVideoEvent (ID,Panel,Device,SecondaryDevice, Channel, Type, SubType, Description, SerialNumber, TimeStamp, StartTime, EndTime, Com- mServerHostName, EventText) Actioncategory:logical LenelOnGuardvideoevent. Parameter Function ID ID TheIDthatuniquelyidentifiesthetypeofthisevent. panel Panel Thenameofthepanelwherethiseventoriginated. device Device Thenameofthedevicewherethiseventoriginated. secondary deviceSecondaryDevice TheIDofthesecondarydevicewherethiseventori- ginated. channel Channel Thephysicalchannelthecameraisconnectedtothatis creatingthisevent. type Type Eventtypei.e.,duress,system,etc. subtype SubType Eventsub-typei.e.,granted,doorforcedopen,etc. description Description Ahumanreadable,briefdescriptionofthisevent. serialnum- berSerialNumber Anumberthatuniquelyidentifiestheinstanceoftheevent foraparticularpanel. timestamp TimeStamp Timestamp. startstamp StartTime Thetimethevideoeventstarted endtime EndTime Thetimethevideoeventended. serverhostCommServerHostName HostnameoftheCommunication serverthroughwhichthe eventarrived. eventtext EventText Textassociatedwithevent Logistic Logisticactionsareusedinthelogisticenvironment wheremetadata,e.g.barcodes, is usedtostartrecordingevents.Later,aresearchonthebarcodesisdonetoshowthescan- ningoperationintherecordedimages.Tospeedupthesearch,aCRC32checksum isused asahashandservesasaforeignkeyoftheeventstartd.Theforeignkeyisindexedinthe eventtableancanthereforebefoundmuchfasterthanalookuponthestringitself.Addi- tionalparameters areusedtonotifypositioning information sincetheassignment ofscan- ningandrecordingcameraisoftendoneaccording tothepositionofthescanner. Logbarcode data Actionname:LogBarcodeData (Barcode, Hash,Scanner, AreaID,AreaName, Channel, TimeStamp) Actioncategory:notification Logisticbarcodedata. Parameter Function barcode BarcodeBarcode. hashvalue HashHashvalueofbarcode(Optional) scannernameScannerScannernameorIPAddress(Optional) areanumber AreaIDGlobalnumberofareaforeventmapping(Optional) --- Page 79 --- Parameter Function areaname AreaNameAreaname(Optional) channel ChannelGlobalnumberofamediachannelformapping(Optional) timestamp TimeStampTimestamp(Optional) Logbarcode dataLPS Actionname:LogBarcodeDataLPS (Barcode, Hash,Scanner, AreaID,AreaName, Channel, TimeStamp, X,Y,Z,LpsTagID, LpsStatus, LpsCellID, LpsAreaID, UserParam) Actioncategory:notification Logisticbarcodedataincludingpositioning andareainformation. Parameter Function barcode BarcodeBarcode. hashvalue HashHashvalueofthebarcode(Optional) scannernameScannerScannernameorIPAddress(Optional) areanumber AreaIDGlobalnumberofareaforeventmapping(Optional) areaname AreaNameAreaname.(Optional) channel ChannelGlobalnumberofamediachannelformapping(Optional) timestamp TimeStampTimestamp(Optional) Xcoordinate XXcoordinateofthepositionquery(Optional) Ycoordinate YYcoordinateofthepositionquery(Optional) Zcoordinate ZZcoordinateofthepositionquery(Optional) LPStagIDLpsTagIDTagIDofthepositioningsystem(Optional) LPSstatus LpsStatusLPSstatusofthepositionquery(Optional) LPScellIDLpsCellIDCellIDofthepositioningsystem(Optional) LPSareaIDLpsAreaIDAreaIDofthepositioningsystem(Optional) Userparam UserParamUserparamforinternaluse(Optional) LogNPRrecognition Actionname:LogNPRRecognition (PlateNo, Hash,Country, Channel, TimeStamp, Restric- tion,Category) Actioncategory:logical LogNPRrecognition. Parameter Function plateno.PlateNoRecognizedplateno. hashvalueHashHashvalueoftherecognizedplateno.(Optional) country CountryCountry(Optional) channel ChannelChannel(Optional) timestampTimeStampTimestamp(Optional) restriction RestrictionRestrictionofrecognizednumber(Optional) category CategoryCategoryofrecognizednumber(Optional) LPSActions LPS(LocalPositioning System)actionsareusedtoqueryandreceivepositiondata.The positioning systemisintegrated bytheGscLPSpluginandisusedtolocatetaggedobjects, e.g.mobilescannersinthelogisticenvironment. ThetagshaveIDsthatcanbeusedto querythepositionwhichisthennotifiedascartesianorgeograficcoordinates. Sometags areabletoinitiateapositionrequestbyanexternaltriggerorbyascaneventonamobile scanner. --- Page 80 --- LPSposition data Actionname:LPSPositionData (TagID,ScannerID, X,Y,Z,Latitude, Longitude, AreaID, CellID,Status,TimeStamp, Data,AreaName) Actioncategory:logical LPSpositiondata. Parameter Function tagID TagIDTagID. scannerIDScannerIDScannerIDorIPAddress. Xcoordinate XXcoordinateofcartesiancoordinates. Ycoordinate YYcoordinateofcartesiancoordinates. Zcoordinate ZZcoordinateofcartesiancoordinates. Latitude LatitudeLatitudeofgeographiccoordinates. Longitude LongitudeLongitudeofgeographiccoordinates. areaID AreaIDAreaID. cellID CellIDCellID. status StatusStatus. timestamp TimeStampTimestamp. data DataDatareceivedbythepositioningsystem,eg.barcode. areaname AreaNameAreaName. LPSqueryposition Actionname:LPSQueryPosition (TagID,ScannerID, Data) Actioncategory:command SendpositionqueryforaTagtoLPSserver. Parameter Function tagID TagIDTagID. scannerIDScannerIDScannerIDorIPAddress. data DataData. POS Pointsofsales(POS)Actionsenabletheexchange ofaccompanying metadatabetween POSManagement SystemsandGeViScope/re_ porter.Withtheseactionspaymentpro- cessescanbedocumented consistently byvideo.Theuseoftheseactionsforstartandre- startofeventrecordings leadstotheoutputofaccompanying metadatainlivevideoin GSCView aswellasinthestorageofthoseinthevideodatabase.Thevideosequences recordedviaPOSActionscaneasilyberetrievedinGscViewusingtheaccompanying meta dataundspecialdatafilterdialogs(optional)BesidestheactionsPOSStatus andPOSData forthegeneralintegration intoPOSManagement SystemstherearealsoPOSactions whichbelongtospecialGeViScope drivers.TheactionsFillingPumpStatus, Ter- minalArticleData andTerminalPaymentData areusedbythedriver"HUTH".Thedriver "HUTH"isaGeViScope MediaPlugin,whichwasdeveloped byGEUTEBRÜCK, tointeg- ratefillingstationmanagement systemsofthemanufacturer HUTHElektronik Systeme GmbHintoGeViScope/re_ porter.Thedriveriscompatible toHUTHVideoInterface T400/T450/Maxi/mini V1.2.TheactionsInterfaceRawData andInterfaceRawAnswer are alsousedbythedriver"HUTH".Buttheyonlyservefordebugging andfaultanalysispur- pose.Theycanalsobeusedingeneralforanylinkthattheconcerned actionsupports- respectively usestheseactions.TheactionBarcodeData servesasageneralintegration of barcodescanners. --- Page 81 --- Barcode data Actionname:BarcodeData (ReaderName, TimeStamp, Barcode) Actioncategory:notification ThePOSManagement System(oranyothersystemlikebarcodescannerorsimilar)sends theactionassoonasabarcodewasread.Viatheparameter "ReaderName" theaffected barcodescannerwillbeidentified. Thefurtherparameter willbefilledwithvideometadata bythePOSManagement System. Parameter Function scanner ReaderName Alphanumerical identification ofthebarcodescanner timestamp TimeStamp Timestamp. code Barcode Alphanumerical fieldforrecordingthescannedbarcode. Fillingpumpstatus Actionname:FillingPumpStatus (TerminalName, TimeStamp, PumpNo,Status,Amount, Price,Details)Actioncategory:notification The"HUTH"driversendstheactionforeachstatuschangeofonefillingpump.Viathepara- meter"TerminalName" theconcerned devicewillbeidentified. The"HUTH"driverisprin- cipallyabletobuildupseveralconnections todifferentHuthdevices.Thedriversendsthe alphanumerical valuedefinedinhissetupas"Interface name".Thefurtherparameter willbe filledwithvideometadatabythedriver. Parameter Function Terminal TerminalName Identifiestheaffecteddevice.The"HUTH"driverisprin- cipallyabletobuildupseveralconnections todifferentHuth devices.Thedriversendsthealphanumerical valuedefined inhissetupas"Interfacename". timestamp TimeStamp TimeStamp,whenthestatuschangewasdetectedbythe Huth-System pumpno PumpNo Numberofthefillingpump status Status Newstatusofthefillingpump Fillingstarted=Huth-devicestatus"takenoffbeforefilling" Fillingstopped=Huth-devicestatus"putbackonendof filling" Pumpreleased=Huth-devicestatus"disconnect afterfilling" Amountmessage=sum-respectively amountnoticeofthe fillingpump amount Amount Amountofthebooking(optional) price Price Sumofthebooking(optional) details Details Freetext(optional) Interface rawanswer Actionname:InterfaceRawAnswer (InterfaceName, TimeStamp, Data) Actioncategory:notification Thisactionisusedbythe"HUTH"driver.".Itservesonlyasadebugserviceandcanalso beusedingeneralforanyintegration thatsupportsorusesthisaction.The"HUTH"driver sendstheactionforeachtelegramithassenttotheenddevice.Theaffectedenddevice willbeidentifiedbytheparameter "TerminalName". The"HUTH"drivercanalwaysbuildup numerous connections todifferentHuthdevices.Thedriverthensendsthealphanumerical valuedefinedinitssetupas"Interface name"Thefurtherparameter willbefilledwithvideo metadatabythedriver. --- Page 82 --- Parameter Function interface InterfaceName Identifiestheaffectedenddevice.The"HUTH"driverisprin- cipallyabletobuildupseveralconnections todifferentHuth devices.Thedriversendsthealphanumerical valuedefined inhissetupas"Interfacename". timestamp TimeStamp TimeStampwhenthetelegramwasreceivedfromtheHuth system. answer Data Thesenttelegraminrawformat. Interface rawdata Actionname:InterfaceRawData (InterfaceName, TimeStamp, Data) Actioncategory:notification Thisactionisusedbythedriver"HUTH".Itservesonlyasadebugserviceandcanalsobe usedingeneralforanyintegration thatsupportsorusesthisaction.The"HUTH"driver sendstheactionforeachtelegramithasreceivedfromtheenddevice.Theaffectedend devicewillbeidentifiedbytheparameter "TerminalName". The"HUTH"drivercanalways buildupnumerous connections todifferentHuthdevices.Thedriverthensendsthealpha- numerical valuedefinedinitssetupas"Interface name"Thefurtherparameter willbefilled withvideometadatabythedriver. Parameter Function interface InterfaceName Identifiestheaffectedenddevice.The"HUTH"driverisprin- cipallyabletobuildupseveralconnections todifferentHuth devices.Thedriversendsthealphanumerical valuedefined inhissetupas"Interfacename". timestamp TimeStamp TimeStampwhenthetelegramwasreceivedfromtheHuth system. data Data Thereceivedtelegraminrawformat. POSdata Actionname:POSData (POSName, TimeStamp, Article,Price,Units,PricePerUnit, Line1, Line2,Line3,Line4,Line5) Actioncategory:logical ThePOSManagement Systemsendstheactionforeachtransaction carriedoutatacash point Viatheparameter "POS"the affectedcashpointwillbeidentified. Thefurtherparameter will befilledwithvideometadatabythePOSManagement System Parameter Function POS POSName Alphanumerical identification ofthecashpoint timestamp TimeStamp TimeStamp,whentheactionwassendfromthePOSman- agementsystem article Article Identification ofthebookedarticle(optional) price Price Amount(singlepricemultipliedwithnumberofarticles)of transaction(optional) units Units Amountofarticlesofthetransaction(optional) priceperunit PricePerUnit Singlearticlepriceofthetransaction(optional) line1 Line1 Alphanumerical fields/sectionsforstoringofadditional informationconcerningthetransactionorforstoringinform- ationwhichhavebeenprintedoutonthesalesslip(optional) line2 Line2 Alphanumerical fields/sectionsforstoringofadditional informationconcerningthetransactionorforstoringinform- --- Page 83 --- Parameter Function ationwhichhavebeenprintedoutonthesalesslip(optional) line3 Line3 Alphanumerical fields/sectionsforstoringofadditional informationconcerningthetransactionorforstoringinform- ationwhichhavebeenprintedoutonthesalesslip(optional) line4 Line4 Alphanumerical fields/sectionsforstoringofadditional informationconcerningthetransactionorforstoringinform- ationwhichhavebeenprintedoutonthesalesslip(optional) line5 Line5 Alphanumerical fields/sectionsforstoringofadditional informationconcerningthetransactionorforstoringinform- ationwhichhavebeenprintedoutonthesalesslip(optional) POSstatus Actionname:POSStatus (POSName, TimeStamp, Status,Details) Actioncategory:logical ThePOSmanagement systemsendstheactionassoonasthecashpointisopenedor closedorassoonasacancellation willbemadeatacashpoint. Viatheparameter "POS"theconcerned cashpointwillbeidentified. Thefurtherparameter willbefilledwithvideometadatafromthePOSmanagement system. Theparameter "Status"canbeaddressed bythePOSmanagement systemwithacodefig- ureforthecurrentlynotifiedstatus. Parameter Function POS POSName Alphanumerical identification ofcashpoint timestamp TimeStamp TimeStamp,whentheactionwassentfromthePOSman- agementsystem status Status Identification figureforthecurrentlynotifiedstatus details Details Additionalalphanumerical informationfromPOSmanagement system(optional) Terminal articledata Actionname:TerminalArticleData (TerminalName, TimeStamp, CashierStation, PumpNo, AlarmStatus, Amount,Price,Details) Actioncategory:notification The"Huth"driversendstheactionsforeachproduct-group-booking.Viatheparameter "Ter- minalName" theaffecteddevicewillbeidentified. The"HUTH"driverisprincipally ableto buildupseveralconnections todifferentHuthdevices.Thedriversendsthealphanumerical valuedefinedinhissetupas"Interface name".Thefurtherparameter willbefilledwithvideo metadataviathedriver. Parameter Function Terminal TerminalName Identifiestheaffecteddevice.The"HUTH"driverisprin- cipallyabletobuildupseveralconnections todifferentHuth devices.Thedriversendsthealphanumerical valuedefined inhissetupas"Interfacename". timestamp TimeStamp TimeStamp,whenthestatuschangewasdetectedbythe Huth-System cashierstation CashierStation Numberofthecashpointwherethebookingiscarriedout pumpno PumpNo Numberofthefillingpoint alarm AlarmStatus StatusofAlarm-Flags Yes=Alarm-FlagwassetbytheHuthsystem No=Alarm-Flagnotset --- Page 84 --- Parameter Function amount Amount Amountofthebooking(optional) price Price Sumofthebooking(optional) details Details Freetext(optional) Terminal payment data Actionname:TerminalPaymentData (TerminalName, TimeStamp, CashierStation, PumpNo,AlarmStatus, Amount,Price,Details) Actioncategory:notification The"HUTH"driversendstheactionforeachtermination ofabookingwiththeusedmethod ofpayment.Viatheparameter "TerminalName" theaffecteddevicewillbeidentified. The "HUTH"driverisprincipally abletobuildupseveralconnections todifferentHuthdevices. Thedriversendsthealphanumerical valuedefinedinhissetupas"Interface name".Thefur- therparameter willbefilledwithvideometadataviathedriver. Parameter Function Terminal TerminalName Identifiestheaffecteddevice.The"HUTH"driverisprin- cipallyabletobuildupseveralconnections todifferentHuth devices.Thedriversendsthealphanumerical valuedefined inhissetupas"Interfacename". timestamp TimeStamp TimeStamp,whenthestatuschangewasdetectedbythe Huth-System cashierstation CashierStation Numberofthecashpointwherethebookingiscarriedout withtheusedpaymentmethod pumpno PumpNo Numberofthefillingpoint(optional) alarm AlarmStatus StatusofAlarm-Flags Yes=Alarm-FlagwassetbytheHuthsystem No=Alarm-Flagnotset amount Amount Amountofthebooking(optional) price Price Sumofthebooking(optional) details Details Freetext(optional) Remote export Theactionsofthecategory"RemoteExport"subservetostartandcontrolexportsoverthe network.TheactionsareonlyatdisposalifGSCRemEx servicerunsoneverydeviceanda connection toacentralGeViSoftserverpersists.TheGSCServer andGSCRemEx service havetoruntogetheronalocalmachineotherwise exportsarenotpossible.The GSCRemEx servicehastobesetupinadvancebyGSCRemExEditor. Theexportscanbe executedbyaPILOTcenterdeviceorothersoftwaresystems(SDKbased, GEUTEBRUECK devices).ThePILOTisasystemmanagement consoleof GEUTEBRUECK whichsimplifiesthehandlingofcomplexsecuritysystems.ThePILOT amongotherscanbeusedtocontrolGSCView. Especially inviewofthefactofexportsthe usercandefinestartandendpointsbythehelpofthePILOTthroughGSCRemEx ("SetEx- portMarker" action).GSCView remembers thepointsintimeandinsertsthemtotheaction "StartRemoteExport". Theaction"StartRemoteExport" isinitiatedbyGSCView afterthe PILOThassendtheaction"InitializeRemoteExport" byindirection viatheGeViSoftserver andGeViScope servertoGSCView. GSCView sendstheaction"StartRemoteExport" to --- Page 85 --- theGSCRemEx serviceandtriggerstheappropriate export.Exportsthathavebeenstarted throughGSCRemEx servicecanbestartedorabortedfromotherdevicesorsoftwaresys- temsoverthenetwork.ExportsthathavebeenstartedlocallyinGSCView cannotbecon- trolledfromotherdevicesorsoftwaresystems.Inthecurseofanexportprocessnonew exportcanbestarted.Thisexporthastoberestartedaftertherunningexportprocesshas beencompleted! Theactions"SetExportMarker" and"InitializeRemoteExport" havebeen developed especially forthePILOT. Cancelexport Actionname:CancelExport (ExportID, AbortFlag) Actioncategory:command ThroughthisactiontherunningexportprocesswiththespecifiedexportIDisbeingaborted ifGSCView remote-controlstheGSCRemEx service.IftheGSCRemEx serviceisremote- controlled byanexternalapplication theexternalapplication hastosendtheactiontoabort therunningexportprocess. Parameter Function exportGUIDExportID IDoftheexportprocessthathastobeaborted. TheexportGUIDisbeingassignedontheaction"StartRe- moteExport". e.g.:01E68451-2406-484d-A9BC-5140762931E0 abortflag AbortFlag reasonforabort 0:userabort;abortofexportthroughuser 1:lowdiscspace;toolittlestoragecapacity 2:nouserrights;accessbasedonrestricteduserrightsnotpos- sible 3:error;internalerror Exportfinished Actionname:ExportFinished (ExportID, Success) Actioncategory:notification TheGSCRemEx servicenotifiesthroughthisactionthattherunningprocesswascom- pleted. Possiblestatusmessages are:userabort,lowdiscspace,nouserrights,error. Parameter Function exportGUIDExportID IDofcompletedexportprocess.TheexportGUIDisbeingassigned ontheaction"StartRemoteExport". e.g.:01E68451-2406-484d-A9BC-5140762931E0 success Success reasonforabort 0:userabort;abortofexportthroughuser 1:lowdiscspace;toolittlestoragecapacity 2:nouserrights;accessbasedonrestricteduserrightsnotpos- sible 3:error;internalerror Exportprogress Actionname:ExportProgress (ExportID, Progress) Actioncategory:notification TheGSCRemEx servicenotifiesthecurrentstatusoftherunningexportprocessin%. Parameter Function exportGUIDExportID IDofrunningexport.TheexportGUIDisbeingassignedonthe action"StartRemoteExport". e.g.:01E68451-2406-484d-A9BC-5140762931E0 progress Progress showscurrentstatusoftheexportprocessin% --- Page 86 --- Initialize remoteexport Actionname:InitializeRemoteExport (Viewer, Device) Actioncategory:command Thisactionisbeingusedespecially inthecontextofcontrolunitsorsystemslikefor examplethePILOT. ThePILOTcenterdevicenotifiesGSCView thatanewexporthastobeinitiated.Thereupon GSCView createstheaction"StartRemoteExport" withtheappropriate parameters. Parameter Function viewer Viewer globalviewernumber deviceGUIDDevice IDofthePILOTcenterdevice(transmitted bythePILOTitself) e.g.:01E68451-2406-484d-A9BC-5140762931E0 Setexportmarker Actionname:SetExportMarker (Viewer, Marker) Actioncategory:command Thisactionisbeingusedespecially inthecontextofcontrolunitsorsystemslikefor examplethePILOT. ItindicatesGSCView thatanexportstartandendpointhastobesetonthecurrentposition ofviewerX. Theso-calledmarkersarebeingtransferred automatically intothe"StartRemoteExport" actiononcethe"InitializeRemoteExport" actionhasbeensentfromthePILOT.Theaction "StartRemoteExport" transfersthestartandendpointstotheGSCRemEx servicewhich conductstheappropriate export. Parameter Function viewer Viewer globalviewernumber marker Marker tagsandstoresthestartandendpointofthedatathathastobe exported (selectionbegin=0,selectionend=1) Startremoteexport Actionname:StartRemoteExport (ExportID, Device,BackupFormat, Channel, Selec- tionBegin, SelectionEnd, JobID) Actioncategory:command ThisactiontellstheGSCRemEx servicetostartanewexport. Theaction"StartRemoteExport" wascreatedbecausethePILOToranotherexternalsoft- waresystemdidsendtheaction"InitializeRemoteExport" toGSCView before. Parameter Function exportGUIDExportID IDofrunningexports.TheexportGUIDhastobedeterminedsep- aratelyinadvancebecausetheactionitselfdoesnotcreatea GUID. deviceGUIDDevice IDofPILOTcenterdevice.IfnoPILOTisbeingusedtheblank GUIDcanbeusedinstead. e.g.:01E68451-2406-484d-A9BC-5140762931E0 format BackupFormat definestheformatoftheexportedfile 0=default(inthiscaseitequals1=GBF) 1=GBF( GEUTEBRUECK backupfile) 2=MPEG2 channel Channel globalchannelnumber/camera number starttime SelectionBegin holdsthepositionofthemarkerforthestartpoint("selection begin") endtime SelectionEnd holdsthepositionofthemarkerfortheendpoint("selectionend") --- Page 87 --- Parameter Function jobID JobID Containsthelogindata(servername,username,encodedpass- word) Optionalseconduserpassword.Thelogindataisseparatedby|. e.g.:|||| localhost|admin|test| Ifthereisnoseconduser(seconduserpassword)nothinghasto be enteredatthispoint. Passwordsinthisparameterareencoded.Thereforthefunction DBIEncodeString ()ofGscDBI-DLL(fromGeViScope/re_ porter SDK)isbeingused. Startscenestore Actionname:StartSceneStore (SceneStoreID, CutList,PreHistoryLength, Record- ingLength) Actioncategory:command Forinternaluseonly! Parameter Function scenestore GUIDSceneStoreID ScenestoreGUID. cut-list CutList Cut-list. pre-history lengthPreHistoryLength Pre-historylength. recording lengthRecordingLength Recordinglength. SKIDATA SKIDATA messages. SKIDATA control Actionname:SkidataControl (InterfaceName, Data) Actioncategory:logical SKIDATA controlinformation. Parameter Function interface InterfaceName Interfacename. state Data Interfacestate. SKIDATA deviceevent Actionname:SkidataDeviceEvent (InterfaceName, DeviceID, EventCode) Actioncategory:logical SKIDATA deviceevent. Parameter Function interface InterfaceName Interfacename. device DeviceID DeviceID. eventcodeEventCode Eventcode. SKIDATA entry Actionname:SkidataEntry (InterfaceName, MessageCode, TranscactionID, CarParkNo, DeviceID) --- Page 88 --- Actioncategory:logical SKIDATA entry. Parameter Function interface InterfaceName Interfacename. message MessageCode Messagecode. transaction TranscactionID Transcaction ID. carpark CarParkNo Carparkno. device DeviceID DeviceID. SKIDATA exit Actionname:SkidataExit (InterfaceName, MessageCode, TranscactionID, CarParkNo, DeviceID) Actioncategory:logical SKIDATA exit. Parameter Function interface InterfaceName Interfacename. message MessageCode Messagecode. transaction TranscactionID Transcaction ID. carpark CarParkNo Carparkno. device DeviceID DeviceID. SKIDATA transaction Actionname:SkidataTransaction (InterfaceName, MessageCode, TranscactionID, CarParkNo, DeviceID) Actioncategory:logical SKIDATA transaction. Parameter Function interface InterfaceName Interfacename. message MessageCode Messagecode. transaction TranscactionID Transcaction ID. carpark CarParkNo Carparkno. device DeviceID DeviceID. Systemactions Allactionsdescribing systembehaviour. Custom action Actionname:CustomAction (Int,String) Actioncategory:logical Thisactionhasnosideeffectsandcanbeusedforcustomerpurposes. Parameter Function INTparameter IntNumericparameter. STRINGparameterStringLiteralparameter. Database recording infoperring Actionname:DatabaseRecordingInfoRing (DatabaseRing, NoVideoRecording, NoAu- dioRecording, NoRecordingAtAll, VideoSamplesPerSecond, VideoMBPerSecond, Audi- oSamplesPerSecond, AudioMBPerSecond, WriteWaitTimesPercent, RingCapacity, OldestItem, RecordingDepth, EstimatedRequiredCapacity) --- Page 89 --- Actioncategory:logical Database recordinginfoperring. Parameter Function databasering DatabaseRing Databasering. novideorecording NoVideoRecording Videoisrecordingornot. noaudiorecording NoAudioRecording Audioisrecordingornot. norecording NoRecordingAtAll Videoand/oraudioisrecordingornot. videosamples/s VideoSamplesPerSecond Videosamplespersecond. videosamplesMB/s VideoMBPerSecond VideoMBpersecond. audiosamples/s AudioSamplesPerSecond Audiosamplespersecond. audiosamplesMB/s AudioMBPerSecond AudioMBpersecond. writewait% WriteWaitTimesPercent Writewaittimesinpercent. ringcapacity RingCapacity Ringcapacity. oldestitem OldestItem Timestampoftheoldestitem. recordingdepth RecordingDepth Recordingdepthinhours. estimatedrequiredcapacityEstimatedRequiredCapacity Estimatedrequiredcapacity. Database recording infototal Actionname:DatabaseRecordingInfoTotal (NoVideoRecording, NoAudioRecording, NoRe- cordingAtAll, VideoSamplesPerSecond, VideoMBPerSecond, AudioSamplesPerSecond, AudioMBPerSecond, WriteWaitTimesPercent, TotalCapacity, FreeCapacity, Alloc- atedCapacity, OldestItem, RecordingDepth, EstimatedRequiredCapacity, RequiredCa - pacityFactor, RequiredCapacityAvailable) Actioncategory:logical Database recordinginfototal. Parameter Function novideorecording NoVideoRecording Videoisrecordingornot. noaudiorecording NoAudioRecording Audioisrecordingornot. norecording NoRecordingAtAll Videoand/oraudioisrecordingornot. videosamples/s VideoSamplesPerSecond Videosamplespersecond. videosamplesMB/s VideoMBPerSecond VideoMBpersecond. audiosamples/s AudioSamplesPerSecond Audiosamplespersecond. audiosamplesMB/s AudioMBPerSecond AudioMBpersecond. writewait% WriteWaitTimesPercent Writewaittimesinpercent. totalcapacity TotalCapacity Totalcapacity. freecapacity FreeCapacity Freecapacity. allocatedcapacity AllocatedCapacity Allocatedcapacity. oldestitem OldestItem Timestampoftheoldestitem. recordingdepth RecordingDepth Recordingdepthinhours. estimatedrequiredcapacityEstimatedRequiredCapacity Estimatedrequiredcapacity. requiredcapacityfactorRequiredCapacityFactor Requiredcapacityfactor. requiredcapacityavailableRequiredCapacityAvailable Requiredcapacityavailable. Database started Actionname:DatabaseStarted (Status,TotalSize) Actioncategory:logical --- Page 90 --- Thisactionwillbefiredatthedatabasestart-up. Parameter Function statusStatusDatabasestatusmessage. totalsizeTotalSizeDatabasetotalsize. Eventrecording changed Actionname:EventRecordingChanged (EventID, TypeID) Actioncategory:logical Eventrecordingsettingsarechanged. Parameter Function instanceIDEventIDInstanceIDoftheevent. eventtypeTypeIDTypeoftheevent. Eventstarted Actionname:EventStarted (EventID, TypeID,ForeignKey) Actioncategory:logical Eventhasstarted. Parameter Function instanceIDEventID InstanceIDoftheevent. eventtypeTypeID Typeoftheevent. foreignkeyForeignKey Optionalforeignkeyusedtostartthealarm. Eventstopped Actionname:EventStopped (EventID, TypeID) Actioncategory:logical Eventhasstopped. Parameter Function instanceIDEventIDInstanceIDoftheevent. eventtypeTypeIDTypeoftheevent. FRCnotification Actionname:FRCNotification (Notification, Param,Description, XMLInfo) Actioncategory:logical FRCnotification. Parameter Function notification Notification Notificationreason. param Param Additionalparameter. description Description Optionalnotificationtext. additionalinfoXMLInfo Optionaladditionalinfo(usuallyasXMLstring). GEMOS alarm Actionname:GEMOSalarm (GEMOSkey, GEMOSint, GEMOSstr) Actioncategory:logical GEMOSalarmnotification. Parameter Function GEMOSkeyGEMOSkeyGEMOSalarmkey. GEMOSintGEMOSintGEMOSalarmintegerparameter. GEMOSstrGEMOSstrGEMOSalarmstringparameter. --- Page 91 --- Killallevents Actionname:KillAllEvents () Actioncategory:logical Killallactiveevents. Killevent Actionname:KillEvent (TypeID) Actioncategory:logical Killevent. Parameter Function eventtypeTypeIDTypeoftheevent. Killeventbyinstance Actionname:KillEventByID (EventID) Actioncategory:logical KilleventbyinstanceID. Parameter Function instanceIDEventIDInstanceIDoftheevent. Livecheck Actionname:LiveCheck (Counter,Date) Actioncategory:logical Thisactionwillbefiredevery10secondsandintendedforuseaslivecheck. Parameter Function counter CounterThisisthenumberofalreadyfiredlivecheckactions. timestampDateCurrentservertime. Setclock Actionname:SetClock (Date) Actioncategory:logical Setclock. Parameter Function currenttimeDateCurrenttime. Setupchanged Actionname:SetupChanged (User,Host,Date,ResourceKind, ResourceID, ChangeKind, Details,ClientHost, ClientType, ClientAccount) Actioncategory:logical Setupchanged. Parameter Function usernameUser Nameoftheusermodifiedthesetup. remotehostHost Hostfromwheretheconnectionwasdone. currenttimeDate Currenttime. resourcekindResourceKind Modifiedresourcekind. resourceIDResourceID ModifiedresourceID. changekindChangeKind Changekind. details Details Detailsofthemodification. clienthostClientHost Hostfromwheretheconnectionisdone. --- Page 92 --- Parameter Function clienttypeClientType Clienttype. clientaccountClientAccount Useraccountfromwheretheconnectionisdone. Setupuploadprogress Actionname:SetupUploadProgress (User1,User2,Host,Progress, Date) Actioncategory:logical Setupuploadprogress. Parameter Function firstuserUser1Nameoftheusermodifiedthesetup. seconduserUser2Nameoftheseconduserbyfoureyesauthentication. remotehostHostHostfromwheretheconnectionwasdone. progress%ProgressProgressinpercent. currenttimeDateCurrentstagetime. Setwatchdog Actionname:SetWatchdog (Timeout) Actioncategory:logical Setwatchdog. Parameter Function timeoutTimeoutTimeoutinseconds,beforethewatchdogmustberetriggeredandbeforethe hardwarewatchdogwillsetthehardwarecontact. SMRPviewercleared Actionname:SMRPViewerCleared () Actioncategory:logical SMRPviewercleared. SMRPviewerconnected Actionname:SMRPViewerConnected (Server,Channel) Actioncategory:logical SMRPviewerconnected tothecamera. Parameter Function serverServerServername. channelChannelChannel. SMTPmail Actionname:SMTPMailSend (Subject,To,Cc,Body,Channel) Actioncategory:logical ThisactionwillsendauserdefinedemailifGscMailisconnected Parameter Function subjectSubjectMailsubject. toToMailrecepients. ccCcCarboncopyrecepients. bodyBodyMailbody. channelChannelChannel. Startevent Actionname:StartEvent (TypeID,ForeignKey) Actioncategory:logical --- Page 93 --- Startevent. Parameter Function eventtypeTypeID Typeoftheevent. foreignkeyForeignKey Optionalforeignkeyusedtostoreforthealarm. Stopallevents Actionname:StopAllEvents () Actioncategory:logical Stopallactiveevents. Stopevent Actionname:StopEvent (TypeID) Actioncategory:logical Stopevent. Parameter Function eventtypeTypeIDTypeoftheevent. Stopeventbyinstance Actionname:StopEventByID (EventID) Actioncategory:logical StopeventbyinstanceID. Parameter Function instanceIDEventIDInstanceIDoftheevent. Systemerror Actionname:SystemError (Source,Message, WindowsError, Description, XMLInfo) Actioncategory:logical Notifysystemerror. Parameter Function sourcesubsystem Source Sourceofthemessage. messagecodeMessage Kindofthemessage. WindowserrorcodeWindowsError OptionalWindowserrorcode. description Description Optionaldescriptionofthemessage. additionalinfoXMLInfo Optionaladditionalinfo(usuallyasXMLstring). Systeminfo Actionname:SystemInfo (Source,Message, Description, XMLInfo) Actioncategory:logical Notifysysteminformation. Parameter Function sourcesubsystem Source Sourceofthemessage. messagecodeMessage Kindofthemessage. description Description Optionaldescriptionofthemessage. additionalinfoXMLInfo Optionaladditionalinfo(usuallyasXMLstring). Systemsettings changed Actionname:SystemSettingsChanged (SetupChanged, User1,User2,Host, TimeRangeChanged, TimeRange, LicenceChanged, Date) Actioncategory:logical Setupofthesystemand/orthecurrenttimerangechanged. --- Page 94 --- Parameter Function setupchanged SetupChanged Systemsetuphaschanged. firstuser User1 Nameoftheusermodifiedthesetup. seconduser User2 Nameoftheseconduserbyfoureyesauthentication. remotehost Host Hostfromwheretheconnectionwasdone. timerangechangedTimeRangeChanged Timerangehaschanged. currenttimerangeTimeRange Currentlyactivetimerange. licencechanged LicenceChanged Licencehaschanged. changetime Date Timeofthesystemsettingschanged. Systemstarted Actionname:SystemStarted (Date) Actioncategory:logical Thisactionwillbefiredonlyonceatthesystemstart-up. Parameter Function starttimeDateTimeofthesystemstart-up. Systemterminating Actionname:SystemTerminating (Date,WindowsShutdown) Actioncategory:logical Thisactionwillbefiredwhenthesystemisgoingshutdown. Parameter Function stoptimeDate Timeofthesystemshutdown. Windowsshut- downWindowsShutdown Indicateswhetherthesystemshutdownisdoneduetothe windowsshutdown. Systemwarning Actionname:SystemWarning (Source,Message, WindowsError, Description, XMLInfo) Actioncategory:logical Notifysystemwarning. Parameter Function sourcesubsystem Source Sourceofthemessage. messagecodeMessage Kindofthemessage. WindowserrorcodeWindowsError OptionalWindowserrorcode. description Description Optionaldescriptionofthemessage. additionalinfoXMLInfo Optionaladditionalinfo(usuallyasXMLstring). Transfer binarybuffer Actionname:TransferBinaryBuffer (InternalHandle, Parameter) Actioncategory:logical Transferbinarybuffer. Parameter Function internalhandleInternalHandle Internalhandle. parameter Parameter Parameter. Transfer binarychannel buffer Actionname:TransferBinaryChannelBuffer (Channel, InternalHandle, Parameter) Actioncategory:logical Transferbinarychannelbuffer. --- Page 95 --- Parameter Function channel Channel Channel. internalhandleInternalHandle Internalhandle. parameter Parameter Parameter. Userlogin Actionname:UserLogin (User1,User2,Host,ClientHost, ClientType, ClientAccount) Actioncategory:logical Thisactionwillbefiredwhentheuserhasconnected tothesystem. Parameter Function firstuserUser1 Nameoftheuserconnectedtothesystem. seconduserUser2 Nameoftheseconduserbyfoureyesauthentication. remotehostHost Hostfromwheretheconnectionisdone. clienthostClientHost Hostfromwheretheconnectionisdone. clienttypeClientType Clienttype. clientaccountClientAccount Useraccountfromwheretheconnectionisdone. Userloginfailed Actionname:UserLoginFailed (User1,User2,Host,RejectReason, ClientHost, ClientType, ClientAccount) Actioncategory:logical Thisactionwillbefiredwhentheuserhastriedtoconnecttothesystembutwasrejected. Parameter Function firstuserUser1 Nameoftheusertriedtoconnecttothesystem. seconduserUser2 Nameoftheseconduserbyfoureyesauthentication. remotehostHost Hostfromwheretheconnectionisdone. rejectreasonRejectReason Reasonoftherejection. clienthostClientHost Hostfromwheretheconnectionisdone. clienttypeClientType Clienttype. clientaccountClientAccount Useraccountfromwheretheconnectionisdone. Userlogout Actionname:UserLogout (User1,User2,Host,ClientHost, ClientType, ClientAccount) Actioncategory:logical Thisactionwillbefiredwhentheuserhasdisconnected fromthesystem. Parameter Function firstuserUser1 Nameoftheuserdisconnected fromthesystem. seconduserUser2 Nameoftheseconduserbyfoureyesauthentication. remotehostHost Hostfromwheretheconnectionwasdone. clienthostClientHost Hostfromwheretheconnectionisdone. clienttypeClientType Clienttype. clientaccountClientAccount Useraccountfromwheretheconnectionisdone. Videocontrolactions Allactionstocontrolthevideostreams,alsoallnotifications aboutthestatechangeofthe videostreams. --- Page 96 --- Activate external process Actionname:ActivateExternalProcess (Channel, TimeStamp, ExternalSystem) Actioncategory:logical Activateexternalprocess. Parameter Function channel Channel Channel. timestamp TimeStamp Timestamp. externalsystemExternalSystem Externalsystemtoactivate. Change ADparameter set Actionname:ChangeADParameterSet (Channel, ParameterSet) Actioncategory:logical ThisactionchangesthecurrentADparameter setofthevideochannel. Parameter Function channel Channel Channel. ADparametersetParameterSet ThenameofthenewADparameterset. Change cameraprofile Actionname:ChangeCameraProfile (HardwareModule, CameraProfile) Actioncategory:logical Thisactionchangesthecurrentcameraprofileofthehardwaremodule. Parameter Function hardwareHardwareModule Hardwaremodule. profileCameraProfile Thenameofthecameraprofile. Change CPAparameter set Actionname:ChangeCPAParameterSet (Channel, ParameterSet) Actioncategory:logical ThisactionchangesthecurrentCPAparameter setofthevideochannel. Parameter Function channel Channel Channel. CPAparametersetParameterSet ThenameofthenewCPAparameterset. Change OBTRACK parameter set Actionname:ChangeObtrackParameterSet (Channel, ParameterSet) Actioncategory:logical ThisactionchangesthecurrentOBTRACK parameter setofthevideochannel. Parameter Function channel Channel Channel. OBTRACKparametersetParameterSet ThenameofthenewOBTRACKparameterset. Change VMDparameter set Actionname:ChangeVMDParameterSet (Channel, ParameterSet) Actioncategory:logical ThisactionchangesthecurrentVMDparameter setofthevideochannel. Parameter Function channel Channel Channel. VMDparametersetParameterSet ThenameofthenewVMDparameterset. --- Page 97 --- Channel error Actionname:ChannelError (Channel, SensorType, Source,Message, WindowsError, Description, XMLInfo) Actioncategory:logical Notifychannelerror. Parameter Function channel Channel Channel. sensortype SensorType Sensortype. sourcesubsystem Source Sourceofthemessage. messagecodeMessage Kindofthemessage. WindowserrorcodeWindowsError OptionalWindowserrorcode. description Description Optionaldescriptionofthemessage. additionalinfoXMLInfo Optionaladditionalinfo(usuallyasXMLstring). Channel info Actionname:ChannelInfo (Channel, SensorType, Source,Message, Description, XMLInfo) Actioncategory:logical Notifychannelinformation. Parameter Function channel Channel Channel. sensortype SensorType Sensortype. sourcesubsystem Source Sourceofthemessage. messagecodeMessage Kindofthemessage. description Description Optionaldescriptionofthemessage. additionalinfoXMLInfo Optionaladditionalinfo(usuallyasXMLstring). Channel livecheck Actionname:ChannelLiveCheck (Channel, SensorType, TimeStamp) Actioncategory:logical Thisactionnotifiesthatthechannbelisalive. Parameter Function channel Channel Channel. sensortypeSensorType Sensortype. timestampTimeStamp Timestamp. Channel warning Actionname:ChannelWarning (Channel, SensorType, Source,Message, WindowsError, Description, XMLInfo) Actioncategory:logical Notifychannelwarning. Parameter Function channel Channel Channel. sensortype SensorType Sensortype. sourcesubsystem Source Sourceofthemessage. messagecodeMessage Kindofthemessage. WindowserrorcodeWindowsError OptionalWindowserrorcode. description Description Optionaldescriptionofthemessage. additionalinfoXMLInfo Optionaladditionalinfo(usuallyasXMLstring). --- Page 98 --- CPAmeasurement Actionname:CPAMeasurement (Channel, Correlation) Actioncategory:logical CPAmeasurement. Parameter Function channelChannel Channel. correlationCorrelation Correlationfactor. IASsettings changed Actionname:IASSettingsChanged (Channel, SensorType) Actioncategory:logical IASsettingschanged. Parameter Function channel Channel Channel. sensortypeSensorType Sensortype. IPcamerarawcommand Actionname:IPCameraRawCommand (URL,User,Password, POST) Actioncategory:logical Thisactionsendsaspecialcommand totheIPcamera. Parameter Function urlURLCompletecommandURL(likehttp://192.168.0.165:80/ - set?daynight=night). userUserUsernametoauthenticate bythecamera(optional). passwordPasswordPasswordtoauthenticate bythecamera(optional). postPOSTPOSTparameters(optional,separatelineswith\\r\\n). MakeCPAreference image Actionname:MakeCPAReferenceImage (Channel) Actioncategory:logical MakeCPAreferenceimage. Parameter Function channelChannelChannel. Mediachannel setup Actionname:MediaChannelSetupInfo (Channel, TimeStamp, Parameter) Actioncategory:logical Mediachannelsetupinfo. Parameter Function channel Channel Channel. timestampTimeStamp Timestamp. parameter Parameter Parameter. NPRrawdata Actionname:NPRRawData (PlateNo,Country,Channel,TimeStamp, ZoneRect, Weight, ZoneState, ZonePlace, Speed,Direction, ZoneIndex, CurBest,PlateWidth, PlateHeight, PlateAngle, SymHeight, Type) Actioncategory:logical NPRrawdata. --- Page 99 --- Parameter Function plateno.PlateNo Recognizedplateno. country Country Country. channel Channel Channel. timestampTimeStamp Timestamp. zonerectZoneRect Zonerectangle. weight Weight Weightofrecognition. zonestateZoneState Zonestate. zonestatusZonePlace Zonestatus. speed Speed Speedinkm/h direction Direction Directionofthemotion. zoneindexZoneIndex Zoneindex. best CurBest Currentrecognitionisbest. platewidthPlateWidth Platewidth. plateheightPlateHeight Plateheight. plateanglePlateAngle Plateangle. SymbolheightSymHeight Symbolheight. type Type Numbertype. NPRrecognition Actionname:NPRRecognition (PlateNo,Country,Channel,TimeStamp, ZoneRect, Restric- tion,Category, Speed,Direction, ZoneIndex, Type,Weight) Actioncategory:logical NPRrecognition. Parameter Function plateno.PlateNo Recognizedplateno. country Country Country. channel Channel Channel. timestampTimeStamp Timestamp. zonerectZoneRect Zonerectangle. restriction Restriction Restrictionofrecognizednumber. category Category Categoryofrecognizednumber. speed Speed Speedinkm/h direction Direction Directionofthemotion. zoneindexZoneIndex Zoneindex. type Type Numbertype. weight Weight Weightofrecognition. OBTRACK channel counter Actionname:ObtrackChannelCounter (Channel, CounterType, CounterValue, ObjectDir- ection,TimeStamp, ResetTimeStamp) Actioncategory:logical OBTRACK channelcounter. Parameter Function channel Channel Channel. countertypeCounterType Countertype. countervalueCounterValue Countervalue. objectdirectionObjectDirection Objectdirection. --- Page 100 --- Parameter Function timestamp TimeStamp Timestamp. resettimestampResetTimeStamp Resettimestamp. OBTRACK channel counter threshold Actionname:ObtrackChannelCounterThreshold (Channel, CounterType, CounterValue, ExceedingDirection, TimeStamp) Actioncategory:logical OBTRACK channelcounterthreshold. Parameter Function channel Channel Channel. countertype CounterType Countertype. countervalue CounterValue Countervalue. exceedingdirectionExceedingDirection Exceedingdirection. timestamp TimeStamp Timestamp. OBTRACK channel setcounter Actionname:ObtrackChannelSetCounter (Channel, CounterType, CounterValue, TimeStamp) Actioncategory:logical OBTRACK channelsetcounter. Parameter Function channel Channel Channel. countertypeCounterType Countertype. countervalueCounterValue Countervalue. timestampTimeStamp Timestamp. OBTRACK framerawdata Actionname:ObtrackFrameRawData (TimeStamp, Channel,Brightness, Contrast) Actioncategory:logical OBTRACK framerawdata. Parameter Function timestampTimeStamp Timestamp. channel Channel Channel. brightness Brightness Brightness. contrast Contrast Contrast. OBTRACK groupcounter Actionname:ObtrackGroupCounter (GroupId,CounterType, CounterValue, ObjectDirection, TimeStamp, ResetTimeStamp, GroupName) Actioncategory:logical OBTRACK groupcounter. Parameter Function groupidGroupId GroupID. countertypeCounterType Countertype. countervalueCounterValue Countervalue. objectdirectionObjectDirection Objectdirection. timestamp TimeStamp Timestamp. resettimestampResetTimeStamp Resettimestamp. groupnameGroupName Groupname. --- Page 101 --- OBTRACK groupcounter threshold Actionname:ObtrackGroupCounterThreshold (GroupId,CounterType, CounterValue, ExceedingDirection, TimeStamp, GroupName) Actioncategory:logical OBTRACK groupcounterthreshold. Parameter Function groupid GroupId GroupID. countertype CounterType Countertype. countervalue CounterValue CounterValue. exceedingdirectionExceedingDirection Exceedingdirection. timestamp TimeStamp Timestamp. groupname GroupName Groupname. OBTRACK groupsetcounter Actionname:ObtrackGroupSetCounter (GroupId,CounterType, CounterValue, TimeStamp, GroupName) Actioncategory:logical OBTRACK groupsetcounter. Parameter Function groupidGroupId GroupID. countertypeCounterType Countertype. countervalueCounterValue Countervalue. timestampTimeStamp Timestamp. groupnameGroupName Groupname. OBTRACK objectrawdata Actionname:ObtrackObjectRawData (TimeStamp, Channel,Area,ObjectID, ObjectStatus, ObjectClass, Confidence, Position,Speed,Duration,Direction, Size,ObjectWidth, ObjectHeight, ProcessSize, GscNetName) Actioncategory:logical OBTRACK objectrawdata. Parameter Function timestampTimeStamp Timestamp. channel Channel Channel. areanoArea Areano. objectIDObjectID ObjectID. objectstatusObjectStatus Objectstatus. objectclassObjectClass Objectclass. confidence Confidence Confidence. position Position Position. speed Speed Speed. duration Duration Duration. direction Direction Direction. objectsizeSize Objectsize. objectwidthObjectWidth Objectwidthinmeters. objectheightObjectHeight Objectheightinmeters. processsizeProcessSize Processsize. GSCnetnameGscNetName GeviScopenetworkname. --- Page 102 --- OBTRACK tunnelalarm Actionname:ObtrackTunnelAlarm (Channel, TimeStamp, AlarmReason, ObjectID, AlarmAreaID, ObjectArea) Actioncategory:logical OBTRACK tunnelalarmnotification. Parameter Function channel Channel Channel. timestampTimeStamp Timestamp. alarmreasonAlarmReason Alarmreason. objectIDObjectID ObjectID. alarmareaIDAlarmAreaID AlarmareaID. objectareaObjectArea Objectarea. Sensoralarmfinished Actionname:SensorAlarmFinished (Channel, SensorType) Actioncategory:logical Thisactionwillbefiredwhenthealarmisfinished. Parameter Function channel Channel Channel. sensortypeSensorType Sensortype. Sensorinhibitalarmfinished Actionname:SensorInhibitAlarmFinished (Channel, SensorType) Actioncategory:logical Thisactionwillbefiredwhentheinhibitalarmfinished. Parameter Function channel Channel Channel. sensortypeSensorType Sensortype. Sensorinhibitvideoalarm Actionname:SensorInhibitVideoAlarm (Channel, SensorType, ADArea,ADCell, VMDGroup, VMDZone, VMDCycle, AlarmArea, ObjectClass) Actioncategory:logical Thisactionwillbefiredwhenthemotionininhibitareadetected. Parameter Function channel Channel Channel. sensortypeSensorType Sensortype. ADalarmareaADArea ADalarmarea. ADcell ADCell ADcellnr. VMDalarmgroupVMDGroup VMDalarmgroup. VMDzone VMDZone VMDzonenr. VMDcycle VMDCycle VMDmeasurecycle. alarmarea AlarmArea Alarmarea. objectclassObjectClass OBTRACKobjectclass. Sensorvideoalarm Actionname:SensorVideoAlarm (Channel, SensorType, ADArea,ADCell,VMDGroup, VMDZone, VMDCycle, AlarmArea, ObjectClass) Actioncategory:logical --- Page 103 --- Thisactionwillbefiredwhenvideoalarmisdetected. Parameter Function channel Channel Channel. sensortypeSensorType Sensortype. ADalarmareaADArea ADalarmarea. ADcell ADCell ADcellnr. VMDalarmgroupVMDGroup VMDalarmgroup. VMDzone VMDZone VMDzonenr. VMDcycle VMDCycle VMDmeasurecycle. alarmarea AlarmArea Alarmarea. objectclassObjectClass OBTRACKobjectclass. Setsystemtime Actionname:SetSystemTime (TimeStamp) Actioncategory:logical Setsystemtime. Parameter Function timestampTimeStamp Timestamp. Settestpicturemode Actionname:SetTestPictureMode (Channel, Mode) Actioncategory:logical Enableordisabletestpicturegenerator. Parameter Function channelChannelChannel. enableModeEnableordisabletestpicturegenerator. Videocontrast detected Actionname:VideoContrastDetected (Channel) Actioncategory:logical Thisactionwillbefiredwhenthecontrastisdetectedinthevideosignal. Parameter Function channelChannelChannel. Videocontrast failed Actionname:VideoContrastFailed (Channel) Actioncategory:logical Thisactionwillbefiredwhenthecontrastislostinthevideosignal. Parameter Function Parameter Function channelChannelChannel. Videosetimagebrightness Actionname:VideoSetImageBrightness (Channel, SensorType, Brightness) Actioncategory:logical Videosetimagebrightness. Parameter Function channel Channel Channel. sensortypeSensorType Sensortype. brightness Brightness Brightness. --- Page 104 --- Videosetimagecontrast Actionname:VideoSetImageContrast (Channel, SensorType, Contrast) Actioncategory:logical Videosetimagecontrast. Parameter Function channel Channel Channel. sensortypeSensorType Sensortype. contrast Contrast Contrast. Videosetimagesaturation Actionname:VideoSetImageSaturation (Channel, SensorType, Saturation) Actioncategory:logical Videosetimagesaturation. Parameter Function channel Channel Channel. sensortypeSensorType Sensortype. saturation Saturation Saturation. Videosourcehaschanged Actionname:VideoSourceChanged (Channel, SignalNorm, SignalType, InterlaceType) Actioncategory:logical Thisactionindicatesthechangesonthevideoinputsource. Parameter Function channel Channel Channel. signalnormSignalNorm Newsignalnorm. signaltypeSignalType Newsignaltype. interlacetypeInterlaceType Newinterlacetype. Videosyncdetected Actionname:VideoSyncDetected (Channel) Actioncategory:logical Thisactionwillbefiredwhenthesyncisdetectedinthevideosignal. Parameter Function channelChannelChannel. Videosyncfailed Actionname:VideoSyncFailed (Channel) Actioncategory:logical Thisactionwillbefiredwhenthesyncislostinthevideosignal. Parameter Function channelChannelChannel. Vieweractions Vieweractionsallowremotecontrolling GSCView. Toenableremotecontrolling GSCView the"Remotecontrol"settinginGscProfileManager andaglobaluniqueviewerclientnumber hastobeconfigured. --- Page 105 --- VCalarmqueueconfirm Actionname:VCAlarmQueueConfirm (Viewer,SelectionMode) Actioncategory:command ThealarmqueueoftheGSCView withthegivenviewerclientnumbercanberemotecon- trolled. Acurrentalarmisconfirmed. Theparameter "selection mode"defineswhichalarminthe queuewillbeconfirmed. Parameter Function viewer Viewer Globalviewerclientnumber,identifiestheGSCViewthatshouldbe remotecontrolled selection modeSelectionMode first=firstactivealarminqueue next=nextactivealarminqueue(fromcurrentposition) previous=previousalarminqueue(fromcurrentposition) last=lastactivealarminqueue VCalarmqueueconfirm byinstance Actionname:VCAlarmQueueConfirmByInstance (Viewer,AlarmID) Actioncategory:command ThealarmqueueofGSCView withthegivenviewerclientnumbercanberemotecontrolled. Acurrentalarmisconfirmed. ItisidentifiedbyitsalarminstanceID(eventinstanceID).A uniqueinstanceIDisassignedtoeachalarm/recording eventatcreationtimebytheGeViS- copeserver. Parameter Function viewerViewerGlobalviewerclientnumber,identifiestheGSCViewthatshouldberemote controlled instance IDAlarmIDThealarminstanceID(eventinstanceID) VCalarmqueueconfirm bytype Actionname:VCAlarmQueueConfirmByType (Viewer,TypeID,SelectionMode) Actioncategory:command ThealarmqueueofGSCView withthegivenviewerclientnumbercanberemotecontrolled. Acurrentalarmisconfirmed. Itisidentifiedbyitsalarmtype(eventtype)whichmeansthe nameofthealarm(event)intheGeViScope Setupeventlistandalsobytheparameter "selection mode".Theparameter "selection mode"defineswhichalarminthequeuewillbe selected. Parameter Function viewer Viewer Globalviewerclientnumber,identifiestheGSCViewthatshouldbe remotecontrolled eventtypeTypeID Thealarmtype(eventtype) selection modeSelectionMode first=firstactivealarminqueue next=nextactivealarminqueue(fromcurrentposition) previous=previousalarminqueue(fromcurrentposition) last=lastactivealarminqueue --- Page 106 --- VCalarmqueueremove Actionname:VCAlarmQueueRemove (Viewer,SelectionMode) Actioncategory:command ThealarmqueueoftheGSCView withthegivenviewerclientnumbercanberemotecon- trolled. Analarmisremovedfromthequeue.Theparameter "selection mode"defineswhichalarm inthequeuewillberemoved. Parameter Function viewer Viewer Globalviewerclientnumber,identifiestheGSCViewthatshouldbe remotecontrolled selection modeSelectionMode first=firstactivealarminqueue next=nextactivealarminqueue(fromcurrentposition) previous=previousalarminqueue(fromcurrentposition) last=lastactivealarminqueue VCalarmqueueremovebyinstance Actionname:VCAlarmQueueRemoveByInstance (Viewer,AlarmID) Actioncategory:command ThealarmqueueoftheGSCView withthegivenviewerclientnumbercanberemotecon- trolled. Analarmisremovedfromthequeue.ItisidentifiedbyitsalarminstanceID(eventinstance ID).AuniqueinstanceIDisassignedtoeachalarm/event recording. Parameter Function viewerViewerGlobalviewerclientnumber,identifiestheGSCViewthatshouldberemote controlled instance IDAlarmIDThealarminstanceID(eventinstanceID) VCalarmqueueremovebytype Actionname:VCAlarmQueueRemoveByType (Viewer,TypeID,SelectionMode) Actioncategory:command ThealarmqueueoftheGSCView withthegivenviewerclientnumbercanberemotecon- trolled. Analarmisremovedfromthequeue.Itisidentifiedbyitsalarmtype(eventtype)which meansthenameofthealarm(event)intheGeViScope Setupeventlist.Theparameter "selection mode"defineswhichalarmwillberemoved. Parameter Function viewer Viewer Globalviewerclientnumber,identifiestheGSCViewthatshouldbe remotecontrolled eventtypeTypeID Thealarmtype(eventtype) selection modeSelectionMode first=firstactivealarminqueue next=nextactivealarminqueue(fromcurrentposition) previous=previousalarminqueue(fromcurrentposition) last=lastactivealarminqueue --- Page 107 --- VCalarmqueueselect Actionname:VCAlarmQueueSelect (Viewer,SelectionMode) Actioncategory:command ThealarmqueueoftheGSCView withthegivenviewerclientnumbercanberemotecon- trolled. Analarmofthequeueispresented. Theparameter "selection mode"defineswhichalarmin thequeuewillbepresented. Parameter Function viewer Viewer Globalviewerclientnumber,identifiestheGSCViewthatshouldbe remotecontrolled selection modeSelectionMode first=firstactivealarminqueue next=nextactivealarminqueue(fromcurrentposition) previous=previousalarminqueue(fromcurrentposition) last=lastactivealarminqueue VCalarmqueueselectbyinstance Actionname:VCAlarmQueueSelectByInstance (Viewer,AlarmID) Actioncategory:command ThealarmqueueoftheGSCView withthegivenviewerclientnumbercanberemotecon- trolled. Analarmofthequeueispresented. ItisidentifiedbyitsalarminstanceID(eventinstance ID).AuniqueinstanceIDisassignedtoeachalarm/event recording. Parameter Function viewerViewerGlobalviewerclientnumber,identifiestheGSCViewthatshouldberemote controlled instance IDAlarmIDThealarminstanceID(eventinstanceID) VCalarmqueueselectbytype Actionname:VCAlarmQueueSelectByType (Viewer,TypeID,SelectionMode) Actioncategory:command ThealarmqueueoftheGSCView withthegivenviewerclientnumbercanberemotecon- trolled. Analarmofthequeueispresented. Itisidentifiedbyitsalarmtype(eventtype)which meansthenameofthealarm(event)intheGeViScope Setupeventlistandalsobythepara- meter"selection mode".Theparameter "selection mode"defineswhichalarminthequeue willbeselected. Parameter Function viewer Viewer Globalviewerclientnumber,identifiestheGSCViewthatshouldbe remotecontrolled eventtypeTypeID Thealarmtype(eventtype) selection modeSelectionMode first=firstactivealarminqueue next=nextactivealarminqueue(fromcurrentposition) previous=previousalarminqueue(fromcurrentposition) last=lastactivealarminqueue --- Page 108 --- VCchangescenebyname Actionname:VCChangeSceneByName (Viewer,Scene) Actioncategory:command TheactiondisplaysasceneintheGSCView withthegivenviewerclientnumber. Thesceneisidentifiedbyitsnamewhichiscaseinsensitive. (e.g."MyScene" equal "myscene") Parameter Function viewerViewerGlobalviewerclientnumber,identifiestheGSCViewthatshouldberemotecon- trolled sceneSceneThenameofthescenethatshouldbedisplayed VCclearscenebyname Actionname:VCClearSceneByName (Viewer,Scene) Actioncategory:command TheactionclearsasceneintheGSCView withthegivenviewerclientnumber. Thesceneisidentifiedbyitsnamewhichiscaseinsensitive. Ifthesceneiscurrentlynot activeitwillbedisplayedaftertheactionisexecuted. (e.g."MyScene" equal"myscene") Parameter Function viewerViewerGlobalviewerclientnumber,identifiestheGSCViewthatshouldberemotecon- trolled sceneSceneThenameofthescenethatshouldbecleared VCfullmode Actionname:VCFullMode (Viewer,FullMode, SensitiveAreaEnabled) Actioncategory:command TheGscViewwiththegivenviewerclientnumbercanbeswitchedintofullmodedisplayor normalmodedisplay. InfullmodedisplayGscViewoffersthepossibility tofadeincontrolslikethetoolbarorthe sidebariftheusermovesthemousecursorinthenearofthewindowborders.Thisbehavior canbecontrolled bytheParameter "Sensitive areaenabled". Parameter Function viewer Viewer Globalviewerclientnumber,identifiestheGscViewthat shouldberemotecontrolled fullmode FullMode yes=switchtofullmodedisplay no=switchtonormalmodedisplay sensitivearea enabledSensitiveAreaEnabled yes=movingmousecursorinthenearofthewindowbor- derscausescontrolstofadein no=nocontrolsfadein VCsetaudiolevel Actionname:VCSetAudioLevel (Viewer,AudioLevel) Actioncategory:command ThevolumeoftheaudiooutputoftheGSCView withthegivenviewerclientnumbercanbe controlled. Parameter Function viewerViewerGlobalviewerclientnumber,identifiestheGSCViewthatshouldberemote controlled audio levelAudioLevel0=audiooutputoff 100=audiooutputinmaximumvolume --- Page 109 --- VCshowviewertext Actionname:VCShowViewerText (Viewer,ShowText) Actioncategory:command Thetextfade-inofallviewersoftheGSCView withthegivenviewerclientnumbercanbe switchedonandoff. Parameter Function viewerViewerGlobalviewerclientnumber,identifiestheGSCViewthatshouldberemote controlled show textShowTextyes=switchtextfade-inon no=switchtextfade-inoff VCstretchmode Actionname:VCStretchMode (Viewer,StretchMode) Actioncategory:command TheGSCView withthegivenviewerclientnumbercanbeswitchedintostretchedmodedis- playornormalmodedisplay. Inthestretchedview,theviewersarestretchedtotheavailablesizeintheGSCView main window.Inthenormalmodedisplaytheviewersaresizedin4:3ratio. Parameter Function viewerViewer Globalviewerclientnumber,identifiestheGSCViewthatshouldbe remotecontrolled stretch modeStretchMode yes=switchtostretchedmodedisplay no=switchtonormalmodedisplay Viewerchangescene Actionname:ViewerChangeScene (Viewer) Actioncategory:command TheactiondisplaysthescenewheretheviewerwiththeglobalnumberonanyGSCView in thenetworkbelongsto. Parameter Function viewerViewerGlobalviewerclientnumber,identifiestheGSCViewthatshouldberemotecon- trolled Viewerclear Actionname:ViewerClear (Viewer) Actioncategory:command TheactionclearstheactivevieweroftheGSCView withthegivenviewerclientnumberor theviewerwiththeglobalnumberonanyGSCView inthenetwork. Parameter Function viewerViewerGlobalviewerclientnumber,identifiestheGSCViewthatshouldberemotecon- trolled or GlobalnumberofavieweronanyGSCViewinthenetwork Viewerclearscene Actionname:ViewerClearScene (Viewer) Actioncategory:command --- Page 110 --- TheactionclearsthescenewheretheactivevieweroftheGSCView withthegivenviewer clientnumberortheviewerwiththeglobalnumberonanyGSCView inthenetworkbelongs to. Parameter Function viewerViewerGlobalviewerclientnumber,identifiestheGSCViewthatshouldberemotecon- trolled or GlobalnumberofavieweronanyGSCViewinthenetwork Viewercleartextoutput Actionname:ViewerClearTextOutput (Viewer) Actioncategory:command Theactiondoesn'tdisplayatextintheactivevieweroftheGSCView withthegivenviewer clientnumberortheviewerwiththeglobalnumberonanyGSCView inthenetworkany- more. Parameter Function viewerViewerGlobalviewerclientnumber,identifiestheGSCViewthatshouldberemotecon- trolledorGlobalnumberofavieweronanyGSCViewinthenetwork Viewerconnect Actionname:ViewerConnect (Viewer,Channel,PlayMode) Actioncategory:command DisplaypicturesofavideochannelontheactivevieweroftheGscViewwiththegiven viewerclientnumberorontheviewerwiththeglobalnumberonsomeGscViewinthenet- work. Theparameter "playmode"definesinwhichmodethepicturesarepresented (live,forward, backward). Parameter Function viewerViewerGlobalviewerclientnumber,identifiestheGscViewthatshouldberemotecon- trolled or GlobalnumberofavieweronsomeGscViewinthenetwork channelChannelGlobalnumberofthemediachannel play modePlayModeplaystop=iftheviewerisalreadydisplayingpicturesfromthatchannel,itis stopped;ifnotthenewestpictureinthedatabaseisdisplayed playforward=iftheviewerisalreadydisplayingpicturesfromthatchannel, itisdisplayingpicturesinnormalspeedforwardfromtheactualposition;if notdisplayofpictureswithnormalspeedstartsatthebeginningofthedata- base playbackward=iftheviewerisalreadydisplayingpicturesfromthatchan- nel,itisdisplayingpicturesinnormalspeedbackwardfromtheactualpos- ition;ifnotdisplayofpictureswithnormalspeedstartsattheendofthe database fastforward=like"playforward"butwithhighspeed fastbackward=like"playbackward"butwithhighspeed stepforward=like"playforward"butonlyonepicture stepbackward=like"playbackward"butonlyonepicture playBOD=displaythefirst(theoldest)pictureinthedatabase playEOD=displaythelast(thenewest)pictureinthedatabase live=displaylivepictures nextevent=like"playforward"butonlypicturesthatbelongtoeventrecord- ings prevevent=like"playbackward"butonlypicturesthatbelongtoevent recordings peeklivepicture=displayonlyoneactuallivepicture nextdetectedmotion=like"playforward"butonlypictureswithmotioninit --- Page 111 --- Parameter Function (ifnoMOSsearchareaisdefinedinGscViewthewholepicturesizeisusedfor it)aredisplayed;thedisplaystopsaftermotionisdetected prevdetectedmotion=like"playbackward"butonlypictureswithmotionin it(ifnoMOSsearchareaisdefinedinGscViewthewholepicturesizeisused forit)aredisplayed;thedisplaystopsaftermotionisdetected Viewerconnect live Actionname:ViewerConnectLive (Viewer,Channel) Actioncategory:command ThisactiondisplayslivepicturesofavideochannelontheactivevieweroftheGSCView withthegivenviewerclientnumberorontheviewerwiththeglobalnumberonany GSCView inthenetwork. Parameter Function viewerViewerGlobalviewerclientnumber,identifiestheGSCViewthatshouldberemotecon- trolled or GlobalnumberofavieweronanyGSCViewinthenetwork channelChannelGlobalnumberofthemediachannel Viewerexportpicture Actionname:ViewerExportPicture (Viewer,FilePath) Actioncategory:command TheactionexportsthecurrentpictureoftheactivevieweroftheGSCView withthegiven viewerclientnumberortheviewerwiththeglobalnumberonanyGSCView inthenetwork. TheactualpictureisexportedasawindowsbitmapgraphicfileintheGSCView directoryor inthepath(localorUNC)definedviatheparameter "filepath". Parameter Function viewerViewerGlobalviewerclientnumber,identifiestheGSCViewthatshouldberemotecon- trolled or GlobalnumberofavieweronanyGSCViewinthenetwork file pathFilePathPath(localorUNC)wherethepictureshouldbeexportedto Viewerjumpbytime Actionname:ViewerJumpByTime (Viewer,Channel,PlayMode, TimeInSec) Actioncategory:command TheactiondisplayspicturesofavideochannelontheactivevieweroftheGSCView with thegivenviewerclientnumberorontheviewerwiththeglobalnumberonanyGSCView in thenetwork. Theparameter "playmode"definesinwhichmodethepicturesarepresented (live,forward, backward .). Theparameter "timeinsec"definesthetimespanthatthestartofthereplayshouldbe movedfromtheactualtimestamp. Parameter Function viewerViewerGlobalviewerclientnumber,identifiestheGSCViewthatshouldberemote controlled --- Page 112 --- Parameter Function or GlobalnumberofavieweronanyGSCViewinthenetwork channelChannelGlobalnumberofthemediachannel play modePlayModeplaystop=iftheviewerisalreadydisplayingpicturesfromthatchannel,it isstopped?ifnotthenewestpictureinthedatabaseisdisplayed playforward=iftheviewerisalreadydisplayingpicturesfromthatchannel, itisdisplayingpicturesinnormalspeedforwardfromthecurrentposition;if notdisplayofpictureswithnormalspeedstartsatthebeginningofthedata- baseplaybackward=iftheviewerisalreadydisplayingpicturesfromthat channel,itisdisplayingpicturesinnormalspeedbackwardfromtheactual position;ifnotdisplayofpictureswithnormalspeedstartsattheendofthe database fastforward=like"playforward"highspeed fastbackward=like"playbackward"highspeed stepforward=like"playforward"picturebypicture stepbackward=like"playbackward"picturebypicture playBOD=displaythefirst(theoldest)pictureinthedatabase playEOD=displaythelast(thenewest)pictureinthedatabase live=displaylivepictures nextevent=jumptothenexteventrecording prevevent=jumptothepreviouseventrecording peeklivepicture=displaysonlyonecurrentlivepicture nextdetectedmotion=like"playforward"butonlypictureswithmotioninit (ifnoMOSsearchareaisdefinedinGSCViewthewholepicturesizeisused forit)aredisplayed;thedisplaystopsaftermotionisdetected prevdetectedmotion=like"playbackward"butonlypictureswithmotion init(ifnoMOSsearchareaisdefinedinGSCViewthewholepicturesizeis usedforit)aredisplayed;thedisplaystopsaftermotionisdetected timein secTimeInSecTimespanthatthestartofthereplayshouldbemovedfromtheactual timestamp Viewermaximize Actionname:ViewerMaximize (Viewer,Maximize) Actioncategory:command TheactivevieweroftheGSCView withthegivenviewerclientnumberortheviewerwith theglobalnumberonanyGSCView inthenetworkwhichshouldberemotecontrolled. Theparameter "maximize" defineswhethertheviewershouldbedisplayedinmaximized modeornot. Parameter Function viewerViewerGlobalviewerclientnumber,identifiestheGSCViewthatshouldberemote controlled or GlobalnumberofavieweronanyGSCViewinthenetwork maximizeMaximizeyes=displaytheviewerinmaximizedmode no=displaytheviewerinnormalmode Viewerplayfromtime Actionname:ViewerPlayFromTime (Viewer,Channel,PlayMode, Time) Actioncategory:command DisplaypicturesofavideochannelontheactivevieweroftheGscViewwiththegiven viewerclientnumberorontheviewerwiththeglobalnumberonsomeGscViewinthenet- work. --- Page 113 --- Theparameter "playmode"definesinwhichmodethepicturesarepresented (live,forward, backward, .). Theparameter "time"definesthetimestamp wherethereplayoftherecordedvideoshould start. Parameter Function viewerViewerGlobalviewerclientnumber,identifiestheGscViewthatshouldberemotecon- trolled or GlobalnumberofavieweronsomeGscViewinthenetwork channelChannelGlobalnumberofthemediachannel play modePlayModeplaystop=iftheviewerisalreadydisplayingpicturesfromthatchannel,itis stopped?ifnotthenewestpictureinthedatabaseisdisplayed playforward=iftheviewerisalreadydisplayingpicturesfromthatchannel, itisdisplayingpicturesinnormalspeedforwardfromthecurrentposition;if notdisplayofpictureswithnormalspeedstartsatthebeginningofthedata- baseplaybackward=iftheviewerisalreadydisplayingpicturesfromthat channel,itisdisplayingpicturesinnormalspeedbackwardfromtheactual position;ifnotdisplayofpictureswithnormalspeedstartsattheendofthe database fastforward=like"playforward"highspeed fastbackward=like"playbackward"highspeed stepforward=like"playforward"picturebypicture stepbackward=like"playbackward"picturebypicture playBOD=displaythefirst(theoldest)pictureinthedatabase playEOD=displaythelast(thenewest)pictureinthedatabase live=displaylivepictures nextevent=jumptothenexteventrecording prevevent=jumptothepreviouseventrecording peeklivepicture=displaysonlyonecurrentlivepicture nextdetectedmotion=like"playforward"butonlypictureswithmotioninit (ifnoMOSsearchareaisdefinedinGSCViewthewholepicturesizeisused forit)aredisplayed;thedisplaystopsaftermotionisdetected prevdetectedmotion=like"playbackward"butonlypictureswithmotionin it(ifnoMOSsearchareaisdefinedinGSCViewthewholepicturesizeisused forit)aredisplayed;thedisplaystopsaftermotionisdetected timeTimeTimestampwherethereplayoftherecordedvideoshouldstart.Thepara- metershouldbedefinedinthefollowingformat: "2009/02/13 07:22:00,594 GMT+01:00" Viewerprintpicture Actionname:ViewerPrintPicture (Viewer) Actioncategory:command TheactionprintsoutthecurrentpictureoftheactivevieweroftheGSCView withthegiven viewerclientnumberortheviewerwiththeglobalnumberonanyGSCView inthenetwork. TheprintoutisdoneonthedefaultprinterofthePConwhichGSCView isrunning. Parameter Function viewerViewerGlobalviewerclientnumber,identifiestheGSCViewthatshouldberemotecon- trolledorGlobalnumberofavieweronanyGSCViewinthenetwork Viewerselect Actionname:ViewerSelect (Viewer) Actioncategory:command TheactiondeclarestheviewerwiththeglobalnumberonanyGSCView inthenetworkto theactiveviewerofthecorresponding GSCView. --- Page 114 --- Parameter Function viewerViewerGlobalnumberofavieweronanyGSCViewinthenetwork Viewersetplaymode Actionname:ViewerSetPlayMode (Viewer,PlayMode, PlaySpeed) Actioncategory:command Theactionsetsthe"playmode"oftheactivevieweroftheGSCView withthegivenviewer clientnumberortheviewerwiththeglobalnumberonanyGSCView inthenetwork. Parameter Function viewerViewerGlobalviewerclientnumber,identifiestheGSCViewthatshouldberemotecon- trolled or GlobalnumberofavieweronanyGSCViewinthenetwork play modePlayModeplaystop=iftheviewerisalreadydisplayingpicturesfromthatchannel,itis stopped?ifnotthenewestpictureinthedatabaseisdisplayed playforward=iftheviewerisalreadydisplayingpicturesfromthatchannel,it isdisplayingpicturesinnormalspeedforwardfromthecurrentposition;if notdisplayofpictureswithnormalspeedstartsatthebeginningofthedata- baseplaybackward=iftheviewerisalreadydisplayingpicturesfromthat channel,itisdisplayingpicturesinnormalspeedbackwardfromtheactual position;ifnotdisplayofpictureswithnormalspeedstartsattheendofthe database fastforward=like"playforward"highspeed fastbackward=like"playbackward"highspeed stepforward=like"playforward"picturebypicture stepbackward=like"playbackward"picturebypicture playBOD=displaythefirst(theoldest)pictureinthedatabase playEOD=displaythelast(thenewest)pictureinthedatabase live=displaylivepictures nextevent=jumptothenexteventrecording prevevent=jumptothepreviouseventrecording peeklivepicture=displaysonlyonecurrentlivepicture nextdetectedmotion=like"playforward"butonlypictureswithmotioninit (ifnoMOSsearchareaisdefinedinGSCViewthewholepicturesizeisusedfor it)aredisplayed;thedisplaystopsaftermotionisdetected prevdetectedmotion=like"playbackward"butonlypictureswithmotionin it(ifnoMOSsearchareaisdefinedinGSCViewthewholepicturesizeisused forit)aredisplayed;thedisplaystopsaftermotionisdetected play speedPlaySpeedSpeedrateforfastforward/backward (2.) Viewershowalarmbyinstance Actionname:ViewerShowAlarmByInstance (Viewer,AlarmID,PlayMode) Actioncategory:command TheactiondisplayspicturesofanalarmontheGSCView withthegivenviewerclientnum- berinthenetwork. ThealarmisidentifiedbyitsalarminstanceID(eventinstanceID).Everyalarm(event)is assignedauniqueinstanceIDatcreationtimebytheGeViScope server. Theparameter "playmode"definesinwhichmodethepicturesarepresented (livereplay, replayeventpictures,.). Parameter Function viewerViewerGlobalviewerclientnumber,identifiestheGSCViewthatshouldberemote controlled --- Page 115 --- Parameter Function instance IDAlarmIDThealarminstanceID(eventinstanceID) play modePlayModeShowalarmusingdefaultsettings=displayalarmpicturesusingthedefault settingsdefinedintheGeViScopesetup Livereplay=displaylivepicturesofthecamerasbelongingtothealarmcon- figuration replayeventpictures=replaythepicturesbelongingtothealarm(onlyonce) continuouseventreplay=replaythepicturesbelongingtothealarm continuously inaloop showfirstalarmpictureonly=onlydisplaythefirstpicturebelongingtothe alarm Viewershowalarmbykey Actionname:ViewerShowAlarmByKey (Viewer,ForeignKey, PlayMode) Actioncategory:command TheactiondisplayspicturesofanalarmontheGSCView withthegivenviewerclientnum- berinthenetwork. Thealarmisidentifiedbyits"foreignkey".The"foreignkey"wasassignedexplicittothe alarmasthealarmwasstarted. Theparameter "playmode"definesinwhichmodethepicturesarepresented (livereplay, replayeventpictures.). Parameter Function viewerViewerGlobalviewerclientnumber,identifiestheGSCViewthatshouldberemote controlled foreign keyForeignKeyTheforeignkeythatwasassignedtothealarmasthealarmwasstarted play modePlayModeplaystop=iftheviewerisalreadydisplayingpicturesfromthatchannel,it isstopped?ifnotthenewestpictureinthedatabaseisdisplayed playforward=iftheviewerisalreadydisplayingpicturesfromthatchannel, itisdisplayingpicturesinnormalspeedforwardfromthecurrentposition;if notdisplayofpictureswithnormalspeedstartsatthebeginningofthedata- baseplaybackward=iftheviewerisalreadydisplayingpicturesfromthat channel,itisdisplayingpicturesinnormalspeedbackwardfromtheactual position;ifnotdisplayofpictureswithnormalspeedstartsattheendofthe database fastforward=like"playforward"highspeed fastbackward=like"playbackward"highspeed stepforward=like"playforward"picturebypicture stepbackward=like"playbackward"picturebypicture playBOD=displaythefirst(theoldest)pictureinthedatabase playEOD=displaythelast(thenewest)pictureinthedatabase live=displaylivepictures nextevent=jumptothenexteventrecording prevevent=jumptothepreviouseventrecording peeklivepicture=displaysonlyonecurrentlivepicture nextdetectedmotion=like"playforward"butonlypictureswithmotioninit (ifnoMOSsearchareaisdefinedinGSCViewthewholepicturesizeisused forit)aredisplayed;thedisplaystopsaftermotionisdetected prevdetectedmotion=like"playbackward"butonlypictureswithmotionin it(ifnoMOSsearchareaisdefinedinGSCViewthewholepicturesizeisused forit)aredisplayed;thedisplaystopsaftermotionisdetected --- Page 116 --- Viewershowalarmbytype Actionname:ViewerShowAlarmByType (Viewer,TypeID,ForeignKey, PlayMode) Actioncategory:command TheactiondisplayspicturesofanalarmontheGSCView withthegivenviewerclientnum- berinthenetwork. Thealarmisidentifiedbyitsalarmtypeandoptionalbyitsforeignkey.Thealarmtype (eventname)isdefinedintheGeViScope setup.Theforeignkeywasassignedexplicitto thealarmasthealarmwasstarted.Itisoptional.Ifitisnotset,thelastalarmwiththe definedalarmtypeisdisplayed. Theparameter "playmode"definesinwhichmodethepicturesarepresented (livereplay, replayeventpictures.). Parameter Function viewerViewerGlobalviewerclientnumber,identifiestheGSCViewthatshouldberemote controlled alarm typeTypeIDType(eventname)ofthealarm,definedintheGeViScopesetup foreign keyForeignKeyTheforeignkeythatwasassignedtothealarmasthealarmwasstarted play modePlayModeplaystop=iftheviewerisalreadydisplayingpicturesfromthatchannel,it isstopped?ifnotthenewestpictureinthedatabaseisdisplayed playforward=iftheviewerisalreadydisplayingpicturesfromthatchannel, itisdisplayingpicturesinnormalspeedforwardfromthecurrentposition;if notdisplayofpictureswithnormalspeedstartsatthebeginningofthedata- baseplaybackward=iftheviewerisalreadydisplayingpicturesfromthat channel,itisdisplayingpicturesinnormalspeedbackwardfromtheactual position;ifnotdisplayofpictureswithnormalspeedstartsattheendofthe database fastforward=like"playforward"highspeed fastbackward=like"playbackward"highspeed stepforward=like"playforward"picturebypicture stepbackward=like"playbackward"picturebypicture playBOD=displaythefirst(theoldest)pictureinthedatabase playEOD=displaythelast(thenewest)pictureinthedatabase live=displaylivepictures nextevent=jumptothenexteventrecording prevevent=jumptothepreviouseventrecording peeklivepicture=displaysonlyonecurrentlivepicture nextdetectedmotion=like"playforward"butonlypictureswithmotioninit (ifnoMOSsearchareaisdefinedinGSCViewthewholepicturesizeisused forit)aredisplayed;thedisplaystopsaftermotionisdetected prevdetectedmotion=like"playbackward"butonlypictureswithmotionin it(ifnoMOSsearchareaisdefinedinGSCViewthewholepicturesizeisused forit)aredisplayed;thedisplaystopsaftermotionisdetected Viewerchangesyncaudio/video Actionname:ViewerSyncAudioAndVideo (Viewer,EnableSync) Actioncategory:command TheactivevieweroftheGSCView withthegivenviewerclientnumberortheviewerwith theglobalnumberonanyGSCView inthenetworkshouldberemotecontrolled. Theparameter "enablesync"defineswhetheraudioandvideoshouldbesynchronized or not. --- Page 117 --- Parameter Function viewerViewer Globalviewerclientnumber,identifiestheGSCViewthatshouldbe remotecontrolled or GlobalnumberofavieweronanyGSCViewinthenetwork enable syncEnableSync yes=synchronize audioandvideo no=don'tsynchronize audioandvideo Viewertextoutput Actionname:ViewerTextOutput (Viewer,Text) Actioncategory:command TheactiondisplaysatextintheactivevieweroftheGSCView withthegivenviewerclient numberortheviewerwiththeglobalnumberonanyGSCView inthenetwork. Parameter Function viewerViewerGlobalviewerclientnumber,identifiestheGSCViewthatshouldberemotecon- trolled or GlobalnumberofavieweronanyGSCViewinthenetwork text stringTextTextthatshouldbedisplayedinthepicture Viewernotification actions Viewernotifications arefiredbyGSCView whileGSCView isremotecontrolled. Toenable remotecontrolling GSCView the"Remotecontrol"settinginGscProfileManager anda globaluniqueviewerclientnumberhastobeconfigured. ToenableGSCView sending viewernotifications the"Sendnotification actions"settingsinGscProfileManager haveto beconfigured. Imageexportnotification Actionname:ImageExportNotification (User,Destination, DestinationType, TimeStamp, TimeEnd, Channels, ClientHost, ClientType, ClientAccount) Actioncategory:notification Asingleimageoravideosequence hasbeenexportedbyaGSCView inthenetwork. GSCView hasfiredthisnotification becauseasinglepicturehasbeenexportedviaaView- erExportPicture actionwhileGSCView isremotecontrolled orbecausetheuserhasmanu- allyexportedapictureoravideosequence inGSCView. Parameter Function user User GeViScopeuser,who hasdonetheexport destination Destination Path(localorUNC) wherethepictureor sequencewasexported destinationtypeDestinationType 0=singleimage 1=backupfile(GBF) 2=videofile(MPEG, VideoDVD,MPEG4CCTV raw) 3=snapshottoclip- --- Page 118 --- Parameter Function board 4=printpicture timestamp TimeStamp Timestampbelongingto thepictureexportedor belongingtothefirstpic- tureoftheexported videosequence.The parameteristransmitted inthefollowingformat: "2009/05/06 14:47:48,359 GMT+02:00" endtime TimeEnd Timestampbelongingto thelastpictureofthe exportedvideo sequence.Thepara- meteristransmittedin thefollowingformat: "2009/05/06 14:47:48,359 GMT+02:00" channels Channels Listofvideochannels thatareincludedinthe exportresult clienthost ClientHost HostnameofthePC whereGSCViewisrun- ning clienttype ClientType 1=GSCView Allothervaluesarefor futureuse! clientaccount ClientAccount Windowsuseraccount underthatGSCViewis running Scenestoremodification Actionname:SceneStoreModification (Viewer,SceneStoreID, SceneStoreName, TimeStamp, ModificationType, User,ClientHost, ClientType, ClientAccount) Actioncategory:notification Scenestoremodification. Parameter Function viewer Viewer GlobalnumberofavieweronsomeGSCViewinthenetwork scenestore GUIDSceneStoreID ScenestoreGUID. scenestore nameSceneStoreNam - eScenestorename. timestamp TimeStamp Timestamp. modification typeModi- ficationTypeModification type. user User Nameoftheuser. clienthostClientHost HostnameofthePCwhereGSCViewisrunning clienttypeClientType 1=GSCView Allothervaluesareforfutureuse! clientaccountClientAccount WindowsuseraccountunderthatGSCViewisrunning --- Page 119 --- VCalarmqueuenotification Actionname:VCAlarmQueueNotification (Viewer,Notification, AlarmID,TypeID,Cli- entHost,ClientType, ClientAccount) Actioncategory:notification ThestateofthealarmqueueoftheGSCView withthetransmitted viewerclientnumberhas beenchanged. GSCView hasfiredthisnotification becausethestateofitsalarmqueuehasbeenchanged viaaVCAlarmQueue... actionwhileGSCView isremotecontrolled orbecausetheuserhas manuallychangedthestateofthealarmqueueinGSCView. AnalarmcanbeidentifiedbyitsalarminstanceID(eventinstanceID).Everyalarm(event) isassignedauniqueinstanceIDatcreationtimebytheGeViScope server. Alternatively thealarmcanbeidentifiedbyitsalarmtype(eventtype)whichmeansthe nameofthealarm(event)intheGeViScope Setupeventlist. Parameter Function viewer Viewer Globalviewerclientnum- ber,identifiesthe GSCViewthatfiredthis notification notification Notification Newalarm=annew alarmoccurred Presented=analarmwas presented Stacked=analarmwas stackedinthequeue, becausethequeueis blockedbyanactivealarm Confirmed=analarmwas confirmed Removed=analarmwas removedfromthequeue Lastconfirmed=thelast alarminthequeuewas confirmed Lastremoved=thelast alarmwasremovedfrom thequeue Listconfirmed=thereare nomoreunconfirmed alarmsinthequeue Listempty=thereareno morealarmsinthequeue instanceIDAlarmID ThealarminstanceID (eventinstanceID) eventtype TypeID Thealarmtype(event type) clienthost ClientHost HostnameofthePC whereGSCViewisrun- ning clienttype ClientType 1=GSCView Allothervaluesarefor futureuse! --- Page 120 --- Parameter Function clientaccount ClientAccount Windowsuseraccount underthatGSCViewisrun- ning VCscenechanged Actionname:VCSceneChanged (Viewer,Scene) Actioncategory:notification TheactivesceneoftheGSCView withthetransmitted viewerclientnumberhasbeen changed. GSCView hasfiredthisnotification becauseitsactivescenehasbeenchangedviaa VCChangeSceneByName orViewerChangeScene actionwhileGSCView isremotecon- trolledorbecausetheuserhasmanuallychangedtheactivesceneinGSCView. Parameter Function viewer Viewer Globalviewerclientnumber,identifiestheGSCViewthatfired thisnotification scene Scene Thenameofthescenethatisdisplayedafterthechange Viewercleared Actionname:ViewerCleared (Viewer,ClientHost, ClientType, ClientAccount) Actioncategory:notification Theviewerwiththetransmitted globalnumberonsomeGSCView inthenetworkhasbeen cleared. GSCView hasfiredthisnotification becauseoneofitsviewershasbeenclearedviaaView- erClearactionwhileGSCView isremotecontrolled orbecausetheuserhasmanually clearedtheviewerinGSCView. Parameter Function viewer Viewer GlobalnumberofavieweronsomeGSCViewinthenetwork clienthostClientHost HostnameofthePCwhereGSCViewisrunning clienttypeClientType 1=GSCView Allothervaluesareforfutureuse! clientaccountClientAccount WindowsuseraccountunderthatGSCViewisrunning Viewerconnected Actionname:ViewerConnected (Viewer,Channel,PlayMode, ClientHost, ClientType, Cli- entAccount) Actioncategory:notification Theviewerwiththetransmitted globalnumberonsomeGSCView inthenetworkhasbeen connected. GSCView hasfiredthisnotification becauseoneofitsviewershasbeenconnected viaa ViewerConnect orViewerConnectLive actionwhileGSCView isremotecontrolled or becausetheuserhasmanuallyconnected theviewerinGSCView. Theparameter "playmode"definesinwhichmodethepicturesarepresented (live,forward, backward, .). --- Page 121 --- Parameter Function viewer Viewer Globalnumberofa vieweronsome GSCViewinthenetwork channel Channel Globalnumberofthe mediachannel playmode PlayMode playstop=iftheviewer isalreadydisplayingpic- turesfromthatchannel, itisstopped;ifnotthe newestpictureinthe databaseisdisplayed playforward=ifthe viewerisalreadydis- playingpicturesfrom thatchannel,itisdis- playingpicturesinnor- malspeedforwardfrom theactualposition;if notdisplayofpictures withnormalspeed startsatthebeginning ofthedatabase playbackward=ifthe viewerisalreadydis- playingpicturesfrom thatchannel,itisdis- playingpicturesinnor- malspeedbackward fromtheactualposition; ifnotdisplayofpictures withnormalspeed startsattheendofthe database fastforward=like"play forward"butwithhigh speed fastbackward=like "playbackward"but withhighspeed stepforward=like "playforward"butonly onepicture stepbackward=like "playbackward"but onlyonepicture playBOD=displaythe first(theoldest)picture inthedatabase playEOD=displaythe last(thenewest)pic- tureinthedatabase live=displaylivepic- tures nextevent=like"play forward"butonlypic- turesthatbelongto eventrecordings prevevent=like"play --- Page 122 --- Parameter Function backward"butonlypic- turesthatbelongto eventrecordings peeklivepicture=dis- playonlyoneactuallive picture nextdetectedmotion= like"playforward"but onlypictureswith motioninit(ifnoMOS searchareaisdefinedin GscViewthewholepic- turesizeisusedforit) aredisplayed;thedis- playstopsaftermotion isdetected prevdetectedmotion= like"playbackward"but onlypictureswith motioninit(ifnoMOS searchareaisdefinedin GscViewthewholepic- turesizeisusedforit) aredisplayed;thedis- playstopsaftermotion isdetected clienthost ClientHost HostnameofthePC whereGSCViewisrun- ning clienttype ClientType 1=GSCView Allothervaluesarefor futureuse! clientaccount ClientAccount Windowsuseraccount underthatGSCViewis running Viewerplaymodechanged Actionname:ViewerPlayModeChanged (Viewer,Channel,PlayMode, ChannelTime, Cli- entHost,ClientType, ClientAccount) Actioncategory:notification Theplaymode oftheviewerwiththetransmitted globalnumberonsomeGSCView inthe networkhasbeenchanged. GSCView hasfiredthisnotification becausetheplaymode ofoneofitsviewershasbeen changedviaaViewerConnect, ViewerConnectLive, ViewerSetPlayMode, View- erPlayFromTime, ViewerJumpByTime oroneoftheViewerShowAlarmBy. actionswhile GSCView isremotecontrolled orbecausetheuserhasmanuallychangedtheplaymode of theviewerinGSCView. Parameter Function viewer Viewer Globalnumberofa vieweronsome GSCViewinthenetwork channel Channel Globalnumberofthe mediachannel,dis- playedintheviewer --- Page 123 --- Parameter Function playmode PlayMode playstop=iftheviewer isalreadydisplayingpic- turesfromthatchannel, itisstopped;ifnotthe newestpictureinthe databaseisdisplayed playforward=ifthe viewerisalreadydis- playingpicturesfrom thatchannel,itisdis- playingpicturesinnor- malspeedforwardfrom theactualposition;if notdisplayofpictures withnormalspeed startsatthebeginning ofthedatabase playbackward=ifthe viewerisalreadydis- playingpicturesfrom thatchannel,itisdis- playingpicturesinnor- malspeedbackward fromtheactualposition; ifnotdisplayofpictures withnormalspeed startsattheendofthe database fastforward=like"play forward"butwithhigh speed fastbackward=like "playbackward"but withhighspeed stepforward=like "playforward"butonly onepicture stepbackward=like "playbackward"but onlyonepicture playBOD=displaythe first(theoldest)picture inthedatabase playEOD=displaythe last(thenewest)pic- tureinthedatabase live=displaylivepic- tures nextevent=like"play forward"butonlypic- turesthatbelongto eventrecordings prevevent=like"play backward"butonlypic- turesthatbelongto eventrecordings peeklivepicture=dis- playonlyoneactuallive picture --- Page 124 --- Parameter Function nextdetectedmotion= like"playforward"but onlypictureswith motioninit(ifnoMOS searchareaisdefinedin GscViewthewholepic- turesizeisusedforit) aredisplayed;thedis- playstopsaftermotion isdetected prevdetectedmotion= like"playbackward"but onlypictureswith motioninit(ifnoMOS searchareaisdefinedin GscViewthewholepic- turesizeisusedforit) aredisplayed;thedis- playstopsaftermotion isdetected channeltimeChannelTime Timestampbelongingto thepicturepresentedin theviewerdirectlyafter theplamodehad changed.Thepara- meteristransmittedin thefollowingformat: "2009/05/06 14:47:48,359 GMT+02:00" clienthost ClientHost HostnameofthePC whereGSCViewisrun- ning clienttype ClientType 1=GSCView Allothervaluesarefor futureuse! clientaccount ClientAccount Windowsuseraccount underthatGSCViewis running Viewerselection changed Actionname:ViewerSelectionChanged (Viewer,Channel,PlayMode, ClientHost, Cli- entType,ClientAccount) Actioncategory:notification TheactivevieweronsomeGSCView inthenetworkhasbeenchanged. GSCView hasfiredthisnotification becausetheuserhasselectedoneofitsviewersby mouseclickorbydraggingacameraontooneofitsviewers. GSCView onlyfiresthenotification, ifacameraisdisplayedontheselectedviewer. Parameter Function viewer Viewer Globalnumberofa vieweronsome GSCViewinthenetwork channel Channel Globalnumberofthe mediachannel,dis- playedintheviewer --- Page 125 --- Parameter Function playmode PlayMode playstop=iftheviewer isalreadydisplayingpic- turesfromthatchannel, itisstopped;ifnotthe newestpictureinthe databaseisdisplayed playforward=ifthe viewerisalreadydis- playingpicturesfrom thatchannel,itisdis- playingpicturesinnor- malspeedforwardfrom theactualposition;if notdisplayofpictures withnormalspeed startsatthebeginning ofthedatabase playbackward=ifthe viewerisalreadydis- playingpicturesfrom thatchannel,itisdis- playingpicturesinnor- malspeedbackward fromtheactualposition; ifnotdisplayofpictures withnormalspeed startsattheendofthe database fastforward=like"play forward"butwithhigh speed fastbackward=like "playbackward"but withhighspeed stepforward=like "playforward"butonly onepicture stepbackward=like "playbackward"but onlyonepicture playBOD=displaythe first(theoldest)picture inthedatabase playEOD=displaythe last(thenewest)pic- tureinthedatabase live=displaylivepic- tures nextevent=like"play forward"butonlypic- turesthatbelongto eventrecordings prevevent=like"play backward"butonlypic- turesthatbelongto eventrecordings peeklivepicture=dis- playonlyoneactuallive picture --- Page 126 --- Parameter Function nextdetectedmotion= like"playforward"but onlypictureswith motioninit(ifnoMOS searchareaisdefinedin GscViewthewholepic- turesizeisusedforit) aredisplayed;thedis- playstopsaftermotion isdetected prevdetectedmotion= like"playbackward"but onlypictureswith motioninit(ifnoMOS searchareaisdefinedin GscViewthewholepic- turesizeisusedforit) aredisplayed;thedis- playstopsaftermotion isdetected clienthost ClientHost HostnameofthePC whereGSCViewisrun- ning clienttype ClientType 1=GSCView Allothervaluesarefor futureuse! clientaccount ClientAccount Windowsuseraccount underthatGSCViewis running --- Page 127 ---