feat: Geutebruck GeViScope/GeViSoft Action Mapping System - MVP

This MVP release provides a complete full-stack solution for managing action mappings
in Geutebruck's GeViScope and GeViSoft video surveillance systems.

## Features

### Flutter Web Application (Port 8081)
- Modern, responsive UI for managing action mappings
- Action picker dialog with full parameter configuration
- Support for both GSC (GeViScope) and G-Core server actions
- Consistent UI for input and output actions with edit/delete capabilities
- Real-time action mapping creation, editing, and deletion
- Server categorization (GSC: prefix for GeViScope, G-Core: prefix for G-Core servers)

### FastAPI REST Backend (Port 8000)
- RESTful API for action mapping CRUD operations
- Action template service with comprehensive action catalog (247 actions)
- Server management (G-Core and GeViScope servers)
- Configuration tree reading and writing
- JWT authentication with role-based access control
- PostgreSQL database integration

### C# SDK Bridge (gRPC, Port 50051)
- Native integration with GeViSoft SDK (GeViProcAPINET_4_0.dll)
- Action mapping creation with correct binary format
- Support for GSC and G-Core action types
- Proper Camera parameter inclusion in action strings (fixes CrossSwitch bug)
- Action ID lookup table with server-specific action IDs
- Configuration reading/writing via SetupClient

## Bug Fixes
- **CrossSwitch Bug**: GSC and G-Core actions now correctly display camera/PTZ head parameters in GeViSet
- Action strings now include Camera parameter: `@ PanLeft (Comment: "", Camera: 101028)`
- Proper filter flags and VideoInput=0 for action mappings
- Correct action ID assignment (4198 for GSC, 9294 for G-Core PanLeft)

## Technical Stack
- **Frontend**: Flutter Web, Dart, Dio HTTP client
- **Backend**: Python FastAPI, PostgreSQL, Redis
- **SDK Bridge**: C# .NET 8.0, gRPC, GeViSoft SDK
- **Authentication**: JWT tokens
- **Configuration**: GeViSoft .set files (binary format)

## Credentials
- GeViSoft/GeViScope: username=sysadmin, password=masterkey
- Default admin: username=admin, password=admin123

## Deployment
All services run on localhost:
- Flutter Web: http://localhost:8081
- FastAPI: http://localhost:8000
- SDK Bridge gRPC: localhost:50051
- GeViServer: localhost (default port)

