================================================================================ 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.