COLSYS/geutebruck
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
master
geutebruck/GeViScope_SDK_Docs/GeViScope_SDK_Part03_Pages_41-60.txt
Administrator a92b909539 feat: GeViScope SDK integration with C# Bridge and Flutter app 
- Add GeViScope Bridge (C# .NET 8.0) on port 7720
  - Full SDK wrapper for camera control, PTZ, actions/events
  - 17 REST API endpoints for GeViScope server interaction
  - Support for MCS (Media Channel Simulator) with 16 test channels
  - Real-time action/event streaming via PLC callbacks

- Add GeViServer Bridge (C# .NET 8.0) on port 7710
  - Integration with GeViSoft orchestration layer
  - Input/output control and event management

- Update Python API with new routers
  - /api/geviscope/* - Proxy to GeViScope Bridge
  - /api/geviserver/* - Proxy to GeViServer Bridge
  - /api/excel/* - Excel import functionality

- Add Flutter app GeViScope integration
  - GeViScopeRemoteDataSource with 17 API methods
  - GeViScopeBloc for state management
  - GeViScopeScreen with PTZ controls
  - App drawer navigation to GeViScope

- Add SDK documentation (extracted from PDFs)
  - GeViScope SDK docs (7 parts + action reference)
  - GeViSoft SDK docs (12 chunks)

- Add .mcp.json for Claude Code MCP server config

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-19 08:14:17 +01:00

1381 lines
39 KiB
Plaintext
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

================================================================================
GeViScope SDK Documentation - Pages 41 to 60
================================================================================
============================================================
PAGE 41
============================================================
Examples grouped by programming tasks
Conne c t to and di s c onne c t f r om a Ge Vi Sc ope s e r v e r
l LiveStream (CodeGear C++ Builder 6 and 2009)
l SimpleClient (CodeGear Delphi 7, 2005 and 2009)
l GSCLiveStream (Microsoft Visual Studio 2005, C++, MFC)
l VS2008CPP_SimpleClient (Microsoft Visual Studio 2008, C++, MFC)
l VS2008CPP_ActionsAndEvents (Microsoft Visual Studio 2008, C++, MFC)
l VS2008NET_SimpleClient (Microsoft Visual Studio 2008, C#)
l VS2008NET_ActionsAndEvents (Microsoft Visual Studio 2008, C#)
l VS2008WPF_SimpleClient (Microsoft Visual Studio 2008, C#, WPF)
l VS2010NET_SimpleClient (Microsoft Visual Studio 2010, C#)
l VS2010NET_ActionsAndEvents (Microsoft Visual Studio 2010, C#)
l VS2010WPF_SimpleClient (Microsoft Visual Studio 2010, C#, WPF)
Enum e r ate e x i s ti ng m e di a c hanne l s and e v e nt ty pe s f r om a
Ge Vi Sc ope s e r v e r
l LiveStream (CodeGear C++ Builder 6 and 2009)
l SimpleClient (CodeGear Delphi 7, 2005 and 2009)
l GSCLiveStream (Microsoft Visual Studio 2005, C++, MFC)
l VS2008CPP_SimpleClient (Microsoft Visual Studio 2008, C++, MFC)
l VS2008CPP_ActionsAndEvents (Microsoft Visual Studio 2008, C++, MFC)
l VS2008NET_GscRegEdit (Microsoft Visual Studio 2008, C#)
l VS2008NET_GscRegistryBasics (Microsoft Visual Studio 2008, C#)
l VS2008NET_SimpleClient (Microsoft Visual Studio 2008, C#)
l VS2010CPP_ConfigReader (Microsoft Visual Studio 2010, C++)
l VS2010NET_SimpleClient (Microsoft Visual Studio 2010, C#)
l VS2010NET_ActionsAndEvents (Microsoft Visual Studio 2010, C#)
l VS2010NET_GscRegEdit (Microsoft Visual Studio 2010, C#)
l VS2010NET_GscRegistryBasics (Microsoft Visual Studio 2010, C#)
l VS2010WPF_SimpleClient (Microsoft Visual Studio 2010, C#, WPF)
Di s pl ay l i v e and r e c or de d m e di a w i th the Me di a Pl ay e r i nte r -
f a c e
l LiveStream (CodeGear C++ Builder 6 and 2009)
l SimpleClient (CodeGear Delphi 7, 2005 and 2009)
l GSCLiveStream (Microsoft Visual Studio 2005, C++, MFC)
l VS2008CPP_SimpleClient (Microsoft Visual Studio 2008, C++, MFC)
l VS2008CPP_ActionsAndEvents (Microsoft Visual Studio 2008, C++, MFC)
l VS2008NET_SimpleClient (Microsoft Visual Studio 2008, C#)
l VS2008WPF_SimpleClient (Microsoft Visual Studio 2008, C#, WPF)
l VS2010NET_SimpleClient (Microsoft Visual Studio 2010, C#)
l VS2010WPF_SimpleClient (Microsoft Visual Studio 2010, C#, WPF)
Di s pl ay r e c or de d e v e nt m e di a w i th the Me di aPl ay e r i nte r f a c e
l VS2008CPP_ActionsAndEvents (Microsoft Visual Studio 2008, C++, MFC)
l VS2008NET_ActionsAndEvents (Microsoft Visual Studio 2008, C#)
l VS2010NET_ActionsAndEvents (Microsoft Visual Studio 2010, C#)
============================================================
PAGE 42
============================================================
Ha ndl i ng ac ti ons and PLC noti f i c a ti ons
l GSCActions (CodeGear C++ Builder 6 and 2009)
l SimpleClient (CodeGear Delphi 7, 2005 and 2009)
l ResourceStateMonitor (Delphi 2009)
l VS2008CPP_ActionsAndEvents (Microsoft Visual Studio 2008, C++, MFC)
l VS2008NET_ActionsAndEvents (Microsoft Visual Studio 2008, C#)
l VS2010CPP_ControlBlockingFilters (Microsoft Visual Studio 2010, C++)
l VS2010NET_ActionsAndEvents (Microsoft Visual Studio 2010, C#)
Ha ndl i ng e v e nts
l LiveStream (CodeGear C++ Builder 6 and 2009)
l GSCLiveStream (Microsoft Visual Studio 2005, C++, MFC)
l VS2008CPP_ActionsAndEvents (Microsoft Visual Studio 2008, C++, MFC)
l VS2008NET_ActionsAndEvents (Microsoft Visual Studio 2008, C#)
l VS2010NET_ActionsAndEvents (Microsoft Visual Studio 2010, C#)
Cr e ati ng bac k ups
l Backup (CodeGear Delphi 7 and 2009)
Sy nc hr oni ze d di s pl ay of m or e tha n one m e di a c ha nne l s
l SynchPlayback (CodeGear C++ Builder 6 and 2009)
Cus tom dr aw i n v i e w e r s of Me di aPl a y e r i nte r f a c e
l SynchPlayback (CodeGear C++ Builder 6 and 2009)
l VS2008CPP_SimpleClient (Microsoft Visual Studio 2008, C++, MFC)
l VS2008NET_SimpleClient (Microsoft Visual Studio 2008, C#)
l VS2010NET_SimpleClient (Microsoft Visual Studio 2010, C#)
Ex por t pi c tur e data
l MediaPlayerExport (CodeGear Delphi 7 and 2009)
l MPEGExport (CodeGear Delphi 7 and 2009)
l VS2008NET_MediaPlayerExport (Microsoft Visual Studio 2008, C#)
l VS2010NET_MediaPlayerExport (Microsoft Visual Studio 2010, C#)
Contr ol PTZ c am s
l Telecontrol (CodeGear Delphi 7 and 2009)
F e tc h a us e r bl oc k i ng l i s t f r om the s e r v e r
l UserBlockingList (CodeGear C++ Builder 6 and 2009)
De c om pr e s s l i v e and r e c or de d m e di a w i th the of f s c r e e n
v i e w e r
l OffscreenViewer (CodeGear Delphi 7 and 2009)
l VS2008CPP_OffscreenViewer (Microsoft Visual Studio 2008, C++, MFC)
============================================================
PAGE 43
============================================================
l VS2008CPP_OffscreenViewer_Console (Microsoft Visual Studio 2008, C++)
l VS2008NET_OffscreenViewer (Microsoft Visual Studio 2008, C#)
l VS2010NET_OffscreenViewer (Microsoft Visual Studio 2010, C#)
De c om pr e s s r a w l i v e m e di a by us i ng the DBI
l VS2008CPP_RawLiveStreamDecompress (Microsoft Visual Studio 2008, C++,
MFC)
l VS2008CPP_RawLiveStreamDecompress_Console (Microsoft Visual Studio 2008,
C++)
Cr e ate a ge ne r a l s e r v i c e appl i c a ti on
l WindowsService (CodeGear C++ Builder 6 and 2009)
l VS2008CPP_ServiceFrameworkDemo (Microsoft Visual Studio 2008, C++)
l VS2008NET_ServiceFrameworkDemo (Microsoft Visual Studio 2008, C#)
l VS2010NET_ServiceFrameworkDemo (Microsoft Visual Studio 2010, C#)
F ul l -dupl e x audi o c om m uni c ati on be tw e e n Ge Vi Sc ope c om -
pone nts
The AudioBackChannel GeViScope Server Plugin (Visual Studio 2010) is an example for a
GeViScope Server plugin. It realizes a full-duplex audio communication between different
GeViScope components. The full scope of operation can be found in the document Audio
Back Channel (ABC) Plugin documentation.
Si m ul ate m e di a c hanne l s i n Ge Vi Sc ope s e r v e r s
The MCS (Media Channel Simulator) GeViScope Server Plugin (CodeGear C++ Builder 6)
is another example for a GeViScope Server plugin. It shows how to channel media data
inside the GeViScope system without using special video hardware. In addition the handling
of actions inside a server plugin is demonstrated. The full scope of operation can be found in
the document MCS Documentation.
Si m ul ate a s c r e e n s a v e r as a Ge v i Sc ope Se r v e r Pl ugi n
The DelphiScreenSaverPlugin GeViScope Server Plugin (CodeGear Delphi 7) is another
example to demonstrate channeling media into a GeViScope Server with the help of a
Server Plugin.
Pr ov i de a c us tom i z e d data f i l te r di al og i n GSCVi e w
GSCView offers the possibility to integrate customized data filter dialogs. Data filter dialogs
are used to search and filter video footage by additional event data. They can be customized
to the different business environments in which GeViScope is used. Detailed information
can be found in the document GSCView data filter plugins.
The following examples demonstrate how to create customized data filter dialogs:
l SimpleGSCViewDataFilter (CodeGear Delphi 7 and 2009)
l GSCViewDataFilter (CodeGear Delphi 7 and 2009)
l VS2008CPP_SimpleGSCViewDataFilter (Microsoft Visual Studio 2008, C++, MFC)
Pr e s e nti ng GEU TEBRÜ CK Ba c k up F i l e s (GBF )
============================================================
PAGE 44
============================================================
l VS2008CPP_SimpleGBFViewer (Microsoft Visual Studio 2008, C++, MFC)
l SimpleGBFViewer (CodeGear Delphi 2009)
l VS2008NET_SimpleGBFViewer (Microsoft Visual Studio 2008, C#)
Moni tor the s tate of m e di a c hanne l s (c am e r a s )
l ResourceStateMonitor (CodeGear Delphi 2009)
Examples grouped by development platforms
Code Ge ar C+ + Bui l de r 6 and 2009 ©
l LiveStream
Connect to and disconnect from a GeViScope server
enumerate existing media channels and event types from a GeViScope server
Display live and recorded media with the MediaPlayer interface
Handling events
l GSCActions
Connect to and disconnect from a GeViScope server
Handling actions
l SynchPlayback
Connect to and disconnect from a GeViScope server
enumerate existing media channels and event types from a GeViScope server
Display live and recorded media with the MediaPlayer interface
Handling events
Synchronized display of more than one media channels
l UserBlockingList
Connect to and disconnect from a GeViScope server
Fetch a user blocking list from the server
l WindowsService
WindowsService (CodeGear C++ Builder 6 and 2009)
l The MCS(Media Channel Simulator) GeViScope Server Plugin is another example
for a GeViScope Server plugin. It shows how to channel media data inside the GeViS-
cope system without using special video hardware. In addition the handling of
actions inside a server plugin is demonstrated. The full scope of operation can be
found in the document MCS Documentation.
Code Ge ar De l phi 7, 2005 und 2009 ©
l SimpleClient
Connect to and disconnect from a GeViScope server
enumerate existing media channels and event types from a GeViScope server
Display live and recorded media with the MediaPlayer interface
l Backup
Connect to and disconnect from a GeViScope server
enumerate existing media channels from a GeViScope server
Creating backups
l MediaPlayerExport
Connect to and disconnect from a GeViScope server
enumerate existing media channels from a GeViScope server
Export picture data
l MPEGExport
Connect to and disconnect from a GeViScope server
enumerate existing media channels from a GeViScope server
============================================================
PAGE 45
============================================================
Export picture data
l Telecontrol
Connect to and disconnect from a GeViScope server
enumerate existing media channels and event types from a GeViScope server
Display live and recorded media with the MediaPlayer interface
Handling actions
Control PTZ cams
l OffscreenViewer
Connect to and disconnect from a GeViScope server
enumerate existing media channels from a GeViScope server
Decompress live and recorded media
Custom draw
l The SimpleGSCViewDataFilter and GSCViewDataFilter example are examples for
customized data filter dialogs of GSCView. Detailed information can be found in the
document GSCView data filter plugins.
l SimpleGBFViewer (only Delphi 2009)
Open and close a GEUTEBRÜCK Backup Files (GBF)
enumerate existing media channels in the GBF file
Display media with the MediaPlayer interface
l ResourceStateMonitor (only Delphi 2009)
Connect to and disconnect from a GeViScope server
enumerate existing media channels from a GeViScope server
monitor the state of media channels (cameras)
Handling actions
Mi c r os of t Vi s ual Studi o 2005, C+ + , MF C ©
l GSCLiveStream
Connect to and disconnect from a GeViScope server
enumerate existing media channels from a GeViScope server
Display live and recorded media with the MediaPlayer interface
Mi c r os of t Vi s ual Studi o 2005, C+ + , CLI ©
l The VSIPCamPlugin GeViScope Server Plugin is an example to show how simple it
is to channel some pictures from an IP cam into a GeViScope server
Mi c r os of t Vi s ual Studi o 2008, C+ + , MF C ©
l VS2008CPP_SimpleClient
Connect to and disconnect from a GeViScope server
enumerate existing media channels from a GeViScope server
Display live and recorded media with the MediaPlayer interface
Custom draw
l VS2008CPP_OffscreenViewer
Connect to and disconnect from a GeViScope server
enumerate existing media channels from a GeViScope server
Decompress live and recorded media
Custom draw
l VS2008CPP_ActionsAndEvents
Connect to and disconnect from a GeViScope server
enumerate existing media channels and event types from a GeViScope server
Display live and recorded media with the MediaPlayer interface
Handling actions
============================================================
PAGE 46
============================================================
Handling events
Display recorded event media with the MediaPlayer interface
l VS2008CPP_SimpleGBFViewer
Open and close a GEUTEBRÜCK Backup Files (GBF)
enumerate existing media channels in the GBF file
Display media with the MediaPlayer interface
l The VS2008CPP_SimpleGSCViewDataFilter example is an example for a cus-
tomized data filter dialog of GSCView. Detailed information can be found in the doc-
ument GSCView data filter plugins.
l VS2008CPP_RawLiveStreamDecompress_Console
Receiving live streams by using the DBI
Decompressing frames by means of the decompressor object of the GscMe-
diaPlayer-DLL
l VS2008CPP_OffscreenViewer_Console
Using the OffscreenViewer to receive a live stream in a console application
OffscreenViewer provides a decompressed image in a callback
Only the picture ID (PicID) of the image will be displayed in the console
l VS2008CPP_RawLiveStreamDecompress_Console
Receiving live streams by using the DBI
Decompressing frames by means of the decompressor object of the GscMe-
diaPlayer-DLL
l VS2008CPP_OffscreenViewer_Console
Using the OffscreenViewer to receive a live stream in a console application
OffscreenViewer provides a decompressed image in a callback
Only the picture ID (PicID) of the image will be displayed in the console
Mi c r os of t Ac ti v e X ©
l GscViewer (ActiveX Control)
Encapsulating of GeViScope functionality into an ActiveX control
l ActiveX_DOTNETClient
Invocation of the GscViewer ActiveX control from C#
l ActiveX_HTML_Page
Invocation of the GscViewer ActiveX control from inside a web page (html)
l ActiveX_VB6Client (deprecated)
Invocation of the GscViewer ActiveX control from inside a VB6 application
l ActiveX_VB6MultiClient (deprecated)
Invocation of several GscViewer ActiveX control from inside a VB6 application
Mi c r os of t Vi s ual Studi o 2008, C# ©
l VS2008NET_SimpleClient
Connect to and disconnect from a GeViScope server
enumerate existing media channels from a GeViScope server
Display live and recorded media with the MediaPlayer interface
Custom draw
l VS2008NET_ActionsAndEvents
Connect to and disconnect from a GeViScope server
enumerate existing media channels and event types from a GeViScope server
Display live and recorded media with the MediaPlayer interface
Handling actions
Handling events
Display recorded event media with the MediaPlayer interface
============================================================
PAGE 47
============================================================
l VS2008NET_OffscreenViewer
Connect to and disconnect from a GeViScope server
enumerate existing media channels from a GeViScope server
Decompress live and recorded media
Custom draw
l VS2008NET_RawDBDecompress
Fetching database records
Decompressing the fetched records as fast as possible
l VS2008NET_MediaPlayerExport
Connect to and disconnect from a GeViScope server
enumerate existing media channels from a GeViScope server
Export picture data
l VS2008NET_SimpleGBFViewer
Open and close a GEUTEBRÜCK Backup Files (GBF)
enumerate existing media channels in the GBF file
Display media with the MediaPlayer interface
l The VS2010NET_ServiceFrameworkDemo example
is an example for a general service application. Services based on the
GEUTEBRÜCK
Service Framework behave like all GEUTEBRÜCK product
l VS2008NET_GscRegEdit
Simple GeViScope registry editor
Connect to a GeViScope server
Modify GeViScope settings using the GeViScope registry
Export settings to GeViScope registry file format
l VS2008NET_GscRegistryBasics
Simple demonstration in using the GeViScope registry
Reading out media channels
Add a value to the GeViScope registry
Saving the GeViScope registry
Mi c r os of t Vi s ual Studi o 2008, C# , WPF ©
l VS2008WPF_SimpleClient
Connect to and disconnect from a GeViScope server
enumerate existing media channels from a GeViScope server
Display live and recorded media with the MediaPlayer interface
Mi c r os of t Vi s ual Studi o 2010, C+ +
l VS2010CPP_ConfigReader
l VS2010CPP_ControlBlockingFilters
Mi c r os of t Vi s ual Studi o 2010, C# ©
l VS2010NET_SimpleClient
Connect to and disconnect from a GeViScope server
enumerate existing media channels from a GeViScope server
Display live and recorded media with the MediaPlayer interface
Custom draw
l VS2010NET_ActionsAndEvents
Connect to and disconnect from a GeViScope server
enumerate existing media channels and event types from a GeViScope server
Display live and recorded media with the MediaPlayer interface
============================================================
PAGE 48
============================================================
Handling actions
Handling events
Display recorded event media with the MediaPlayer interface
l VS2010NET_OffscreenViewer
Connect to and disconnect from a GeViScope server
enumerate existing media channels from a GeViScope server
Decompress live and recorded media
Custom draw
l VS2010NET_RawDBDecompress
Fetching database records
Decompressing the fetched records as fast as possible
l VS2010NET_MediaPlayerExport
Connect to and disconnect from a GeViScope server
enumerate existing media channels from a GeViScope server
Export picture data
l VS2010NET_SimpleGBFViewer
Open and close a GEUTEBRÜCK Backup Files (GBF)
enumerate existing media channels in the GBF file
Display media with the MediaPlayer interface
l The VS2010NET_ServiceFrameworkDemo
example is an example for a general service application. Services based on
the GEUTEBRÜCK Service Framework behave like all GEUTEBRÜCK
product services.
l VS2010NET_GscRegEdit
Simple GeViScope registry editor
Connect to a GeViScope server
Modify GeViScope settings using the GeViScope registry
Export settings to GeViScope registry file format
l VS2010NET_GscRegistryBasics
Simple demonstration in using the GeViScope registry
Reading out media channels
Add a value to the GeViScope registry
Saving the GeViScope registry
Mi c r os of t Vi s ual Studi o 2010, C# , WPF ©
l VS2010WPF_SimpleClient
Connect to and disconnect from a GeViScope server
enumerate existing media channels from a GeViScope server
Display live and recorded media with the MediaPlayer interface
============================================================
PAGE 49
============================================================
Action documentation
The following chapter contains a short overview about the existing GEUTEBRÜCK actions
and there parameter descriptions.
ATM / ACS
ACS access denied
Action name:ACSAccessDenied(ACSName, ACSNo, Account, BancCode, CardNo,
TimeStamp, Reason)Action category: logical ACS access denied.
Parameter
Function
ACS
ACSName
ACS name.
ACS no
ACSNo
ACS no.
account
Account
Account no.
bank code
BancCode
Bank code.
card no
CardNo
Card no.
time stamp TimeStamp Time stamp.
reason
Reason
Reason.
ACS access granted
Action name:ACSAccessGranted(ACSName, ACSNo, Account, BancCode, CardNo,
TimeStamp)Action category: logical
ACS access granted.
Parameter
Function
ACS
ACSName
ACS name.
ACS no
ACSNo
ACS no.
account
Account
Account no.
bank code
BancCode
Bank code.
card no
CardNo
Card no.
time stamp TimeStamp Time stamp.
ACS raw answer
Action name:ACSRawAnswer(ACSName, TimeStamp, ACSData)Action category: logical
ACS raw answer.
Parameter
Function
ACS
ACSName
ACS name.
time stamp TimeStamp Time stamp.
answer
ACSData
ACS answer.
ACS raw data
Action name:ACSRawData(ACSName, TimeStamp, ACSData)Action category: logical
============================================================
PAGE 50
============================================================
ACS raw data.
Parameter
Function
ACS
ACSName
ACS name.
time stamp TimeStamp Time stamp.
data
ACSData
ACS data.
ATM raw answer
Action name:ATMRawAnswer(ATMName, TimeStamp, ATMData)Action category: logical
ATM raw answer.
Parameter
Function
ATM
ATMName
ATM name.
time stamp TimeStamp Time stamp.
answer
ATMData
ATM answer.
ATM raw data
Action name:ATMRawData(ATMName, TimeStamp, ATMData)Action category: logical
ATM raw data.
Parameter
Function
ATM
ATMName
ATM name.
time stamp TimeStamp Time stamp.
data
ATMData
ATM data.
ATM transaction
Action name:ATMTransaction(ATMName, NewTransaction, Photostep, ATMNo, Account,
BancCode, CardNo, TAN1, TAN2, TimeStamp1, TimeStamp2, Amount, Currency)Action
category: logical ATM transaction.
Parameter
Function
ATM
ATMName
ATM name.
new transaction NewTransaction New transaction.
photostep
Photostep
Photostep.
ATM no
ATMNo
ATM no.
account
Account
Account no.
bank code
BancCode
Bank code.
card no
CardNo
Card no.
tan 1
TAN1
TAN 1.
tan 2
TAN2
TAN 2.
time stamp 1
TimeStamp1
Time stamp 1.
time stamp 2
TimeStamp2
Time stamp 2.
amount
Amount
Amount.
currency
Currency
Currency.
============================================================
PAGE 51
============================================================
Audio control
All actions to control the audio streams, also all notifications about the state change of the
audio streams.
ABC connect
Action name:ABCConnect(Address)Action category: logical Connect audio back channel.
Parameter
Function
address Address Address of the remote server.
ABC disconnect
Action name:ABCDisconnect()Action category: logical Disconnect audio back channel.
ABC play file
Action name:ABCPlayFile(FileID, FileName, AutoRepeat)Action category: logical Play file
on audio back channel.
Parameter
Function
file id
FileID
File ID.
file name FileName
Name of the file.
repeat
AutoRepeat Repeat file automatically
Sensor audio alarm
Action name:SensorAudioAlarm(Channel)Action category: logical Audio alarm detected.
Parameter
Function
channel Channel Channel.
Backup actions
All actions for backup.
Abort all auto backups
Action name:AbortAllAutoBackups()Action category: logical Abort all auto backups.
Abort auto backup
Action name:AbortAutoBackup(Schedule)Action category: logical Abort auto backup.
Parameter
Function
schedule
Schedule
Schedule.
Auto backup capacity warning
Action name:AutoBackupCapacityMonitoringCapacityWarning(Warning, Destination,
TotalCapacity, FreeCapacity, AllocatedByGbf, PercentFree, PercentAllocated, Per-
============================================================
PAGE 52
============================================================
centAllocatedByGbf)Action category: logical Auto backup capacity monitoring: capacity
warning.
Parameter
Function
warning
Warning
Warning.
destination
Destination
Destination.
total capacity
TotalCapacity
Total capacity.
free capacity
FreeCapacity
Free capacity.
allocated by GBF
AllocatedByGbf
Allocated by GBF.
percent free
PercentFree
Percent free.
percent allocated
PercentAllocated
Percent allocated.
percent allocated by GBF PercentAllocatedByGbf Percent allocated by GBF.
Auto backup capacity file auto deleted
Action name:AutoBackupCapacityMonitoringFileAutoDeleted(Warning, Destination,
TotalCapacity, FreeCapacity, AllocatedByGbf, PercentFree, PercentAllocated, Per-
centAllocatedByGbf, FileSize, FileName)Action category: logical Auto backup capacity
monitoring: file auto deleted.
Parameter
Function
warning
Warning
Warning.
destination
Destination
Destination.
total capacity
TotalCapacity
Total capacity.
free capacity
FreeCapacity
Free capacity.
allocated by GBF
AllocatedByGbf
Allocated by GBF.
percent free
PercentFree
Percent free.
percent allocated
PercentAllocated
Percent allocated.
percent allocated by GBF PercentAllocatedByGbf Percent allocated by GBF.
file size
FileSize
File size.
file name
FileName
File name.
Auto backup capacity out of disk space
Action name:AutoBackupCapacityMonitoringOutOfDiskSpace(Warning, Destination,
TotalCapacity, FreeCapacity, AllocatedByGbf, PercentFree, PercentAllocated, Per-
centAllocatedByGbf)Action category: logical Auto backup capacity monitoring: out of disk
space.
Parameter
Function
warning
Warning
Warning.
destination
Destination
Destination.
total capacity
TotalCapacity
Total capacity.
free capacity
FreeCapacity
Free capacity.
allocated by GBF
AllocatedByGbf
Allocated by GBF.
percent free
PercentFree
Percent free.
percent allocated
PercentAllocated
Percent allocated.
percent allocated by GBF PercentAllocatedByGbf Percent allocated by GBF.
============================================================
PAGE 53
============================================================
Auto backup file done
Action name:AutoBackupFileDone(Schedule, StartTime, EffectiveStartTime, Oper-
ationCount, TimerStart, OperationIndex, OperationStartTime, Source, Destination, FileS-
izeLimit, BandWidthLimit, FileIndex, FileName, FileSize)Action category: logical Auto
backup progress notification: file done.
Parameter
Function
schedule
Schedule
Schedule.
start time
StartTime
Start time, empty during event backup.
effective start time
EffectiveStartTime
Effective schedule start time.
operation count
OperationCount
Operation count.
timer start
TimerStart
Timer start.
operation index
OperationIndex
Operation index.
operation start time OperationStartTime Operation start time.
source
Source
Source.
destination
Destination
Destination.
file size limit
FileSizeLimit
File size limit.
band width limit
BandWidthLimit
Band width limit.
file index
FileIndex
File index.
file name
FileName
File name.
file size
FileSize
File size.
Auto backup file progress
Action name:AutoBackupFileProgress(Schedule, StartTime, EffectiveStartTime, Oper-
ationCount, TimerStart, OperationIndex, OperationStartTime, Source, Destination, FileS-
izeLimit, BandWidthLimit, FileIndex, FileName, FileSize)Action category: logical Auto
backup progress notification: file progress.
Parameter
Function
schedule
Schedule
Schedule.
start time
StartTime
Start time, empty during event backup.
effective start time
EffectiveStartTime
Effective schedule start time.
operation count
OperationCount
Operation count.
timer start
TimerStart
Timer start.
operation index
OperationIndex
Operation index.
operation start time OperationStartTime Operation start time.
source
Source
Source.
destination
Destination
Destination.
file size limit
FileSizeLimit
File size limit.
band width limit
BandWidthLimit
Band width limit.
file index
FileIndex
File index.
file name
FileName
File name.
file size
FileSize
File size.
Auto backup file started
Action name:AutoBackupFileStarted(Schedule, StartTime, EffectiveStartTime, Oper-
ationCount, TimerStart, OperationIndex, OperationStartTime, Source, Destination,
============================================================
PAGE 54
============================================================
FileSizeLimit, BandWidthLimit, FileIndex, FileName)Action category: logical Auto backup
progress notification: file started.
Parameter
Function
schedule
Schedule
Schedule.
start time
StartTime
Start time, empty during event backup.
effective start time
EffectiveStartTime
Effective schedule start time.
operation count
OperationCount
Operation count.
timer start
TimerStart
Timer start.
operation index
OperationIndex
Operation index.
operation start time OperationStartTime Operation start time.
source
Source
Source.
destination
Destination
Destination.
file size limit
FileSizeLimit
File size limit.
band width limit
BandWidthLimit
Band width limit.
file index
FileIndex
File index.
file name
FileName
File name.
Auto backup operation done
Action name:AutoBackupOperationDone(Schedule, StartTime, EffectiveStartTime, Oper-
ationCount, TimerStart, OperationIndex, OperationStartTime, OperationStopTime, Source,
Destination, FileSizeLimit, BandWidthLimit)Action category: logical Auto backup progress
notification: operation done.
Parameter
Function
schedule
Schedule
Schedule.
start time
StartTime
Start time, empty during event backup.
effective start time
EffectiveStartTime
Effective schedule start time.
operation count
OperationCount
Operation count.
timer start
TimerStart
Timer start.
operation index
OperationIndex
Operation index.
operation start time OperationStartTime Operation start time.
operation stop time OperationStopTime Operation stop time.
source
Source
Source.
destination
Destination
Destination.
file size limit
FileSizeLimit
File size limit.
band width limit
BandWidthLimit
Band width limit.
Auto backup operation started
Action name:AutoBackupOperationStarted(Schedule, StartTime, EffectiveStartTime, Oper-
ationCount, TimerStart, OperationIndex, OperationStartTime, Source, Destination, FileS-
izeLimit, BandWidthLimit)Action category: logical Auto backup progress notification:
operation started.
Parameter
Function
schedule
Schedule
Schedule.
start time
StartTime
Start time, empty during event backup.
effective start time
EffectiveStartTime
Effective schedule start time.
operation count
OperationCount
Operation count.
============================================================
PAGE 55
============================================================
Parameter
Function
timer start
TimerStart
Timer start.
operation index
OperationIndex
Operation index.
operation start time OperationStartTime Operation start time.
source
Source
Source.
destination
Destination
Destination.
file size limit
FileSizeLimit
File size limit.
band width limit
BandWidthLimit
Band width limit.
Auto backup schedule done
Action name:AutoBackupScheduleDone(Schedule, StartTime, EffectiveStartTime,
StopTime, OperationCount, TimerStart)Action category: logical Auto backup progress noti-
fication: schedule done.
Parameter
Function
schedule
Schedule
Schedule.
start time
StartTime
Start time, empty during event backup.
effective start time EffectiveStartTime Effective schedule start time.
stop time
StopTime
Schedule stop time.
operation count
OperationCount
Operation count.
timer start
TimerStart
Timer start.
Auto backup schedule started
Action name:AutoBackupScheduleStarted(Schedule, StartTime, EffectiveStartTime, Oper-
ationCount, TimerStart)Action category: logical Auto backup progress notification: schedule
started.
Parameter
Function
schedule
Schedule
Schedule.
start time
StartTime
Start time, empty during event backup.
effective start time EffectiveStartTime Effective schedule start time.
operation count
OperationCount
Operation count.
timer start
TimerStart
Timer start.
Backup event
Action name:BackupEvent(EventID, TypeID, Destination, StartHintID, StopHintID, Sub-
folder)Action category: logical Backup event.
Parameter
Function
instance ID
EventID
Instance ID of the event.
event type
TypeID
Type of the event.
destination
Destination
Destination.
start hint ID
StartHintID
Optional start hint ID.
stop hint ID
StopHintID
Optional stop hint ID.
sub folder
Subfolder
Sub folder to backup event.
============================================================
PAGE 56
============================================================
Event backup done
Action name:EventBackupDone(JobID, EventTypeID, EventID, Destination, FileSizeLimit,
BandWidthLimit, StartTime, StopTime)Action category: logical Event backup progress noti-
fication: backup done.
Parameter
Function
job ID
JobID
Backup job ID.
event type
EventTypeID
Type of the event.
instance ID
EventID
Instance ID of the event.
destination
Destination
Destination.
file size limit
FileSizeLimit
File size limit.
band width limit
BandWidthLimit
Band width limit.
start time
StartTime
Backup start time.
stop time
StopTime
Backup stop time.
Event backup file done
Action name:EventBackupFileDone(JobID, EventTypeID, EventID, Destination, FileS-
izeLimit, BandWidthLimit, StartTime, FileIndex, FileName, FileSize)Action category:
logical Event backup progress notification: file done.
Parameter
Function
job ID
JobID
Backup job ID.
event type
EventTypeID
Type of the event.
instance ID
EventID
Instance ID of the event.
destination
Destination
Destination.
file size limit
FileSizeLimit
File size limit.
band width limit
BandWidthLimit
Band width limit.
start time
StartTime
Effective backup start time.
file index
FileIndex
File index.
file name
FileName
File name.
file size
FileSize
File size.
Event backup file progress
Action name:EventBackupFileProgress(JobID, EventTypeID, EventID, Destination, FileS-
izeLimit, BandWidthLimit, StartTime, FileIndex, FileName, FileSize)Action category:
logical Event backup progress notification: file progress.
Parameter
Function
job ID
JobID
Backup job ID.
event type
EventTypeID
Type of the event.
instance ID
EventID
Instance ID of the event.
destination
Destination
Destination.
file size limit
FileSizeLimit
File size limit.
band width limit
BandWidthLimit
Band width limit.
start time
StartTime
Effective backup start time.
file index
FileIndex
File index.
file name
FileName
File name.
file size
FileSize
File size.
============================================================
PAGE 57
============================================================
Event backup file started
Action name:EventBackupFileStarted(JobID, EventTypeID, EventID, Destination, FileS-
izeLimit, BandWidthLimit, StartTime, FileIndex, FileName)Action category: logical Event
backup progress notification: file started.
Parameter
Function
job ID
JobID
Backup job ID.
event type
EventTypeID
Type of the event.
instance ID
EventID
Instance ID of the event.
destination
Destination
Destination.
file size limit
FileSizeLimit
File size limit.
band width limit
BandWidthLimit
Band width limit.
start time
StartTime
Effective backup start time.
file index
FileIndex
File index.
file name
FileName
File name.
Event backup started
Action name:EventBackupStarted(JobID, EventTypeID, EventID, Destination, FileS-
izeLimit, BandWidthLimit, StartTime)Action category: logical Event backup progress noti-
fication: backup started.
Parameter
Function
job ID
JobID
Backup job ID.
event type
EventTypeID
Type of the event.
instance ID
EventID
Instance ID of the event.
destination
Destination
Destination.
file size limit
FileSizeLimit
File size limit.
band width limit
BandWidthLimit
Band width limit.
start time
StartTime
Backup start time.
Start auto backup
Action name:StartAutoBackup(Schedule)Action category: logical Start auto backup.
Parameter
Function
schedule
Schedule
Schedule.
Camera control
Actions to set and control PTZ/normal cameras.
Note: Which camera types are supported always depends on model and man-
ufacturer!
Auto focus off
Action name: AutoFocusOff(PTZ Head)
Action category: command
This action disables the auto-focus function of the camera.
============================================================
PAGE 58
============================================================
Parameter
Function
PTZ head
Camera
Global camera number
Auto focus on
Action name:AutoFocusOn(PTZ Head)
Action category: command
This action enables the auto-focus function of the camera.
Parameter
Function
PTZ head
Camera
Global camera number
Camera backlight compensation mode
Action name: CameraBacklightCompensationMode(PTZ Head, mode)
Category: command
This action changes the backlight compensation of the camera.
Parameter
Function
PTZ head
Camera
Global camera number
mode
Mode
off=backlight compensation is turned off
on=backlight compensation is turned on
Camera clear preset text
Action name: CameraClearPresetText(PTZ Head, position)
Category: command
This action clears the text that was previously defined and assigned to a particular camera
position by the action “CameraSetPresetText” and displayed when the camera moves to
this position.
Parameter
Function
PTZ head
Camera
Global camera number
position
Position
Number of the camera position for which the
previously defined text (by the action “Cam-
eraSetPresetText”) has to be cleared.
Camera day/night mode
Action name: CameraDayNightMode(PTZ Head, mode)
Category: command
This action changes the day/night mode of the camera.
Parameter
Function
PTZ head
Camera
Global camera number
mode
Mode
day=day mode is activated
night=night mode is activated
auto=the camera changes automatically
between day and night mode
Camera light off
Action name: CameraLightOff(PTZ Head)
Category: command
This action turns the camera light off.
============================================================
PAGE 59
============================================================
Parameter
Function
PTZ head
Camera
Global camera number
Camera light on
Action name: CameraLightOn(PTZ Head)
Category: command
This action turns the camera light on.
Parameter
Function
PTZ head
Camera
Global camera number
Camera manual iris off
Action name: CameraManualIrisOff(PTZ Head)
Category: command
This action disables the option to adjust the camera iris manually.
Parameter
Function
PTZ head
Camera
Global camera number
Camera manual iris on
Action name: CameraManualIrisOn(PTZ Head)
Category: command
This action enables the option to adjust the camera iris manually.
Parameter
Function
PTZ head
Camera
Global camera number
Camera off
Action name: CameraOff(PTZ Head)
Category: command
This action turns off the camera.
Parameter
Function
PTZ head
Camera
Global camera number
Camera on
Action name: CameraOn(PTZ Head)
Category: command
This action turns on the camera.
Parameter
Function
PTZ head
Camera
Global camera number
Camera pump off
Action name: CameraPumpOff(PTZ Head)
Category: command
This action disables the pump of the camera.
Parameter
Function
PTZ head
Camera
Global camera number
============================================================
PAGE 60
============================================================
Camera pump on
Action name: CameraPumpOn(PTZ Head)
Category: command
This action enables the pump of the camera.
Parameter
Function
PTZ head
Camera
Global camera number
Camera RAW output
Action name: CameraRAWOutput(PTZ Head, output)
Category: command
This action sends a raw string (parameter output) to the camera.
Parameter
Function
PTZ head
Camera
Global camera number
output
Output
raw string
The following escape sequences are sup-
ported:
\\a, b, f, n, r, t, v => \ a, b, f, n, r, t, v
\\\=> \\
\\‘ => \‘ 
\“ => \“ 
\Xhh or \xhh => ASCII-character
Camera select char mode
For internal use only
Camera set preset text
Action name: CameraSetPresetText(PTZ Head, position)
Category: command
With this action, one defines the text that is associated with a particular camera position
and displayed when the camera moves to this position.
Parameter
Function
PTZ head
Camera
Global camera number
position
Position
Number of the camera for which the text is
defined.
Camera spec func U off
Action name: CameraSpecFuncUOff(PTZ Head)
Category: command
Special functions are mapped to this action.
(MBeg functions X, Y, U and V).
Parameter
Function
PTZ head
Camera
Global camera number
Camera spec func U on
Action name: CameraSpecFuncUOn(PTZ Head)
Category: command
Reference in New Issue View Git Blame Copy Permalink