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