Generated with Claude Code (https://claude.com/claude-code)

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>

SOURCES/GeViScope_SDK_text/GeViScope_SDK_pages_001-010.txt

@@ -0,0 +1,236 @@
+================================================================================
+GeViScope_SDK.pdf - Pages 1 to 10
+================================================================================
+
+
+────────────────────────────────────────────────────────────────────────────────
+Page 1
+────────────────────────────────────────────────────────────────────────────────
+
+GeViScopeSDK
+Dokumentation|Documentation|Documentation|Documentatión
+Version04.2013
+
+────────────────────────────────────────────────────────────────────────────────
+Page 2
+────────────────────────────────────────────────────────────────────────────────
+
+GeViScopeSoftwareDevelopmentKit(SDK)
+Introduction
+TheGeViScopeSDKconsistsofacollectionoffreesoftwareinterfacesforthe
+GEUTEBRÜCKDVRsGeViScopeandRePorter.Itcanbeusedtointegratethesedevices
+incustomapplicationsandalthoughforlinkingnotyetsupportedperipherals.
+TheinterfacesarebasedonnativeWin32DLLs.Sotheycanbeusedwithvariousdevel-
+opmentplatformsoftheWindowsOS.
+Tosupportthe.NETtechnologytheSDKexamplescontainwrapperclassesbasedon
+C++/CLI.Thesewrapperexamplescanbefreelyused,modifiedandextendedbytheSDK
+users.TheC#examplesincludedintheSDKdemonstrate,howthewrapperscanbeused
+bycustomapplications.
+Contents
+FilesanddirectorystructureoftheSDK
+Settingupavirtualtestenvironment
+RemotecontrolGSCView
+OverviewoftheinterfacesintheSDK
+Supporteddevelopmentplatforms
+Guidelinesandhints
+GSCViewdatafilterplugins
+Examplesoverview
+Actiondocumentation
+Documentation-HistoryVersion3.9/PME
+FilesanddirectorystructureoftheSDK
+DuringtheinstallationoftheSDKtheenvironmentvariable%GSCSDKPATH%which
+pointstotherootdirectoryoftheSDKisset.Thisreferencepathisusedinallexamples.
+%GSCSDKPATH%\BinContainsalldynamiclinklibrariesandisthetargetdirectoryforthe
+compiledexamples
+%GSCSDKPATH%\includeContainsallDelphiimportunits,C++headerandcppfiles
+%GSCSDKPATH%\libContainsalllibfilesforBorlandC++BuilderandMicrosoftVisualC++
+ThematchinginterfaceunitsbetweenC++andDelphihavethesamenamebutcompiler
+specificfileextensions.
+
+────────────────────────────────────────────────────────────────────────────────
+Page 3
+────────────────────────────────────────────────────────────────────────────────
+
+Settingupavirtualtestenvironment
+Introduction
+AllrequiredcomponentsforsettingupavirtualGeViScopedeviceareincludedintheSDK.
+Soanindependentdevelopmentofcustomsolutionscanbeachievedwithoutanyspecial
+hardwarerequired.
+AfterstartinguptheGeViScopeserver(partofthevirtualGeViScopedevice)GeViScope
+softwarecanbeusedwithfullfunctionfortwohours.Afterthattimethefunctionalityislim-
+ited.Afterstopandrestartoftheserverfullfunctionalityisofferedfortwohoursagain.
+Stepbystep
+AfterthesuccessfulinstallationoftheSDKallnecessaryfilesexistintheinstallationfolder
+(normally“%HOMEPATH%\MyDocuments\GeViScopeSDK”).
+Step1:Assignlocalpolicy“Lockpagesinmemory”
+TorunGeViScopeserveronyourlocalmachine,alocalpolicyneedstobeassignedtothe
+useraccountunderwhichGeViScopeservershouldwork.
+Pleaseopenthe“LocalSecurityPolicy”dialoginthecontrolpanel–AdministrativeTools.
+With“SecuritySettings/LocalPolicies/UserRightsAssignment”theprivilege“Lock
+pagesinmemory”hastobeassignedtotheuseraccountunderwhichGeViScopeserver
+shouldrun.
+TheuserhastobeamemberofthelocalAdministratorsgroup.
+Theuserhastologoutandloginagaintoletthesettingtakeeffect.
+
+────────────────────────────────────────────────────────────────────────────────
+Page 4
+────────────────────────────────────────────────────────────────────────────────
+
+Step2:unpackthetestfiles
+Unpackthefile“\BIN\GeViScope.Database.zip”totherootdirectoryofyoursystemdrive
+(normally“C:”). Afterwardsthefile“C:\GeViScope.Database”shouldexist.Pleasenotethat
+thefileisnotseeninthewindowsexplorerifhiddenfilesandfoldersaremaskedout.
+Unpackthefile“\BIN\DatabaseBackup.zip”tothesubfolder“\BIN”oftheGeViScopeSDK
+basedirectory(normally“%HOMEPATH%\MyDocuments\GeViScopeSDK”).Afterthat
+thefile“\BIN\DatabaseBackup.gpf“,whichcontainsatestbackupfileinGBFformat
+(“GEUTEBRÜCKBackupFile”)shouldexist.
+Step3:starttheGeViScopeserver
+Starttheserverbydoubleclickingonfile“\BIN\GSCServer.exe“.Nowaconsoleapplication
+shouldstart.
+Step4:importthetestsetup
+StarttheGSCSetupsoftware(file“\BIN\GSCSetup.exe“ )andestablishaconnectiontothe
+localserver.Usethefollowinglogininformation:
+Username=sysadmin
+Password=masterkey
+Sendthesetuponcetotheserverbyusingthemenuentry“Sendsetuptoserver“.
+Thetestsetup“\BIN\GeViScopeSDKSetup.set“ canbeimportedintotheserverwiththehelp
+ofthemenuentry“Importsetupfromfile“.Afterwardsitshouldbesendtotheserveronce
+again.
+Step5:viewlivevideoandbackupvideoinGSCView
+Nowthecorrectsetupofthetestenvironmentshouldbetested.Forthatpurposethe
+GSCViewsoftware(file“\BIN\GSCView.exe”)canbestartedandagainaconnectiontothe
+localservershouldbeestablished. Afterasuccessfulconnectionmediachannelsareavail-
+ableandcanbeviewed. SimplydragthemediachannelsontheviewersofGSCView.
+
+────────────────────────────────────────────────────────────────────────────────
+Page 5
+────────────────────────────────────────────────────────────────────────────────
+
+Themenuentry“Openbackupfile…”allowsopeningthetestbackupfile“\BIN\Data-
+baseBackup.gpf“,whichalsocontainsmediachannelsthatcanbedisplayed.Pleasecheck
+thecorrectfunctionofthebackupbyplaybackthevideomaterial.
+Step6:Useoftool“\BIN\GSCPLCSimulator.exe”
+Thesoftware“\BIN\GSCPLCSimulator.exe”servesasamonitoringtoolforallmessages
+(actions)andeventsthataretransportedinsidethecompletesystem.Furthermoreactions
+canbetriggeredandeventscanbestartedandstopped.
+Afterbuildingupaconnectiontothelocalserverallactiontrafficisdisplayedinalist.
+ThistoolisextremelyhelpfulfortestingofcustomapplicationsbasedontheSDKandfor
+analyzingmessageflowinthecompletesystem.
+Backgroundinformation
+ToprovideatestenvironmentwithfullfunctionalitytheGeViScopemediaplugin“MCS”
+(MediaChannelSimulator)isused.Itsimulatesrealvideomediachannelsbychanneling
+testpicturesintotheGeViScopeserver.16mediachannelscanbeusedaslivechannelsor
+canberecordedintothetestdatabase.Furthermorethechannelscreatemessages
+(actions)thatallowusingthemasbasefordevelopingvideoanalysissoftware.
+Themediaplugin“MCS”ispartoftheSDKincludingsourcecode(developmentplatformBor-
+landC++Builder6)anddocumentation(pleaseseetopic“Examplesoverview”formore
+information).
+OverviewoftheinterfacesintheSDK
+Introduction
+ThisdocumentgivesashortoverviewofthedifferentinterfacesthatbelongtotheSDK.
+Pleasenote,thatallinterfacesincludeclassdeclarationstoaccesstheexportedfunctions
+ofthedynamiclinklibraries.TousetheminC++,thematchingcppfilesandthelibfilescor-
+respondingtotheDLLshavetobeaddedtothecustomproject.
+
+────────────────────────────────────────────────────────────────────────────────
+Page 6
+────────────────────────────────────────────────────────────────────────────────
+
+Buildingblocksoffunctionality
+DBI
+l Lowlevelserveranddatabaseinterface
+l Connectionhandling,GBFaccess,rawdatabaseaccess(novideodisplay!),media
+exportfunctionality,backupfunctions,accesstorawlivemedia(novideodisplay!),
+setupdataaccess
+l Supportsbasicfunctionalityforbuildingblocks“PLC”and“MediaPlayer”
+l Mainbinaryfile:GSCDBI.DLL
+l Mainincludefiles(C++):GSCDBI.h,GSCDBI.cpp
+l Mainincludefiles(Pascal):GSCDBI.pas
+PLC
+l Complexnotification,actionandeventprocessing
+l Listento,dispatch,createandsendactions
+l Listentoeventsandsystemnotifications
+l Allowscontrollingandmonitoringthesystem
+l Mainbinaryfile:GSCActions.DLL
+l Mainincludefiles(C++):GSCActions.h
+l Mainincludefiles(Pascal):GSCActions.pas
+TACI
+l TelnetActionCommandInterface
+l SimpleASCII-FormatcommunicationbasedonTelnet
+l Allowscontrollingandmonitoringthesystem
+l Receivedactionsneedtobeparsed
+
+────────────────────────────────────────────────────────────────────────────────
+Page 7
+────────────────────────────────────────────────────────────────────────────────
+
+l Tousethatinterface,themediaplugin“GSCTelnetActionCommand”needstobe
+installed
+MediaPlayer
+l Highlevelserveranddatabaseinterfaceincludingmediapresentation
+l Displayvideo,playaudio(liveandbackup)
+l Integratedexportfunctionality(GBF,MPEG,Video-DVD,Singlepicture)
+l Searchmediadatabytimeorcorrespondingtoeventdata
+l Mainbinaryfile:GSCMediaPlayer.DLL
+l Mainincludefiles(C++):GSCMediaPlayer.h,GSCMediaPlayer.cpp
+l Mainincludefiles(Pascal):GSCMediaPlayer.pas
+OffscreenViewer
+l Partofbuildingblock“MediaPlayer”
+l SamefunctionalityasMediaPlayer,but:norendering,onlydecompressing
+l ClassTGSCOffscreenViewercanbeusedanalogoustoTGSCViewer
+Mediaplugin(GeViScopeserverplugins)
+l GeViScopeserverpluginsallowintegratingcustomperipheralsinGeViScopesys-
+tems
+l Channelingofvideoand/oraudiomediaintotheserver
+l IncludingfullaccesstoPLC
+l PluginsrunasIn-Process-DLLsinGeViScopeserversoftware
+GSCViewdatafilter plugin
+l GSCViewpluginsallowintegratingcustomdatafilterfrontendsinGSCViewsoft-
+ware
+l PluginsrunasIn-Process-DLLsinGSCViewsoftware
+GSCViewdatapresentationplugin
+l GSCViewpluginsallowcustomizedpresentationofeventdatainGSCViewsoft-
+ware,especiallyofeventdatapresentedinviewedpictures
+l PluginsrunasIn-Process-DLLsinGSCViewsoftware
+RemotecontrolGSCViewbyactions
+Introduction
+ThesimplestapproachtoviewandbrowseliveandrecordedvideoofoneormoreGeViS-
+copesistoremotecontrolGSCViewoutofcustomsolutions.
+GSCViewcanbeusedinaspecialmodesothatitcanbecontrolledbyactionsthataresent
+fromaGeViScopeserver.TheactionscanbechanneledintothesystemusingtheSDK
+(GSCDBI.DLLandGSCActions.DLL)incustomapplications.Asanalternativetheactions
+canbesenttotheTACIinterfaceoftheGeViScopeserver.TheTACIinterfaceisamedia
+pluginoftheGeViScopeserver,whichcanreceiveactionsasASCIItextcommandssimilar
+toaTELNETcommunication.TheTACIpluginhastobelicensed.
+
+────────────────────────────────────────────────────────────────────────────────
+Page 8
+────────────────────────────────────────────────────────────────────────────────
+
+Stepbystep
+Thefollowingstepbystepinstructionsshowhowtoconfigureasimplesystemtodemon-
+strateremotecontrollingGSCView.ThevirtualtestenvironmentincludedintheSDKshould
+besuccessfullyinstalledandsetupbeforefollowingtheseinstructions(seetopicSettingup
+avirtualtestenvironment).
+Step1:starttheGeViScopeserver
+Starttheserverbydoubleclickingonfile“\BIN\GSCServer.exe“.Nowaconsoleapplication
+shouldstart.
+
+────────────────────────────────────────────────────────────────────────────────
+Page 9
+────────────────────────────────────────────────────────────────────────────────
+
+Step2:startGSCView
+StarttheGSCViewsoftware(file“\BIN\GSCView.exe”).
+Step3:starttheprofilemanager
+Themenuentry“Options–Profilemanager…”startstheinternalprofilemanagerof
+GSCView.TheprofilmanagerallowsconfiguringallGSCViewsettings.
+
+────────────────────────────────────────────────────────────────────────────────
+Page 10
+────────────────────────────────────────────────────────────────────────────────
+
+Step4:declarelocalconnectionas“connectautomatically”
+Byselecting“Connections”inthesection“Resources”thelocalconnectioncanbedeclared
+asaconnectionthatisautomaticallybuiltupafterstartingGSCView.Additionaltheoption
+“Reconnectautomatically”shouldbeactivated.

SOURCES/GeViScope_SDK_text/GeViScope_SDK_pages_011-020.txt

@@ -0,0 +1,109 @@
+================================================================================
+GeViScope_SDK.pdf - Pages 11 to 20
+================================================================================
+
+
+────────────────────────────────────────────────────────────────────────────────
+Page 11
+────────────────────────────────────────────────────────────────────────────────
+
+IftheconnectionisopeninGSCVieworGSCSetup,thesettingsoftheconnectioncannot
+bechanged.Closealllocalconnectionsatfirsttobeabletochangetheconnectionsettings.
+Step5:configureGSCViewtobeabletoremotecontrolitby
+actions
+Theentry“Optionsprofile”inthesection“Profiles”showsatabcontrolwithalotofdifferent
+GSCViewsettings.TobeabletoremotecontrolGSCViewtheoption“Remotecontrol”on
+the“Actions”tabhastobeset.
+
+────────────────────────────────────────────────────────────────────────────────
+Page 12
+────────────────────────────────────────────────────────────────────────────────
+
+The“Viewerclientnumber”shouldbesettoaarbitraryglobalnumberthatisuniqueinthe
+wholesystem.Thisglobal“Viewerclientnumber”identifiesthisspecialinstanceof
+GSCViewinthewholenetwork.Thenumberisusedindifferentactionstoremotecontrol
+GSCView.
+Bycontrastthe“globalnumber”ofaviewerinacustomsceneidentifiesaspecialviewerin
+auserdefinedscene.Detailsaboutuserdefinedsceneswillbetopicofthenextstep.
+Step6:userdefinedscenes
+TodefineuserdefinedscenesinGSCViewtheentry“Scenes”insection“Resources”
+shouldbeselected.Byrightclickingononeofthepredefinedscenesnewuserdefined
+scenescanbecreated.Forthisstepbystepexampletwonewsceneswiththenames
+“MyStartScene”and“MyScene”havetobeadded.Withthebutton“Editscene”theglobal
+numbersoftheviewersofthesceneandthevideochannelsthatshouldbedisplayedcanbe
+set.
+The“MyStartScene”shouldbebasedonthe“Matrix4x4”.Theviewersshouldhavethe
+globalnumbers1001to1016.Eachviewershoulddisplaylivepicturesofavideochannelof
+thelocalconnection.Thevideochannelscanbesetviadrag&dropwhileeditingthescene.
+
+────────────────────────────────────────────────────────────────────────────────
+Page 13
+────────────────────────────────────────────────────────────────────────────────
+
+The“MyScene”shouldbebasedonthe“Matrix2x2”andtheviewersshouldhavetheglobal
+numbers1101to1104.Theviewersshouldnotautomaticallydisplayanyvideochannel.
+Theywillbeusedbyspecialactionstodisplayvideochannels.
+
+────────────────────────────────────────────────────────────────────────────────
+Page 14
+────────────────────────────────────────────────────────────────────────────────
+
+Step7:modifytheappearanceofGSCView
+TheappearanceofGSCViewcanbecontrolledbydifferentsettingsintheentry“Optionspro-
+file”ofthesection“Profiles”.Forthistestscenario,GSCViewshouldappearasastupid
+videowallwithoutanyusercontrolsdirectlyvisibleintheGSCViewapplicationwindow.To
+achievethis,thefollowingoptionsonthe“Application”tabhavetobeset:
+
+────────────────────────────────────────────────────────────────────────────────
+Page 15
+────────────────────────────────────────────────────────────────────────────────
+
+Pleasekeepinmind,thatiftheoption“Sensitiveareaenabled”isnotsetandifall“Hide…”
+optionsareset,themainmenuofGSCViewonlycanbeaccessedbypressingF10!
+Step8:saveall settings
+Allsettingsshouldbesavedbyselectingthemenuentry“File–Save”.
+Step9:testthesystemwithGSCPLCSimulator
+AfterrestartingGSCViewitshouldappearinfullmodewith16viewersdisplayinglivepic-
+turesofthevideochannelsofthelocalconnection.
+
+────────────────────────────────────────────────────────────────────────────────
+Page 16
+────────────────────────────────────────────────────────────────────────────────
+
+Nowstartthesoftware“\BIN\GSCPLCSimulator.exe”totestthesystem.The
+GSCPLCSimulatorservesasamonitoringtoolforallmessages(actions)andeventsthat
+aretransportedinsidethecompletesystem.Furthermoreactionscanbetriggeredand
+eventscanbestartedandstopped.
+Afteritsstarttheconnectiontothelocalservershouldbebuildupautomaticallyandall
+actiontrafficisdisplayedinalist.
+
+────────────────────────────────────────────────────────────────────────────────
+Page 17
+────────────────────────────────────────────────────────────────────────────────
+
+Withthebutton“Dialog”anactioncanbeselectedandwiththebutton“Send”thisactioncan
+besendtotheGeViScopeserver.Fortestingthesystemfirstselecttheaction“VCchange
+scenebyname”inthecategory“Vieweractions”todisplay“MyScene”ontheGSCView
+withtheglobal“Viewerclientnumber”1000.
+
+────────────────────────────────────────────────────────────────────────────────
+Page 18
+────────────────────────────────────────────────────────────────────────────────
+
+Aftersendingtheaction,GSCViewshoulddisplayan“empty”“MyScene”.
+
+────────────────────────────────────────────────────────────────────────────────
+Page 19
+────────────────────────────────────────────────────────────────────────────────
+
+Todisplayvideochannelsintheviewersof“MyScene”theaction“Viewerconnectlive”can
+beused.Theparameter“viewer”nowmeanstheglobalnumberofaviewerof“MyScene”,
+e.g.1102.Theparameter“channel”shouldbesettotheglobalnumberofthevideochannel
+thatshouldbedisplayed,e.g.2.
+
+────────────────────────────────────────────────────────────────────────────────
+Page 20
+────────────────────────────────────────────────────────────────────────────────
+
+Aftersendingtheaction,GSCViewdisplayslivevideoofthevideochannel2ontheupper
+leftviewerinGSCView.

SOURCES/GeViScope_SDK_text/GeViScope_SDK_pages_021-030.txt

@@ -0,0 +1,393 @@
+================================================================================
+GeViScope_SDK.pdf - Pages 21 to 30
+================================================================================
+
+
+────────────────────────────────────────────────────────────────────────────────
+Page 21
+────────────────────────────────────────────────────────────────────────────────
+
+Backgroundinformation
+InGeViScopesystemsactionsareusedtocommunicatebetweentheGeViScopeserver
+andanyclientapplication.Allavailableactionscanbedividedintothreegroups:
+Notificationactions(forexample“UserLogin”),commandactions(forexample“Viewercon-
+nectlive”)andlogicalactions(theseactionsarenotdirectlycreatedbytheGeViScope
+serverandtheydon’tdirectlyresultinanyreactionintheGeViScopeserver,forexample
+“Customaction”).
+Allactionsaregroupedindifferentcategories.Thecategory“Vieweractions”containsall
+actionsthatarerelevantforremotecontrollingGSCView.
+TogetnotificationsaboutGSCViewactivities,oneoftheoptions“Sendnotificationactions”
+intheprofilemanagerofGSCViewhastobeset.Allpossiblenotificationactionsarecol-
+lectedintheactioncategory“Viewernotifications”.
+
+────────────────────────────────────────────────────────────────────────────────
+Page 22
+────────────────────────────────────────────────────────────────────────────────
+
+Moredetailedinformationaboutallavailableactionscanbefoundinthetopic“Actiondoc-
+umentation”(especiallyVieweractionsandViewernotifications).
+PleasebeawareofthefactthatGSCViewisworkinginanasynchronousmode.Ifacustom
+applicationsendsanaction,thatdependsontheresultoftheprevioussentactiontheremay
+betheneedforinsertingapausetimebeforesendingthesecondaction(e.g.sendaction
+“Viewerconnectlive”,waitonesecond,sendaction“Viewerprintpicture”).GSCViewdoes
+nothaveaninputqueueforremotecontrolactions.
+Supporteddevelopmentplatforms
+TheSDKisdesignedandtestedtobeusedwiththefollowingdevelopmentenvironments:
+l CodeGearC++Builder6©
+l CodeGearC++Builder2009©
+l CodeGearDelphi7©
+l CodeGearDelphi2005©
+l CodeGearDelphi2009©
+l MicrosoftVisualStudio2005,C++,MFC©
+l MicrosoftVisualStudio2008,C++,MFC©
+l MicrosoftVisualStudio2005,C++/CLI©
+l Microsoft.NET ©(wrapperclassesarecontainedinthe“Examples”folder)
+
+────────────────────────────────────────────────────────────────────────────────
+Page 23
+────────────────────────────────────────────────────────────────────────────────
+
+Guidelinesandhints
+Introduction
+ItisrecommendedtobefamiliarwiththeGeViScopesystemandthepossibilitiesofmodern
+videosurveillancesystemsandvideomanagementsystems.Beforestartingprogramming
+yourcustomGeViScopeclientyoushouldknowbasicsofvideoformats,videocom-
+pression,GeViScopeevents,GeViScopeactionsandtheprinciplesofaclient-servernet-
+workcommunication.
+ThefollowingsectionssupportyouwithsomesuggestionsandhintsaboutusingtheSDK
+interfaces.
+Generalhints
+IfyourapplicationneedstolistentoeventsandactionspleaseusetheapplicationPLCSim-
+ulator.exethatyoucanfindonYourGeViScopedevice.Thissoftwareallowsyoutostart
+actionsandeventswhichmightbeusedbyyourprogram.
+YoushouldworkanddosometestswitharealGeViScopedeviceorwiththevirtualtest
+environmentbelongingtotheSDK.Createsomeeventsandactions,startthemwith
+PLCSimulator.exe.
+StartingthesetupsoftwareGSCSetup.exewiththecommandlineparameter/utilitieswill
+offeryouthepossibilitytoopenDBITesttodiscoverthedatabasestructureandtoevaluate
+andtestselectstatementsagainstthedatabase.Additionallythistooloffersyouthepos-
+sibilitytostarttheregistryeditortoevaluatetheinternalstructureoftheGeViScopesetup.
+MakesuretodeleteallobjectsthatarecreatedinsideofDLLs.Theobjects
+themselvesshouldalwaysofferaDestroy()orFree()methodforthat.
+Callbackfunctions,whicharecalledoutoftheSDKDLLs,arecalledfromthreads,which
+werecreatedinsidetheDLLs.Variablesandpointersthatarepassedasargumentsofthe
+callbackmaynotbeusedoutsidethecallbackcontext.Theyareonlyvalidfortheduration
+ofthecallbackcall.
+StructuresthatareusedasargumentsforSDKfunctionsshouldalwaysbeinitializedbythe
+functionmemset().Aftersettingallthestructureelementstozero,thesizeorstructsizeele-
+menthastobeinitializedwiththesizeof()function.
+MPEG-2filesthatwerecreatedbySDKfunctionscanpossiblynotbeplayedwiththewin-
+dowsmediaplayer.ThereasonisamissingMPEG-2decoder.WerecommendusingDVD
+playersoftwarelikePowerDVDortheVCLMediaPlayersoftware.
+Workingwithhandlesandinstances
+IntegralpartoftheSDKareunitsthatgivetheuseracomfortableaccesstotheplainfunc-
+tionsoftheDLL,e.g.GSCDBI.h/.cpp/.pas.Intheseunitsclassesencapsulateaccessto
+instancesofobjectswhicharecreatedinsidetheDLL.Tohaveaccessfromoutsidethe
+DLL(customapplication)totheinsideresidinginstances,handlesareused.Theunitshave
+tobeaddedtotheprojectrespectivelytothesolutiontoavoidlinkererrors.
+
+────────────────────────────────────────────────────────────────────────────────
+Page 24
+────────────────────────────────────────────────────────────────────────────────
+
+Afterworkwithinstancesisfinished,theinstanceshavetobedeletedbycallingtheirdes-
+troy()orfree()method.Otherwisetherewillbememoryleaksleft.
+UsingtheplainexportedfunctionsoftheDLLisnotrecommended.Togetaccesstofull
+functionalityyoushouldusetheunitsinstead(pasfilesorh/cppfiles).
+Thefollowingexample(inpseudocode)shouldillustratetheabovefacts:
+ //defineahandletoaserverobject
+ HGscServerMyServer;
+//createaserverobjectinstanceinsidetheDLLand
+ //getahandletoit
+ MyServer=DBICreateRemoteserver();
+ ...
+//workwiththeobjectinstancewiththehelpofthehandle
+ MyServer->Connect();
+ ...
+ //defineahandletoaPLCobject
+ HGscPLCPLC;
+  //createaPLCobjectinstanceinsidetheDLLand
+ //getahandletoit
+ PLC=MyServer.CreatePLC();
+ ...
+//workwiththeobjectinstancewiththehelpofthehandle
+ PLC->OpenPushCallback(...);
+ ...
+//destroyPLCobject
+ PLC->Destroy();
+ ...
+ //destroyserverobject
+ MyServer->Destroy();
+InteractionbetweenDBIandMediaPlayer
+TheDBIinterfacegivesaccesstoGeViScopeserverfunctionality.Aftercreatingan
+instancewiththefunctionDBICreateRemoteserver()aconnectiontotheservercanbe
+establishedbycallingthemethodConnect()oftheserverobjectinstance.
+Thefollowingmethodsofaserverobjectinstancecanbecalledtogetaccesstodifferent
+kindsoffunctions(notacompletelist):
+
+────────────────────────────────────────────────────────────────────────────────
+Page 25
+────────────────────────────────────────────────────────────────────────────────
+
+Method Function
+CreateDataSet(),
+CreateDataPacket()
+Fetchdatafromserverdatabase
+CreateLiveStream() Fetchlivedatafromserver
+CreateRegistry() Fetchsetupdatafromserver(mediachannelinformation,event
+information,…)
+CreatePLC() Listento,createandsendactions
+Theexample(inpseudocode)ofthepreviouschaptershouldillustratetheabovefacts.
+TheMediaPlayerinterfaceofferssimpletouseobjectstodisplayliveandrecordedvideoin
+windowscontrols.Aviewerobjectinstanceneedstobecreatedbycalling
+GMPCreateViewer().Theviewerneedsahandletoawindowscontrolandahandletoa
+serverobjectinstance.Ithandlesfetchingdata,decompressingdataanddisplayingvideoin
+thelinkedwindowscontrolbyitself.
+Thefollowingmethodsofaviewerobjectinstancecanbecalledtogetaccesstodifferent
+kindsoffunctions(notacompletelist):
+Method Function
+ConnectDB() Fetchvideodatafromthedatabaseanddisplayitinanyplaymoderequired.
+Filterandsearchcriteriacanoptionallybedefined.
+SetPlayMode
+(pmPlayNextEvent)
+Displaythenextavailableeventpictures
+Thefollowingexample(inpseudocode)showshowtocreateavieweranduseitafter-
+wards:
+//defineahandletoaviewerobject
+ HGscViewerMyViewer;
+//createaviewerobjectinstanceinsidetheDLLand
+//getahandletoit
+ MyViewer=GMPCreateViewer(WindowHandle,...);
+//defineastructurewithdataneededtolink
+//theviewertoamediachannelintheserver
+ TMPConnectDataMyViewerConnectData;
+  //handletotheserverobjectinstance
+ MyViewerConnectData.Connection=MyServer;
+ MyViewerConnectData.ServerType=ctGSCServer;
+ MyViewerConnectData.MediaType=mtServer;
+ //IDofthemediachannelthatshouldbedisplayed
+ MyViewerConnectData.MediaChID=...
+//linktheviewertoamediachannelanddisplaylivedata
+ MyViewer->ConnectDB(MyViewerConnectData,pmPlayStream,...);
+ //destroyviewerobject
+  MyViewer->Destroy();
+BesidetheviewerobjectclassthereisanotherclassintheMediaPlayerinterface:Theoff-
+screenviewerobjectclass.Ifyouwanttodecompressmedia,whichshouldnotbe
+
+────────────────────────────────────────────────────────────────────────────────
+Page 26
+────────────────────────────────────────────────────────────────────────────────
+
+displayedwiththehelpoftheviewerobject,youcanusetheoffscreenviewerobject.An
+instancecanbecreatedwiththefunctionGMPCreateOffscreenViewer().Theoffscreen
+viewerobjectinstanceprovidesnearlythesamefunctionalityastheviewerobjectclass
+does.Thevideofootageisnotrenderedinawindow,itisdecompressedinaspecialDecom-
+pBufferobjectinstance.Afterthedecompressionisdoneinsidetheoffscreenviewer,the
+hostingapplicationcanbenotifiedwiththehelpofacallbackfunction.Insidethecallback
+thedecompressedimagecanbeaccessed.
+TheDecompBufferclassencapsulatesspecialfunctionsforeffectivedecompressing.Soit
+isrecommendtouseit.Creatinganinstanceofthebuffercanbereachedbycallingthefunc-
+tionGMPCreateDecompBuffer().Theinstancecanbeusedforasmanydecompressions
+asneeded.ThemethodGetBufPointer()givesaccesstotherawpicturedatainsidethebuf-
+fer.
+Hereisashortexample(inpseudocode)howtoworkwithanoffscreenviewerobject:
+ //defineahandletoaDecompBufferobject
+ HGscDecompBufferMyDecompBuffer;
+ //createaDecompBufferobjectinstanceinsidetheDLLand
+ //getahandletoit
+ MyDecompBuffer=GMPCreateDecompBuffer();
+ //defineahandletoaoffscreenviewerobject
+ HGscViewerMyOffscreenViewer;
+ //createanoffscreenviewerobjectinstanceinsidetheDLLand
+ //getahandletoit
+ MyOffscreenViewer=GMPCreateOffscreenViewer(MyDecompBuffer);
+ //setcallbackoftheoffscreenviewerobject
+ MyOffscreenViewer.SetNewOffscreenImageCallBack(NewOff-
+screenImageCallback);
+ //defineastructurewithdataneededtolink
+ //theoffscreenviewertoamediachannelintheserver
+ TMPConnectDataMyOffscreenViewerConnectData;
+//handletotheserverobjectinstance
+ MyOffscreenViewerConnectData.Connection=MyServer;
+ MyOffscreenViewerConnectData.ServerType=ctGSCServer;
+ MyOffscreenViewerConnectData.MediaType=mtServer;
+ //IDofthemediachannelthatshouldbedecompressed
+ MyOffscreenViewerConnectData.MediaChID=...
+//linktheoffscreenviewertoamediachannelanddecompresslivedata
+ MyOffscreenViewer->ConnectDB(MyOffscreenViewerConnectData,pmPlayStream,
+...);
+ ...
+ //destroyoffscreenviewerobject
+ MyOffscreenViewer->Destroy();
+ //destroyDecompBufferobject
+
+────────────────────────────────────────────────────────────────────────────────
+Page 27
+────────────────────────────────────────────────────────────────────────────────
+
+ MyDecompBuffer->Destroy();
+ ...
+ //callbackfunction,thatiscalledafterimageshavebeendecompressed
+ ...
+ //getarawpointertothepictureintheDecompBuffer
+ //object
+ MyDecompBuffer->GetBufPointer(BufferPointer,...);
+ //copythepictureintoawindowsbitmapresource
+ //forexample
+ SetDIBits(...,BitmapHandle,...,BufferPointer,...,DIB_RGB_COLORS);
+ ...
+Enumerationofsetupdata
+GeViScopeServerresourcescanbeenumeratedbycustomapplications.Thesetupobject,
+whichcanbeinstantiatedbycallingtheservermethodCreateRegistry(),offersfunctionality
+forthis.
+Enumerationofresourcesnormallyisdoneinfoursteps:
+1. DefineanarrayoftypeGSCSetupReadRequestwiththeonlyelement“/”.This
+causesthemethodReadNodes()totransferthewholesetupfromtheservertothe
+customapplication.
+2. CallthemethodReadNodes()ofthesetupobjecttogetthewholesetupfromthe
+server.
+3. CalloneoftheGet…()methodsofthesetupobjecttogetanarrayofGUIDsrep-
+resentingthelistofresources.TherearedifferentGet…()methods,e.g.GetMe-
+diaChannels()orGetEvents().
+4. UsetheGUIDarraytoreceivetheresourcesdatabycallingGet…Settings()meth-
+ods,e.g.GetMediaChannelSettings()orGetEventSettings().
+Hereisanexample(inpseudocode),thatshowshowtoenumeratethemediachannels:
+ ...
+//connecttotheserver
+ MyServer->Connect();
+ ...
+//defineahandletoasetupobject
+ HGscRegistryMySetup;
+ //createasetupobjectinstanceinsidetheDLLand
+ //getahandletoit
+ MySetup=MyServer->CreateRegistry();
+//defineaarrayforthesetupreadrequest
+ GscSetupReadRequestSetupReadRequest[1];
+ SetupReadRequest[0].NodeName="/";
+
+────────────────────────────────────────────────────────────────────────────────
+Page 28
+────────────────────────────────────────────────────────────────────────────────
+
+//readthesetupdatafromtheserver
+ MySetup->ReadNodes(&SetupReadRequest,...);
+ //defineaGUIDarrayfortheGUIDsofthe
+ //existingmediachannels
+ GuidDynArrayMediaChannels;
+//gettheGUIDarrayoutofthesetupdata
+ MySetup->GetMediaChannels(MediaChannels);
+//getthedataofeachsinglemediachannel
+foreachMediaChannelGUIDinMediaChannels
+ MySetup->GetMediaChannelSettings(MediaChannelGUID,
+ MediaChannelID,
+  GlobalNumber,
+ ...);
+ ...
+//destroysetupobject
+ MySetup->Destroy();
+//destroyserverobject
+ MyServer->Destroy();
+  ...
+Pleasenotethatespeciallythemediachannelscanbeenumeratedbyusingtheglobalfunc-
+tionGMPQueryMediaChannelList()oftheMediaPlayerinterfaceaswell.
+PLC,actionsandevents
+ThePLC(PrcessLogicControl)objectsupportsyouwithfunctionalityforhandlingnoti-
+fications,actionsandevents.ThemethodCreatePLC()oftheserverobjectclasscreatesa
+handletoaPLCobjectinsidetheDBIDLL.
+ThefollowingmethodsofaPLCobjectinstancecanbecalledtogetaccesstodifferent
+kindsoffunctions(notacompletelist):
+Method Function
+SendAction() Sendanactiontotheconnectedserver
+StartEvent() Startaneventoftheconnectedserver
+SubscribeActions() Subscribealistofactionsthatshouldbenotifiedbyaregisteredcallback
+function
+OpenPushCallback
+()
+Registeracallbackfunction,thatiscalledifannotificationarrivesora
+eventstarts/stopsorifoneofthesubscribedactionsarrives
+ToreceiveNotificationsandactionsacallbackfunctioncanberegisteredwiththemethod
+OpenPushCallback().Afterreceivinganaction,theactionshouldbedecodedanddis-
+patchedbytheaninstanceoftheclassGSCActionDispatcher.Theactiondispatchergives
+youasimplewaytoreactonspecificactions.Hereisashortexample(inpseudocode):
+
+────────────────────────────────────────────────────────────────────────────────
+Page 29
+────────────────────────────────────────────────────────────────────────────────
+
+ //initializationcode:
+ ...
+ //connecttotheserver
+ MyServer->Connect();
+ ...
+//defineahandletoaPLCobject
+ HGSCPLCPLC;
+ //createaPLCobjectinstanceinsidetheDLLand
+ //getahandletoit
+ PLC=MyServer.CreatePLC();
+  ...
+ //linkyourcallbackfunctionforacustomaction
+ //totheactiondispatcher,sothatthecallbackfunction
+ //iscalledautomaticallyifacutsomactionarrives
+ ActionDispatcher->OnCustomAction=this->MyCustomActionHandler;
+ //registeracallbackfunctionfornotifications,
+ //eventsandactions(thiscallbackfunctiondispatches
+ //allreceivedactionswiththehelpofthe
+ //GSCActionDispatcher)
+ PLC->OpenPushCallback(...);
+ ...
+//destroyPLCobject
+ PLC->Destroy();
+ ...
+//destroyserverobject
+ MyServer->Destroy();
+ //callbackfunctionforallnotifications,eventsand
+ //subscribedactions:
+ ...
+ //dispatchthereceivedactiontothelinked
+ //callbackfunctions
+ ActionDispatcher->Dispatch(ActionHandle);
+ ...
+MediachannelIDs
+TheexistingmediachannelscanbedisplayedbytheviewerobjectsoftheMediaPlayer
+interface.NormallythisisdonewiththemethodConnectDB().Thismethodneedsthe
+
+────────────────────────────────────────────────────────────────────────────────
+Page 30
+────────────────────────────────────────────────────────────────────────────────
+
+mediachannelIDtoidentifythemediachannel(camera)thatshouldbedisplayed.
+ThemediachannelIDsaregeneratedautomaticallybytheGeViScopeserver.Everycre-
+atedmediachannelgetsanIDthatisalwaysunique.Soifyouremovemediachannelsfrom
+thesetupandaddthemagain,theywillsurereceivesomenewIDs.
+ForthatreasonmediachannelsshouldnotbeaccessedbyconstantIDs.Itisrecommend
+usingglobalnumbersinstead,becausetheycanbechangedinthesetup.Tofindthefitting
+mediachannelIDforagivenglobalnumber,themediachannelsshouldbeenumeratedfrom
+theserversetup.Pleaserefertochapter“Enumerationofsetupdata”inthisdocumentto
+seehowthisisdone.
+Thereisasimilardifficultywithevents,digitalinputsandoutputs.Eventsdon’thaveglobal
+numbers.Heretheeventnameshouldbeusedinstead.
+Handlingconnectioncollapses
+ThecallbackOpenPushCallback()ofthePLCobjectenablestolistentodifferentkindsof
+notificationsfromthePLCobject.Oneisthe“plcnPushCallbackLost”notification.Itisfired
+ifaconnectionisinternallydetectedascollapsed.Asareactiononthiseventyoushould
+destroyorfreeallobjectsthatwerecreatedinsidetheDLLsandstartaphaseofreconnect
+tries.Thereconnecttriesshouldstartevery30secondsforexample.Additionallyyour
+applicationcanlistentoUDPbroadcaststhataresentbytheGeViScopeserver.Afteryour
+applicationreceivedthisbroadcastitcandirectlytrytoreconnecttotheserver.Pleasebe
+awareofthefact,thatbroadcastsonlyworkinLAN–routersnormallyblockbroadcasts.
+UsingMediaPlayerwithGeViScopeandMULTISCOPEIII
+servers
+GenerallytheMediaPlayerinterfacecanbeusedwithGeViScopeaswellasMULTISCOPE
+IIIservers.Tolinktheserverconnectiontotheviewerobject,theconnectiondatastructure
+hastobedefined.Thetypeofthestructureis“TMPConnectData”.Theelement“Server-
+Type”identifiesthekindofserverwhosemediashouldbedisplayedintheviewer.
+Pleasehavealookontheexample(inpseudocode)inthechapter“InteractionbetweenDBI
+andMediaPlayer”inthisdocument.
+Forcreatingdifferentkindofconnections,differentDLLshavetobeused.ForGeViScope
+theDLL“GSCDBI.DLL”andforMULTISCOPEIIItheDLL“MscDBI.DLL”hastobe
+includedintheprojectorsolutionofthecustomapplication.Theycancoexist.
+HandlingaconnectiontoaMULTISCOPEIIIserverissimilartoGeViScope.Detailscanbe
+foundintheMULTISCOPEIIISDKdocumentation.
+UsingtheSDKwith.NET
+TomaketheusageofthenativeWin32DLLseasierin.NETlanguageslikeC#orVB.NET,
+theSDKcontainssomewrapperassembliesaroundtheplainSDKDLLs.

SOURCES/GeViScope_SDK_text/GeViScope_SDK_pages_031-040.txt

@@ -0,0 +1,407 @@
+================================================================================
+GeViScope_SDK.pdf - Pages 31 to 40
+================================================================================
+
+
+────────────────────────────────────────────────────────────────────────────────
+Page 31
+────────────────────────────────────────────────────────────────────────────────
+
+ThesewrapperassembliesaredevelopedinC++/CLIandpublishedwiththeSDK.The
+assembliescanbefoundintheGeViScopeSDKbinaryfolder“GeViScopeSDK\BIN”.
+TheSDKprovideswrapperassembliesforthe.NET-Frameworksversions2.0and4.0
+whicharenamedasfollows:
+.NET-Framework2.0
+•GscExceptionsNET_2_0.dll
+•GscActionsNET_2_0.dll
+•GscMediaPlayerNET_2_0.dll
+•GscDBINET_2_0.dll
+.NET-Framework4.0
+•GscExceptionsNET_4_0.dll
+•GscActionsNET_4_0.dll
+•GscMediaPlayerNET_4_0.dll
+•GscDBINET_4_0.dll
+ThesewrapperassembliescanbeusedtogetherwithournativeSDKDLLs(GscAc-
+tions.DLL,GscDBI.DLL,GscHelper.DLL,GscMediaPlayer.DLL,MscDBI.DLL)tocreate
+customapplicationsunderany.NETlanguageonawindowsplatform.Theassemblies
+needtobereferencedbythe.NETprojectandallthefiles(assembliesandnativeDLLs)
+havetoresideintheapplicationfolder.
+
+────────────────────────────────────────────────────────────────────────────────
+Page 32
+────────────────────────────────────────────────────────────────────────────────
+
+Deployingacustomsolutionbasedonthe.NETwrapper
+Tosuccessfullydeployacustomapplicationthatusesthe.NETwrappercontainedinthe
+SDK,thefollowingprerequisiteshavetobefulfilled:
+a)MicrosoftVisualC++RedistributablePackagehastobe
+installed
+ThewrapperassembliesaredevelopedinC++/CLI.Soforexecutingthemonanonedevel-
+opmentmachine,theMicrosoftVisualC++RedistributablePackageisneeded.Thispack-
+ageexistsinadebugorinareleaseversion.Onproductivemachinesthereleaseversion
+needstobeinstalled.
+Forapplicationsusingthe.NET-Framework2.0theVisualC++2008RedistributablePack-
+ageisneeded.Incasethattheapplicationisdevelopedusingthe.NET-Framework4.0you
+needtoinstalltheVisualC++2010RedistributablePackage.
+b).NETFrameworkVersion2.0SP1ornewerhastobe
+installed
+Ifupdatingthe.NETFrameworkonaGEUTEBRÜCKdevice(GeViScopeorre_porter)
+fails,aspecialMicrosofttoolWindowsInstallerCleanUpUtility(MSICUU2.exe)can
+improvethesituation.Afterexecutingthistool,updatingtheFrameworkshouldbepossible.
+c)WrapperassembliesANDnativeSDKDLLsareneeded
+BesidethecustomapplicationalsothewrapperassembliesandthenativeSDKDLLs(lis-
+tedabove)areneededinthesamefolderasinwhichthecustomapplicationresides.
+Iftheapplicationusesthe.NET-Framework4.0youneedtoreferencetheGeViScopewrap-
+perDLLswiththeextension_4_0otherwisepleaseusethewrapperassemblieswiththe
+extension_2_0(seeabove).
+GeViScopeREGISTRY
+UsingtheGscRegistrywith.NET
+Introduction
+ByusingtheGeViScoperegistry(GSCREGISTRY)itispossibletomodifyGeViScope/Re_
+portersettingsprogrammatically.TheGscRegistryisaproprietaryregistryformat
+developedbyGEUTEBRÜCK.ThisregistryformatissimilartotheMicrosoftWindows
+registry.
+
+────────────────────────────────────────────────────────────────────────────────
+Page 33
+────────────────────────────────────────────────────────────────────────────────
+
+AllneededGeViScopeserversettingsarestoredintheGscRegistrydatabase.Thecreation
+ofownregistrydatabasesbasedonfilesisalsopossible.
+TheGEUTEBRÜCKGEVISCOPESDKprovidesseveralclassesandmethodstoallowa
+comfortableaccesstotheGscRegistry.
+Requirements
+Thefollowingrequirementsareneededtocreatea.NETapplicationthatusestheGscRe-
+gistryfunctionality:
+•.NET-Framework2.0SP1ornewer
+-.NET-Framework2.0SP1Wrapper-Assemblies:
+GscExceptionsNET_2_0.dll
+GscDBINET_2_0.dll
+-.NET-Framework4.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++RedistributablePackage
+Usingtheregistry
+Inthefollowing,theusageoftheGscRegistrywith.NETisexplainedindetail.Itdiscusses
+thefollowingsteps:
+l Opentheregistry
+l Readvaluesoutofnodes
+l Createanode
+l Addvaluestoanode
+l Savetheregistry
+AllnecessaryclassesandmethodsforusingtheGscRegistryareavailableintheGscDBI
+namespace.Toincludethisnamespacethefollowingusing-statementisneeded:
+usingGEUTEBRUECK.GeViScope.Wrapper.DBI;
+Opentheregistry
+ToreadormodifyGeViScope/Re_portersettingsitisnecessarytoestablishaconnection
+tothepreferredGeViScope/Re_porterserverbefore.Afterthisisdoneyouneedtocreatea
+newobjectoftheclassGscRegistryandinitializeitbyusingtheCreateRegistry()method
+whichiscontainedintheGscServerobject.
+C#-Code:Opentheregistry
+if(_GscServer!=null)
+{
+//createanobjectinstanceoftheserverregistry
+GscRegistryGscRegistry=_GscServer.CreateRegistry();
+if(GscRegistry!=null)
+{
+//defineanarrayforthesetupreadrequest(registrynodepaths
+toread)
+
+────────────────────────────────────────────────────────────────────────────────
+Page 34
+────────────────────────────────────────────────────────────────────────────────
+
+GscRegistryReadRequest[]ReadRequests=newGscRegistryReadRequest
+[1];
+ReadRequests[0]=newGscRegistryReadRequest("/",0);
+//readthenodes(setupdata)outoftheserverregistry
+GscRegistry.ReadNodes(ReadRequests);
+}
+}
+ThemethodReadNodes()oftheGscRegistryobjectexpectsanarrayofthetypeGscRe-
+gistryReadRequestwhichcontainsallnodepathstobereadoutoftheregistry.Inthe
+sourcecodesnippetabove,thearraysimplycontainsoneelementwhichrepresentsthe
+rootnode(“/”).Byreadingtherootnodetheentireregistrywillbereadout.
+Readvaluesofnodes
+Thefollowingsourcecodesnippetshowshowtoreadvaluesoutofnodes:
+C#-Code:Readvaluesoutofnodes
+if(GscRegistry!=null)
+{
+GscRegNodeRegNode=GscRegistry.FindNode("/System/MediaChannels/");
+for(inti=0;i<RegNode.SubNodeCount;++i)
+{
+//findtheGeViScoperegistrynodeoftheparentnodebymeansof
+theindex
+GscRegNodeSubRegNode=RegNode.SubNodeByIndex(i);
+GscRegVariantRegVariant=newGscRegVariant();
+//Getthevalue"Name"outofthesubregistrytypeandstorethe
+valueand
+//valuetypeintheGscRegVariantclass
+SubRegNode.GetValueInfoByName("Name",refRegVariant);
+if(RegVariant!=null&&RegVariant.ValueType==
+GscNodeType.ntWideString)
+Console.WriteLine(RegVariant.Value.WideStringValue);
+}
+}
+ToreadaspecificnodeoutoftheregistrytheGscRegistryclassprovidesthemethod
+FindNode().
+Forthatthepathtothepreferrednodehastobecommittedtothemethodandityouwillget
+backanobjectofthetypeofGscRegNode.Thisobjectcontainsallsubnodesandvaluesof
+thefoundnode.
+ToaccessasubnodeoftheparentnodethemethodSubNodeByIndex()providedbythe
+classGscRegNodecanbeusedorusetheSubNodeByName()methodifthenameofthe
+subnodeisalreadyknown.
+ThemethodGetValueInfoByName()canbeusedtoaccessaspecificvalueofanode.This
+methodexpectsthenameofthespecificvalueaswellasareferencetoanobjectoftypeof
+GscRegVariant.TheGscRegVariantobjectwillbefilledwiththetypeofthevalue
+(ValueType)aswellasthevalueitself(Value).
+Createanode
+
+────────────────────────────────────────────────────────────────────────────────
+Page 35
+────────────────────────────────────────────────────────────────────────────────
+
+TocreateanewnodeinaparentnodethemethodCreateSubNode()whichisprovidedby
+theclassGscRegNodeneedstobecalled.Themethodexpectsthenameofthenewnode.
+C#-Code:Createanode
+if(_GscRegistry!=null)
+{
+GscRegNodeRegNode=_GscRegistry.FindNode("/System/MediaChannels/0000");
+//createanewsubnodeinNodePath
+if(RegNode!=null)
+RegNode.CreateSubNode("NewNode");
+}
+Addvaluestoanode
+ThereareseveralmethodsintheclassGscRegNodetoaddvaluestoanode.Dependingon
+thetypeofthevalueitisneededtocalltherightmethodforwritingthistypeintotheregistry.
+ForexampleifyouwouldliketowriteanInt32valueintotheregistryyouneedtousethe
+methodWriteInt32().
+C#-Code:Addvaluestonode
+publicvoidAddValue(stringNodePath,stringValueName,GscNodeTypeValueType,
+objectValue)
+{
+GscRegNodeRegNode=_GscRegistry.FindNode(NodePath);
+if(RegNode!=null)
+{
+switch(ValueType)
+{
+caseGscNodeType.ntWideString:
+{
+RegNode.WriteWideString(ValueName,Value.ToString());
+break;
+}
+caseGscNodeType.ntInt32:
+{
+RegNode.WriteInt32(ValueName,Convert.ToInt32(Value));
+break;
+}
+}
+}
+}
+Savetheregistry
+AftertheGscRegistryobjectwasmodified(e.g.newnodes/newvalues),theserveralso
+needstoknowaboutthechangesmade.ForthistheGscRegistryclassprovidesthe
+methodWriteNodes().
+C#-Code:Addvaluestonode
+//defineanarrayforthesetupwriterequest
+
+────────────────────────────────────────────────────────────────────────────────
+Page 36
+────────────────────────────────────────────────────────────────────────────────
+
+GscRegistryWriteRequest[]WriteRequests=newGscRegistryWriteRequest[1];
+WriteRequests[0]=newGscRegistryWriteRequest("/",0);
+GscRegistry.WriteNodes(WriteRequests,true);
+TheWriteNodes()methodexpectsanarraycontainingobjectsofthetypeofGscRe-
+gistryWriteRequest.EachGscRegistryWriteRequestcontainsapathtoanodethathasto
+besaved.
+ NOTICE
+Itisrecommendedtoonlyaddoneelementtothisarraywhichcontainstherootpath(“/”).
+Thisresultsinsavingtheentireregistrystructure.
+StructureofGSCRegistry
+TheGEVISCOPESDKofferstwopossibilitiestobrowsethestructureoftheGscRegistry.
+BymeansoftheapplicationGscRegEditthatisdeliveredwiththeSDK,itispossibleto
+browseormodifytheregistrysimilartoMicrosoft’sWindowsregistry.
+InadditiontoGscRegEdityoucanalsousetheregistryeditorwhichisintegratedin
+GSCSetup.ToactivatethisfeaturethekeycombinationSTRG+ALT+Uneedstobeactu-
+ated.TheentryRegistryeditorinthesectionUtilitiesinthenavigationbarontheleftwill
+nowbeshown.
+Examples
+TogetabetterideaofhowtousetheGscRegistry,theGEVISCOPESDKprovidesfurther
+.NETexampleapplications.
+Theexamplescanbefoundinthefolder„Examples“ folderintheGeViScopeSDKmain
+folder:
+l C:\ProgramFiles(x86)\GeViScopeSDK\Examples\VS2008NET\VS2008NET_
+GscRegEdit
+Simpleregistryeditor,GUIapplication(VisualStudio2008)
+l C:\ProgramFiles(x86)\GeViScopeSDK\Examples\VS2008NET\VS2010NET_
+GscRegEdit
+Simpleregistryeditor,GUIapplication(VisualStudio2010)
+l C:\ProgramFiles(x86)\GeViScopeSDK\Examples\VS2008NET\VS2008NET_
+GscRegistryBasics
+Consoleapplication(VisualStudio2008)
+l C:\ProgramFiles(x86)\GeViScopeSDK\Examples\VS2010NET\VS2010NET_
+GscRegistryBasics
+Consoleapplication(VisualStudio2010)
+GSCViewdatafilterplugins
+Introduction
+GSCViewoffersthepossibilitytointegratecustomizeddatafilterdialogs.Datafilterdialogs
+areusedtosearchandfiltervideofootagebyadditionaleventdata.Theycanbecustomized
+tothedifferentbusinessenvironmentsinwhichGeViScopeisused.
+
+────────────────────────────────────────────────────────────────────────────────
+Page 37
+────────────────────────────────────────────────────────────────────────────────
+
+Thefollowingsectionssupportyouwithsomesuggestionsandhintsaboutcreatingcus-
+tomizeddatafilterplugins.
+Generalhints
+Customdatafiltersarehostedinflatwindows32Bitdynamiclinklibraries.Differingfromnor-
+malDLLsthedatafilterDLLshavetheextension“.GPI”.AlldatafilterDLLsexistinginthe
+samefolderasGSCViewareintegratedinGSCViewautomatically.
+ThecustomizeddatafilterDLLinterface
+EachDLLhastoexportthefunctionGSCPluginRegisterSearchFilter()thatiscalledby
+GSCViewtousethecustomizeddialogs.Theexactdefinitionofthisfunctionandsome
+additionaltypedefinitionscanbefoundintheunit“GSCGPIFilter.pas/.h”.
+InsidethefunctionGSCPluginRegisterSearchFilter()oneorevenmoredatafilterdialogs
+havetoberegisteredbycallingthefunctionCallbacks.RegisterFilter().
+Thefollowingexample(inpseudocode)showshowthisisdone:
+if(Callbacks.RegisterFilter==NULL)
+
+────────────────────────────────────────────────────────────────────────────────
+Page 38
+────────────────────────────────────────────────────────────────────────────────
+
+returnFALSE;
+TPluginFilterDefinitiondef;
+def=SimpleFilter.GetFilterDefinition();
+Callbacks.RegisterFilter(Callbacks.HostHandle,def);
+ThestructureTPluginFilterDefinitiondefinessomeinformationaldataandallthecallback
+functionsneededforasingledialog.GSCViewusesthedefinitiontocallthedifferentcall-
+backfunctionsduringitsexecution.
+Nameofcallback
+function Function
+InitFilter() Canbeusedtoinitializethedatafilterdialog.Tointegratethedialogin
+GSCView,thefunctionhastoreturntrue.
+ShowFilter() Insidethisfunctionthedialogshouldbedisplayedasastand-alone
+(modal)dialog.GSCViewcallsthefunctionaftertheuseractivatesthe
+ button.
+DeinitFilter() Canbeusedtodeinitializethedatafilterdialog.Thefunctionhastoreturn
+true,evenifitisnotused.
+GetFilterGuid() Thefunctionshouldprovideaglobaluniqueidentifier(GUID)thatisused
+insideGSCViewtoidentifythedialog.TheGUIDcanbedefinedasastatic
+constantvalue.
+Asanalternativetothemodaldisplayofthedatafilterdialog,thedialogcanbedisplayed
+nestedintheGSCViewmainwindoworGSCVieweventlist.Butatthemomentthisfeature
+isonlysupportedbycustomfilterdialogscreatedwithBorlandDelphi©.
+Toachievethenesteddisplay,theadditionalcallbackfunctionsofthestructureTPlu-
+ginFilterDefinitionhavetobeimplemented.TheBorlandDelphi©example
+“GSCViewDataFilter”demonstratesthedetails.
+Creatingthefiltercriteria
+Ifthecustomdatafilterisapplied,GSCViewdoesaqueryagainstthetables“events”and
+“eventdata”oftheinternalGeViScopedatabase.Forthisqueryafiltercriteriaisneeded.The
+
+────────────────────────────────────────────────────────────────────────────────
+Page 39
+────────────────────────────────────────────────────────────────────────────────
+
+customdatafilterdeliversthecriteriaandgivesitbacktoGSCViewintheShowFilter()call-
+backfunction.
+TobuildupmeaningfulfiltercriteriasomebackgroundknowledgeoftheGeViScopedata-
+baseisneeded.
+Thetable“events”containsalltheeventsrecordedinthedatabase(onlyeventinformation,
+notthesamples;thesamplesarelinkedtotheevents).
+Thetable“eventdata”containsadditionaldatabelongingtotheevents.Insidethetablethe
+differentparametersofactionsaresaved.IfforexampleaneventisstartedbytheCus-
+tomAction(4711,“Helloworld”),thevalue4711issavedintherow“Int64_A”andthevalue
+“Helloworld”issavedintherow“String_A”.BecausetheeventisstartedbyaCus-
+tomAction,thevalue8issavedintherow“EventDataKind”.Eachactionhasanindividual
+mappingofactionparameterstorowsinthetable“eventdata”.
+FordifferentbusinessenvironmentsspecialactionscanbecreatedbyGEUTEBRÜCK.
+Therealreadyexistsomespecialactionslike:
+Actionname Businessenvironment
+ATMTransaction() Automatedtellermachines
+ACSAccessGranted() Accesscontrolsystems
+SafebagOpen() Cashmanagementsystems
+POSData() Pointofsalesystems
+Theactioninternallydefinesthemappingofactionparameterstorowsinthetable“event-
+data”.Thecodeofanaction(foraCustomActionthecodeis8)isstoredintherow
+“EventDataKind”.Thecodesofactionsarelistedintheactionreferencedocumentation
+“GSCActionsReference_EN.pdf”.
+Toevaluatethemappingofactionparameterstodatabaserows,GSCSetupcanbeused.
+BypressingSTRG+ALT+UinGSCSetupthespecialutility“DBItest”getsavailable.
+With“DBItest”thestructureandcontentoftheGeViScopedatabasecanbeanalyzed.The
+followingSQLqueriescanbehelpful:
+SQLquery Function
+select*fromevents Fetchesrecordsfromthetable“events”
+select*fromeventdata Fetchesrecordsfromthetable“eventdata”
+select*fromsamples Fetchesrecordsfromthetable“samples”
+Thefollowingtableshoulddemonstratehowtobuildupfiltercriteriadependingonpara-
+metersgiveninthecustomdatafilterdialog(heretheCustomAction()isusedtostartthe
+events):
+
+────────────────────────────────────────────────────────────────────────────────
+Page 40
+────────────────────────────────────────────────────────────────────────────────
+
+Action
+para-
+meter
+INT
+Action
+para-
+meter
+STRING
+Fil-
+terCriteria.SQLstatementSQLquery
+Nothing Nothing EventData.EventDataKind=8select*fromEventDataleftjoinEventson
+EventData.EventID=Events.EventIDwith
+EventData.EventDataKind=8
+Nothing Hello
+world
+EventData.EventString_A=
+"Helloworld"and
+EventData.EventDataKind=8
+select*fromEventDataleftjoinEventson
+EventData.EventID=Events.EventIDwith
+EventData.EventString_A="Helloworld"
+andEventData.EventDataKind=8
+4711 Nothing EventData.EventInt64_A=
+4711and
+EventData.EventDataKind=8
+select*fromEventDataleftjoinEventson
+EventData.EventID=Events.EventIDwith
+EventData.EventInt64_A=4711and
+EventData.EventDataKind=8
+4711 Hello
+world
+EventData.EventInt64_A=
+4711and
+EventData.EventString_A=
+"Helloworld"and
+EventData.EventDataKind=8
+select*fromEventDataleftjoinEventson
+EventData.EventID=Events.EventIDwith
+EventData.EventInt64_A=4711and
+EventData.EventString_A="Helloworld"
+andEventData.EventDataKind=8
+Nothing Hello* EventData.EventString_A=
+"Hello*"and
+EventData.EventDataKind=8
+select*fromEventDataleftjoinEventson
+EventData.EventID=Events.EventIDwith
+EventData.EventDataKind=8where
+EventData.EventString_ALIKE"Hello*"
+DuringtestingthecustomdatafilterdialogintheGSCVieweventlistadoubleclickonthe
+statusbaroftheeventlistdeliverstheSQLquerythatisexecutedintheGeViScopeserver.
+Examplesoverview
+Theexamplesoverviewisorganizedintwodifferentviewsonallexamplesincludingthe
+GeViScopeSDK:
+Examplesgroupedbyprogrammingtasks
+Examplesgroupedbydevelopmentplatforms

