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