SOURCES/GeViScope_SDK_text/GeViScope_SDK_pages_041-050.txt

@@ -0,0 +1,475 @@
+================================================================================
+GeViScope_SDK.pdf - Pages 41 to 50
+================================================================================
+
+
+────────────────────────────────────────────────────────────────────────────────
+Page 41
+────────────────────────────────────────────────────────────────────────────────
+
+Examplesgroupedbyprogrammingtasks
+ConnecttoanddisconnectfromaGeViScopeserver
+l LiveStream(CodeGearC++Builder6and2009)
+l SimpleClient(CodeGearDelphi7,2005and2009)
+l GSCLiveStream(MicrosoftVisualStudio2005,C++,MFC)
+l VS2008CPP_SimpleClient(MicrosoftVisualStudio2008,C++,MFC)
+l VS2008CPP_ActionsAndEvents(MicrosoftVisualStudio2008,C++,MFC)
+l VS2008NET_SimpleClient(MicrosoftVisualStudio2008,C#)
+l VS2008NET_ActionsAndEvents(MicrosoftVisualStudio2008,C#)
+l VS2008WPF_SimpleClient(MicrosoftVisualStudio2008,C#,WPF)
+l VS2010NET_SimpleClient(MicrosoftVisualStudio2010,C#)
+l VS2010NET_ActionsAndEvents(MicrosoftVisualStudio2010,C#)
+l VS2010WPF_SimpleClient(MicrosoftVisualStudio2010,C#,WPF)
+Enumerateexistingmediachannelsandeventtypesfroma
+GeViScopeserver
+l LiveStream(CodeGearC++Builder6and2009)
+l SimpleClient(CodeGearDelphi7,2005and2009)
+l GSCLiveStream(MicrosoftVisualStudio2005,C++,MFC)
+l VS2008CPP_SimpleClient(MicrosoftVisualStudio2008,C++,MFC)
+l VS2008CPP_ActionsAndEvents(MicrosoftVisualStudio2008,C++,MFC)
+l VS2008NET_GscRegEdit(MicrosoftVisualStudio2008,C#)
+l VS2008NET_GscRegistryBasics(MicrosoftVisualStudio2008,C#)
+l VS2008NET_SimpleClient(MicrosoftVisualStudio2008,C#)
+l VS2010CPP_ConfigReader(MicrosoftVisualStudio2010,C++)
+l VS2010NET_SimpleClient(MicrosoftVisualStudio2010,C#)
+l VS2010NET_ActionsAndEvents(MicrosoftVisualStudio2010,C#)
+l VS2010NET_GscRegEdit(MicrosoftVisualStudio2010,C#)
+l VS2010NET_GscRegistryBasics(MicrosoftVisualStudio2010,C#)
+l VS2010WPF_SimpleClient(MicrosoftVisualStudio2010,C#,WPF)
+DisplayliveandrecordedmediawiththeMediaPlayerinter-
+face
+l LiveStream(CodeGearC++Builder6and2009)
+l SimpleClient(CodeGearDelphi7,2005and2009)
+l GSCLiveStream(MicrosoftVisualStudio2005,C++,MFC)
+l VS2008CPP_SimpleClient(MicrosoftVisualStudio2008,C++,MFC)
+l VS2008CPP_ActionsAndEvents(MicrosoftVisualStudio2008,C++,MFC)
+l VS2008NET_SimpleClient(MicrosoftVisualStudio2008,C#)
+l VS2008WPF_SimpleClient(MicrosoftVisualStudio2008,C#,WPF)
+l VS2010NET_SimpleClient(MicrosoftVisualStudio2010,C#)
+l VS2010WPF_SimpleClient(MicrosoftVisualStudio2010,C#,WPF)
+DisplayrecordedeventmediawiththeMediaPlayerinterface
+l VS2008CPP_ActionsAndEvents(MicrosoftVisualStudio2008,C++,MFC)
+l VS2008NET_ActionsAndEvents(MicrosoftVisualStudio2008,C#)
+l VS2010NET_ActionsAndEvents(MicrosoftVisualStudio2010,C#)
+
+────────────────────────────────────────────────────────────────────────────────
+Page 42
+────────────────────────────────────────────────────────────────────────────────
+
+HandlingactionsandPLCnotifications
+l GSCActions(CodeGearC++Builder6and2009)
+l SimpleClient(CodeGearDelphi7,2005and2009)
+l ResourceStateMonitor(Delphi2009)
+l VS2008CPP_ActionsAndEvents(MicrosoftVisualStudio2008,C++,MFC)
+l VS2008NET_ActionsAndEvents(MicrosoftVisualStudio2008,C#)
+l VS2010CPP_ControlBlockingFilters(MicrosoftVisualStudio2010,C++)
+l VS2010NET_ActionsAndEvents(MicrosoftVisualStudio2010,C#)
+Handlingevents
+l LiveStream(CodeGearC++Builder6and2009)
+l GSCLiveStream(MicrosoftVisualStudio2005,C++,MFC)
+l VS2008CPP_ActionsAndEvents(MicrosoftVisualStudio2008,C++,MFC)
+l VS2008NET_ActionsAndEvents(MicrosoftVisualStudio2008,C#)
+l VS2010NET_ActionsAndEvents(MicrosoftVisualStudio2010,C#)
+Creatingbackups
+l Backup(CodeGearDelphi7and2009)
+Synchronizeddisplayofmorethanonemediachannels
+l SynchPlayback(CodeGearC++Builder6and2009)
+CustomdrawinviewersofMediaPlayerinterface
+l SynchPlayback(CodeGearC++Builder6and2009)
+l VS2008CPP_SimpleClient(MicrosoftVisualStudio2008,C++,MFC)
+l VS2008NET_SimpleClient(MicrosoftVisualStudio2008,C#)
+l VS2010NET_SimpleClient(MicrosoftVisualStudio2010,C#)
+Exportpicturedata
+l MediaPlayerExport(CodeGearDelphi7and2009)
+l MPEGExport(CodeGearDelphi7and2009)
+l VS2008NET_MediaPlayerExport(MicrosoftVisualStudio2008,C#)
+l VS2010NET_MediaPlayerExport(MicrosoftVisualStudio2010,C#)
+ControlPTZcams
+l Telecontrol(CodeGearDelphi7and2009)
+Fetchauserblockinglist fromtheserver
+l UserBlockingList(CodeGearC++Builder6and2009)
+Decompressliveandrecordedmediawiththeoffscreen
+viewer
+l OffscreenViewer(CodeGearDelphi7and2009)
+l VS2008CPP_OffscreenViewer(MicrosoftVisualStudio2008,C++,MFC)
+
+────────────────────────────────────────────────────────────────────────────────
+Page 43
+────────────────────────────────────────────────────────────────────────────────
+
+l VS2008CPP_OffscreenViewer_Console(MicrosoftVisualStudio2008,C++)
+l VS2008NET_OffscreenViewer(MicrosoftVisualStudio2008,C#)
+l VS2010NET_OffscreenViewer(MicrosoftVisualStudio2010,C#)
+DecompressrawlivemediabyusingtheDBI
+l VS2008CPP_RawLiveStreamDecompress(MicrosoftVisualStudio2008,C++,
+MFC)
+l VS2008CPP_RawLiveStreamDecompress_Console(MicrosoftVisualStudio2008,
+C++)
+Createageneralserviceapplication
+l WindowsService(CodeGearC++Builder6and2009)
+l VS2008CPP_ServiceFrameworkDemo(MicrosoftVisualStudio2008,C++)
+l VS2008NET_ServiceFrameworkDemo(MicrosoftVisualStudio2008,C#)
+l VS2010NET_ServiceFrameworkDemo(MicrosoftVisualStudio2010,C#)
+Full-duplexaudiocommunicationbetweenGeViScopecom-
+ponents
+TheAudioBackChannelGeViScopeServerPlugin(VisualStudio2010)isanexamplefora
+GeViScopeServerplugin.Itrealizesafull-duplexaudiocommunicationbetweendifferent
+GeViScopecomponents.ThefullscopeofoperationcanbefoundinthedocumentAudio
+BackChannel(ABC)Plugindocumentation.
+SimulatemediachannelsinGeViScopeservers
+TheMCS(MediaChannelSimulator)GeViScopeServerPlugin(CodeGearC++Builder6)
+isanotherexampleforaGeViScopeServerplugin.Itshowshowtochannelmediadata
+insidetheGeViScopesystemwithoutusingspecialvideohardware.Inadditionthehandling
+ofactionsinsideaserverpluginisdemonstrated.Thefullscopeofoperationcanbefoundin
+thedocumentMCSDocumentation.
+SimulateascreensaverasaGeviScopeServerPlugin
+TheDelphiScreenSaverPluginGeViScopeServerPlugin(CodeGearDelphi7)isanother
+exampletodemonstratechannelingmediaintoaGeViScopeServerwiththehelpofa
+ServerPlugin.
+Provideacustomizeddatafilter dialoginGSCView
+GSCViewoffersthepossibilitytointegratecustomizeddatafilterdialogs.Datafilterdialogs
+areusedtosearchandfiltervideofootagebyadditionaleventdata.Theycanbecustomized
+tothedifferentbusinessenvironmentsinwhichGeViScopeisused.Detailedinformation
+canbefoundinthedocumentGSCViewdatafilterplugins.
+Thefollowingexamplesdemonstratehowtocreatecustomizeddatafilterdialogs:
+l SimpleGSCViewDataFilter(CodeGearDelphi7and2009)
+l GSCViewDataFilter(CodeGearDelphi7and2009)
+l VS2008CPP_SimpleGSCViewDataFilter(MicrosoftVisualStudio2008,C++,MFC)
+PresentingGEUTEBRÜCKBackupFiles(GBF)
+
+────────────────────────────────────────────────────────────────────────────────
+Page 44
+────────────────────────────────────────────────────────────────────────────────
+
+l VS2008CPP_SimpleGBFViewer(MicrosoftVisualStudio2008,C++,MFC)
+l SimpleGBFViewer(CodeGearDelphi2009)
+l VS2008NET_SimpleGBFViewer(MicrosoftVisualStudio2008,C#)
+Monitorthestateofmediachannels(cameras)
+l ResourceStateMonitor(CodeGearDelphi2009)
+Examplesgroupedbydevelopmentplatforms
+CodeGearC++Builder6and2009©
+l LiveStream
+ConnecttoanddisconnectfromaGeViScopeserver
+enumerateexistingmediachannelsandeventtypesfromaGeViScopeserver
+DisplayliveandrecordedmediawiththeMediaPlayerinterface
+Handlingevents
+l GSCActions
+ConnecttoanddisconnectfromaGeViScopeserver
+Handlingactions
+l SynchPlayback
+ConnecttoanddisconnectfromaGeViScopeserver
+enumerateexistingmediachannelsandeventtypesfromaGeViScopeserver
+DisplayliveandrecordedmediawiththeMediaPlayerinterface
+Handlingevents
+Synchronizeddisplayofmorethanonemediachannels
+l UserBlockingList
+ConnecttoanddisconnectfromaGeViScopeserver
+Fetchauserblockinglistfromtheserver
+l WindowsService
+WindowsService(CodeGearC++Builder6and2009)
+l TheMCS(MediaChannelSimulator)GeViScopeServerPluginisanotherexample
+foraGeViScopeServerplugin.ItshowshowtochannelmediadatainsidetheGeViS-
+copesystemwithoutusingspecialvideohardware.Inadditionthehandlingof
+actionsinsideaserverpluginisdemonstrated.Thefullscopeofoperationcanbe
+foundinthedocumentMCSDocumentation.
+CodeGearDelphi7,2005und2009©
+l SimpleClient
+ConnecttoanddisconnectfromaGeViScopeserver
+enumerateexistingmediachannelsandeventtypesfromaGeViScopeserver
+DisplayliveandrecordedmediawiththeMediaPlayerinterface
+l Backup
+ConnecttoanddisconnectfromaGeViScopeserver
+enumerateexistingmediachannelsfromaGeViScopeserver
+Creatingbackups
+l MediaPlayerExport
+ConnecttoanddisconnectfromaGeViScopeserver
+enumerateexistingmediachannelsfromaGeViScopeserver
+Exportpicturedata
+l MPEGExport
+ConnecttoanddisconnectfromaGeViScopeserver
+enumerateexistingmediachannelsfromaGeViScopeserver
+
+────────────────────────────────────────────────────────────────────────────────
+Page 45
+────────────────────────────────────────────────────────────────────────────────
+
+Exportpicturedata
+l Telecontrol
+ConnecttoanddisconnectfromaGeViScopeserver
+enumerateexistingmediachannelsandeventtypesfromaGeViScopeserver
+DisplayliveandrecordedmediawiththeMediaPlayerinterface
+Handlingactions
+ControlPTZcams
+l OffscreenViewer
+ConnecttoanddisconnectfromaGeViScopeserver
+enumerateexistingmediachannelsfromaGeViScopeserver
+Decompressliveandrecordedmedia
+Customdraw
+l TheSimpleGSCViewDataFilterandGSCViewDataFilterexampleareexamplesfor
+customizeddatafilterdialogsofGSCView.Detailedinformationcanbefoundinthe
+documentGSCViewdatafilterplugins.
+l SimpleGBFViewer(onlyDelphi2009)
+OpenandcloseaGEUTEBRÜCKBackupFiles(GBF)
+enumerateexistingmediachannelsintheGBFfile
+DisplaymediawiththeMediaPlayerinterface
+l ResourceStateMonitor(onlyDelphi2009)
+ConnecttoanddisconnectfromaGeViScopeserver
+enumerateexistingmediachannelsfromaGeViScopeserver
+monitorthestateofmediachannels(cameras)
+Handlingactions
+MicrosoftVisualStudio2005,C++,MFC©
+l GSCLiveStream
+ConnecttoanddisconnectfromaGeViScopeserver
+enumerateexistingmediachannelsfromaGeViScopeserver
+DisplayliveandrecordedmediawiththeMediaPlayerinterface
+MicrosoftVisualStudio2005,C++,CLI©
+l TheVSIPCamPluginGeViScopeServerPluginisanexampletoshowhowsimpleit
+istochannelsomepicturesfromanIPcamintoaGeViScopeserver
+MicrosoftVisualStudio2008,C++,MFC©
+l VS2008CPP_SimpleClient
+ConnecttoanddisconnectfromaGeViScopeserver
+enumerateexistingmediachannelsfromaGeViScopeserver
+DisplayliveandrecordedmediawiththeMediaPlayerinterface
+Customdraw
+l VS2008CPP_OffscreenViewer
+ConnecttoanddisconnectfromaGeViScopeserver
+enumerateexistingmediachannelsfromaGeViScopeserver
+Decompressliveandrecordedmedia
+Customdraw
+l VS2008CPP_ActionsAndEvents
+ConnecttoanddisconnectfromaGeViScopeserver
+enumerateexistingmediachannelsandeventtypesfromaGeViScopeserver
+DisplayliveandrecordedmediawiththeMediaPlayerinterface
+Handlingactions
+
+────────────────────────────────────────────────────────────────────────────────
+Page 46
+────────────────────────────────────────────────────────────────────────────────
+
+Handlingevents
+DisplayrecordedeventmediawiththeMediaPlayerinterface
+l VS2008CPP_SimpleGBFViewer
+OpenandcloseaGEUTEBRÜCKBackupFiles(GBF)
+enumerateexistingmediachannelsintheGBFfile
+DisplaymediawiththeMediaPlayerinterface
+l TheVS2008CPP_SimpleGSCViewDataFilterexampleisanexampleforacus-
+tomizeddatafilterdialogofGSCView.Detailedinformationcanbefoundinthedoc-
+umentGSCViewdatafilterplugins.
+l VS2008CPP_RawLiveStreamDecompress_Console
+ReceivinglivestreamsbyusingtheDBI
+DecompressingframesbymeansofthedecompressorobjectoftheGscMe-
+diaPlayer-DLL
+l VS2008CPP_OffscreenViewer_Console
+UsingtheOffscreenViewertoreceivealivestreaminaconsoleapplication
+OffscreenViewerprovidesadecompressedimageinacallback
+OnlythepictureID(PicID)oftheimagewillbedisplayedintheconsole
+l VS2008CPP_RawLiveStreamDecompress_Console
+ReceivinglivestreamsbyusingtheDBI
+DecompressingframesbymeansofthedecompressorobjectoftheGscMe-
+diaPlayer-DLL
+l VS2008CPP_OffscreenViewer_Console
+UsingtheOffscreenViewertoreceivealivestreaminaconsoleapplication
+OffscreenViewerprovidesadecompressedimageinacallback
+OnlythepictureID(PicID)oftheimagewillbedisplayedintheconsole
+MicrosoftActiveX©
+l GscViewer(ActiveXControl)
+EncapsulatingofGeViScopefunctionalityintoanActiveXcontrol
+l ActiveX_DOTNETClient
+InvocationoftheGscViewerActiveXcontrolfromC#
+l ActiveX_HTML_Page
+InvocationoftheGscViewerActiveXcontrolfrominsideawebpage(html)
+l ActiveX_VB6Client(deprecated)
+InvocationoftheGscViewerActiveXcontrolfrominsideaVB6application
+l ActiveX_VB6MultiClient(deprecated)
+InvocationofseveralGscViewerActiveXcontrolfrominsideaVB6application
+MicrosoftVisualStudio2008,C#©
+l VS2008NET_SimpleClient
+ConnecttoanddisconnectfromaGeViScopeserver
+enumerateexistingmediachannelsfromaGeViScopeserver
+DisplayliveandrecordedmediawiththeMediaPlayerinterface
+Customdraw
+l VS2008NET_ActionsAndEvents
+ConnecttoanddisconnectfromaGeViScopeserver
+enumerateexistingmediachannelsandeventtypesfromaGeViScopeserver
+DisplayliveandrecordedmediawiththeMediaPlayerinterface
+Handlingactions
+Handlingevents
+DisplayrecordedeventmediawiththeMediaPlayerinterface
+
+────────────────────────────────────────────────────────────────────────────────
+Page 47
+────────────────────────────────────────────────────────────────────────────────
+
+l VS2008NET_OffscreenViewer
+ConnecttoanddisconnectfromaGeViScopeserver
+enumerateexistingmediachannelsfromaGeViScopeserver
+Decompressliveandrecordedmedia
+Customdraw
+l VS2008NET_RawDBDecompress
+Fetchingdatabaserecords
+Decompressingthefetchedrecordsasfastaspossible
+l VS2008NET_MediaPlayerExport
+ConnecttoanddisconnectfromaGeViScopeserver
+enumerateexistingmediachannelsfromaGeViScopeserver
+Exportpicturedata
+l VS2008NET_SimpleGBFViewer
+OpenandcloseaGEUTEBRÜCKBackupFiles(GBF)
+enumerateexistingmediachannelsintheGBFfile
+DisplaymediawiththeMediaPlayerinterface
+l TheVS2010NET_ServiceFrameworkDemoexample
+isanexampleforageneralserviceapplication.Servicesbasedonthe
+GEUTEBRÜCK
+ServiceFrameworkbehavelikeallGEUTEBRÜCKproduct
+l VS2008NET_GscRegEdit
+SimpleGeViScoperegistryeditor
+ConnecttoaGeViScopeserver
+ModifyGeViScopesettingsusingtheGeViScoperegistry
+ExportsettingstoGeViScoperegistryfileformat
+l VS2008NET_GscRegistryBasics
+SimpledemonstrationinusingtheGeViScoperegistry
+Readingoutmediachannels
+AddavaluetotheGeViScoperegistry
+SavingtheGeViScoperegistry
+MicrosoftVisualStudio2008,C#,WPF©
+l VS2008WPF_SimpleClient
+ConnecttoanddisconnectfromaGeViScopeserver
+enumerateexistingmediachannelsfromaGeViScopeserver
+DisplayliveandrecordedmediawiththeMediaPlayerinterface
+MicrosoftVisualStudio2010,C++
+l VS2010CPP_ConfigReader
+l VS2010CPP_ControlBlockingFilters
+MicrosoftVisualStudio2010,C#©
+l VS2010NET_SimpleClient
+ConnecttoanddisconnectfromaGeViScopeserver
+enumerateexistingmediachannelsfromaGeViScopeserver
+DisplayliveandrecordedmediawiththeMediaPlayerinterface
+Customdraw
+l VS2010NET_ActionsAndEvents
+ConnecttoanddisconnectfromaGeViScopeserver
+enumerateexistingmediachannelsandeventtypesfromaGeViScopeserver
+DisplayliveandrecordedmediawiththeMediaPlayerinterface
+
+────────────────────────────────────────────────────────────────────────────────
+Page 48
+────────────────────────────────────────────────────────────────────────────────
+
+Handlingactions
+Handlingevents
+DisplayrecordedeventmediawiththeMediaPlayerinterface
+l VS2010NET_OffscreenViewer
+ConnecttoanddisconnectfromaGeViScopeserver
+enumerateexistingmediachannelsfromaGeViScopeserver
+Decompressliveandrecordedmedia
+Customdraw
+l VS2010NET_RawDBDecompress
+Fetchingdatabaserecords
+Decompressingthefetchedrecordsasfastaspossible
+l VS2010NET_MediaPlayerExport
+ConnecttoanddisconnectfromaGeViScopeserver
+enumerateexistingmediachannelsfromaGeViScopeserver
+Exportpicturedata
+l VS2010NET_SimpleGBFViewer
+OpenandcloseaGEUTEBRÜCKBackupFiles(GBF)
+enumerateexistingmediachannelsintheGBFfile
+DisplaymediawiththeMediaPlayerinterface
+l TheVS2010NET_ServiceFrameworkDemo
+exampleisanexampleforageneralserviceapplication.Servicesbasedon
+theGEUTEBRÜCKServiceFrameworkbehavelikeallGEUTEBRÜCK
+productservices.
+l VS2010NET_GscRegEdit
+SimpleGeViScoperegistryeditor
+ConnecttoaGeViScopeserver
+ModifyGeViScopesettingsusingtheGeViScoperegistry
+ExportsettingstoGeViScoperegistryfileformat
+l VS2010NET_GscRegistryBasics
+SimpledemonstrationinusingtheGeViScoperegistry
+Readingoutmediachannels
+AddavaluetotheGeViScoperegistry
+SavingtheGeViScoperegistry
+MicrosoftVisualStudio2010,C#,WPF©
+l VS2010WPF_SimpleClient
+ConnecttoanddisconnectfromaGeViScopeserver
+enumerateexistingmediachannelsfromaGeViScopeserver
+DisplayliveandrecordedmediawiththeMediaPlayerinterface
+
+────────────────────────────────────────────────────────────────────────────────
+Page 49
+────────────────────────────────────────────────────────────────────────────────
+
+Actiondocumentation
+ThefollowingchaptercontainsashortoverviewabouttheexistingGEUTEBRÜCKactions
+andthereparameterdescriptions.
+ATM/ACS
+ACSaccessdenied
+Actionname:ACSAccessDenied(ACSName,ACSNo,Account,BancCode,CardNo,
+TimeStamp,Reason)Actioncategory:logicalACSaccessdenied.
+Parameter Function
+ACS ACSNameACSname.
+ACSno ACSNo ACSno.
+account Account Accountno.
+bankcodeBancCodeBankcode.
+cardno CardNo Cardno.
+timestampTimeStampTimestamp.
+reason Reason Reason.
+ACSaccessgranted
+Actionname:ACSAccessGranted(ACSName,ACSNo,Account,BancCode,CardNo,
+TimeStamp)Actioncategory:logical
+ACSaccessgranted.
+Parameter Function
+ACS ACSNameACSname.
+ACSno ACSNo ACSno.
+account Account Accountno.
+bankcodeBancCodeBankcode.
+cardno CardNo Cardno.
+timestampTimeStampTimestamp.
+ACSrawanswer
+Actionname:ACSRawAnswer(ACSName,TimeStamp,ACSData)Actioncategory:logical
+ACSrawanswer.
+Parameter Function
+ACS ACSNameACSname.
+timestampTimeStampTimestamp.
+answer ACSDataACSanswer.
+ACSrawdata
+Actionname:ACSRawData(ACSName,TimeStamp,ACSData)Actioncategory:logical
+
+────────────────────────────────────────────────────────────────────────────────
+Page 50
+────────────────────────────────────────────────────────────────────────────────
+
+ACSrawdata.
+Parameter Function
+ACS ACSNameACSname.
+timestampTimeStampTimestamp.
+data ACSDataACSdata.
+ATMrawanswer
+Actionname:ATMRawAnswer(ATMName,TimeStamp,ATMData)Actioncategory:logical
+ATMrawanswer.
+Parameter Function
+ATM ATMNameATMname.
+timestampTimeStampTimestamp.
+answer ATMDataATManswer.
+ATMrawdata
+Actionname:ATMRawData(ATMName,TimeStamp,ATMData)Actioncategory:logical
+ATMrawdata.
+Parameter Function
+ATM ATMNameATMname.
+timestampTimeStampTimestamp.
+data ATMDataATMdata.
+ATMtransaction
+Actionname:ATMTransaction(ATMName,NewTransaction,Photostep,ATMNo,Account,
+BancCode,CardNo,TAN1,TAN2,TimeStamp1,TimeStamp2,Amount,Currency)Action
+category:logicalATMtransaction.
+Parameter Function
+ATM ATMName ATMname.
+newtransactionNewTransactionNewtransaction.
+photostep Photostep Photostep.
+ATMno ATMNo ATMno.
+account Account Accountno.
+bankcode BancCode Bankcode.
+cardno CardNo Cardno.
+tan1 TAN1 TAN1.
+tan2 TAN2 TAN2.
+timestamp1 TimeStamp1Timestamp1.
+timestamp2 TimeStamp2Timestamp2.
+amount Amount Amount.
+currency Currency Currency.

SOURCES/GeViScope_SDK_text/GeViScope_SDK_pages_051-060.txt

@@ -0,0 +1,453 @@
+================================================================================
+GeViScope_SDK.pdf - Pages 51 to 60
+================================================================================
+
+
+────────────────────────────────────────────────────────────────────────────────
+Page 51
+────────────────────────────────────────────────────────────────────────────────
+
+Audiocontrol
+Allactionstocontroltheaudiostreams,alsoallnotificationsaboutthestatechangeofthe
+audiostreams.
+ABCconnect
+Actionname:ABCConnect(Address)Actioncategory:logicalConnectaudiobackchannel.
+Parameter Function
+addressAddressAddressoftheremoteserver.
+ABCdisconnect
+Actionname:ABCDisconnect()Actioncategory:logicalDisconnectaudiobackchannel.
+ABCplayfile
+Actionname:ABCPlayFile(FileID,FileName,AutoRepeat)Actioncategory:logicalPlayfile
+onaudiobackchannel.
+Parameter Function
+fileid FileID FileID.
+filenameFileNameNameofthefile.
+repeat AutoRepeatRepeatfileautomatically
+Sensoraudioalarm
+Actionname:SensorAudioAlarm(Channel)Actioncategory:logicalAudioalarmdetected.
+Parameter Function
+channelChannelChannel.
+Backupactions
+Allactionsforbackup.
+Abortallautobackups
+Actionname:AbortAllAutoBackups()Actioncategory:logicalAbortallautobackups.
+Abortautobackup
+Actionname:AbortAutoBackup(Schedule)Actioncategory:logicalAbortautobackup.
+Parameter Function
+schedule Schedule Schedule.
+Autobackupcapacitywarning
+Actionname:AutoBackupCapacityMonitoringCapacityWarning(Warning,Destination,
+TotalCapacity,FreeCapacity,AllocatedByGbf,PercentFree,PercentAllocated,Per-
+
+────────────────────────────────────────────────────────────────────────────────
+Page 52
+────────────────────────────────────────────────────────────────────────────────
+
+centAllocatedByGbf)Actioncategory:logicalAutobackupcapacitymonitoring:capacity
+warning.
+Parameter Function
+warning Warning Warning.
+destination Destination Destination.
+totalcapacity TotalCapacity Totalcapacity.
+freecapacity FreeCapacity Freecapacity.
+allocatedbyGBF AllocatedByGbf AllocatedbyGBF.
+percentfree PercentFree Percentfree.
+percentallocated PercentAllocated Percentallocated.
+percentallocatedbyGBFPercentAllocatedByGbfPercentallocatedbyGBF.
+Autobackupcapacityfileautodeleted
+Actionname:AutoBackupCapacityMonitoringFileAutoDeleted(Warning,Destination,
+TotalCapacity,FreeCapacity,AllocatedByGbf,PercentFree,PercentAllocated,Per-
+centAllocatedByGbf,FileSize,FileName)Actioncategory:logicalAutobackupcapacity
+monitoring:fileautodeleted.
+Parameter Function
+warning Warning Warning.
+destination Destination Destination.
+totalcapacity TotalCapacity Totalcapacity.
+freecapacity FreeCapacity Freecapacity.
+allocatedbyGBF AllocatedByGbf AllocatedbyGBF.
+percentfree PercentFree Percentfree.
+percentallocated PercentAllocated Percentallocated.
+percentallocatedbyGBFPercentAllocatedByGbfPercentallocatedbyGBF.
+filesize FileSize Filesize.
+filename FileName Filename.
+Autobackupcapacityoutofdiskspace
+Actionname:AutoBackupCapacityMonitoringOutOfDiskSpace(Warning,Destination,
+TotalCapacity,FreeCapacity,AllocatedByGbf,PercentFree,PercentAllocated,Per-
+centAllocatedByGbf)Actioncategory:logicalAutobackupcapacitymonitoring:outofdisk
+space.
+Parameter Function
+warning Warning Warning.
+destination Destination Destination.
+totalcapacity TotalCapacity Totalcapacity.
+freecapacity FreeCapacity Freecapacity.
+allocatedbyGBF AllocatedByGbf AllocatedbyGBF.
+percentfree PercentFree Percentfree.
+percentallocated PercentAllocated Percentallocated.
+percentallocatedbyGBFPercentAllocatedByGbfPercentallocatedbyGBF.
+
+────────────────────────────────────────────────────────────────────────────────
+Page 53
+────────────────────────────────────────────────────────────────────────────────
+
+Autobackupfiledone
+Actionname:AutoBackupFileDone(Schedule,StartTime,EffectiveStartTime,Oper-
+ationCount,TimerStart,OperationIndex,OperationStartTime,Source,Destination,FileS-
+izeLimit,BandWidthLimit,FileIndex,FileName,FileSize)Actioncategory:logicalAuto
+backupprogressnotification:filedone.
+Parameter Function
+schedule Schedule Schedule.
+starttime StartTime Starttime,emptyduringeventbackup.
+effectivestarttimeEffectiveStartTimeEffectiveschedulestarttime.
+operationcount OperationCountOperationcount.
+timerstart TimerStart Timerstart.
+operationindex OperationIndexOperationindex.
+operationstarttimeOperationStartTimeOperationstarttime.
+source Source Source.
+destination Destination Destination.
+filesizelimit FileSizeLimit Filesizelimit.
+bandwidthlimit BandWidthLimitBandwidthlimit.
+fileindex FileIndex Fileindex.
+filename FileName Filename.
+filesize FileSize Filesize.
+Autobackupfileprogress
+Actionname:AutoBackupFileProgress(Schedule,StartTime,EffectiveStartTime,Oper-
+ationCount,TimerStart,OperationIndex,OperationStartTime,Source,Destination,FileS-
+izeLimit,BandWidthLimit,FileIndex,FileName,FileSize)Actioncategory:logicalAuto
+backupprogressnotification:fileprogress.
+Parameter Function
+schedule Schedule Schedule.
+starttime StartTime Starttime,emptyduringeventbackup.
+effectivestarttimeEffectiveStartTimeEffectiveschedulestarttime.
+operationcount OperationCountOperationcount.
+timerstart TimerStart Timerstart.
+operationindex OperationIndexOperationindex.
+operationstarttimeOperationStartTimeOperationstarttime.
+source Source Source.
+destination Destination Destination.
+filesizelimit FileSizeLimit Filesizelimit.
+bandwidthlimit BandWidthLimitBandwidthlimit.
+fileindex FileIndex Fileindex.
+filename FileName Filename.
+filesize FileSize Filesize.
+Autobackupfilestarted
+Actionname:AutoBackupFileStarted(Schedule,StartTime,EffectiveStartTime,Oper-
+ationCount,TimerStart,OperationIndex,OperationStartTime,Source,Destination,
+
+────────────────────────────────────────────────────────────────────────────────
+Page 54
+────────────────────────────────────────────────────────────────────────────────
+
+FileSizeLimit,BandWidthLimit,FileIndex,FileName)Actioncategory:logicalAutobackup
+progressnotification:filestarted.
+Parameter Function
+schedule Schedule Schedule.
+starttime StartTime Starttime,emptyduringeventbackup.
+effectivestarttimeEffectiveStartTimeEffectiveschedulestarttime.
+operationcount OperationCountOperationcount.
+timerstart TimerStart Timerstart.
+operationindex OperationIndexOperationindex.
+operationstarttimeOperationStartTimeOperationstarttime.
+source Source Source.
+destination Destination Destination.
+filesizelimit FileSizeLimit Filesizelimit.
+bandwidthlimit BandWidthLimitBandwidthlimit.
+fileindex FileIndex Fileindex.
+filename FileName Filename.
+Autobackupoperationdone
+Actionname:AutoBackupOperationDone(Schedule,StartTime,EffectiveStartTime,Oper-
+ationCount,TimerStart,OperationIndex,OperationStartTime,OperationStopTime,Source,
+Destination,FileSizeLimit,BandWidthLimit)Actioncategory:logicalAutobackupprogress
+notification:operationdone.
+Parameter Function
+schedule Schedule Schedule.
+starttime StartTime Starttime,emptyduringeventbackup.
+effectivestarttimeEffectiveStartTimeEffectiveschedulestarttime.
+operationcount OperationCountOperationcount.
+timerstart TimerStart Timerstart.
+operationindex OperationIndexOperationindex.
+operationstarttimeOperationStartTimeOperationstarttime.
+operationstoptimeOperationStopTimeOperationstoptime.
+source Source Source.
+destination Destination Destination.
+filesizelimit FileSizeLimit Filesizelimit.
+bandwidthlimit BandWidthLimitBandwidthlimit.
+Autobackupoperationstarted
+Actionname:AutoBackupOperationStarted(Schedule,StartTime,EffectiveStartTime,Oper-
+ationCount,TimerStart,OperationIndex,OperationStartTime,Source,Destination,FileS-
+izeLimit,BandWidthLimit)Actioncategory:logicalAutobackupprogressnotification:
+operationstarted.
+Parameter Function
+schedule Schedule Schedule.
+starttime StartTime Starttime,emptyduringeventbackup.
+effectivestarttimeEffectiveStartTimeEffectiveschedulestarttime.
+operationcount OperationCountOperationcount.
+
+────────────────────────────────────────────────────────────────────────────────
+Page 55
+────────────────────────────────────────────────────────────────────────────────
+
+Parameter Function
+timerstart TimerStart Timerstart.
+operationindex OperationIndexOperationindex.
+operationstarttimeOperationStartTimeOperationstarttime.
+source Source Source.
+destination Destination Destination.
+filesizelimit FileSizeLimit Filesizelimit.
+bandwidthlimit BandWidthLimitBandwidthlimit.
+Autobackupscheduledone
+Actionname:AutoBackupScheduleDone(Schedule,StartTime,EffectiveStartTime,
+StopTime,OperationCount,TimerStart)Actioncategory:logicalAutobackupprogressnoti-
+fication:scheduledone.
+Parameter Function
+schedule Schedule Schedule.
+starttime StartTime Starttime,emptyduringeventbackup.
+effectivestarttimeEffectiveStartTimeEffectiveschedulestarttime.
+stoptime StopTime Schedulestoptime.
+operationcount OperationCountOperationcount.
+timerstart TimerStart Timerstart.
+Autobackupschedulestarted
+Actionname:AutoBackupScheduleStarted(Schedule,StartTime,EffectiveStartTime,Oper-
+ationCount,TimerStart)Actioncategory:logicalAutobackupprogressnotification:schedule
+started.
+Parameter Function
+schedule Schedule Schedule.
+starttime StartTime Starttime,emptyduringeventbackup.
+effectivestarttimeEffectiveStartTimeEffectiveschedulestarttime.
+operationcount OperationCountOperationcount.
+timerstart TimerStart Timerstart.
+Backupevent
+Actionname:BackupEvent(EventID,TypeID,Destination,StartHintID,StopHintID,Sub-
+folder)Actioncategory:logicalBackupevent.
+Parameter Function
+instanceID EventID InstanceIDoftheevent.
+eventtype TypeID Typeoftheevent.
+destination Destination Destination.
+starthintID StartHintID OptionalstarthintID.
+stophintID StopHintID OptionalstophintID.
+subfolder Subfolder Subfoldertobackupevent.
+
+────────────────────────────────────────────────────────────────────────────────
+Page 56
+────────────────────────────────────────────────────────────────────────────────
+
+Eventbackupdone
+Actionname:EventBackupDone(JobID,EventTypeID,EventID,Destination,FileSizeLimit,
+BandWidthLimit,StartTime,StopTime)Actioncategory:logicalEventbackupprogressnoti-
+fication:backupdone.
+Parameter Function
+jobID JobID BackupjobID.
+eventtype EventTypeID Typeoftheevent.
+instanceID EventID InstanceIDoftheevent.
+destination Destination Destination.
+filesizelimit FileSizeLimit Filesizelimit.
+bandwidthlimit BandWidthLimit Bandwidthlimit.
+starttime StartTime Backupstarttime.
+stoptime StopTime Backupstoptime.
+Eventbackupfiledone
+Actionname:EventBackupFileDone(JobID,EventTypeID,EventID,Destination,FileS-
+izeLimit,BandWidthLimit,StartTime,FileIndex,FileName,FileSize)Actioncategory:
+logicalEventbackupprogressnotification:filedone.
+Parameter Function
+jobID JobID BackupjobID.
+eventtype EventTypeID Typeoftheevent.
+instanceID EventID InstanceIDoftheevent.
+destination Destination Destination.
+filesizelimit FileSizeLimit Filesizelimit.
+bandwidthlimit BandWidthLimit Bandwidthlimit.
+starttime StartTime Effectivebackupstarttime.
+fileindex FileIndex Fileindex.
+filename FileName Filename.
+filesize FileSize Filesize.
+Eventbackupfileprogress
+Actionname:EventBackupFileProgress(JobID,EventTypeID,EventID,Destination,FileS-
+izeLimit,BandWidthLimit,StartTime,FileIndex,FileName,FileSize)Actioncategory:
+logicalEventbackupprogressnotification:fileprogress.
+Parameter Function
+jobID JobID BackupjobID.
+eventtype EventTypeID Typeoftheevent.
+instanceID EventID InstanceIDoftheevent.
+destination Destination Destination.
+filesizelimit FileSizeLimit Filesizelimit.
+bandwidthlimit BandWidthLimit Bandwidthlimit.
+starttime StartTime Effectivebackupstarttime.
+fileindex FileIndex Fileindex.
+filename FileName Filename.
+filesize FileSize Filesize.
+
+────────────────────────────────────────────────────────────────────────────────
+Page 57
+────────────────────────────────────────────────────────────────────────────────
+
+Eventbackupfilestarted
+Actionname:EventBackupFileStarted(JobID,EventTypeID,EventID,Destination,FileS-
+izeLimit,BandWidthLimit,StartTime,FileIndex,FileName)Actioncategory:logicalEvent
+backupprogressnotification:filestarted.
+Parameter Function
+jobID JobID BackupjobID.
+eventtype EventTypeID Typeoftheevent.
+instanceID EventID InstanceIDoftheevent.
+destination Destination Destination.
+filesizelimit FileSizeLimit Filesizelimit.
+bandwidthlimit BandWidthLimit Bandwidthlimit.
+starttime StartTime Effectivebackupstarttime.
+fileindex FileIndex Fileindex.
+filename FileName Filename.
+Eventbackupstarted
+Actionname:EventBackupStarted(JobID,EventTypeID,EventID,Destination,FileS-
+izeLimit,BandWidthLimit,StartTime)Actioncategory:logicalEventbackupprogressnoti-
+fication:backupstarted.
+Parameter Function
+jobID JobID BackupjobID.
+eventtype EventTypeID Typeoftheevent.
+instanceID EventID InstanceIDoftheevent.
+destination Destination Destination.
+filesizelimit FileSizeLimit Filesizelimit.
+bandwidthlimit BandWidthLimit Bandwidthlimit.
+starttime StartTime Backupstarttime.
+Startautobackup
+Actionname:StartAutoBackup(Schedule)Actioncategory:logicalStartautobackup.
+Parameter Function
+schedule Schedule Schedule.
+Cameracontrol
+ActionstosetandcontrolPTZ/normalcameras.
+Note:Whichcameratypesaresupportedalwaysdependsonmodelandman-
+ufacturer!
+Autofocusoff
+Actionname:AutoFocusOff(PTZHead)
+Actioncategory:command
+Thisactiondisablestheauto-focusfunctionofthecamera.
+
+────────────────────────────────────────────────────────────────────────────────
+Page 58
+────────────────────────────────────────────────────────────────────────────────
+
+Parameter Function
+PTZhead Camera Globalcameranumber
+Autofocuson
+Actionname:AutoFocusOn(PTZHead)
+Actioncategory:command
+Thisactionenablestheauto-focusfunctionofthecamera.
+Parameter Function
+PTZhead Camera Globalcameranumber
+Camerabacklightcompensationmode
+Actionname:CameraBacklightCompensationMode(PTZHead,mode)
+Category:command
+Thisactionchangesthebacklightcompensationofthecamera.
+Parameter Function
+PTZhead Camera Globalcameranumber
+mode Mode off=backlightcompensationisturnedoff
+on=backlightcompensationisturnedon
+Cameraclearpresettext
+Actionname:CameraClearPresetText(PTZHead,position)
+Category:command
+Thisactionclearsthetextthatwaspreviouslydefinedandassignedtoaparticularcamera
+positionbytheaction“CameraSetPresetText”anddisplayedwhenthecameramovesto
+thisposition.
+Parameter Function
+PTZhead Camera Globalcameranumber
+position Position Numberofthecamerapositionforwhichthe
+previouslydefinedtext(bytheaction“Cam-
+eraSetPresetText”)hastobecleared.
+Cameraday/nightmode
+Actionname:CameraDayNightMode(PTZHead,mode)
+Category:command
+Thisactionchangestheday/nightmodeofthecamera.
+Parameter Function
+PTZhead Camera Globalcameranumber
+mode Mode day=daymodeisactivated
+night=nightmodeisactivated
+auto=thecamerachangesautomatically
+betweendayandnightmode
+Cameralightoff
+Actionname:CameraLightOff(PTZHead)
+Category:command
+Thisactionturnsthecameralightoff.
+
+────────────────────────────────────────────────────────────────────────────────
+Page 59
+────────────────────────────────────────────────────────────────────────────────
+
+Parameter Function
+PTZhead Camera Globalcameranumber
+Cameralighton
+Actionname:CameraLightOn(PTZHead)
+Category:command
+Thisactionturnsthecameralighton.
+Parameter Function
+PTZhead Camera Globalcameranumber
+Cameramanualirisoff
+Actionname:CameraManualIrisOff(PTZHead)
+Category:command
+Thisactiondisablestheoptiontoadjustthecamerairismanually.
+Parameter Function
+PTZhead Camera Globalcameranumber
+Cameramanualirison
+Actionname:CameraManualIrisOn(PTZHead)
+Category:command
+Thisactionenablestheoptiontoadjustthecamerairismanually.
+Parameter Function
+PTZhead Camera Globalcameranumber
+Cameraoff
+Actionname:CameraOff(PTZHead)
+Category:command
+Thisactionturnsoffthecamera.
+Parameter Function
+PTZhead Camera Globalcameranumber
+Cameraon
+Actionname:CameraOn(PTZHead)
+Category:command
+Thisactionturnsonthecamera.
+Parameter Function
+PTZhead Camera Globalcameranumber
+Camerapumpoff
+Actionname:CameraPumpOff(PTZHead)
+Category:command
+Thisactiondisablesthepumpofthecamera.
+Parameter Function
+PTZhead Camera Globalcameranumber
+
+────────────────────────────────────────────────────────────────────────────────
+Page 60
+────────────────────────────────────────────────────────────────────────────────
+
+Camerapumpon
+Actionname:CameraPumpOn(PTZHead)
+Category:command
+Thisactionenablesthepumpofthecamera.
+Parameter Function
+PTZhead Camera Globalcameranumber
+CameraRAWoutput
+Actionname:CameraRAWOutput(PTZHead,output)
+Category:command
+Thisactionsendsarawstring(parameteroutput)tothecamera.
+Parameter Function
+PTZhead Camera Globalcameranumber
+output Output rawstring
+Thefollowingescapesequencesaresup-
+ported:
+\\a,b,f,n,r,t,v=>\a,b,f,n,r,t,v
+\\\=>\\
+\\‘ =>\‘ 
+\“ =>\“ 
+\Xhhor\xhh=>ASCII-character
+Cameraselectcharmode
+Forinternaluseonly
+Camerasetpresettext
+Actionname:CameraSetPresetText(PTZHead,position)
+Category:command
+Withthisaction,onedefinesthetextthatisassociatedwithaparticularcameraposition
+anddisplayedwhenthecameramovestothisposition.
+Parameter Function
+PTZhead Camera Globalcameranumber
+position Position Numberofthecameraforwhichthetextis
+defined.
+CameraspecfuncUoff
+Actionname:CameraSpecFuncUOff(PTZHead)
+Category:command
+Specialfunctionsaremappedtothisaction.
+(MBegfunctionsX,Y,UandV).
+Parameter Function
+PTZhead Camera Globalcameranumber
+CameraspecfuncUon
+Actionname:CameraSpecFuncUOn(PTZHead)
+Category:command

SOURCES/GeViScope_SDK_text/GeViScope_SDK_pages_061-070.txt

@@ -0,0 +1,482 @@
+================================================================================
+GeViScope_SDK.pdf - Pages 61 to 70
+================================================================================
+
+
+────────────────────────────────────────────────────────────────────────────────
+Page 61
+────────────────────────────────────────────────────────────────────────────────
+
+Specialfunctionsaremappedtothisaction.
+(MBegfunctionsX,Y,UandV).
+Parameter Function
+PTZhead Camera Globalcameranumber
+CameraspecfuncVoff
+Actionname:CameraSpecFuncVOff(PTZHead)
+Category:command
+Specialfunctionsaremappedtothisaction.
+(MBegfunctionsX,Y,UandV).
+Parameter Function
+PTZhead Camera Globalcameranumber
+CameraspecfuncVon
+Actionname:CameraSpecFuncVOn(PTZHead)
+Category:command
+Specialfunctionsaremappedtothisaction.
+(MBegfunctionsX,Y,UandV).
+Parameter Function
+PTZhead Camera Globalcameranumber
+CameraspecfuncXoff
+Actionname:CameraSpecFuncXOff(PTZHead)
+Category:command
+Specialfunctionsaremappedtothisaction.
+(MBegfunctionsX,Y,UandV).
+Parameter Function
+PTZhead Camera Globalcameranumber
+CameraspecfuncXon
+Actionname:CameraSpecFuncXOn(PTZHead)
+Category:command
+Specialfunctionsaremappedtothisaction.
+(MBegfunctionsX,Y,UandV).
+Parameter Function
+PTZhead Camera Globalcameranumber
+CameraspecfuncYoff
+Actionname:CameraSpecFuncYOff(PTZHead)
+Category:command
+Specialfunctionsaremappedtothisaction.
+(MBegfunctionsX,Y,UandV).
+Parameter Function
+PTZhead Camera Globalcameranumber
+
+────────────────────────────────────────────────────────────────────────────────
+Page 62
+────────────────────────────────────────────────────────────────────────────────
+
+CameraspecfuncYon
+Actionname:CameraSpecFuncYOn(PTZHead)
+Category:command
+Specialfunctionsaremappedtothisaction.
+(MBegfunctionsX,Y,UandV).
+Parameter Function
+PTZhead Camera Globalcameranumber
+Camerastopall
+Actionname:CameraStopAll(PTZHead)
+Category:command
+Thisactionstopsallmovementsofthecamera.
+Parameter Function
+PTZhead Camera Globalcameranumber
+Cameratextoff
+Actionname:CameraTextOff(PTZHead)
+Category:command
+Thisactionturnsoffthetextdisplayofthecamera.
+Parameter Function
+PTZhead Camera Globalcameranumber
+Cameratexton
+Actionname:CameraTextOn(PTZHead)
+Category:command
+Thisactionturnsonthetextdisplayofthecamera.
+Parameter Function
+PTZhead Camera Globalcameranumber
+Cameratourstart
+Actionname:CameraTourStart(PTZHead,tourID,tourname)
+Category:command
+Thisactionstartsapre-definedtour.
+Parameter Function
+PTZhead Camera Globalcameranumber
+tourid TourID Tourid.
+tourname TourName Tourname.
+Cameratourstop
+Actionname:CameraTourStop(PTZHead)
+Category:command
+Thisactionstopsarunningtour.
+Parameter Function
+PTZhead Camera Globalcameranumber
+
+────────────────────────────────────────────────────────────────────────────────
+Page 63
+────────────────────────────────────────────────────────────────────────────────
+
+Cameraversionoff
+Actionname:CameraVersionOff(PTZHead)
+Category:command
+Withthisactionthefirmwareversionofthecamerawillbehidden.
+Parameter Function
+PTZhead Camera Globalcameranumber
+Cameraversionon
+Actionname:CameraVersionOn(PTZHead)
+Category:command
+WiththisactionthefirmwareversionofthecamerawillbeshownasOSD.
+Parameter Function
+PTZhead Camera Globalcameranumber
+Camerawash-wipeoff
+Actionname:CameraWashOff(PTZHead)
+Category:command
+Thisactiondisablesthefunctions“wash”and“wipe”.
+Parameter Function
+PTZhead Camera Globalcameranumber
+Camerawash-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 64
+────────────────────────────────────────────────────────────────────────────────
+
+Clearpresetposition
+Actionname:CameraPresetPosition(PTZHead,position)
+Category:command
+Thisactiondeletesapositionpreviouslysavedbytheaction“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 65
+────────────────────────────────────────────────────────────────────────────────
+
+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/openingaperture.
+Parameter Function
+PTZhead Camera Thecamerastops
+closing/opening
+aperture
+Movetoabsoluteposition
+Forinternaluseonly
+Movetobyspeed
+Forinternaluseonly
+Movetorelativeposition
+Forinternaluseonly
+
+────────────────────────────────────────────────────────────────────────────────
+Page 66
+────────────────────────────────────────────────────────────────────────────────
+
+Panauto
+Actionname:PanAuto(Camera,Modus)
+Actioncategory:command
+Cameraswithoutautomaticendstopturnonandonuntilthisfunctionisstoppedthroughthe
+action"PanStop".Cameraswithautomaticendstopdostopautomaticallyaftera360turn.
+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
+Thecameramovestoapresetpositiondeterminedinadvancethroughtheaction"SavePre-
+setPosition".
+Parameter Function
+PTZhead Camera Globalcameranumber
+position Position Numberofselectedpresetposition.
+Theamountofpositionstosavedependson
+
+────────────────────────────────────────────────────────────────────────────────
+Page 67
+────────────────────────────────────────────────────────────────────────────────
+
+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
+Thisactionsavesthecameradescriptioninaccordancewiththeparameter“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 68
+────────────────────────────────────────────────────────────────────────────────
+
+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
+Cashmanagementactions
+CashManagementActionsoffertheexchangeofaccompanyingmetadatabetweenCash
+ManagementSystemsandGeViScope/Re_porter.Withtheseactionsmoneyhandlingpro-
+cessescanbedocumentedconsistentlyviavideo.Theuseoftheseactionsforstartingand
+restartingofeventrecordingsleadstothedisplayoftheaccompanyingvideodatainlive
+
+────────────────────────────────────────────────────────────────────────────────
+Page 69
+────────────────────────────────────────────────────────────────────────────────
+
+streamsofGscViewandthestorageofthoseinthevideodatabase.Thevideosequences
+recordedbyCashManagementActionscanlaterberecoveredeasilyinGscViewbyusing
+theaccompanyingmetadataandaspecialdatafilterdialog.
+Safebagclose
+Actionname:SafebagClose(WorkingPlace,StartTime,StopTime,SafebagNo,Safe-
+bagInfo,StepID,Debit,Total,Difference,HasDifference,Notes,Coins,Cheques)
+Actioncategory:logical
+Safebagclose.
+TheintegratedCashManagementSystemsendstheactionassoonastheuserhasfin-
+ishedthecountingofonesafebagandhasconfirmedthattotheCashManagementSystem
+.
+Viatheparameter"workingplace"theaffectedworkingplacewillbeidentified.Thefurther
+parameterwillbeprovidedwithaccompanyingvideodatabyCashManagementSystem.
+Theparameter"StepID"canbeprovidedwithacodefigurebytheCashManagementSys-
+temforthecurrentlyrunningprocessstep.
+Parameter Function
+working
+place
+WorkingPlaceWorkingplaceno.
+starttimeStartTime Timestamp,whenthehandlingofthesafebagbegan.
+stoptimeStopTime Timestamp,whenthehandlingofthesafebagstopped.
+safebag
+no.
+SafebagNoAlphanumericalidentificationofsafebag;searchcriteriainGscView
+safebag
+info
+SafebagInfoAdditionalalphanumericalidentificationofsafebag
+stepid StepID Codefigureforthecurrentlyrunningprocessstep(givenbyCashMan-
+agementSystemindividually)
+debit Debit Debitamountofsafebag
+total Total Effectivetotalamountofsafebagaccordingtocounting(willbeaccu-
+mulatedbyCashManagementSystemsoncounting)
+differenceDifference Differencebetweentotalamountandresultrespectivelyprogressof
+counting
+hasdif-
+ference
+HasDifferenceYes=currenttotalamounthasadifferencetodebitamount
+No=currenttotalamountisidenticalwithdebitamount
+notes Notes Denominationofcountedbanknotes.TheDisplayinGscViewisintable
+form.Thetablehasmax.2columns.Theindividuallinescanbesep-
+aratedviainsertionofcontrol'\r'(0x0D).Theseparationofboth
+columnswithinonelinecanbecarriedoutviainsertionofcontrol'\t'
+(0x09).
+coins Coins Denominationofcountedcoins.TheDisplayinGscViewisintable
+form.Thetablehasmax.2columns.Theindividuallinescanbesep-
+aratedviainsertionofcontrol'\r'(0x0D).Theseparationofboth
+columnswithinonelinecanbecarriedoutviainsertionofcontrol'\t'
+(0x09).
+chequesCheques Denominationofcountedcheques.TheDisplayinGscViewisintable
+form.Thetablehasmax.2columns.Theindividuallinescanbesep-
+aratedviainsertionofcontrol'\r'(0x0D).Theseparationofboth
+columnswithinonelinecanbecarriedoutviainsertionofcontrol'\t'
+(0x09).
+
+────────────────────────────────────────────────────────────────────────────────
+Page 70
+────────────────────────────────────────────────────────────────────────────────
+
+Safebagdata
+Actionname:SafebagData(WorkingPlace,StartTime,SafebagNo,SafebagInfo,StepID,
+Debit,Total,Difference,HasDifference,Notes,Coins,Cheques)
+Actioncategory:command
+Safebagdata.
+TheintegratedCashManagementSystemsendstheactionassoonastheuserhasfin-
+ishedcountingonevarietyofnotesorcoinsandhasconfirmedthattothesystem.
+Viatheparameter"workingplace"theaffectedworkingplacewillbeidentified.Thefurther
+parameterwillbeprovidedwithaccompanyingmetadatabytheCashManagementSys-
+tem.
+Theparameter"StepID"canbeprovidedwithacodefigurebytheCashManagementSys-
+temforthecurrentlyrunningprocessstep.
+Parameter Function
+working
+place
+WorkingPlaceWorkingplaceno.
+starttimeStartTime Timestamp,whenthehandlingofthesafebagbegan.
+safebag
+no.
+SafebagNoAlphanumericalidentificationofsafebag;searchcriteriainGscView
+safebag
+info
+SafebagInfoAdditionalalphanumericalidentificationofsafebag
+stepid StepID Codefigureforthecurrentlyrunningprocessstep(givenbycashman-
+agementsystemindividually
+debit Debit Debitamountofsafebag
+total Total Effectivetotalamountofsafebagaccordingtocounting( willbeaccu-
+mulatedbytheCashmanagementSystemduringcounting)
+differenceDifference Differencebetweentotalamountandresultrespectivelyprogressof
+counting
+hasdif-
+ference
+HasDifferenceYes=currenttotalamounthasadifferencetodebitamount
+No=currenttotalamountisidenticalwithdebitamount
+notes Notes Denominationofcountedbanknotes.TheDisplayinGscViewisintable
+form.Thetablehasmax.2columns.Theindividuallinescanbesep-
+aratedviainsertionofcontrol'\r'(0x0D).Theseparationofboth
+columnswithinonelinecanbecarriedoutviainsertionofcontrol'\t'
+(0x09).
+coins Coins Denominationofcountedcoins.TheDisplayinGscViewisintable
+form.Thetablehasmax.2columns.Theindividuallinescanbesep-
+aratedviainsertionofcontrol'\r'(0x0D).Theseparationofboth
+columnswithinonelinecanbecarriedoutviainsertionofcontrol'\t'
+(0x09).
+chequesCheques Denominationofcountedcheques.TheDisplayinGscViewisintable
+form.Thetablehasmax.2columns.Theindividuallinescanbesep-
+aratedviainsertionofcontrol'\r'(0x0D).Theseparationofboth
+columnswithinonelinecanbecarriedoutviainsertionofcontrol'\t'
+(0x09).
+Safebagopen
+Actionname:SafebagOpen(WorkingPlace,StartTime,SafebagNo,SafebagInfo,StepID)
+Actioncategory:notification
+Safebagopen.
+TheintegratedCashManagementSystemsendstheactionassoonastheuserhasopened
+thesafebagandconfirmedthatwithanentryintheCashManagementSystem.

SOURCES/GeViScope_SDK_text/GeViScope_SDK_pages_071-080.txt

@@ -0,0 +1,539 @@
+================================================================================
+GeViScope_SDK.pdf - Pages 71 to 80
+================================================================================
+
+
+────────────────────────────────────────────────────────────────────────────────
+Page 71
+────────────────────────────────────────────────────────────────────────────────
+
+TheaffectedWorkingPlacewillbeidentifiedviatheparameter"Workingplace".Further
+parameterswillbefilledwithaccompanyingmetadataonthepartoftheCashManagement
+System.
+TheParameter"StepID"canbeaddressedbytheCashManagementSystemwithacode
+figureforthecurrentlyrunningprocessstep.
+Parameter Function
+working
+place
+WorkingPlaceWorkingplaceno.
+starttimeStartTime Timestamp,whenthehandlingofthesafebagbegan.
+safebag
+no.
+SafebagNoAlphanumericalidentificationofsafebag;searchcriteriainGscView
+safebag
+info
+SafebagInfoAdditionalalphanumericalidentificationofsafebag
+stepid StepID Codefigureforthecurrentlyrunningprocessstep(givenbycashman-
+agementsystemindividually
+Safebagpassingofriskdata
+Actionname:SafebagPassingOfRiskData(WorkingPlace,StartTime,SafebagNo,Safe-
+bagInfo,StepID,UserID1,UserID2,TourNumber,TargetWorkingPlace,
+PassingOfRiskType)
+Actioncategory:command
+TheintegratedCashManagementSystemsendstheactioncontinuouslyforeachsafebag
+whiletheamountofsafebagsbetweentwoemployeeswillbetransferredandthiswillbe
+confirmedtotheCashManagementSystem.Thispartofthemoneyhandlingprocessisa
+"passingofrisk".Viatheparameter"workingplace"theaffectedtransferplaceandrespect-
+ivelytheworkingplacewillbeidentified.Thefurtherparameterswillbefilledwithaccom-
+panyingvideodatabytheCashManagementSystem.Theparameter"StepID"canbe
+providedwithacodefigurebytheCashManagementSystemforthecurrentlyrunningpro-
+cessstep.
+Parameter Function
+working
+place
+WorkingPlace Workingplaceno.
+starttime StartTime Timestamp,whenthehandlingofthesafebagbegan.
+safebagno.SafebagNo Alphanumericalidentificationofsafebag;searchcriteriain
+GscView
+safebag
+info
+SafebagInfo Additionalalphanumericalidentificationofsafebag
+stepid StepID Codefigureforthecurrentlyrunningprocessstep(givenby
+cashmanagementsystemindividually
+user1 UserID1 Numberofemployee,transferringthesafebagtoanother
+employee.
+user2 UserID2 Numberofemployee,whoreceivesthesafebagfromanother
+employee.
+tourno TourNumber Tour-Number(optional)
+targetwork-
+ingplace
+TargetWorkingPlaceAlphanumericalidentificationofaplacerespectivelyaworking
+placewheresafebagswillbetransferredto(optional)
+passingof
+risktype
+PassingOfRiskTypeDetailedinformationto"passingofrisk"(optional)
+
+────────────────────────────────────────────────────────────────────────────────
+Page 72
+────────────────────────────────────────────────────────────────────────────────
+
+Safebagpassingofriskstart
+Actionname:SafebagPassingOfRiskStart(WorkingPlace,StartTime,SafebagNo,Safe-
+bagInfo,StepID,UserID1,UserID2,TourNumber,TargetWorkingPlace,
+PassingOfRiskType)
+Actioncategory:command
+TheintegratedCashManagementSystemsendstheactionassoonasanumberofsafe
+bagswillbetransferredbetweentwoemployeesandthisisconfirmedtotheCashMan-
+agementSystem.Thispartofthemoneyhandlingprocessisa"passingofrisk".Viathe
+parameter"workingplace"theaffectedtransferplaceandrespectivelytheworkingplace
+willbeidentified.Thefurtherparameterswillbefilledwithaccompanyingmetadatabythe
+CashManagementSystem.Theparameter"StepID"canbeprovidedwithacodefigureby
+theCashManagementSystemforthecurrentlyrunningprocessstep.
+Parameter Function
+working
+place
+WorkingPlace Workingplaceno.
+starttime StartTime Timestamp,whenthehandlingofthesafebagbegan.
+safebagno.SafebagNo Alphanumericalidentificationofsafebag;searchcriteriain
+GscView
+safebag
+info
+SafebagInfo Additionalalphanumericalidentificationofsafebag
+stepid StepID Codefigureforthecurrentlyrunningprocessstep(givenby
+cashmanagementsystemindividually
+user1 UserID1 Numberofemployee,transferringthesafebagtoanother
+employee.
+user2 UserID2 Numberofemployee,whoreceivesthesafebagfromanother
+employee.
+tourno TourNumber Tour-Number(optional)
+targetwork-
+ingplace
+TargetWorkingPlaceAlphanumericalidentificationofaplacerespectivelyaworking
+placewheresafebagswillbetransferredto(optional)
+passingof
+risktype
+PassingOfRiskTypeDetailedinformationto"passingofrisk"(optional)
+Safebagpassingofriskstop
+Actionname:SafebagPassingOfRiskStop(WorkingPlace,StartTime,StopTime,Safe-
+bagNo,SafebagInfo,StepID,UserID1,UserID2,TourNumber,TargetWorkingPlace,
+PassingOfRiskType)
+Actioncategory:command
+TheintegratedCashManagementSystemsendstheactionclosingafterthelastsafebag,
+whilethenumberofsafebagswillbetransferredbetweentwoemployeesandthisiscon-
+firmedtotheCashManagementSystem.Thispartofthemoneyhandlingprocessisa
+"passingofrisk".Viatheparameter"Workingplace"theaffectedtransferplacerespective
+workingplacewillbeidentified.Thefurtherparameterswillbefilledwithaccompanying
+videodatabytheCashManagementSystem.Theparameter"StepID"canbesuppliedby
+CashManagementSystemwithacodefigureforacurrentlyrunningprocessstep
+Parameter Function
+working
+place
+WorkingPlace Workingplaceno.
+starttime StartTime Timestamp,whenthehandlingofthesafebagbegan.
+safebagno.SafebagNo Alphanumericalidentificationofsafebag;searchcriteriain
+
+────────────────────────────────────────────────────────────────────────────────
+Page 73
+────────────────────────────────────────────────────────────────────────────────
+
+Parameter Function
+GscView
+safebag
+info
+SafebagInfo Additionalalphanumericalidentificationofsafebag
+stepid StepID Codefigureforthecurrentlyrunningprocessstep(givenby
+cashmanagementsystemindividually
+user1 UserID1 Numberofemployee,transferringthesafebagtoanother
+employee.
+user2 UserID2 Numberofemployee,whoreceivesthesafebagfromanother
+employee.
+tourno TourNumber Tour-Number(optional)
+targetwork-
+ingplace
+TargetWorkingPlaceAlphanumericalidentificationofaplacerespectivelyaworking
+placewheresafebagswillbetransferredto(optional)
+passingof
+risktype
+PassingOfRiskTypeDetailedinformationto"passingofrisk"(optional)
+Deviceinformation
+Allactionsforlow-levelnotificationofthedeviceormediachannelschanges.
+Devicefound
+Actionname:DeviceFound(Type,Name,Serial)
+Actioncategory:logical
+ThisactionwillbefiredwhentheUSBorNETdeviceisconnectedtothesystem.Itisalso
+firedatstart-upforalldetecteddevices.
+Parameter Function
+devicetypeTypeTypeofthedevice.
+devicenameNameDevicenameifassignedinsetup,emptyotherwise.
+serialID SerialSerialIDofthedevice.
+Newfirmwarereceived
+Actionname:DeviceNewFirmware(Type,Name,Serial,Firmware)
+Actioncategory:logical
+ThisactionwillbefiredwhentheUSBorNETdevicehasgotthenewfirmware.
+Parameter Function
+devicetype Type Typeofthedevice.
+devicename Name Devicenameifassignedinsetup,emptyotherwise.
+serialID Serial SerialIDofthedevice.
+firmwareserialFirmwareSerialIDofthefirmware.
+Devicepluginerror
+Actionname:DevicePluginError(Channel,Type,SubType,Name,Serial,ErrorClass,
+ErrorCode,Description)
+Actioncategory:logical
+Thisactionnotifiesdevicepluginerror.
+Parameter Function
+channel Channel Channel.
+devicetype Type Typeofthedevice.
+devicesubtypeSubType Subtypeofthedevice.
+
+────────────────────────────────────────────────────────────────────────────────
+Page 74
+────────────────────────────────────────────────────────────────────────────────
+
+Parameter Function
+devicename Name Devicename.
+serialID Serial SerialIDofthedevice.
+errorclass ErrorClassErrorclassoftheerroroccured.
+errorcode ErrorCodePlugintypespecificerrorcode.
+description DescriptionErrordescription.
+Devicepluginstate
+Actionname:DevicePluginState(Channel,Type,SubType,Name,Serial,State,Intern-
+alState,Description)
+Actioncategory:logical
+Thisactionnotifiesdevicepluginstate.
+Parameter Function
+channel Channel Channel.
+devicetype Type Typeofthedevice.
+devicesubtypeSubType Subtypeofthedevice.
+devicename Name Devicename.
+serialID Serial SerialIDofthedevice.
+pluginstate State Newplugindevicestate.
+internalstate InternalStatePlugindevicespecificstate.
+description DescriptionStatedescription.
+Devicereattached
+Actionname:DeviceReattached(Type,Name,Serial)
+Actioncategory:logical
+ThisactionwillbefiredwhentheUSBorNETdeviceisreattachedtothesystem.
+Parameter Function
+devicetypeTypeTypeofthedevice.
+devicenameNameDevicenameifassignedinsetup,emptyotherwise.
+serialID SerialSerialIDofthedevice.
+Deviceremoved
+Actionname:DeviceRemoved(Type,Name,Serial)
+Actioncategory:logical
+ThisactionwillbefiredwhentheUSBorNETdeviceisdisconnectedfromthesystem.Itis
+alsofiredatthestart-upforallparameterizedbutnotpresentdevices.
+Parameter Function
+devicetypeTypeTypeofthedevice.
+devicenameNameDevicenameifassignedinsetup,emptyotherwise.
+serialID SerialSerialIDofthedevice.
+Digitalcontacts
+Allactionsforhandlingdigitalinputsandoutputs.
+Digitalinput
+Actionname:DigitalInput(Contact,State)
+
+────────────────────────────────────────────────────────────────────────────────
+Page 75
+────────────────────────────────────────────────────────────────────────────────
+
+Actioncategory:logical
+Thisactionwillbefiredwhenthestateofthedigitalinputhaschanged.
+Parameter Function
+contactContactContact.
+state State Newstate.
+IOI43resetmainboard
+Actionname:IOI43ResetMainboard()
+Actioncategory:logical
+ResetmainboardusingIOI43a/abUSBAlarm-I/O.
+IOI43temperaturenotification
+Actionname:IOI43Temperature(ID,Temperature)
+Actioncategory:logical
+TemperaturenotificationfromIOI43a/abUSBAlarm-I/O.
+Parameter Function
+ID ID IDoftheIOI43module(likeIOI43-00).
+temperatureTemperatureTemperature.
+IOI43watchdogactivate
+Actionname:IOI43WDActivate()
+Actioncategory:logical
+ActivatewatchdogonIOI43a/abUSBAlarm-I/O.
+IOI43watchdogdeactivate
+Actionname:IOI43WDDeactivate()
+Actioncategory:logical
+DeactivatewatchdogonIOI43a/abUSBAlarm-I/O.
+IOI43watchdogtrigger
+Actionname:IOI43WDTrigger()
+Actioncategory:logical
+TriggerwatchdogonIOI43a/abUSBAlarm-I/O.
+Keypressed
+Actionname:KeyPressed(Key)
+Actioncategory:logical
+ThisactionisnotifiedifoneoftheGEVISCOPEsystemkeysispressed.
+ParameterFunction
+Key Key Systemkey.
+Keyreleased
+Actionname:KeyReleased(Key)
+Actioncategory:logical
+ThisactionisnotifiedifoneoftheGEVISCOPEsystemkeysisreleased.
+
+────────────────────────────────────────────────────────────────────────────────
+Page 76
+────────────────────────────────────────────────────────────────────────────────
+
+ParameterFunction
+Key Key Systemkey.
+Setdigitaloutput
+Actionname:SetDigitalOutput(Contact,State)
+Actioncategory:logical
+Thisactionisusedtomodifythestateofthedigitaloutputandtonotifythischange.
+Parameter Function
+contactContactContact.
+state State Newstate.
+SetsystemLED
+Actionname:SetLED(LED,State)
+Actioncategory:logical
+ThisactionisusedtoturnthesystemLEDsonoroff.
+ParameterFunction
+LED LED SystemLED.
+stateStateNewstate.
+SetsystemLEDtoblink
+Actionname:SetLEDBlink(LED,LedTimeOnMs,LedTimeOffMs)
+Actioncategory:logical
+ThisactionisusedtoblinkthesystemLEDs.
+Parameter Function
+LED LED SystemLED.
+LedtimeON LedTimeOnMsTimeinmillisecondstheLEDwillbeswitchedon.
+LedtimeOFFLedTimeOffMsTimeinmillisecondstheLEDwillbeswitchedoff.
+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
+device
+SecondaryDevice TheIDofthesecondarydevicewherethiseventori-
+ginated.
+cardnumberCardNumber ThebadgeIDforthecardthatwasread,ifavailable.
+accessresultAccessResult Thelevelofaccessthatwasgrantedthatresultedfrom
+readingthecard.
+
+────────────────────────────────────────────────────────────────────────────────
+Page 77
+────────────────────────────────────────────────────────────────────────────────
+
+Parameter Function
+type Type Eventtypei.e.,duress,system,etc.
+subtype SubType Eventsub-typei.e.,granted,doorforcedopen,etc.
+descriptionDescription Ahumanreadable,briefdescriptionofthisevent.
+serialnumberSerialNumber Anumberthatuniquelyidentifiestheinstanceofthe
+eventforaparticularpanel.
+timestamp TimeStamp Timestamp.
+areaenteredAreaEnteredID TheIDoftheareathatwasentered,ifany.
+areaexited AreaExitedID TheIDoftheareathatwasexited,ifany.
+assetID AssetID TheIDoftheassetrelatedtothisevent,ifany.
+cardholder
+entered
+CardholderEnteredWhetherentrywasmadebythecardholder.
+duress Duress Indicateswhetherthiscardaccessindicatesanunder
+duress/emergencystate.
+elevatorfloorElevatorFloor Theelevatorflooronwhichtheaccesseventwasgen-
+erated,ifany.
+facilitycode FacilityCode Thefacilitycodeforthecardthatwasread,ifavailable.
+readablecardIsReadableCard Whetherthecardcouldberead.
+issuecode IssueCode Theissuecodeforthecardthatwasread,ifavailable.
+serverhost CommServerHostNameHostnameoftheCommunicationserverthroughwhich
+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
+device
+SecondaryDevice TheIDofthesecondarydevicewherethiseventori-
+ginated.
+troublecodeTroubleCode Atroublecodeassociatedwiththefireevent.
+type Type Eventtypei.e.,duress,system,etc.
+subtype SubType Eventsub-typei.e.,granted,doorforcedopen,etc.
+descriptionDescription Ahumanreadable,briefdescriptionofthisevent.
+serialnum-
+ber
+SerialNumber Anumberthatuniquelyidentifiestheinstanceoftheevent
+foraparticularpanel.
+timestampTimeStamp Timestamp.
+serverhost CommServerHostNameHostnameoftheCommunicationserverthroughwhichthe
+eventarrived.
+eventtext EventText Textassociatedwithevent
+Lenelintercomevent
+Actionname:LenelIntercomEvent(ID,Panel,Device,SecondaryDevice,IntercomData,
+LineNumber,Type,SubType,Description,SerialNumber,TimeStamp,Com-
+mServerHostName,EventText)
+Actioncategory:logical
+LenelOnGuardintercomevent.
+
+────────────────────────────────────────────────────────────────────────────────
+Page 78
+────────────────────────────────────────────────────────────────────────────────
+
+Parameter Function
+ID ID TheIDthatuniquelyidentifiesthetypeofthisevent.
+panel Panel Thenameofthepanelwherethiseventoriginated.
+device Device Thenameofthedevicewherethiseventoriginated.
+secondary
+device
+SecondaryDevice TheIDofthesecondarydevicewherethiseventori-
+ginated.
+intercom
+data
+IntercomData Additionaldatafortheintercomeventthatoccurred.
+linenumberLineNumber Thelinenumberinvolvedintheintercomevent.
+type Type Eventtypei.e.,duress,system,etc.
+subtype SubType Eventsub-typei.e.,granted,doorforcedopen,etc.
+descriptionDescription Ahumanreadable,briefdescriptionofthisevent.
+serialnum-
+ber
+SerialNumber Anumberthatuniquelyidentifiestheinstanceoftheevent
+foraparticularpanel.
+timestampTimeStamp Timestamp.
+serverhost CommServerHostNameHostnameoftheCommunicationserverthroughwhichthe
+eventarrived.
+eventtext EventText Textassociatedwithevent
+Lenelrawdata
+Actionname:LenelRawData(TimeStamp,LenelData)
+Actioncategory:logical
+LenelOnGuardrawdata.
+Parameter Function
+timestampTimeStampTimestamp.
+data LenelDataLenelOnGuarddata.
+Lenelrefreshnames
+Actionname:LenelRefreshNames()
+Actioncategory:logical
+LenelOnGuardrefreshnames.
+Lenelsecurityevent
+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
+device
+SecondaryDevice TheIDofthesecondarydevicewherethiseventori-
+ginated.
+type Type Eventtypei.e.,duress,system,etc.
+subtype SubType Eventsub-typei.e.,granted,doorforcedopen,etc.
+descriptionDescription Ahumanreadable,briefdescriptionofthisevent.
+serialnum-
+ber
+SerialNumber Anumberthatuniquelyidentifiestheinstanceoftheevent
+foraparticularpanel.
+timestampTimeStamp Timestamp.
+serverhost CommServerHostNameHostnameoftheCommunicationserverthroughwhichthe
+eventarrived.
+
+────────────────────────────────────────────────────────────────────────────────
+Page 79
+────────────────────────────────────────────────────────────────────────────────
+
+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
+device
+SecondaryDevice TheIDofthesecondarydevicewherethiseventori-
+ginated.
+channel Channel Thephysicalchannelthecameraisconnectedtothatis
+creatingthisevent.
+type Type Eventtypei.e.,duress,system,etc.
+subtype SubType Eventsub-typei.e.,granted,doorforcedopen,etc.
+descriptionDescription Ahumanreadable,briefdescriptionofthisevent.
+serialnum-
+ber
+SerialNumber Anumberthatuniquelyidentifiestheinstanceoftheevent
+foraparticularpanel.
+timestampTimeStamp Timestamp.
+startstampStartTime Thetimethevideoeventstarted
+endtime EndTime Thetimethevideoeventended.
+serverhost CommServerHostNameHostnameoftheCommunicationserverthroughwhichthe
+eventarrived.
+eventtext EventText Textassociatedwithevent
+Logistic
+Logisticactionsareusedinthelogisticenvironmentwheremetadata,e.g.barcodes,is
+usedtostartrecordingevents.Later,aresearchonthebarcodesisdonetoshowthescan-
+ningoperationintherecordedimages.Tospeedupthesearch,aCRC32checksumisused
+asahashandservesasaforeignkeyoftheeventstartd.Theforeignkeyisindexedinthe
+eventtableancanthereforebefoundmuchfasterthanalookuponthestringitself.Addi-
+tionalparametersareusedtonotifypositioninginformationsincetheassignmentofscan-
+ningandrecordingcameraisoftendoneaccordingtothepositionofthescanner.
+Logbarcodedata
+Actionname:LogBarcodeData(Barcode,Hash,Scanner,AreaID,AreaName,Channel,
+TimeStamp)
+Actioncategory:notification
+Logisticbarcodedata.
+Parameter Function
+barcode Barcode Barcode.
+hashvalue Hash Hashvalueofbarcode(Optional)
+scannernameScanner ScannernameorIPAddress(Optional)
+areanumberAreaID Globalnumberofareaforeventmapping(Optional)
+
+────────────────────────────────────────────────────────────────────────────────
+Page 80
+────────────────────────────────────────────────────────────────────────────────
+
+Parameter Function
+areaname AreaNameAreaname(Optional)
+channel Channel Globalnumberofamediachannelformapping(Optional)
+timestamp TimeStampTimestamp(Optional)
+LogbarcodedataLPS
+Actionname:LogBarcodeDataLPS(Barcode,Hash,Scanner,AreaID,AreaName,Channel,
+TimeStamp,X,Y,Z,LpsTagID,LpsStatus,LpsCellID,LpsAreaID,UserParam)
+Actioncategory:notification
+Logisticbarcodedataincludingpositioningandareainformation.
+Parameter Function
+barcode Barcode Barcode.
+hashvalue Hash Hashvalueofthebarcode(Optional)
+scannernameScanner ScannernameorIPAddress(Optional)
+areanumberAreaID Globalnumberofareaforeventmapping(Optional)
+areaname AreaNameAreaname.(Optional)
+channel Channel Globalnumberofamediachannelformapping(Optional)
+timestamp TimeStampTimestamp(Optional)
+XcoordinateX Xcoordinateofthepositionquery(Optional)
+YcoordinateY Ycoordinateofthepositionquery(Optional)
+ZcoordinateZ Zcoordinateofthepositionquery(Optional)
+LPStagID LpsTagIDTagIDofthepositioningsystem(Optional)
+LPSstatus LpsStatusLPSstatusofthepositionquery(Optional)
+LPScellID LpsCellIDCellIDofthepositioningsystem(Optional)
+LPSareaID LpsAreaIDAreaIDofthepositioningsystem(Optional)
+Userparam UserParamUserparamforinternaluse(Optional)
+LogNPRrecognition
+Actionname:LogNPRRecognition(PlateNo,Hash,Country,Channel,TimeStamp,Restric-
+tion,Category)
+Actioncategory:logical
+LogNPRrecognition.
+Parameter Function
+plateno. PlateNo Recognizedplateno.
+hashvalueHash Hashvalueoftherecognizedplateno.(Optional)
+country Country Country(Optional)
+channel Channel Channel(Optional)
+timestampTimeStampTimestamp(Optional)
+restrictionRestrictionRestrictionofrecognizednumber(Optional)
+categoryCategoryCategoryofrecognizednumber(Optional)
+LPSActions
+LPS(LocalPositioningSystem)actionsareusedtoqueryandreceivepositiondata.The
+positioningsystemisintegratedbytheGscLPSpluginandisusedtolocatetaggedobjects,
+e.g.mobilescannersinthelogisticenvironment.ThetagshaveIDsthatcanbeusedto
+querythepositionwhichisthennotifiedascartesianorgeograficcoordinates.Sometags
+areabletoinitiateapositionrequestbyanexternaltriggerorbyascaneventonamobile
+scanner.

SOURCES/GeViScope_SDK_text/GeViScope_SDK_pages_081-090.txt

@@ -0,0 +1,522 @@
+================================================================================
+GeViScope_SDK.pdf - Pages 81 to 90
+================================================================================
+
+
+────────────────────────────────────────────────────────────────────────────────
+Page 81
+────────────────────────────────────────────────────────────────────────────────
+
+LPSpositiondata
+Actionname:LPSPositionData(TagID,ScannerID,X,Y,Z,Latitude,Longitude,AreaID,
+CellID,Status,TimeStamp,Data,AreaName)
+Actioncategory:logical
+LPSpositiondata.
+Parameter Function
+tagID TagID TagID.
+scannerID ScannerIDScannerIDorIPAddress.
+XcoordinateX Xcoordinateofcartesiancoordinates.
+YcoordinateY Ycoordinateofcartesiancoordinates.
+ZcoordinateZ Zcoordinateofcartesiancoordinates.
+Latitude Latitude Latitudeofgeographiccoordinates.
+LongitudeLongitudeLongitudeofgeographiccoordinates.
+areaID AreaID AreaID.
+cellID CellID CellID.
+status Status Status.
+timestampTimeStampTimestamp.
+data Data Datareceivedbythepositioningsystem,eg.barcode.
+areanameAreaNameAreaName.
+LPSqueryposition
+Actionname:LPSQueryPosition(TagID,ScannerID,Data)
+Actioncategory:command
+SendpositionqueryforaTagtoLPSserver.
+Parameter Function
+tagID TagID TagID.
+scannerIDScannerIDScannerIDorIPAddress.
+data Data Data.
+POS
+Pointsofsales(POS)Actionsenabletheexchangeofaccompanyingmetadatabetween
+POSManagementSystemsandGeViScope/re_porter.Withtheseactionspaymentpro-
+cessescanbedocumentedconsistentlybyvideo.Theuseoftheseactionsforstartandre-
+startofeventrecordingsleadstotheoutputofaccompanyingmetadatainlivevideoin
+GSCViewaswellasinthestorageofthoseinthevideodatabase.Thevideosequences
+recordedviaPOSActionscaneasilyberetrievedinGscViewusingtheaccompanyingmeta
+dataundspecialdatafilterdialogs(optional)BesidestheactionsPOSStatusandPOSData
+forthegeneralintegrationintoPOSManagementSystemstherearealsoPOSactions
+whichbelongtospecialGeViScopedrivers.TheactionsFillingPumpStatus,Ter-
+minalArticleDataandTerminalPaymentDataareusedbythedriver"HUTH".Thedriver
+"HUTH"isaGeViScopeMediaPlugin,whichwasdevelopedbyGEUTEBRÜCK,tointeg-
+ratefillingstationmanagementsystemsofthemanufacturerHUTHElektronikSysteme
+GmbHintoGeViScope/re_porter.ThedriveriscompatibletoHUTHVideoInterface
+T400/T450/Maxi/miniV1.2.TheactionsInterfaceRawDataandInterfaceRawAnswerare
+alsousedbythedriver"HUTH".Buttheyonlyservefordebuggingandfaultanalysispur-
+pose.Theycanalsobeusedingeneralforanylinkthattheconcernedactionsupports-
+respectivelyusestheseactions.TheactionBarcodeDataservesasageneralintegrationof
+barcodescanners.
+
+────────────────────────────────────────────────────────────────────────────────
+Page 82
+────────────────────────────────────────────────────────────────────────────────
+
+Barcodedata
+Actionname:BarcodeData(ReaderName,TimeStamp,Barcode)
+Actioncategory:notification
+ThePOSManagementSystem(oranyothersystemlikebarcodescannerorsimilar)sends
+theactionassoonasabarcodewasread.Viatheparameter"ReaderName"theaffected
+barcodescannerwillbeidentified.Thefurtherparameterwillbefilledwithvideometadata
+bythePOSManagementSystem.
+Parameter Function
+scanner ReaderNameAlphanumericalidentificationofthebarcodescanner
+timestamp TimeStamp Timestamp.
+code Barcode Alphanumericalfieldforrecordingthescannedbarcode.
+Fillingpumpstatus
+Actionname:FillingPumpStatus(TerminalName,TimeStamp,PumpNo,Status,Amount,
+Price,Details)Actioncategory:notification
+The"HUTH"driversendstheactionforeachstatuschangeofonefillingpump.Viathepara-
+meter"TerminalName"theconcerneddevicewillbeidentified.The"HUTH"driverisprin-
+cipallyabletobuildupseveralconnectionstodifferentHuthdevices.Thedriversendsthe
+alphanumericalvaluedefinedinhissetupas"Interfacename".Thefurtherparameterwillbe
+filledwithvideometadatabythedriver.
+Parameter Function
+Terminal TerminalNameIdentifiestheaffecteddevice.The"HUTH"driverisprin-
+cipallyabletobuildupseveralconnectionstodifferentHuth
+devices.Thedriversendsthealphanumericalvaluedefined
+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"disconnectafterfilling"
+Amountmessage=sum-respectivelyamountnoticeofthe
+fillingpump
+amount Amount Amountofthebooking(optional)
+price Price Sumofthebooking(optional)
+details Details Freetext(optional)
+Interfacerawanswer
+Actionname:InterfaceRawAnswer(InterfaceName,TimeStamp,Data)
+Actioncategory:notification
+Thisactionisusedbythe"HUTH"driver.".Itservesonlyasadebugserviceandcanalso
+beusedingeneralforanyintegrationthatsupportsorusesthisaction.The"HUTH"driver
+sendstheactionforeachtelegramithassenttotheenddevice.Theaffectedenddevice
+willbeidentifiedbytheparameter"TerminalName".The"HUTH"drivercanalwaysbuildup
+numerousconnectionstodifferentHuthdevices.Thedriverthensendsthealphanumerical
+valuedefinedinitssetupas"Interfacename"Thefurtherparameterwillbefilledwithvideo
+metadatabythedriver.
+
+────────────────────────────────────────────────────────────────────────────────
+Page 83
+────────────────────────────────────────────────────────────────────────────────
+
+Parameter Function
+interface InterfaceNameIdentifiestheaffectedenddevice.The"HUTH"driverisprin-
+cipallyabletobuildupseveralconnectionstodifferentHuth
+devices.Thedriversendsthealphanumericalvaluedefined
+inhissetupas"Interfacename".
+timestamp TimeStamp TimeStampwhenthetelegramwasreceivedfromtheHuth
+system.
+answer Data Thesenttelegraminrawformat.
+Interfacerawdata
+Actionname:InterfaceRawData(InterfaceName,TimeStamp,Data)
+Actioncategory:notification
+Thisactionisusedbythedriver"HUTH".Itservesonlyasadebugserviceandcanalsobe
+usedingeneralforanyintegrationthatsupportsorusesthisaction.The"HUTH"driver
+sendstheactionforeachtelegramithasreceivedfromtheenddevice.Theaffectedend
+devicewillbeidentifiedbytheparameter"TerminalName".The"HUTH"drivercanalways
+buildupnumerousconnectionstodifferentHuthdevices.Thedriverthensendsthealpha-
+numericalvaluedefinedinitssetupas"Interfacename"Thefurtherparameterwillbefilled
+withvideometadatabythedriver.
+Parameter Function
+interface InterfaceNameIdentifiestheaffectedenddevice.The"HUTH"driverisprin-
+cipallyabletobuildupseveralconnectionstodifferentHuth
+devices.Thedriversendsthealphanumericalvaluedefined
+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
+ThePOSManagementSystemsendstheactionforeachtransactioncarriedoutatacash
+point
+Viatheparameter"POS"theaffectedcashpointwillbeidentified.Thefurtherparameterwill
+befilledwithvideometadatabythePOSManagementSystem
+Parameter Function
+POS POSName Alphanumericalidentificationofthecashpoint
+timestamp TimeStamp TimeStamp,whentheactionwassendfromthePOSman-
+agementsystem
+article Article Identificationofthebookedarticle(optional)
+price Price Amount(singlepricemultipliedwithnumberofarticles)of
+transaction(optional)
+units Units Amountofarticlesofthetransaction(optional)
+priceperunit PricePerUnit Singlearticlepriceofthetransaction(optional)
+line1 Line1 Alphanumericalfields/sectionsforstoringofadditional
+informationconcerningthetransactionorforstoringinform-
+ationwhichhavebeenprintedoutonthesalesslip(optional)
+line2 Line2 Alphanumericalfields/sectionsforstoringofadditional
+informationconcerningthetransactionorforstoringinform-
+
+────────────────────────────────────────────────────────────────────────────────
+Page 84
+────────────────────────────────────────────────────────────────────────────────
+
+Parameter Function
+ationwhichhavebeenprintedoutonthesalesslip(optional)
+line3 Line3 Alphanumericalfields/sectionsforstoringofadditional
+informationconcerningthetransactionorforstoringinform-
+ationwhichhavebeenprintedoutonthesalesslip(optional)
+line4 Line4 Alphanumericalfields/sectionsforstoringofadditional
+informationconcerningthetransactionorforstoringinform-
+ationwhichhavebeenprintedoutonthesalesslip(optional)
+line5 Line5 Alphanumericalfields/sectionsforstoringofadditional
+informationconcerningthetransactionorforstoringinform-
+ationwhichhavebeenprintedoutonthesalesslip(optional)
+POSstatus
+Actionname:POSStatus(POSName,TimeStamp,Status,Details)
+Actioncategory:logical
+ThePOSmanagementsystemsendstheactionassoonasthecashpointisopenedor
+closedorassoonasacancellationwillbemadeatacashpoint.
+Viatheparameter"POS"theconcernedcashpointwillbeidentified.Thefurtherparameter
+willbefilledwithvideometadatafromthePOSmanagementsystem.
+Theparameter"Status"canbeaddressedbythePOSmanagementsystemwithacodefig-
+ureforthecurrentlynotifiedstatus.
+Parameter Function
+POS POSName Alphanumericalidentificationofcashpoint
+timestamp TimeStamp TimeStamp,whentheactionwassentfromthePOSman-
+agementsystem
+status Status Identificationfigureforthecurrentlynotifiedstatus
+details Details AdditionalalphanumericalinformationfromPOSmanagement
+system(optional)
+Terminalarticledata
+Actionname:TerminalArticleData(TerminalName,TimeStamp,CashierStation,PumpNo,
+AlarmStatus,Amount,Price,Details)
+Actioncategory:notification
+The"Huth"driversendstheactionsforeachproduct-group-booking.Viatheparameter"Ter-
+minalName"theaffecteddevicewillbeidentified.The"HUTH"driverisprincipallyableto
+buildupseveralconnectionstodifferentHuthdevices.Thedriversendsthealphanumerical
+valuedefinedinhissetupas"Interfacename".Thefurtherparameterwillbefilledwithvideo
+metadataviathedriver.
+Parameter Function
+Terminal TerminalNameIdentifiestheaffecteddevice.The"HUTH"driverisprin-
+cipallyabletobuildupseveralconnectionstodifferentHuth
+devices.Thedriversendsthealphanumericalvaluedefined
+inhissetupas"Interfacename".
+timestamp TimeStamp TimeStamp,whenthestatuschangewasdetectedbythe
+Huth-System
+cashierstationCashierStationNumberofthecashpointwherethebookingiscarriedout
+pumpno PumpNo Numberofthefillingpoint
+alarm AlarmStatus StatusofAlarm-Flags
+Yes=Alarm-FlagwassetbytheHuthsystem
+No=Alarm-Flagnotset
+
+────────────────────────────────────────────────────────────────────────────────
+Page 85
+────────────────────────────────────────────────────────────────────────────────
+
+Parameter Function
+amount Amount Amountofthebooking(optional)
+price Price Sumofthebooking(optional)
+details Details Freetext(optional)
+Terminalpaymentdata
+Actionname:TerminalPaymentData(TerminalName,TimeStamp,CashierStation,
+PumpNo,AlarmStatus,Amount,Price,Details)
+Actioncategory:notification
+The"HUTH"driversendstheactionforeachterminationofabookingwiththeusedmethod
+ofpayment.Viatheparameter"TerminalName"theaffecteddevicewillbeidentified.The
+"HUTH"driverisprincipallyabletobuildupseveralconnectionstodifferentHuthdevices.
+Thedriversendsthealphanumericalvaluedefinedinhissetupas"Interfacename".Thefur-
+therparameterwillbefilledwithvideometadataviathedriver.
+Parameter Function
+Terminal TerminalNameIdentifiestheaffecteddevice.The"HUTH"driverisprin-
+cipallyabletobuildupseveralconnectionstodifferentHuth
+devices.Thedriversendsthealphanumericalvaluedefined
+inhissetupas"Interfacename".
+timestamp TimeStamp TimeStamp,whenthestatuschangewasdetectedbythe
+Huth-System
+cashierstationCashierStationNumberofthecashpointwherethebookingiscarriedout
+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)
+Remoteexport
+Theactionsofthecategory"RemoteExport"subservetostartandcontrolexportsoverthe
+network.TheactionsareonlyatdisposalifGSCRemExservicerunsoneverydeviceanda
+connectiontoacentralGeViSoftserverpersists.TheGSCServerandGSCRemExservice
+havetoruntogetheronalocalmachineotherwiseexportsarenotpossible.The
+GSCRemExservicehastobesetupinadvancebyGSCRemExEditor.Theexportscanbe
+executedbyaPILOTcenterdeviceorothersoftwaresystems(SDKbased,
+GEUTEBRUECKdevices).ThePILOTisasystemmanagementconsoleof
+GEUTEBRUECKwhichsimplifiesthehandlingofcomplexsecuritysystems.ThePILOT
+amongotherscanbeusedtocontrolGSCView.Especiallyinviewofthefactofexportsthe
+usercandefinestartandendpointsbythehelpofthePILOTthroughGSCRemEx("SetEx-
+portMarker"action).GSCViewremembersthepointsintimeandinsertsthemtotheaction
+"StartRemoteExport".Theaction"StartRemoteExport"isinitiatedbyGSCViewafterthe
+PILOThassendtheaction"InitializeRemoteExport"byindirectionviatheGeViSoftserver
+andGeViScopeservertoGSCView.GSCViewsendstheaction"StartRemoteExport"to
+
+────────────────────────────────────────────────────────────────────────────────
+Page 86
+────────────────────────────────────────────────────────────────────────────────
+
+theGSCRemExserviceandtriggerstheappropriateexport.Exportsthathavebeenstarted
+throughGSCRemExservicecanbestartedorabortedfromotherdevicesorsoftwaresys-
+temsoverthenetwork.ExportsthathavebeenstartedlocallyinGSCViewcannotbecon-
+trolledfromotherdevicesorsoftwaresystems.Inthecurseofanexportprocessnonew
+exportcanbestarted.Thisexporthastoberestartedaftertherunningexportprocesshas
+beencompleted!Theactions"SetExportMarker"and"InitializeRemoteExport"havebeen
+developedespeciallyforthePILOT.
+Cancelexport
+Actionname:CancelExport(ExportID,AbortFlag)
+Actioncategory:command
+ThroughthisactiontherunningexportprocesswiththespecifiedexportIDisbeingaborted
+ifGSCViewremote-controlstheGSCRemExservice.IftheGSCRemExserviceisremote-
+controlledbyanexternalapplicationtheexternalapplicationhastosendtheactiontoabort
+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
+TheGSCRemExservicenotifiesthroughthisactionthattherunningprocesswascom-
+pleted.
+Possiblestatusmessagesare: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
+TheGSCRemExservicenotifiesthecurrentstatusoftherunningexportprocessin%.
+Parameter Function
+exportGUIDExportID IDofrunningexport.TheexportGUIDisbeingassignedonthe
+action"StartRemoteExport".
+e.g.:01E68451-2406-484d-A9BC-5140762931E0
+progress Progress showscurrentstatusoftheexportprocessin%
+
+────────────────────────────────────────────────────────────────────────────────
+Page 87
+────────────────────────────────────────────────────────────────────────────────
+
+Initializeremoteexport
+Actionname:InitializeRemoteExport(Viewer,Device)
+Actioncategory:command
+Thisactionisbeingusedespeciallyinthecontextofcontrolunitsorsystemslikefor
+examplethePILOT.
+ThePILOTcenterdevicenotifiesGSCViewthatanewexporthastobeinitiated.Thereupon
+GSCViewcreatestheaction"StartRemoteExport"withtheappropriateparameters.
+Parameter Function
+viewer Viewer globalviewernumber
+deviceGUIDDevice IDofthePILOTcenterdevice(transmittedbythePILOTitself)
+e.g.:01E68451-2406-484d-A9BC-5140762931E0
+Setexportmarker
+Actionname:SetExportMarker(Viewer,Marker)
+Actioncategory:command
+Thisactionisbeingusedespeciallyinthecontextofcontrolunitsorsystemslikefor
+examplethePILOT.
+ItindicatesGSCViewthatanexportstartandendpointhastobesetonthecurrentposition
+ofviewerX.
+Theso-calledmarkersarebeingtransferredautomaticallyintothe"StartRemoteExport"
+actiononcethe"InitializeRemoteExport"actionhasbeensentfromthePILOT.Theaction
+"StartRemoteExport"transfersthestartandendpointstotheGSCRemExservicewhich
+conductstheappropriateexport.
+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
+ThisactiontellstheGSCRemExservicetostartanewexport.
+Theaction"StartRemoteExport"wascreatedbecausethePILOToranotherexternalsoft-
+waresystemdidsendtheaction"InitializeRemoteExport"toGSCViewbefore.
+Parameter Function
+exportGUIDExportID IDofrunningexports.TheexportGUIDhastobedeterminedsep-
+aratelyinadvancebecausetheactionitselfdoesnotcreatea
+GUID.
+deviceGUIDDevice IDofPILOTcenterdevice.IfnoPILOTisbeingusedtheblank
+GUIDcanbeusedinstead.
+e.g.:01E68451-2406-484d-A9BC-5140762931E0
+format BackupFormatdefinestheformatoftheexportedfile
+0=default(inthiscaseitequals1=GBF)
+1=GBF( GEUTEBRUECKbackupfile)
+2=MPEG2
+channel Channel globalchannelnumber/cameranumber
+starttime SelectionBeginholdsthepositionofthemarkerforthestartpoint("selection
+begin")
+endtime SelectionEndholdsthepositionofthemarkerfortheendpoint("selectionend")
+
+────────────────────────────────────────────────────────────────────────────────
+Page 88
+────────────────────────────────────────────────────────────────────────────────
+
+Parameter Function
+jobID JobID Containsthelogindata(servername,username,encodedpass-
+word)
+Optionalseconduserpassword.Thelogindataisseparatedby|.
+e.g.:<servername>|<user>|<PW>|<user2>|<PW2>
+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
+GUID
+SceneStoreIDScenestoreGUID.
+cut-list CutList Cut-list.
+pre-history
+length
+PreHistoryLengthPre-historylength.
+recording
+length
+RecordingLengthRecordinglength.
+SKIDATA
+SKIDATAmessages.
+SKIDATAcontrol
+Actionname:SkidataControl(InterfaceName,Data)
+Actioncategory:logical
+SKIDATAcontrolinformation.
+Parameter Function
+interfaceInterfaceNameInterfacename.
+state Data Interfacestate.
+SKIDATAdeviceevent
+Actionname:SkidataDeviceEvent(InterfaceName,DeviceID,EventCode)
+Actioncategory:logical
+SKIDATAdeviceevent.
+Parameter Function
+interfaceInterfaceNameInterfacename.
+device DeviceID DeviceID.
+eventcodeEventCode Eventcode.
+SKIDATAentry
+Actionname:SkidataEntry(InterfaceName,MessageCode,TranscactionID,CarParkNo,
+DeviceID)
+
+────────────────────────────────────────────────────────────────────────────────
+Page 89
+────────────────────────────────────────────────────────────────────────────────
+
+Actioncategory:logical
+SKIDATAentry.
+Parameter Function
+interfaceInterfaceNameInterfacename.
+messageMessageCodeMessagecode.
+transactionTranscactionIDTranscactionID.
+carpark CarParkNo Carparkno.
+device DeviceID DeviceID.
+SKIDATAexit
+Actionname:SkidataExit(InterfaceName,MessageCode,TranscactionID,CarParkNo,
+DeviceID)
+Actioncategory:logical
+SKIDATAexit.
+Parameter Function
+interfaceInterfaceNameInterfacename.
+messageMessageCodeMessagecode.
+transactionTranscactionIDTranscactionID.
+carpark CarParkNo Carparkno.
+device DeviceID DeviceID.
+SKIDATAtransaction
+Actionname:SkidataTransaction(InterfaceName,MessageCode,TranscactionID,
+CarParkNo,DeviceID)
+Actioncategory:logical
+SKIDATAtransaction.
+Parameter Function
+interfaceInterfaceNameInterfacename.
+messageMessageCodeMessagecode.
+transactionTranscactionIDTranscactionID.
+carpark CarParkNo Carparkno.
+device DeviceID DeviceID.
+Systemactions
+Allactionsdescribingsystembehaviour.
+Customaction
+Actionname:CustomAction(Int,String)
+Actioncategory:logical
+Thisactionhasnosideeffectsandcanbeusedforcustomerpurposes.
+Parameter Function
+INTparameter Int Numericparameter.
+STRINGparameterStringLiteralparameter.
+Databaserecordinginfoperring
+Actionname:DatabaseRecordingInfoRing(DatabaseRing,NoVideoRecording,NoAu-
+dioRecording,NoRecordingAtAll,VideoSamplesPerSecond,VideoMBPerSecond,Audi-
+oSamplesPerSecond,AudioMBPerSecond,WriteWaitTimesPercent,RingCapacity,
+OldestItem,RecordingDepth,EstimatedRequiredCapacity)
+
+────────────────────────────────────────────────────────────────────────────────
+Page 90
+────────────────────────────────────────────────────────────────────────────────
+
+Actioncategory:logical
+Databaserecordinginfoperring.
+Parameter Function
+databasering DatabaseRing Databasering.
+novideorecording NoVideoRecording Videoisrecordingornot.
+noaudiorecording NoAudioRecording Audioisrecordingornot.
+norecording NoRecordingAtAll Videoand/oraudioisrecordingornot.
+videosamples/s VideoSamplesPerSecondVideosamplespersecond.
+videosamplesMB/s VideoMBPerSecond VideoMBpersecond.
+audiosamples/s AudioSamplesPerSecondAudiosamplespersecond.
+audiosamplesMB/s AudioMBPerSecond AudioMBpersecond.
+writewait% WriteWaitTimesPercentWritewaittimesinpercent.
+ringcapacity RingCapacity Ringcapacity.
+oldestitem OldestItem Timestampoftheoldestitem.
+recordingdepth RecordingDepth Recordingdepthinhours.
+estimatedrequiredcapacityEstimatedRequiredCapacityEstimatedrequiredcapacity.
+Databaserecordinginfototal
+Actionname:DatabaseRecordingInfoTotal(NoVideoRecording,NoAudioRecording,NoRe-
+cordingAtAll,VideoSamplesPerSecond,VideoMBPerSecond,AudioSamplesPerSecond,
+AudioMBPerSecond,WriteWaitTimesPercent,TotalCapacity,FreeCapacity,Alloc-
+atedCapacity,OldestItem,RecordingDepth,EstimatedRequiredCapacity,RequiredCa-
+pacityFactor,RequiredCapacityAvailable)
+Actioncategory:logical
+Databaserecordinginfototal.
+Parameter Function
+novideorecording NoVideoRecording Videoisrecordingornot.
+noaudiorecording NoAudioRecording Audioisrecordingornot.
+norecording NoRecordingAtAll Videoand/oraudioisrecordingornot.
+videosamples/s VideoSamplesPerSecondVideosamplespersecond.
+videosamplesMB/s VideoMBPerSecond VideoMBpersecond.
+audiosamples/s AudioSamplesPerSecondAudiosamplespersecond.
+audiosamplesMB/s AudioMBPerSecond AudioMBpersecond.
+writewait% WriteWaitTimesPercentWritewaittimesinpercent.
+totalcapacity TotalCapacity Totalcapacity.
+freecapacity FreeCapacity Freecapacity.
+allocatedcapacity AllocatedCapacity Allocatedcapacity.
+oldestitem OldestItem Timestampoftheoldestitem.
+recordingdepth RecordingDepth Recordingdepthinhours.
+estimatedrequiredcapacityEstimatedRequiredCapacityEstimatedrequiredcapacity.
+requiredcapacityfactor RequiredCapacityFactorRequiredcapacityfactor.
+requiredcapacityavailableRequiredCapacityAvailableRequiredcapacityavailable.
+Databasestarted
+Actionname:DatabaseStarted(Status,TotalSize)
+Actioncategory:logical

SOURCES/GeViScope_SDK_text/GeViScope_SDK_pages_091-100.txt

@@ -0,0 +1,494 @@
+================================================================================
+GeViScope_SDK.pdf - Pages 91 to 100
+================================================================================
+
+
+────────────────────────────────────────────────────────────────────────────────
+Page 91
+────────────────────────────────────────────────────────────────────────────────
+
+Thisactionwillbefiredatthedatabasestart-up.
+Parameter Function
+status Status Databasestatusmessage.
+totalsizeTotalSizeDatabasetotalsize.
+Eventrecordingchanged
+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.
+foreignkeyForeignKeyOptionalforeignkeyusedtostartthealarm.
+Eventstopped
+Actionname:EventStopped(EventID,TypeID)
+Actioncategory:logical
+Eventhasstopped.
+Parameter Function
+instanceIDEventIDInstanceIDoftheevent.
+eventtypeTypeIDTypeoftheevent.
+FRCnotification
+Actionname:FRCNotification(Notification,Param,Description,XMLInfo)
+Actioncategory:logical
+FRCnotification.
+Parameter Function
+notificationNotificationNotificationreason.
+param Param Additionalparameter.
+descriptionDescriptionOptionalnotificationtext.
+additionalinfoXMLInfo Optionaladditionalinfo(usuallyasXMLstring).
+GEMOSalarm
+Actionname:GEMOSalarm(GEMOSkey,GEMOSint,GEMOSstr)
+Actioncategory:logical
+GEMOSalarmnotification.
+Parameter Function
+GEMOSkeyGEMOSkeyGEMOSalarmkey.
+GEMOSint GEMOSintGEMOSalarmintegerparameter.
+GEMOSstr GEMOSstrGEMOSalarmstringparameter.
+
+────────────────────────────────────────────────────────────────────────────────
+Page 92
+────────────────────────────────────────────────────────────────────────────────
+
+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.
+timestampDate Currentservertime.
+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
+username User Nameoftheusermodifiedthesetup.
+remotehost Host Hostfromwheretheconnectionwasdone.
+currenttime Date Currenttime.
+resourcekindResourceKindModifiedresourcekind.
+resourceID ResourceIDModifiedresourceID.
+changekind ChangeKindChangekind.
+details Details Detailsofthemodification.
+clienthost ClientHost Hostfromwheretheconnectionisdone.
+
+────────────────────────────────────────────────────────────────────────────────
+Page 93
+────────────────────────────────────────────────────────────────────────────────
+
+Parameter Function
+clienttype ClientTypeClienttype.
+clientaccountClientAccountUseraccountfromwheretheconnectionisdone.
+Setupuploadprogress
+Actionname:SetupUploadProgress(User1,User2,Host,Progress,Date)
+Actioncategory:logical
+Setupuploadprogress.
+Parameter Function
+firstuser User1 Nameoftheusermodifiedthesetup.
+seconduserUser2 Nameoftheseconduserbyfoureyesauthentication.
+remotehostHost Hostfromwheretheconnectionwasdone.
+progress% ProgressProgressinpercent.
+currenttimeDate Currentstagetime.
+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
+SMRPviewerconnectedtothecamera.
+Parameter Function
+serverServerServername.
+channelChannelChannel.
+SMTPmail
+Actionname:SMTPMailSend(Subject,To,Cc,Body,Channel)
+Actioncategory:logical
+ThisactionwillsendauserdefinedemailifGscMailisconnected
+Parameter Function
+subjectSubjectMailsubject.
+to To Mailrecepients.
+cc Cc Carboncopyrecepients.
+body Body Mailbody.
+channelChannelChannel.
+Startevent
+Actionname:StartEvent(TypeID,ForeignKey)
+Actioncategory:logical
+
+────────────────────────────────────────────────────────────────────────────────
+Page 94
+────────────────────────────────────────────────────────────────────────────────
+
+Startevent.
+Parameter Function
+eventtypeTypeID Typeoftheevent.
+foreignkeyForeignKeyOptionalforeignkeyusedtostoreforthealarm.
+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
+sourcesubsystemSource Sourceofthemessage.
+messagecode Message Kindofthemessage.
+WindowserrorcodeWindowsErrorOptionalWindowserrorcode.
+description DescriptionOptionaldescriptionofthemessage.
+additionalinfo XMLInfo Optionaladditionalinfo(usuallyasXMLstring).
+Systeminfo
+Actionname:SystemInfo(Source,Message,Description,XMLInfo)
+Actioncategory:logical
+Notifysysteminformation.
+Parameter Function
+sourcesubsystemSource Sourceofthemessage.
+messagecode Message Kindofthemessage.
+description DescriptionOptionaldescriptionofthemessage.
+additionalinfo XMLInfo Optionaladditionalinfo(usuallyasXMLstring).
+Systemsettingschanged
+Actionname:SystemSettingsChanged(SetupChanged,User1,User2,Host,
+TimeRangeChanged,TimeRange,LicenceChanged,Date)
+Actioncategory:logical
+Setupofthesystemand/orthecurrenttimerangechanged.
+
+────────────────────────────────────────────────────────────────────────────────
+Page 95
+────────────────────────────────────────────────────────────────────────────────
+
+Parameter Function
+setupchanged SetupChanged Systemsetuphaschanged.
+firstuser User1 Nameoftheusermodifiedthesetup.
+seconduser User2 Nameoftheseconduserbyfoureyesauthentication.
+remotehost Host Hostfromwheretheconnectionwasdone.
+timerangechangedTimeRangeChangedTimerangehaschanged.
+currenttimerangeTimeRange Currentlyactivetimerange.
+licencechanged LicenceChangedLicencehaschanged.
+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
+stoptime Date Timeofthesystemshutdown.
+Windowsshut-
+down
+WindowsShutdownIndicateswhetherthesystemshutdownisdoneduetothe
+windowsshutdown.
+Systemwarning
+Actionname:SystemWarning(Source,Message,WindowsError,Description,XMLInfo)
+Actioncategory:logical
+Notifysystemwarning.
+Parameter Function
+sourcesubsystemSource Sourceofthemessage.
+messagecode Message Kindofthemessage.
+WindowserrorcodeWindowsErrorOptionalWindowserrorcode.
+description DescriptionOptionaldescriptionofthemessage.
+additionalinfo XMLInfo Optionaladditionalinfo(usuallyasXMLstring).
+Transferbinarybuffer
+Actionname:TransferBinaryBuffer(InternalHandle,Parameter)
+Actioncategory:logical
+Transferbinarybuffer.
+Parameter Function
+internalhandleInternalHandleInternalhandle.
+parameter Parameter Parameter.
+Transferbinarychannelbuffer
+Actionname:TransferBinaryChannelBuffer(Channel,InternalHandle,Parameter)
+Actioncategory:logical
+Transferbinarychannelbuffer.
+
+────────────────────────────────────────────────────────────────────────────────
+Page 96
+────────────────────────────────────────────────────────────────────────────────
+
+Parameter Function
+channel Channel Channel.
+internalhandleInternalHandleInternalhandle.
+parameter Parameter Parameter.
+Userlogin
+Actionname:UserLogin(User1,User2,Host,ClientHost,ClientType,ClientAccount)
+Actioncategory:logical
+Thisactionwillbefiredwhentheuserhasconnectedtothesystem.
+Parameter Function
+firstuser User1 Nameoftheuserconnectedtothesystem.
+seconduser User2 Nameoftheseconduserbyfoureyesauthentication.
+remotehost Host Hostfromwheretheconnectionisdone.
+clienthost ClientHost Hostfromwheretheconnectionisdone.
+clienttype ClientTypeClienttype.
+clientaccountClientAccountUseraccountfromwheretheconnectionisdone.
+Userloginfailed
+Actionname:UserLoginFailed(User1,User2,Host,RejectReason,ClientHost,ClientType,
+ClientAccount)
+Actioncategory:logical
+Thisactionwillbefiredwhentheuserhastriedtoconnecttothesystembutwasrejected.
+Parameter Function
+firstuser User1 Nameoftheusertriedtoconnecttothesystem.
+seconduser User2 Nameoftheseconduserbyfoureyesauthentication.
+remotehost Host Hostfromwheretheconnectionisdone.
+rejectreasonRejectReasonReasonoftherejection.
+clienthost ClientHost Hostfromwheretheconnectionisdone.
+clienttype ClientTypeClienttype.
+clientaccountClientAccountUseraccountfromwheretheconnectionisdone.
+Userlogout
+Actionname:UserLogout(User1,User2,Host,ClientHost,ClientType,ClientAccount)
+Actioncategory:logical
+Thisactionwillbefiredwhentheuserhasdisconnectedfromthesystem.
+Parameter Function
+firstuser User1 Nameoftheuserdisconnectedfromthesystem.
+seconduser User2 Nameoftheseconduserbyfoureyesauthentication.
+remotehost Host Hostfromwheretheconnectionwasdone.
+clienthost ClientHost Hostfromwheretheconnectionisdone.
+clienttype ClientTypeClienttype.
+clientaccountClientAccountUseraccountfromwheretheconnectionisdone.
+Videocontrolactions
+Allactionstocontrolthevideostreams,alsoallnotificationsaboutthestatechangeofthe
+videostreams.
+
+────────────────────────────────────────────────────────────────────────────────
+Page 97
+────────────────────────────────────────────────────────────────────────────────
+
+Activateexternalprocess
+Actionname:ActivateExternalProcess(Channel,TimeStamp,ExternalSystem)
+Actioncategory:logical
+Activateexternalprocess.
+Parameter Function
+channel Channel Channel.
+timestamp TimeStamp Timestamp.
+externalsystemExternalSystemExternalsystemtoactivate.
+ChangeADparameterset
+Actionname:ChangeADParameterSet(Channel,ParameterSet)
+Actioncategory:logical
+ThisactionchangesthecurrentADparametersetofthevideochannel.
+Parameter Function
+channel Channel Channel.
+ADparametersetParameterSetThenameofthenewADparameterset.
+Changecameraprofile
+Actionname:ChangeCameraProfile(HardwareModule,CameraProfile)
+Actioncategory:logical
+Thisactionchangesthecurrentcameraprofileofthehardwaremodule.
+Parameter Function
+hardwareHardwareModuleHardwaremodule.
+profile CameraProfileThenameofthecameraprofile.
+ChangeCPAparameterset
+Actionname:ChangeCPAParameterSet(Channel,ParameterSet)
+Actioncategory:logical
+ThisactionchangesthecurrentCPAparametersetofthevideochannel.
+Parameter Function
+channel Channel Channel.
+CPAparametersetParameterSetThenameofthenewCPAparameterset.
+ChangeOBTRACKparameterset
+Actionname:ChangeObtrackParameterSet(Channel,ParameterSet)
+Actioncategory:logical
+ThisactionchangesthecurrentOBTRACKparametersetofthevideochannel.
+Parameter Function
+channel Channel Channel.
+OBTRACKparametersetParameterSetThenameofthenewOBTRACKparameterset.
+ChangeVMDparameterset
+Actionname:ChangeVMDParameterSet(Channel,ParameterSet)
+Actioncategory:logical
+ThisactionchangesthecurrentVMDparametersetofthevideochannel.
+Parameter Function
+channel Channel Channel.
+VMDparametersetParameterSetThenameofthenewVMDparameterset.
+
+────────────────────────────────────────────────────────────────────────────────
+Page 98
+────────────────────────────────────────────────────────────────────────────────
+
+Channelerror
+Actionname:ChannelError(Channel,SensorType,Source,Message,WindowsError,
+Description,XMLInfo)
+Actioncategory:logical
+Notifychannelerror.
+Parameter Function
+channel Channel Channel.
+sensortype SensorTypeSensortype.
+sourcesubsystemSource Sourceofthemessage.
+messagecode Message Kindofthemessage.
+WindowserrorcodeWindowsErrorOptionalWindowserrorcode.
+description DescriptionOptionaldescriptionofthemessage.
+additionalinfo XMLInfo Optionaladditionalinfo(usuallyasXMLstring).
+Channelinfo
+Actionname:ChannelInfo(Channel,SensorType,Source,Message,Description,XMLInfo)
+Actioncategory:logical
+Notifychannelinformation.
+Parameter Function
+channel Channel Channel.
+sensortype SensorTypeSensortype.
+sourcesubsystemSource Sourceofthemessage.
+messagecode Message Kindofthemessage.
+description DescriptionOptionaldescriptionofthemessage.
+additionalinfo XMLInfo Optionaladditionalinfo(usuallyasXMLstring).
+Channellivecheck
+Actionname:ChannelLiveCheck(Channel,SensorType,TimeStamp)
+Actioncategory:logical
+Thisactionnotifiesthatthechannbelisalive.
+Parameter Function
+channel Channel Channel.
+sensortypeSensorTypeSensortype.
+timestampTimeStampTimestamp.
+Channelwarning
+Actionname:ChannelWarning(Channel,SensorType,Source,Message,WindowsError,
+Description,XMLInfo)
+Actioncategory:logical
+Notifychannelwarning.
+Parameter Function
+channel Channel Channel.
+sensortype SensorTypeSensortype.
+sourcesubsystemSource Sourceofthemessage.
+messagecode Message Kindofthemessage.
+WindowserrorcodeWindowsErrorOptionalWindowserrorcode.
+description DescriptionOptionaldescriptionofthemessage.
+additionalinfo XMLInfo Optionaladditionalinfo(usuallyasXMLstring).
+
+────────────────────────────────────────────────────────────────────────────────
+Page 99
+────────────────────────────────────────────────────────────────────────────────
+
+CPAmeasurement
+Actionname:CPAMeasurement(Channel,Correlation)
+Actioncategory:logical
+CPAmeasurement.
+Parameter Function
+channel Channel Channel.
+correlationCorrelationCorrelationfactor.
+IASsettingschanged
+Actionname:IASSettingsChanged(Channel,SensorType)
+Actioncategory:logical
+IASsettingschanged.
+Parameter Function
+channel Channel Channel.
+sensortypeSensorTypeSensortype.
+IPcamerarawcommand
+Actionname:IPCameraRawCommand(URL,User,Password,POST)
+Actioncategory:logical
+ThisactionsendsaspecialcommandtotheIPcamera.
+Parameter Function
+url URL CompletecommandURL(likehttp://192.168.0.165:80/-
+set?daynight=night).
+user User Usernametoauthenticatebythecamera(optional).
+passwordPasswordPasswordtoauthenticatebythecamera(optional).
+post POST POSTparameters(optional,separatelineswith\\r\\n).
+MakeCPAreferenceimage
+Actionname:MakeCPAReferenceImage(Channel)
+Actioncategory:logical
+MakeCPAreferenceimage.
+Parameter Function
+channelChannelChannel.
+Mediachannelsetup
+Actionname:MediaChannelSetupInfo(Channel,TimeStamp,Parameter)
+Actioncategory:logical
+Mediachannelsetupinfo.
+Parameter Function
+channel Channel Channel.
+timestampTimeStampTimestamp.
+parameterParameterParameter.
+NPRrawdata
+Actionname:NPRRawData(PlateNo,Country,Channel,TimeStamp,ZoneRect,Weight,
+ZoneState,ZonePlace,Speed,Direction,ZoneIndex,CurBest,PlateWidth,PlateHeight,
+PlateAngle,SymHeight,Type)
+Actioncategory:logical
+NPRrawdata.
+
+────────────────────────────────────────────────────────────────────────────────
+Page 100
+────────────────────────────────────────────────────────────────────────────────
+
+Parameter Function
+plateno. PlateNo Recognizedplateno.
+country Country Country.
+channel Channel Channel.
+timestamp TimeStampTimestamp.
+zonerect ZoneRectZonerectangle.
+weight Weight Weightofrecognition.
+zonestate ZoneStateZonestate.
+zonestatus ZonePlaceZonestatus.
+speed Speed Speedinkm/h
+direction DirectionDirectionofthemotion.
+zoneindex ZoneIndexZoneindex.
+best CurBest Currentrecognitionisbest.
+platewidth PlateWidthPlatewidth.
+plateheight PlateHeightPlateheight.
+plateangle PlateAnglePlateangle.
+SymbolheightSymHeightSymbolheight.
+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.
+timestampTimeStampTimestamp.
+zonerect ZoneRectZonerectangle.
+restrictionRestrictionRestrictionofrecognizednumber.
+categoryCategoryCategoryofrecognizednumber.
+speed Speed Speedinkm/h
+directionDirectionDirectionofthemotion.
+zoneindexZoneIndexZoneindex.
+type Type Numbertype.
+weight Weight Weightofrecognition.
+OBTRACKchannelcounter
+Actionname:ObtrackChannelCounter(Channel,CounterType,CounterValue,ObjectDir-
+ection,TimeStamp,ResetTimeStamp)
+Actioncategory:logical
+OBTRACKchannelcounter.
+Parameter Function
+channel Channel Channel.
+countertype CounterType Countertype.
+countervalue CounterValueCountervalue.
+objectdirectionObjectDirectionObjectdirection.

SOURCES/GeViScope_SDK_text/GeViScope_SDK_pages_101-110.txt

@@ -0,0 +1,516 @@
+================================================================================
+GeViScope_SDK.pdf - Pages 101 to 110
+================================================================================
+
+
+────────────────────────────────────────────────────────────────────────────────
+Page 101
+────────────────────────────────────────────────────────────────────────────────
+
+Parameter Function
+timestamp TimeStamp Timestamp.
+resettimestampResetTimeStampResettimestamp.
+OBTRACKchannelcounterthreshold
+Actionname:ObtrackChannelCounterThreshold(Channel,CounterType,CounterValue,
+ExceedingDirection,TimeStamp)
+Actioncategory:logical
+OBTRACKchannelcounterthreshold.
+Parameter Function
+channel Channel Channel.
+countertype CounterType Countertype.
+countervalue CounterValue Countervalue.
+exceedingdirectionExceedingDirectionExceedingdirection.
+timestamp TimeStamp Timestamp.
+OBTRACKchannelsetcounter
+Actionname:ObtrackChannelSetCounter(Channel,CounterType,CounterValue,
+TimeStamp)
+Actioncategory:logical
+OBTRACKchannelsetcounter.
+Parameter Function
+channel Channel Channel.
+countertypeCounterTypeCountertype.
+countervalueCounterValueCountervalue.
+timestamp TimeStampTimestamp.
+OBTRACKframerawdata
+Actionname:ObtrackFrameRawData(TimeStamp,Channel,Brightness,Contrast)
+Actioncategory:logical
+OBTRACKframerawdata.
+Parameter Function
+timestampTimeStampTimestamp.
+channel Channel Channel.
+brightnessBrightnessBrightness.
+contrast Contrast Contrast.
+OBTRACKgroupcounter
+Actionname:ObtrackGroupCounter(GroupId,CounterType,CounterValue,ObjectDirection,
+TimeStamp,ResetTimeStamp,GroupName)
+Actioncategory:logical
+OBTRACKgroupcounter.
+Parameter Function
+groupid GroupId GroupID.
+countertype CounterType Countertype.
+countervalue CounterValueCountervalue.
+objectdirectionObjectDirectionObjectdirection.
+timestamp TimeStamp Timestamp.
+resettimestampResetTimeStampResettimestamp.
+groupname GroupName Groupname.
+
+────────────────────────────────────────────────────────────────────────────────
+Page 102
+────────────────────────────────────────────────────────────────────────────────
+
+OBTRACKgroupcounterthreshold
+Actionname:ObtrackGroupCounterThreshold(GroupId,CounterType,CounterValue,
+ExceedingDirection,TimeStamp,GroupName)
+Actioncategory:logical
+OBTRACKgroupcounterthreshold.
+Parameter Function
+groupid GroupId GroupID.
+countertype CounterType Countertype.
+countervalue CounterValue CounterValue.
+exceedingdirectionExceedingDirectionExceedingdirection.
+timestamp TimeStamp Timestamp.
+groupname GroupName Groupname.
+OBTRACKgroupsetcounter
+Actionname:ObtrackGroupSetCounter(GroupId,CounterType,CounterValue,TimeStamp,
+GroupName)
+Actioncategory:logical
+OBTRACKgroupsetcounter.
+Parameter Function
+groupid GroupId GroupID.
+countertypeCounterTypeCountertype.
+countervalueCounterValueCountervalue.
+timestamp TimeStampTimestamp.
+groupnameGroupNameGroupname.
+OBTRACKobjectrawdata
+Actionname:ObtrackObjectRawData(TimeStamp,Channel,Area,ObjectID,ObjectStatus,
+ObjectClass,Confidence,Position,Speed,Duration,Direction,Size,ObjectWidth,
+ObjectHeight,ProcessSize,GscNetName)
+Actioncategory:logical
+OBTRACKobjectrawdata.
+Parameter Function
+timestamp TimeStampTimestamp.
+channel Channel Channel.
+areano Area Areano.
+objectID ObjectID ObjectID.
+objectstatusObjectStatusObjectstatus.
+objectclass ObjectClassObjectclass.
+confidence ConfidenceConfidence.
+position Position Position.
+speed Speed Speed.
+duration Duration Duration.
+direction Direction Direction.
+objectsize Size Objectsize.
+objectwidth ObjectWidthObjectwidthinmeters.
+objectheightObjectHeightObjectheightinmeters.
+processsize ProcessSizeProcesssize.
+GSCnetnameGscNetNameGeviScopenetworkname.
+
+────────────────────────────────────────────────────────────────────────────────
+Page 103
+────────────────────────────────────────────────────────────────────────────────
+
+OBTRACKtunnelalarm
+Actionname:ObtrackTunnelAlarm(Channel,TimeStamp,AlarmReason,ObjectID,
+AlarmAreaID,ObjectArea)
+Actioncategory:logical
+OBTRACKtunnelalarmnotification.
+Parameter Function
+channel Channel Channel.
+timestamp TimeStampTimestamp.
+alarmreasonAlarmReasonAlarmreason.
+objectID ObjectID ObjectID.
+alarmareaIDAlarmAreaIDAlarmareaID.
+objectarea ObjectAreaObjectarea.
+Sensoralarmfinished
+Actionname:SensorAlarmFinished(Channel,SensorType)
+Actioncategory:logical
+Thisactionwillbefiredwhenthealarmisfinished.
+Parameter Function
+channel Channel Channel.
+sensortypeSensorTypeSensortype.
+Sensorinhibitalarmfinished
+Actionname:SensorInhibitAlarmFinished(Channel,SensorType)
+Actioncategory:logical
+Thisactionwillbefiredwhentheinhibitalarmfinished.
+Parameter Function
+channel Channel Channel.
+sensortypeSensorTypeSensortype.
+Sensorinhibitvideoalarm
+Actionname:SensorInhibitVideoAlarm(Channel,SensorType,ADArea,ADCell,
+VMDGroup,VMDZone,VMDCycle,AlarmArea,ObjectClass)
+Actioncategory:logical
+Thisactionwillbefiredwhenthemotionininhibitareadetected.
+Parameter Function
+channel Channel Channel.
+sensortype SensorTypeSensortype.
+ADalarmarea ADArea ADalarmarea.
+ADcell ADCell ADcellnr.
+VMDalarmgroupVMDGroupVMDalarmgroup.
+VMDzone VMDZoneVMDzonenr.
+VMDcycle VMDCycleVMDmeasurecycle.
+alarmarea AlarmAreaAlarmarea.
+objectclass ObjectClassOBTRACKobjectclass.
+Sensorvideoalarm
+Actionname:SensorVideoAlarm(Channel,SensorType,ADArea,ADCell,VMDGroup,
+VMDZone,VMDCycle,AlarmArea,ObjectClass)
+Actioncategory:logical
+
+────────────────────────────────────────────────────────────────────────────────
+Page 104
+────────────────────────────────────────────────────────────────────────────────
+
+Thisactionwillbefiredwhenvideoalarmisdetected.
+Parameter Function
+channel Channel Channel.
+sensortype SensorTypeSensortype.
+ADalarmarea ADArea ADalarmarea.
+ADcell ADCell ADcellnr.
+VMDalarmgroupVMDGroupVMDalarmgroup.
+VMDzone VMDZoneVMDzonenr.
+VMDcycle VMDCycleVMDmeasurecycle.
+alarmarea AlarmAreaAlarmarea.
+objectclass ObjectClassOBTRACKobjectclass.
+Setsystemtime
+Actionname:SetSystemTime(TimeStamp)
+Actioncategory:logical
+Setsystemtime.
+Parameter Function
+timestampTimeStampTimestamp.
+Settestpicturemode
+Actionname:SetTestPictureMode(Channel,Mode)
+Actioncategory:logical
+Enableordisabletestpicturegenerator.
+Parameter Function
+channelChannelChannel.
+enableMode Enableordisabletestpicturegenerator.
+Videocontrastdetected
+Actionname:VideoContrastDetected(Channel)
+Actioncategory:logical
+Thisactionwillbefiredwhenthecontrastisdetectedinthevideosignal.
+Parameter Function
+channelChannelChannel.
+Videocontrastfailed
+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.
+sensortypeSensorTypeSensortype.
+brightnessBrightnessBrightness.
+
+────────────────────────────────────────────────────────────────────────────────
+Page 105
+────────────────────────────────────────────────────────────────────────────────
+
+Videosetimagecontrast
+Actionname:VideoSetImageContrast(Channel,SensorType,Contrast)
+Actioncategory:logical
+Videosetimagecontrast.
+Parameter Function
+channel Channel Channel.
+sensortypeSensorTypeSensortype.
+contrast Contrast Contrast.
+Videosetimagesaturation
+Actionname:VideoSetImageSaturation(Channel,SensorType,Saturation)
+Actioncategory:logical
+Videosetimagesaturation.
+Parameter Function
+channel Channel Channel.
+sensortypeSensorTypeSensortype.
+saturationSaturationSaturation.
+Videosourcehaschanged
+Actionname:VideoSourceChanged(Channel,SignalNorm,SignalType,InterlaceType)
+Actioncategory:logical
+Thisactionindicatesthechangesonthevideoinputsource.
+Parameter Function
+channel Channel Channel.
+signalnorm SignalNormNewsignalnorm.
+signaltype SignalTypeNewsignaltype.
+interlacetypeInterlaceTypeNewinterlacetype.
+Videosyncdetected
+Actionname:VideoSyncDetected(Channel)
+Actioncategory:logical
+Thisactionwillbefiredwhenthesyncisdetectedinthevideosignal.
+Parameter Function
+channelChannelChannel.
+Videosyncfailed
+Actionname:VideoSyncFailed(Channel)
+Actioncategory:logical
+Thisactionwillbefiredwhenthesyncislostinthevideosignal.
+Parameter Function
+channelChannelChannel.
+Vieweractions
+VieweractionsallowremotecontrollingGSCView.ToenableremotecontrollingGSCView
+the"Remotecontrol"settinginGscProfileManagerandaglobaluniqueviewerclientnumber
+hastobeconfigured.
+
+────────────────────────────────────────────────────────────────────────────────
+Page 106
+────────────────────────────────────────────────────────────────────────────────
+
+VCalarmqueueconfirm
+Actionname:VCAlarmQueueConfirm(Viewer,SelectionMode)
+Actioncategory:command
+ThealarmqueueoftheGSCViewwiththegivenviewerclientnumbercanberemotecon-
+trolled.
+Acurrentalarmisconfirmed.Theparameter"selectionmode"defineswhichalarminthe
+queuewillbeconfirmed.
+Parameter Function
+viewer Viewer Globalviewerclientnumber,identifiestheGSCViewthatshouldbe
+remotecontrolled
+selection
+mode
+SelectionModefirst=firstactivealarminqueue
+next=nextactivealarminqueue(fromcurrentposition)
+previous=previousalarminqueue(fromcurrentposition)
+last=lastactivealarminqueue
+VCalarmqueueconfirmbyinstance
+Actionname:VCAlarmQueueConfirmByInstance(Viewer,AlarmID)
+Actioncategory:command
+ThealarmqueueofGSCViewwiththegivenviewerclientnumbercanberemotecontrolled.
+Acurrentalarmisconfirmed.ItisidentifiedbyitsalarminstanceID(eventinstanceID).A
+uniqueinstanceIDisassignedtoeachalarm/recordingeventatcreationtimebytheGeViS-
+copeserver.
+Parameter Function
+viewer ViewerGlobalviewerclientnumber,identifiestheGSCViewthatshouldberemote
+controlled
+instance
+ID
+AlarmIDThealarminstanceID(eventinstanceID)
+VCalarmqueueconfirmbytype
+Actionname:VCAlarmQueueConfirmByType(Viewer,TypeID,SelectionMode)
+Actioncategory:command
+ThealarmqueueofGSCViewwiththegivenviewerclientnumbercanberemotecontrolled.
+Acurrentalarmisconfirmed.Itisidentifiedbyitsalarmtype(eventtype)whichmeansthe
+nameofthealarm(event)intheGeViScopeSetupeventlistandalsobytheparameter
+"selectionmode".Theparameter"selectionmode"defineswhichalarminthequeuewillbe
+selected.
+Parameter Function
+viewer Viewer Globalviewerclientnumber,identifiestheGSCViewthatshouldbe
+remotecontrolled
+eventtype TypeID Thealarmtype(eventtype)
+selection
+mode
+SelectionModefirst=firstactivealarminqueue
+next=nextactivealarminqueue(fromcurrentposition)
+previous=previousalarminqueue(fromcurrentposition)
+last=lastactivealarminqueue
+
+────────────────────────────────────────────────────────────────────────────────
+Page 107
+────────────────────────────────────────────────────────────────────────────────
+
+VCalarmqueueremove
+Actionname:VCAlarmQueueRemove(Viewer,SelectionMode)
+Actioncategory:command
+ThealarmqueueoftheGSCViewwiththegivenviewerclientnumbercanberemotecon-
+trolled.
+Analarmisremovedfromthequeue.Theparameter"selectionmode"defineswhichalarm
+inthequeuewillberemoved.
+Parameter Function
+viewer Viewer Globalviewerclientnumber,identifiestheGSCViewthatshouldbe
+remotecontrolled
+selection
+mode
+SelectionModefirst=firstactivealarminqueue
+next=nextactivealarminqueue(fromcurrentposition)
+previous=previousalarminqueue(fromcurrentposition)
+last=lastactivealarminqueue
+VCalarmqueueremovebyinstance
+Actionname:VCAlarmQueueRemoveByInstance(Viewer,AlarmID)
+Actioncategory:command
+ThealarmqueueoftheGSCViewwiththegivenviewerclientnumbercanberemotecon-
+trolled.
+Analarmisremovedfromthequeue.ItisidentifiedbyitsalarminstanceID(eventinstance
+ID).AuniqueinstanceIDisassignedtoeachalarm/eventrecording.
+Parameter Function
+viewer ViewerGlobalviewerclientnumber,identifiestheGSCViewthatshouldberemote
+controlled
+instance
+ID
+AlarmIDThealarminstanceID(eventinstanceID)
+VCalarmqueueremovebytype
+Actionname:VCAlarmQueueRemoveByType(Viewer,TypeID,SelectionMode)
+Actioncategory:command
+ThealarmqueueoftheGSCViewwiththegivenviewerclientnumbercanberemotecon-
+trolled.
+Analarmisremovedfromthequeue.Itisidentifiedbyitsalarmtype(eventtype)which
+meansthenameofthealarm(event)intheGeViScopeSetupeventlist.Theparameter
+"selectionmode"defineswhichalarmwillberemoved.
+Parameter Function
+viewer Viewer Globalviewerclientnumber,identifiestheGSCViewthatshouldbe
+remotecontrolled
+eventtype TypeID Thealarmtype(eventtype)
+selection
+mode
+SelectionModefirst=firstactivealarminqueue
+next=nextactivealarminqueue(fromcurrentposition)
+previous=previousalarminqueue(fromcurrentposition)
+last=lastactivealarminqueue
+
+────────────────────────────────────────────────────────────────────────────────
+Page 108
+────────────────────────────────────────────────────────────────────────────────
+
+VCalarmqueueselect
+Actionname:VCAlarmQueueSelect(Viewer,SelectionMode)
+Actioncategory:command
+ThealarmqueueoftheGSCViewwiththegivenviewerclientnumbercanberemotecon-
+trolled.
+Analarmofthequeueispresented.Theparameter"selectionmode"defineswhichalarmin
+thequeuewillbepresented.
+Parameter Function
+viewer Viewer Globalviewerclientnumber,identifiestheGSCViewthatshouldbe
+remotecontrolled
+selection
+mode
+SelectionModefirst=firstactivealarminqueue
+next=nextactivealarminqueue(fromcurrentposition)
+previous=previousalarminqueue(fromcurrentposition)
+last=lastactivealarminqueue
+VCalarmqueueselectbyinstance
+Actionname:VCAlarmQueueSelectByInstance(Viewer,AlarmID)
+Actioncategory:command
+ThealarmqueueoftheGSCViewwiththegivenviewerclientnumbercanberemotecon-
+trolled.
+Analarmofthequeueispresented.ItisidentifiedbyitsalarminstanceID(eventinstance
+ID).AuniqueinstanceIDisassignedtoeachalarm/eventrecording.
+Parameter Function
+viewer ViewerGlobalviewerclientnumber,identifiestheGSCViewthatshouldberemote
+controlled
+instance
+ID
+AlarmIDThealarminstanceID(eventinstanceID)
+VCalarmqueueselectbytype
+Actionname:VCAlarmQueueSelectByType(Viewer,TypeID,SelectionMode)
+Actioncategory:command
+ThealarmqueueoftheGSCViewwiththegivenviewerclientnumbercanberemotecon-
+trolled.
+Analarmofthequeueispresented.Itisidentifiedbyitsalarmtype(eventtype)which
+meansthenameofthealarm(event)intheGeViScopeSetupeventlistandalsobythepara-
+meter"selectionmode".Theparameter"selectionmode"defineswhichalarminthequeue
+willbeselected.
+Parameter Function
+viewer Viewer Globalviewerclientnumber,identifiestheGSCViewthatshouldbe
+remotecontrolled
+eventtype TypeID Thealarmtype(eventtype)
+selection
+mode
+SelectionModefirst=firstactivealarminqueue
+next=nextactivealarminqueue(fromcurrentposition)
+previous=previousalarminqueue(fromcurrentposition)
+last=lastactivealarminqueue
+
+────────────────────────────────────────────────────────────────────────────────
+Page 109
+────────────────────────────────────────────────────────────────────────────────
+
+VCchangescenebyname
+Actionname:VCChangeSceneByName(Viewer,Scene)
+Actioncategory:command
+TheactiondisplaysasceneintheGSCViewwiththegivenviewerclientnumber.
+Thesceneisidentifiedbyitsnamewhichiscaseinsensitive.(e.g."MyScene"equal
+"myscene")
+ParameterFunction
+viewerViewerGlobalviewerclientnumber,identifiestheGSCViewthatshouldberemotecon-
+trolled
+sceneSceneThenameofthescenethatshouldbedisplayed
+VCclearscenebyname
+Actionname:VCClearSceneByName(Viewer,Scene)
+Actioncategory:command
+TheactionclearsasceneintheGSCViewwiththegivenviewerclientnumber.
+Thesceneisidentifiedbyitsnamewhichiscaseinsensitive.Ifthesceneiscurrentlynot
+activeitwillbedisplayedaftertheactionisexecuted.(e.g."MyScene"equal"myscene")
+ParameterFunction
+viewerViewerGlobalviewerclientnumber,identifiestheGSCViewthatshouldberemotecon-
+trolled
+sceneSceneThenameofthescenethatshouldbecleared
+VCfullmode
+Actionname:VCFullMode(Viewer,FullMode,SensitiveAreaEnabled)
+Actioncategory:command
+TheGscViewwiththegivenviewerclientnumbercanbeswitchedintofullmodedisplayor
+normalmodedisplay.
+InfullmodedisplayGscViewoffersthepossibilitytofadeincontrolslikethetoolbarorthe
+sidebariftheusermovesthemousecursorinthenearofthewindowborders.Thisbehavior
+canbecontrolledbytheParameter"Sensitiveareaenabled".
+Parameter Function
+viewer Viewer Globalviewerclientnumber,identifiestheGscViewthat
+shouldberemotecontrolled
+fullmode FullMode yes=switchtofullmodedisplay
+no=switchtonormalmodedisplay
+sensitivearea
+enabled
+SensitiveAreaEnabledyes=movingmousecursorinthenearofthewindowbor-
+derscausescontrolstofadein
+no=nocontrolsfadein
+VCsetaudiolevel
+Actionname:VCSetAudioLevel(Viewer,AudioLevel)
+Actioncategory:command
+ThevolumeoftheaudiooutputoftheGSCViewwiththegivenviewerclientnumbercanbe
+controlled.
+Parameter Function
+viewer Viewer Globalviewerclientnumber,identifiestheGSCViewthatshouldberemote
+controlled
+audio
+level
+AudioLevel0=audiooutputoff
+100=audiooutputinmaximumvolume
+
+────────────────────────────────────────────────────────────────────────────────
+Page 110
+────────────────────────────────────────────────────────────────────────────────
+
+VCshowviewertext
+Actionname:VCShowViewerText(Viewer,ShowText)
+Actioncategory:command
+Thetextfade-inofallviewersoftheGSCViewwiththegivenviewerclientnumbercanbe
+switchedonandoff.
+Parameter Function
+viewerViewer Globalviewerclientnumber,identifiestheGSCViewthatshouldberemote
+controlled
+show
+text
+ShowTextyes=switchtextfade-inon
+no=switchtextfade-inoff
+VCstretchmode
+Actionname:VCStretchMode(Viewer,StretchMode)
+Actioncategory:command
+TheGSCViewwiththegivenviewerclientnumbercanbeswitchedintostretchedmodedis-
+playornormalmodedisplay.
+Inthestretchedview,theviewersarestretchedtotheavailablesizeintheGSCViewmain
+window.Inthenormalmodedisplaytheviewersaresizedin4:3ratio.
+Parameter Function
+viewer Viewer Globalviewerclientnumber,identifiestheGSCViewthatshouldbe
+remotecontrolled
+stretch
+mode
+StretchModeyes=switchtostretchedmodedisplay
+no=switchtonormalmodedisplay
+Viewerchangescene
+Actionname:ViewerChangeScene(Viewer)
+Actioncategory:command
+TheactiondisplaysthescenewheretheviewerwiththeglobalnumberonanyGSCViewin
+thenetworkbelongsto.
+ParameterFunction
+viewerViewerGlobalviewerclientnumber,identifiestheGSCViewthatshouldberemotecon-
+trolled
+Viewerclear
+Actionname:ViewerClear(Viewer)
+Actioncategory:command
+TheactionclearstheactivevieweroftheGSCViewwiththegivenviewerclientnumberor
+theviewerwiththeglobalnumberonanyGSCViewinthenetwork.
+ParameterFunction
+viewerViewerGlobalviewerclientnumber,identifiestheGSCViewthatshouldberemotecon-
+trolled
+or
+GlobalnumberofavieweronanyGSCViewinthenetwork
+Viewerclearscene
+Actionname:ViewerClearScene(Viewer)
+Actioncategory:command

SOURCES/GeViScope_SDK_text/GeViScope_SDK_pages_111-120.txt

@@ -0,0 +1,589 @@
+================================================================================
+GeViScope_SDK.pdf - Pages 111 to 120
+================================================================================
+
+
+────────────────────────────────────────────────────────────────────────────────
+Page 111
+────────────────────────────────────────────────────────────────────────────────
+
+TheactionclearsthescenewheretheactivevieweroftheGSCViewwiththegivenviewer
+clientnumberortheviewerwiththeglobalnumberonanyGSCViewinthenetworkbelongs
+to.
+ParameterFunction
+viewerViewerGlobalviewerclientnumber,identifiestheGSCViewthatshouldberemotecon-
+trolled
+or
+GlobalnumberofavieweronanyGSCViewinthenetwork
+Viewercleartextoutput
+Actionname:ViewerClearTextOutput(Viewer)
+Actioncategory:command
+Theactiondoesn'tdisplayatextintheactivevieweroftheGSCViewwiththegivenviewer
+clientnumberortheviewerwiththeglobalnumberonanyGSCViewinthenetworkany-
+more.
+ParameterFunction
+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
+mode
+PlayModeplaystop=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 112
+────────────────────────────────────────────────────────────────────────────────
+
+Parameter Function
+(ifnoMOSsearchareaisdefinedinGscViewthewholepicturesizeisusedfor
+it)aredisplayed;thedisplaystopsaftermotionisdetected
+prevdetectedmotion=like"playbackward"butonlypictureswithmotionin
+it(ifnoMOSsearchareaisdefinedinGscViewthewholepicturesizeisused
+forit)aredisplayed;thedisplaystopsaftermotionisdetected
+Viewerconnectlive
+Actionname:ViewerConnectLive(Viewer,Channel)
+Actioncategory:command
+ThisactiondisplayslivepicturesofavideochannelontheactivevieweroftheGSCView
+withthegivenviewerclientnumberorontheviewerwiththeglobalnumberonany
+GSCViewinthenetwork.
+Parameter Function
+viewerViewerGlobalviewerclientnumber,identifiestheGSCViewthatshouldberemotecon-
+trolled
+or
+GlobalnumberofavieweronanyGSCViewinthenetwork
+channelChannelGlobalnumberofthemediachannel
+Viewerexportpicture
+Actionname:ViewerExportPicture(Viewer,FilePath)
+Actioncategory:command
+TheactionexportsthecurrentpictureoftheactivevieweroftheGSCViewwiththegiven
+viewerclientnumberortheviewerwiththeglobalnumberonanyGSCViewinthenetwork.
+TheactualpictureisexportedasawindowsbitmapgraphicfileintheGSCViewdirectoryor
+inthepath(localorUNC)definedviatheparameter"filepath".
+Parameter Function
+viewerViewerGlobalviewerclientnumber,identifiestheGSCViewthatshouldberemotecon-
+trolled
+or
+GlobalnumberofavieweronanyGSCViewinthenetwork
+file
+path
+FilePathPath(localorUNC)wherethepictureshouldbeexportedto
+Viewerjumpbytime
+Actionname:ViewerJumpByTime(Viewer,Channel,PlayMode,TimeInSec)
+Actioncategory:command
+TheactiondisplayspicturesofavideochannelontheactivevieweroftheGSCViewwith
+thegivenviewerclientnumberorontheviewerwiththeglobalnumberonanyGSCViewin
+thenetwork.
+Theparameter"playmode"definesinwhichmodethepicturesarepresented(live,forward,
+backward.).
+Theparameter"timeinsec"definesthetimespanthatthestartofthereplayshouldbe
+movedfromtheactualtimestamp.
+Parameter Function
+viewerViewer Globalviewerclientnumber,identifiestheGSCViewthatshouldberemote
+controlled
+
+────────────────────────────────────────────────────────────────────────────────
+Page 113
+────────────────────────────────────────────────────────────────────────────────
+
+Parameter Function
+or
+GlobalnumberofavieweronanyGSCViewinthenetwork
+channelChannelGlobalnumberofthemediachannel
+play
+mode
+PlayModeplaystop=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
+sec
+TimeInSecTimespanthatthestartofthereplayshouldbemovedfromtheactual
+timestamp
+Viewermaximize
+Actionname:ViewerMaximize(Viewer,Maximize)
+Actioncategory:command
+TheactivevieweroftheGSCViewwiththegivenviewerclientnumberortheviewerwith
+theglobalnumberonanyGSCViewinthenetworkwhichshouldberemotecontrolled.
+Theparameter"maximize"defineswhethertheviewershouldbedisplayedinmaximized
+modeornot.
+Parameter Function
+viewer ViewerGlobalviewerclientnumber,identifiestheGSCViewthatshouldberemote
+controlled
+or
+GlobalnumberofavieweronanyGSCViewinthenetwork
+maximizeMaximizeyes=displaytheviewerinmaximizedmode
+no=displaytheviewerinnormalmode
+Viewerplayfromtime
+Actionname:ViewerPlayFromTime(Viewer,Channel,PlayMode,Time)
+Actioncategory:command
+DisplaypicturesofavideochannelontheactivevieweroftheGscViewwiththegiven
+viewerclientnumberorontheviewerwiththeglobalnumberonsomeGscViewinthenet-
+work.
+
+────────────────────────────────────────────────────────────────────────────────
+Page 114
+────────────────────────────────────────────────────────────────────────────────
+
+Theparameter"playmode"definesinwhichmodethepicturesarepresented(live,forward,
+backward,.).
+Theparameter"time"definesthetimestampwherethereplayoftherecordedvideoshould
+start.
+Parameter Function
+viewerViewerGlobalviewerclientnumber,identifiestheGscViewthatshouldberemotecon-
+trolled
+or
+GlobalnumberofavieweronsomeGscViewinthenetwork
+channelChannelGlobalnumberofthemediachannel
+play
+mode
+PlayModeplaystop=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
+time Time Timestampwherethereplayoftherecordedvideoshouldstart.Thepara-
+metershouldbedefinedinthefollowingformat:
+"2009/02/1307:22:00,594GMT+01:00"
+Viewerprintpicture
+Actionname:ViewerPrintPicture(Viewer)
+Actioncategory:command
+TheactionprintsoutthecurrentpictureoftheactivevieweroftheGSCViewwiththegiven
+viewerclientnumberortheviewerwiththeglobalnumberonanyGSCViewinthenetwork.
+TheprintoutisdoneonthedefaultprinterofthePConwhichGSCViewisrunning.
+ParameterFunction
+viewerViewerGlobalviewerclientnumber,identifiestheGSCViewthatshouldberemotecon-
+trolledorGlobalnumberofavieweronanyGSCViewinthenetwork
+Viewerselect
+Actionname:ViewerSelect(Viewer)
+Actioncategory:command
+TheactiondeclarestheviewerwiththeglobalnumberonanyGSCViewinthenetworkto
+theactiveviewerofthecorrespondingGSCView.
+
+────────────────────────────────────────────────────────────────────────────────
+Page 115
+────────────────────────────────────────────────────────────────────────────────
+
+ParameterFunction
+viewerViewerGlobalnumberofavieweronanyGSCViewinthenetwork
+Viewersetplaymode
+Actionname:ViewerSetPlayMode(Viewer,PlayMode,PlaySpeed)
+Actioncategory:command
+Theactionsetsthe"playmode"oftheactivevieweroftheGSCViewwiththegivenviewer
+clientnumberortheviewerwiththeglobalnumberonanyGSCViewinthenetwork.
+Parameter Function
+viewerViewer Globalviewerclientnumber,identifiestheGSCViewthatshouldberemotecon-
+trolled
+or
+GlobalnumberofavieweronanyGSCViewinthenetwork
+play
+mode
+PlayModeplaystop=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
+speed
+PlaySpeedSpeedrateforfastforward/backward(2.)
+Viewershowalarmbyinstance
+Actionname:ViewerShowAlarmByInstance(Viewer,AlarmID,PlayMode)
+Actioncategory:command
+TheactiondisplayspicturesofanalarmontheGSCViewwiththegivenviewerclientnum-
+berinthenetwork.
+ThealarmisidentifiedbyitsalarminstanceID(eventinstanceID).Everyalarm(event)is
+assignedauniqueinstanceIDatcreationtimebytheGeViScopeserver.
+Theparameter"playmode"definesinwhichmodethepicturesarepresented(livereplay,
+replayeventpictures,.).
+Parameter Function
+viewerViewerGlobalviewerclientnumber,identifiestheGSCViewthatshouldberemote
+controlled
+
+────────────────────────────────────────────────────────────────────────────────
+Page 116
+────────────────────────────────────────────────────────────────────────────────
+
+Parameter Function
+instance
+ID
+AlarmIDThealarminstanceID(eventinstanceID)
+play
+mode
+PlayModeShowalarmusingdefaultsettings=displayalarmpicturesusingthedefault
+settingsdefinedintheGeViScopesetup
+Livereplay=displaylivepicturesofthecamerasbelongingtothealarmcon-
+figuration
+replayeventpictures=replaythepicturesbelongingtothealarm(onlyonce)
+continuouseventreplay=replaythepicturesbelongingtothealarm
+continuouslyinaloop
+showfirstalarmpictureonly=onlydisplaythefirstpicturebelongingtothe
+alarm
+Viewershowalarmbykey
+Actionname:ViewerShowAlarmByKey(Viewer,ForeignKey,PlayMode)
+Actioncategory:command
+TheactiondisplayspicturesofanalarmontheGSCViewwiththegivenviewerclientnum-
+berinthenetwork.
+Thealarmisidentifiedbyits"foreignkey".The"foreignkey"wasassignedexplicittothe
+alarmasthealarmwasstarted.
+Theparameter"playmode"definesinwhichmodethepicturesarepresented(livereplay,
+replayeventpictures.).
+Parameter Function
+viewerViewer Globalviewerclientnumber,identifiestheGSCViewthatshouldberemote
+controlled
+foreign
+key
+ForeignKeyTheforeignkeythatwasassignedtothealarmasthealarmwasstarted
+play
+mode
+PlayModeplaystop=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 117
+────────────────────────────────────────────────────────────────────────────────
+
+Viewershowalarmbytype
+Actionname:ViewerShowAlarmByType(Viewer,TypeID,ForeignKey,PlayMode)
+Actioncategory:command
+TheactiondisplayspicturesofanalarmontheGSCViewwiththegivenviewerclientnum-
+berinthenetwork.
+Thealarmisidentifiedbyitsalarmtypeandoptionalbyitsforeignkey.Thealarmtype
+(eventname)isdefinedintheGeViScopesetup.Theforeignkeywasassignedexplicitto
+thealarmasthealarmwasstarted.Itisoptional.Ifitisnotset,thelastalarmwiththe
+definedalarmtypeisdisplayed.
+Theparameter"playmode"definesinwhichmodethepicturesarepresented(livereplay,
+replayeventpictures.).
+Parameter Function
+viewerViewer Globalviewerclientnumber,identifiestheGSCViewthatshouldberemote
+controlled
+alarm
+type
+TypeID Type(eventname)ofthealarm,definedintheGeViScopesetup
+foreign
+key
+ForeignKeyTheforeignkeythatwasassignedtothealarmasthealarmwasstarted
+play
+mode
+PlayModeplaystop=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
+TheactivevieweroftheGSCViewwiththegivenviewerclientnumberortheviewerwith
+theglobalnumberonanyGSCViewinthenetworkshouldberemotecontrolled.
+Theparameter"enablesync"defineswhetheraudioandvideoshouldbesynchronizedor
+not.
+
+────────────────────────────────────────────────────────────────────────────────
+Page 118
+────────────────────────────────────────────────────────────────────────────────
+
+Parameter Function
+viewer Viewer Globalviewerclientnumber,identifiestheGSCViewthatshouldbe
+remotecontrolled
+or
+GlobalnumberofavieweronanyGSCViewinthenetwork
+enable
+sync
+EnableSyncyes=synchronizeaudioandvideo
+no=don'tsynchronizeaudioandvideo
+Viewertextoutput
+Actionname:ViewerTextOutput(Viewer,Text)
+Actioncategory:command
+TheactiondisplaysatextintheactivevieweroftheGSCViewwiththegivenviewerclient
+numberortheviewerwiththeglobalnumberonanyGSCViewinthenetwork.
+Parameter Function
+viewer ViewerGlobalviewerclientnumber,identifiestheGSCViewthatshouldberemotecon-
+trolled
+or
+GlobalnumberofavieweronanyGSCViewinthenetwork
+text
+string
+Text Textthatshouldbedisplayedinthepicture
+Viewernotificationactions
+ViewernotificationsarefiredbyGSCViewwhileGSCViewisremotecontrolled.Toenable
+remotecontrollingGSCViewthe"Remotecontrol"settinginGscProfileManageranda
+globaluniqueviewerclientnumberhastobeconfigured.ToenableGSCViewsending
+viewernotificationsthe"Sendnotificationactions"settingsinGscProfileManagerhaveto
+beconfigured.
+Imageexportnotification
+Actionname:ImageExportNotification(User,Destination,DestinationType,TimeStamp,
+TimeEnd,Channels,ClientHost,ClientType,ClientAccount)
+Actioncategory:notification
+AsingleimageoravideosequencehasbeenexportedbyaGSCViewinthenetwork.
+GSCViewhasfiredthisnotificationbecauseasinglepicturehasbeenexportedviaaView-
+erExportPictureactionwhileGSCViewisremotecontrolledorbecausetheuserhasmanu-
+allyexportedapictureoravideosequenceinGSCView.
+Parameter Function
+user User GeViScopeuser,who
+hasdonetheexport
+destination Destination Path(localorUNC)
+wherethepictureor
+sequencewasexported
+destinationtype DestinationType0=singleimage
+1=backupfile(GBF)
+2=videofile(MPEG,
+VideoDVD,MPEG4CCTV
+raw)
+3=snapshottoclip-
+
+────────────────────────────────────────────────────────────────────────────────
+Page 119
+────────────────────────────────────────────────────────────────────────────────
+
+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 ClientAccountWindowsuseraccount
+underthatGSCViewis
+running
+Scenestoremodification
+Actionname:SceneStoreModification(Viewer,SceneStoreID,SceneStoreName,
+TimeStamp,ModificationType,User,ClientHost,ClientType,ClientAccount)
+Actioncategory:notification
+Scenestoremodification.
+Parameter Function
+viewer Viewer GlobalnumberofavieweronsomeGSCViewinthenetwork
+scenestore
+GUID
+SceneStoreIDScenestoreGUID.
+scenestore
+name
+SceneStoreNam-
+e
+Scenestorename.
+timestamp TimeStamp Timestamp.
+modification
+type
+Modi-
+ficationType
+Modificationtype.
+user User Nameoftheuser.
+clienthost ClientHost HostnameofthePCwhereGSCViewisrunning
+clienttype ClientType 1=GSCView
+Allothervaluesareforfutureuse!
+clientaccountClientAccountWindowsuseraccountunderthatGSCViewisrunning
+
+────────────────────────────────────────────────────────────────────────────────
+Page 120
+────────────────────────────────────────────────────────────────────────────────
+
+VCalarmqueuenotification
+Actionname:VCAlarmQueueNotification(Viewer,Notification,AlarmID,TypeID,Cli-
+entHost,ClientType,ClientAccount)
+Actioncategory:notification
+ThestateofthealarmqueueoftheGSCViewwiththetransmittedviewerclientnumberhas
+beenchanged.
+GSCViewhasfiredthisnotificationbecausethestateofitsalarmqueuehasbeenchanged
+viaaVCAlarmQueue...actionwhileGSCViewisremotecontrolledorbecausetheuserhas
+manuallychangedthestateofthealarmqueueinGSCView.
+AnalarmcanbeidentifiedbyitsalarminstanceID(eventinstanceID).Everyalarm(event)
+isassignedauniqueinstanceIDatcreationtimebytheGeViScopeserver.
+Alternativelythealarmcanbeidentifiedbyitsalarmtype(eventtype)whichmeansthe
+nameofthealarm(event)intheGeViScopeSetupeventlist.
+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
+instanceID AlarmID ThealarminstanceID
+(eventinstanceID)
+eventtype TypeID Thealarmtype(event
+type)
+clienthost ClientHost HostnameofthePC
+whereGSCViewisrun-
+ning
+clienttype ClientType 1=GSCView
+Allothervaluesarefor
+futureuse!

SOURCES/GeViScope_SDK_text/GeViScope_SDK_pages_121-127.txt

@@ -0,0 +1,398 @@
+================================================================================
+GeViScope_SDK.pdf - Pages 121 to 127
+================================================================================
+
+
+────────────────────────────────────────────────────────────────────────────────
+Page 121
+────────────────────────────────────────────────────────────────────────────────
+
+Parameter Function
+clientaccount ClientAccountWindowsuseraccount
+underthatGSCViewisrun-
+ning
+VCscenechanged
+Actionname:VCSceneChanged(Viewer,Scene)
+Actioncategory:notification
+TheactivesceneoftheGSCViewwiththetransmittedviewerclientnumberhasbeen
+changed.
+GSCViewhasfiredthisnotificationbecauseitsactivescenehasbeenchangedviaa
+VCChangeSceneByNameorViewerChangeSceneactionwhileGSCViewisremotecon-
+trolledorbecausetheuserhasmanuallychangedtheactivesceneinGSCView.
+Parameter Function
+viewer Viewer Globalviewerclientnumber,identifiestheGSCViewthatfired
+thisnotification
+scene Scene Thenameofthescenethatisdisplayedafterthechange
+Viewercleared
+Actionname:ViewerCleared(Viewer,ClientHost,ClientType,ClientAccount)
+Actioncategory:notification
+TheviewerwiththetransmittedglobalnumberonsomeGSCViewinthenetworkhasbeen
+cleared.
+GSCViewhasfiredthisnotificationbecauseoneofitsviewershasbeenclearedviaaView-
+erClearactionwhileGSCViewisremotecontrolledorbecausetheuserhasmanually
+clearedtheviewerinGSCView.
+Parameter Function
+viewer Viewer GlobalnumberofavieweronsomeGSCViewinthenetwork
+clienthost ClientHost HostnameofthePCwhereGSCViewisrunning
+clienttype ClientType 1=GSCView
+Allothervaluesareforfutureuse!
+clientaccountClientAccountWindowsuseraccountunderthatGSCViewisrunning
+Viewerconnected
+Actionname:ViewerConnected(Viewer,Channel,PlayMode,ClientHost,ClientType,Cli-
+entAccount)
+Actioncategory:notification
+TheviewerwiththetransmittedglobalnumberonsomeGSCViewinthenetworkhasbeen
+connected.
+GSCViewhasfiredthisnotificationbecauseoneofitsviewershasbeenconnectedviaa
+ViewerConnectorViewerConnectLiveactionwhileGSCViewisremotecontrolledor
+becausetheuserhasmanuallyconnectedtheviewerinGSCView.
+Theparameter"playmode"definesinwhichmodethepicturesarepresented(live,forward,
+backward,.).
+
+────────────────────────────────────────────────────────────────────────────────
+Page 122
+────────────────────────────────────────────────────────────────────────────────
+
+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 123
+────────────────────────────────────────────────────────────────────────────────
+
+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 ClientAccountWindowsuseraccount
+underthatGSCViewis
+running
+Viewerplaymodechanged
+Actionname:ViewerPlayModeChanged(Viewer,Channel,PlayMode,ChannelTime,Cli-
+entHost,ClientType,ClientAccount)
+Actioncategory:notification
+TheplaymodeoftheviewerwiththetransmittedglobalnumberonsomeGSCViewinthe
+networkhasbeenchanged.
+GSCViewhasfiredthisnotificationbecausetheplaymodeofoneofitsviewershasbeen
+changedviaaViewerConnect,ViewerConnectLive,ViewerSetPlayMode,View-
+erPlayFromTime,ViewerJumpByTimeoroneoftheViewerShowAlarmBy.actionswhile
+GSCViewisremotecontrolledorbecausetheuserhasmanuallychangedtheplaymodeof
+theviewerinGSCView.
+Parameter Function
+viewer Viewer Globalnumberofa
+vieweronsome
+GSCViewinthenetwork
+channel Channel Globalnumberofthe
+mediachannel,dis-
+playedintheviewer
+
+────────────────────────────────────────────────────────────────────────────────
+Page 124
+────────────────────────────────────────────────────────────────────────────────
+
+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 125
+────────────────────────────────────────────────────────────────────────────────
+
+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
+channeltime ChannelTime 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 ClientAccountWindowsuseraccount
+underthatGSCViewis
+running
+Viewerselectionchanged
+Actionname:ViewerSelectionChanged(Viewer,Channel,PlayMode,ClientHost,Cli-
+entType,ClientAccount)
+Actioncategory:notification
+TheactivevieweronsomeGSCViewinthenetworkhasbeenchanged.
+GSCViewhasfiredthisnotificationbecausetheuserhasselectedoneofitsviewersby
+mouseclickorbydraggingacameraontooneofitsviewers.
+GSCViewonlyfiresthenotification,ifacameraisdisplayedontheselectedviewer.
+Parameter Function
+viewer Viewer Globalnumberofa
+vieweronsome
+GSCViewinthenetwork
+channel Channel Globalnumberofthe
+mediachannel,dis-
+playedintheviewer
+
+────────────────────────────────────────────────────────────────────────────────
+Page 126
+────────────────────────────────────────────────────────────────────────────────
+
+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 127
+────────────────────────────────────────────────────────────────────────────────
+
+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 ClientAccountWindowsuseraccount
+underthatGSCViewis
+running