COLSYS/geutebruck
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
a92b9095390577031a38173710950b5bf1a3c7a1
geutebruck/GeViScope_SDK_Docs/GeViScope_SDK_Part06_Pages_101-120.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

1444 lines
46 KiB
Plaintext
Raw Blame History

================================================================================
GeViScope SDK Documentation - Pages 101 to 120
================================================================================
============================================================
PAGE 101
============================================================
Parameter
Function
time stamp
TimeStamp
Time stamp.
reset time stamp ResetTimeStamp Reset time stamp.
OBTRACK channel counter threshold
Action name:ObtrackChannelCounterThreshold(Channel, CounterType, CounterValue,
ExceedingDirection, TimeStamp)
Action category: logical
OBTRACK channel counter threshold.
Parameter
Function
channel
Channel
Channel.
counter type
CounterType
Counter type.
counter value
CounterValue
Counter value.
exceeding direction ExceedingDirection Exceeding direction.
time stamp
TimeStamp
Time stamp.
OBTRACK channel set counter
Action name:ObtrackChannelSetCounter(Channel, CounterType, CounterValue,
TimeStamp)
Action category: logical
OBTRACK channel set counter.
Parameter
Function
channel
Channel
Channel.
counter type
CounterType
Counter type.
counter value CounterValue Counter value.
time stamp
TimeStamp
Time stamp.
OBTRACK frame raw data
Action name:ObtrackFrameRawData(TimeStamp, Channel, Brightness, Contrast)
Action category: logical
OBTRACK frame raw data.
Parameter
Function
time stamp TimeStamp Time stamp.
channel
Channel
Channel.
brightness
Brightness
Brightness.
contrast
Contrast
Contrast.
OBTRACK group counter
Action name:ObtrackGroupCounter(GroupId, CounterType, CounterValue, ObjectDirection,
TimeStamp, ResetTimeStamp, GroupName)
Action category: logical
OBTRACK group counter.
Parameter
Function
group id
GroupId
Group ID.
counter type
CounterType
Counter type.
counter value
CounterValue
Counter value.
object direction
ObjectDirection
Object direction.
time stamp
TimeStamp
Time stamp.
reset time stamp ResetTimeStamp Reset time stamp.
group name
GroupName
Group name.
============================================================
PAGE 102
============================================================
OBTRACK group counter threshold
Action name:ObtrackGroupCounterThreshold(GroupId, CounterType, CounterValue,
ExceedingDirection, TimeStamp, GroupName)
Action category: logical
OBTRACK group counter threshold.
Parameter
Function
group id
GroupId
Group ID.
counter type
CounterType
Counter type.
counter value
CounterValue
Counter Value.
exceeding direction ExceedingDirection Exceeding direction.
time stamp
TimeStamp
Time stamp.
group name
GroupName
Group name.
OBTRACK group set counter
Action name:ObtrackGroupSetCounter(GroupId, CounterType, CounterValue, TimeStamp,
GroupName)
Action category: logical
OBTRACK group set counter.
Parameter
Function
group id
GroupId
Group ID.
counter type
CounterType
Counter type.
counter value CounterValue Counter value.
time stamp
TimeStamp
Time stamp.
group name
GroupName
Group name.
OBTRACK object raw data
Action name:ObtrackObjectRawData(TimeStamp, Channel, Area, ObjectID, ObjectStatus,
ObjectClass, Confidence, Position, Speed, Duration, Direction, Size, ObjectWidth,
ObjectHeight, ProcessSize, GscNetName)
Action category: logical
OBTRACK object raw data.
Parameter
Function
time stamp
TimeStamp
Time stamp.
channel
Channel
Channel.
area no
Area
Area no.
object ID
ObjectID
Object ID.
object status
ObjectStatus
Object status.
object class
ObjectClass
Object class.
confidence
Confidence
Confidence.
position
Position
Position.
speed
Speed
Speed.
duration
Duration
Duration.
direction
Direction
Direction.
object size
Size
Object size.
object width
ObjectWidth
Object width in meters.
object height
ObjectHeight Object height in meters.
process size
ProcessSize
Process size.
GSC net name GscNetName
GeviScope network name.
============================================================
PAGE 103
============================================================
OBTRACK tunnel alarm
Action name:ObtrackTunnelAlarm(Channel, TimeStamp, AlarmReason, ObjectID,
AlarmAreaID, ObjectArea)
Action category: logical
OBTRACK tunnel alarm notification.
Parameter
Function
channel
Channel
Channel.
time stamp
TimeStamp
Time stamp.
alarm reason
AlarmReason Alarm reason.
object ID
ObjectID
Object ID.
alarm area ID AlarmAreaID
Alarm area ID.
object area
ObjectArea
Object area.
Sensor alarm finished
Action name:SensorAlarmFinished(Channel, SensorType)
Action category: logical
This action will be fired when the alarm is finished.
Parameter
Function
channel
Channel
Channel.
sensor type SensorType Sensor type.
Sensor inhibit alarm finished
Action name:SensorInhibitAlarmFinished(Channel, SensorType)
Action category: logical
This action will be fired when the inhibit alarm finished.
Parameter
Function
channel
Channel
Channel.
sensor type SensorType Sensor type.
Sensor inhibit video alarm
Action name:SensorInhibitVideoAlarm(Channel, SensorType, ADArea, ADCell,
VMDGroup, VMDZone, VMDCycle, AlarmArea, ObjectClass)
Action category: logical
This action will be fired when the motion in inhibit area detected.
Parameter
Function
channel
Channel
Channel.
sensor type
SensorType Sensor type.
AD alarm area
ADArea
AD alarm area.
AD cell
ADCell
AD cell nr.
VMD alarm group VMDGroup
VMD alarm group.
VMD zone
VMDZone
VMD zone nr.
VMD cycle
VMDCycle
VMD measure cycle.
alarm area
AlarmArea
Alarm area.
object class
ObjectClass OBTRACK object class.
Sensor video alarm
Action name:SensorVideoAlarm(Channel, SensorType, ADArea, ADCell, VMDGroup,
VMDZone, VMDCycle, AlarmArea, ObjectClass)
Action category: logical
============================================================
PAGE 104
============================================================
This action will be fired when video alarm is detected.
Parameter
Function
channel
Channel
Channel.
sensor type
SensorType Sensor type.
AD alarm area
ADArea
AD alarm area.
AD cell
ADCell
AD cell nr.
VMD alarm group VMDGroup
VMD alarm group.
VMD zone
VMDZone
VMD zone nr.
VMD cycle
VMDCycle
VMD measure cycle.
alarm area
AlarmArea
Alarm area.
object class
ObjectClass OBTRACK object class.
Set system time
Action name:SetSystemTime(TimeStamp)
Action category: logical
Set system time.
Parameter
Function
time stamp TimeStamp Time stamp.
Set test picture mode
Action name:SetTestPictureMode(Channel, Mode)
Action category: logical
Enable or disable test picture generator.
Parameter
Function
channel Channel Channel.
enable
Mode
Enable or disable test picture generator.
Video contrast detected
Action name:VideoContrastDetected(Channel)
Action category: logical
This action will be fired when the contrast is detected in the video signal.
Parameter
Function
channel Channel Channel.
Video contrast failed
Action name:VideoContrastFailed(Channel)
Action category: logical
This action will be fired when the contrast is lost in the video signal.
Parameter
Function
Parameter
Function
channel Channel Channel.
Video set image brightness
Action name:VideoSetImageBrightness(Channel, SensorType, Brightness)
Action category: logical
Video set image brightness.
Parameter
Function
channel
Channel
Channel.
sensor type SensorType Sensor type.
brightness
Brightness
Brightness.
============================================================
PAGE 105
============================================================
Video set image contrast
Action name:VideoSetImageContrast(Channel, SensorType, Contrast)
Action category: logical
Video set image contrast.
Parameter
Function
channel
Channel
Channel.
sensor type SensorType Sensor type.
contrast
Contrast
Contrast.
Video set image saturation
Action name:VideoSetImageSaturation(Channel, SensorType, Saturation)
Action category: logical
Video set image saturation.
Parameter
Function
channel
Channel
Channel.
sensor type SensorType Sensor type.
saturation
Saturation
Saturation.
Video source has changed
Action name:VideoSourceChanged(Channel, SignalNorm, SignalType, InterlaceType)
Action category: logical
This action indicates the changes on the video input source.
Parameter
Function
channel
Channel
Channel.
signal norm
SignalNorm
New signal norm.
signal type
SignalType
New signal type.
interlace type InterlaceType New interlace type.
Video sync detected
Action name:VideoSyncDetected(Channel)
Action category: logical
This action will be fired when the sync is detected in the video signal.
Parameter
Function
channel Channel Channel.
Video sync failed
Action name:VideoSyncFailed(Channel)
Action category: logical
This action will be fired when the sync is lost in the video signal.
Parameter
Function
channel Channel Channel.
Viewer actions
Viewer actions allow remote controlling GSCView. To enable remote controlling GSCView
the "Remote control" setting in GscProfileManager and a global unique viewer client number
has to be configured.
============================================================
PAGE 106
============================================================
VC alarm queue confirm
Action name:VCAlarmQueueConfirm(Viewer, SelectionMode)
Action category: command
The alarm queue of the GSCView with the given viewer client number can be remote con-
trolled.
A current alarm is confirmed. The parameter "selection mode" defines which alarm in the
queue will be confirmed.
Parameter
Function
viewer
Viewer
Global viewer client number, identifies the GSCView that should be
remote controlled
selection
mode
SelectionMode first = first active alarm in queue
next = next active alarm in queue (from current position)
previous = previous alarm in queue (from current position)
last = last active alarm in queue
VC alarm queue confirm by instance
Action name:VCAlarmQueueConfirmByInstance(Viewer, AlarmID)
Action category: command
The alarm queue of GSCView with the given viewer client number can be remote controlled.
A current alarm is confirmed. It is identified by its alarm instance ID (event instance ID). A
unique instance ID is assigned to each alarm /recording event at creation time by the GeViS-
cope server.
Parameter
Function
viewer
Viewer
Global viewer client number, identifies the GSCView that should be remote
controlled
instance
ID
AlarmID The alarm instance ID (event instance ID)
VC alarm queue confirm by type
Action name:VCAlarmQueueConfirmByType(Viewer, TypeID, SelectionMode)
Action category: command
The alarm queue of GSCView with the given viewer client number can be remote controlled.
A current alarm is confirmed. It is identified by its alarm type (event type) which means the
name of the alarm (event) in the GeViScope Setup event list and also by the parameter
"selection mode". The parameter "selection mode" defines which alarm in the queue will be
selected.
Parameter
Function
viewer
Viewer
Global viewer client number, identifies the GSCView that should be
remote controlled
event type
TypeID
The alarm type (event type)
selection
mode
SelectionMode first = first active alarm in queue
next = next active alarm in queue (from current position)
previous = previous alarm in queue (from current position)
last = last active alarm in queue
============================================================
PAGE 107
============================================================
VC alarm queue remove
Action name:VCAlarmQueueRemove(Viewer, SelectionMode)
Action category: command
The alarm queue of the GSCView with the given viewer client number can be remote con-
trolled.
An alarm is removed from the queue. The parameter "selection mode" defines which alarm
in the queue will be removed.
Parameter
Function
viewer
Viewer
Global viewer client number, identifies the GSCView that should be
remote controlled
selection
mode
SelectionMode first = first active alarm in queue
next = next active alarm in queue (from current position)
previous = previous alarm in queue (from current position)
last = last active alarm in queue
VC alarm queue remove by instance
Action name:VCAlarmQueueRemoveByInstance(Viewer, AlarmID)
Action category: command
The alarm queue of the GSCView with the given viewer client number can be remote con-
trolled.
An alarm is removed from the queue. It is identified by its alarm instance ID (event instance
ID). A unique instance ID is assigned to each alarm/event recording.
Parameter
Function
viewer
Viewer
Global viewer client number, identifies the GSCView that should be remote
controlled
instance
ID
AlarmID The alarm instance ID (event instance ID)
VC alarm queue remove by type
Action name:VCAlarmQueueRemoveByType(Viewer, TypeID, SelectionMode)
Action category: command
The alarm queue of the GSCView with the given viewer client number can be remote con-
trolled.
An alarm is removed from the queue. It is identified by its alarm type (event type) which
means the name of the alarm (event) in the GeViScope Setup event list. The parameter
"selection mode" defines which alarm will be removed.
Parameter
Function
viewer
Viewer
Global viewer client number, identifies the GSCView that should be
remote controlled
event type
TypeID
The alarm type (event type)
selection
mode
SelectionMode first = first active alarm in queue
next = next active alarm in queue (from current position)
previous = previous alarm in queue (from current position)
last = last active alarm in queue
============================================================
PAGE 108
============================================================
VC alarm queue select
Action name:VCAlarmQueueSelect(Viewer, SelectionMode)
Action category: command
The alarm queue of the GSCView with the given viewer client number can be remote con-
trolled.
An alarm of the queue is presented. The parameter "selection mode" defines which alarm in
the queue will be presented.
Parameter
Function
viewer
Viewer
Global viewer client number, identifies the GSCView that should be
remote controlled
selection
mode
SelectionMode first = first active alarm in queue
next = next active alarm in queue (from current position)
previous = previous alarm in queue (from current position)
last = last active alarm in queue
VC alarm queue select by instance
Action name:VCAlarmQueueSelectByInstance(Viewer, AlarmID)
Action category: command
The alarm queue of the GSCView with the given viewer client number can be remote con-
trolled.
An alarm of the queue is presented. It is identified by its alarm instance ID (event instance
ID). A unique instance ID is assigned to each alarm/event recording.
Parameter
Function
viewer
Viewer
Global viewer client number, identifies the GSCView that should be remote
controlled
instance
ID
AlarmID The alarm instance ID (event instance ID)
VC alarm queue select by type
Action name:VCAlarmQueueSelectByType(Viewer, TypeID, SelectionMode)
Action category: command
The alarm queue of the GSCView with the given viewer client number can be remote con-
trolled.
An alarm of the queue is presented. It is identified by its alarm type (event type) which
means the name of the alarm (event) in the GeViScope Setup event list and also by the para-
meter "selection mode". The parameter "selection mode" defines which alarm in the queue
will be selected.
Parameter
Function
viewer
Viewer
Global viewer client number, identifies the GSCView that should be
remote controlled
event type
TypeID
The alarm type (event type)
selection
mode
SelectionMode first = first active alarm in queue
next = next active alarm in queue (from current position)
previous = previous alarm in queue (from current position)
last = last active alarm in queue
============================================================
PAGE 109
============================================================
VC change scene by name
Action name:VCChangeSceneByName(Viewer, Scene)
Action category: command
The action displays a scene in the GSCView with the given viewer client number.
The scene is identified by its name which is case insensitive. (e.g. "MyScene" equal
"myscene")
Parameter
Function
viewer Viewer Global viewer client number, identifies the GSCView that should be remote con-
trolled
scene
Scene
The name of the scene that should be displayed
VC clear scene by name
Action name:VCClearSceneByName(Viewer, Scene)
Action category: command
The action clears a scene in the GSCView with the given viewer client number.
The scene is identified by its name which is case insensitive. If the scene is currently not
active it will be displayed after the action is executed. (e.g. "MyScene" equal "myscene")
Parameter
Function
viewer Viewer Global viewer client number, identifies the GSCView that should be remote con-
trolled
scene
Scene
The name of the scene that should be cleared
VC full mode
Action name:VCFullMode(Viewer, FullMode, SensitiveAreaEnabled)
Action category: command
The GscView with the given viewer client number can be switched into full mode display or
normal mode display.
In full mode display GscView offers the possibility to fade in controls like the tool bar or the
side bar if the user moves the mouse cursor in the near of the window borders. This behavior
can be controlled by the Parameter "Sensitive area enabled".
Parameter
Function
viewer
Viewer
Global viewer client number, identifies the GscView that
should be remote controlled
full mode
FullMode
yes = switch to full mode display
no = switch to normal mode display
sensitive area
enabled
SensitiveAreaEnabled yes = moving mouse cursor in the near of the window bor-
ders causes controls to fade in
no = no controls fade in
VC set audio level
Action name:VCSetAudioLevel(Viewer, AudioLevel)
Action category: command
The volume of the audio output of the GSCView with the given viewer client number can be
controlled.
Parameter
Function
viewer
Viewer
Global viewer client number, identifies the GSCView that should be remote
controlled
audio
level
AudioLevel 0 = audio output off
100 = audio output in maximum volume
============================================================
PAGE 110
============================================================
VC show viewer text
Action name:VCShowViewerText(Viewer, ShowText)
Action category: command
The text fade-in of all viewers of the GSCView with the given viewer client number can be
switched on and off.
Parameter
Function
viewer
Viewer
Global viewer client number, identifies the GSCView that should be remote
controlled
show
text
ShowText yes = switch text fade-in on
no = switch text fade-in off
VC stretch mode
Action name:VCStretchMode(Viewer, StretchMode)
Action category: command
The GSCView with the given viewer client number can be switched into stretched mode dis-
play or normal mode display.
In the stretched view, the viewers are stretched to the available size in the GSCView main
window. In the normal mode display the viewers are sized in 4:3 ratio.
Parameter
Function
viewer
Viewer
Global viewer client number, identifies the GSCView that should be
remote controlled
stretch
mode
StretchMode yes = switch to stretched mode display
no = switch to normal mode display
Viewer change scene
Action name:ViewerChangeScene(Viewer)
Action category: command
The action displays the scene where the viewer with the global number on any GSCView in
the network belongs to.
Parameter
Function
viewer Viewer Global viewer client number, identifies the GSCView that should be remote con-
trolled
Viewer clear
Action name:ViewerClear(Viewer)
Action category: command
The action clears the active viewer of the GSCView with the given viewer client number or
the viewer with the global number on any GSCView in the network.
Parameter
Function
viewer Viewer Global viewer client number, identifies the GSCView that should be remote con-
trolled
or
Global number of a viewer on any GSCView in the network
Viewer clear scene
Action name:ViewerClearScene(Viewer)
Action category: command
============================================================
PAGE 111
============================================================
The action clears the scene where the active viewer of the GSCView with the given viewer
client number or the viewer with the global number on any GSCView in the network belongs
to.
Parameter
Function
viewer Viewer Global viewer client number, identifies the GSCView that should be remote con-
trolled
or
Global number of a viewer on any GSCView in the network
Viewer clear text output
Action name:ViewerClearTextOutput(Viewer)
Action category: command
The action doesn't display a text in the active viewer of the GSCView with the given viewer
client number or the viewer with the global number on any GSCView in the network any-
more.
Parameter
Function
viewer Viewer Global viewer client number, identifies the GSCView that should be remote con-
trolled or Global number of a viewer on any GSCView in the network
Viewer connect
Action name:ViewerConnect(Viewer, Channel, PlayMode)
Action category: command
Display pictures of a video channel on the active viewer of the GscView with the given
viewer client number or on the viewer with the global number on some GscView in the net-
work.
The parameter "play mode" defines in which mode the pictures are presented (live, forward,
backward).
Parameter
Function
viewer
Viewer
Global viewer client number, identifies the GscView that should be remote con-
trolled
or
Global number of a viewer on some GscView in the network
channel Channel
Global number of the media channel
play
mode
PlayMode play stop = if the viewer is already displaying pictures from that channel, it is
stopped; if not the newest picture in the database is displayed
play forward = if the viewer is already displaying pictures from that channel,
it is displaying pictures in normal speed forward from the actual position; if
not display of pictures with normal speed starts at the beginning of the data-
base
play backward = if the viewer is already displaying pictures from that chan-
nel, it is displaying pictures in normal speed backward from the actual pos-
ition; if not display of pictures with normal speed starts at the end of the
database
fast forward = like "play forward" but with high speed
fast backward = like "play backward" but with high speed
step forward = like "play forward" but only one picture
step backward = like "play backward" but only one picture
play BOD = display the first (the oldest) picture in the database
play EOD = display the last (the newest) picture in the database
live = display live pictures
next event = like "play forward" but only pictures that belong to event record-
ings
prev event = like "play backward" but only pictures that belong to event
recordings
peek live picture = display only one actual live picture
next detected motion = like "play forward" but only pictures with motion in it
============================================================
PAGE 112
============================================================
Parameter
Function
(if no MOS search area is defined in GscView the whole picture size is used for
it) are displayed; the display stops after motion is detected
prev detected motion = like "play backward" but only pictures with motion in
it (if no MOS search area is defined in GscView the whole picture size is used
for it) are displayed; the display stops after motion is detected
Viewer connect live
Action name:ViewerConnectLive(Viewer, Channel)
Action category: command
This action displays live pictures of a video channel on the active viewer of the GSCView
with the given viewer client number or on the viewer with the global number on any
GSCView in the network.
Parameter
Function
viewer
Viewer
Global viewer client number, identifies the GSCView that should be remote con-
trolled
or
Global number of a viewer on any GSCView in the network
channel Channel Global number of the media channel
Viewer export picture
Action name:ViewerExportPicture(Viewer, FilePath)
Action category: command
The action exports the current picture of the active viewer of the GSCView with the given
viewer client number or the viewer with the global number on any GSCView in the network.
The actual picture is exported as a windows bitmap graphic file in the GSCView directory or
in the path (local or UNC) defined via the parameter "file path".
Parameter
Function
viewer
Viewer
Global viewer client number, identifies the GSCView that should be remote con-
trolled
or
Global number of a viewer on any GSCView in the network
file
path
FilePath Path (local or UNC) where the picture should be exported to
Viewer jump by time
Action name:ViewerJumpByTime(Viewer, Channel, PlayMode, TimeInSec)
Action category: command
The action displays pictures of a video channel on the active viewer of the GSCView with
the given viewer client number or on the viewer with the global number on any GSCView in
the network.
The parameter "play mode" defines in which mode the pictures are presented (live, forward,
backward .).
The parameter "time in sec" defines the time span that the start of the replay should be
moved from the actual timestamp.
Parameter
Function
viewer
Viewer
Global viewer client number, identifies the GSCView that should be remote
controlled
============================================================
PAGE 113
============================================================
Parameter
Function
or
Global number of a viewer on any GSCView in the network
channel Channel
Global number of the media channel
play
mode
PlayMode
play stop = if the viewer is already displaying pictures from that channel, it
is stopped? if not the newest picture in the database is displayed
play forward = if the viewer is already displaying pictures from that channel,
it is displaying pictures in normal speed forward from the current position; if
not display of pictures with normal speed starts at the beginning of the data-
base play backward = if the viewer is already displaying pictures from that
channel, it is displaying pictures in normal speed backward from the actual
position; if not display of pictures with normal speed starts at the end of the
database
fast forward = like "play forward" high speed
fast backward = like "play backward" high speed
step forward = like "play forward" picture by picture
step backward = like "play backward" picture by picture
play BOD = display the first (the oldest) picture in the database
play EOD = display the last (the newest) picture in the database
live = display live pictures
next event = jump to the next event recording
prev event = jump to the previous event recording
peek live picture = displays only one current live picture
next detected motion = like "play forward" but only pictures with motion in it
(if no MOS search area is defined in GSCView the whole picture size is used
for it) are displayed; the display stops after motion is detected
prev detected motion = like "play backward" but only pictures with motion
in it (if no MOS search area is defined in GSCView the whole picture size is
used for it) are displayed; the display stops after motion is detected
time in
sec
TimeInSec Time span that the start of the replay should be moved from the actual
timestamp
Viewer maximize
Action name:ViewerMaximize(Viewer, Maximize)
Action category: command
The active viewer of the GSCView with the given viewer client number or the viewer with
the global number on any GSCView in the network which should be remote controlled.
The parameter "maximize" defines whether the viewer should be displayed in maximized
mode or not.
Parameter
Function
viewer
Viewer
Global viewer client number, identifies the GSCView that should be remote
controlled
or
Global number of a viewer on any GSCView in the network
maximize Maximize yes = display the viewer in maximized mode
no = display the viewer in normal mode
Viewer play from time
Action name:ViewerPlayFromTime(Viewer, Channel, PlayMode, Time)
Action category: command
Display pictures of a video channel on the active viewer of the GscView with the given
viewer client number or on the viewer with the global number on some GscView in the net-
work.
============================================================
PAGE 114
============================================================
The parameter "play mode" defines in which mode the pictures are presented (live, forward,
backward, .).
The parameter "time" defines the timestamp where the replay of the recorded video should
start.
Parameter
Function
viewer
Viewer
Global viewer client number, identifies the GscView that should be remote con-
trolled
or
Global number of a viewer on some GscView in the network
channel Channel
Global number of the media channel
play
mode
PlayMode play stop = if the viewer is already displaying pictures from that channel, it is
stopped? if not the newest picture in the database is displayed
play forward = if the viewer is already displaying pictures from that channel,
it is displaying pictures in normal speed forward from the current position; if
not display of pictures with normal speed starts at the beginning of the data-
base play backward = if the viewer is already displaying pictures from that
channel, it is displaying pictures in normal speed backward from the actual
position; if not display of pictures with normal speed starts at the end of the
database
fast forward = like "play forward" high speed
fast backward = like "play backward" high speed
step forward = like "play forward" picture by picture
step backward = like "play backward" picture by picture
play BOD = display the first (the oldest) picture in the database
play EOD = display the last (the newest) picture in the database
live = display live pictures
next event = jump to the next event recording
prev event = jump to the previous event recording
peek live picture = displays only one current live picture
next detected motion = like "play forward" but only pictures with motion in it
(if no MOS search area is defined in GSCView the whole picture size is used
for it) are displayed; the display stops after motion is detected
prev detected motion = like "play backward" but only pictures with motion in
it (if no MOS search area is defined in GSCView the whole picture size is used
for it) are displayed; the display stops after motion is detected
time
Time
Timestamp where the replay of the recorded video should start. The para-
meter should be defined in the following format:
"2009/02/13 07:22:00,594 GMT+01:00"
Viewer print picture
Action name:ViewerPrintPicture(Viewer)
Action category: command
The action prints out the current picture of the active viewer of the GSCView with the given
viewer client number or the viewer with the global number on any GSCView in the network.
The print out is done on the default printer of the PC on which GSCView is running.
Parameter
Function
viewer Viewer Global viewer client number, identifies the GSCView that should be remote con-
trolled or Global number of a viewer on any GSCView in the network
Viewer select
Action name:ViewerSelect(Viewer)
Action category: command
The action declares the viewer with the global number on any GSCView in the network to
the active viewer of the corresponding GSCView.
============================================================
PAGE 115
============================================================
Parameter
Function
viewer Viewer Global number of a viewer on any GSCView in the network
Viewer set play mode
Action name:ViewerSetPlayMode(Viewer, PlayMode, PlaySpeed)
Action category: command
The action sets the "play mode" of the active viewer of the GSCView with the given viewer
client number or the viewer with the global number on any GSCView in the network.
Parameter
Function
viewer Viewer
Global viewer client number, identifies the GSCView that should be remote con-
trolled
or
Global number of a viewer on any GSCView in the network
play
mode
PlayMode
play stop = if the viewer is already displaying pictures from that channel, it is
stopped? if not the newest picture in the database is displayed
play forward = if the viewer is already displaying pictures from that channel, it
is displaying pictures in normal speed forward from the current position; if
not display of pictures with normal speed starts at the beginning of the data-
base play backward = if the viewer is already displaying pictures from that
channel, it is displaying pictures in normal speed backward from the actual
position; if not display of pictures with normal speed starts at the end of the
database
fast forward = like "play forward" high speed
fast backward = like "play backward" high speed
step forward = like "play forward" picture by picture
step backward = like "play backward" picture by picture
play BOD = display the first (the oldest) picture in the database
play EOD = display the last (the newest) picture in the database
live = display live pictures
next event = jump to the next event recording
prev event = jump to the previous event recording
peek live picture = displays only one current live picture
next detected motion = like "play forward" but only pictures with motion in it
(if no MOS search area is defined in GSCView the whole picture size is used for
it) are displayed; the display stops after motion is detected
prev detected motion = like "play backward" but only pictures with motion in
it (if no MOS search area is defined in GSCView the whole picture size is used
for it) are displayed; the display stops after motion is detected
play
speed
PlaySpeed Speed rate for fast forward/backward (2.)
Viewer show alarm by instance
Action name:ViewerShowAlarmByInstance(Viewer, AlarmID, PlayMode)
Action category: command
The action displays pictures of an alarm on the GSCView with the given viewer client num-
ber in the network.
The alarm is identified by its alarm instance ID (event instance ID). Every alarm (event) is
assigned a unique instance ID at creation time by the GeViScope server.
The parameter "play mode" defines in which mode the pictures are presented (live replay,
replay event pictures, .).
Parameter
Function
viewer
Viewer
Global viewer client number, identifies the GSCView that should be remote
controlled
============================================================
PAGE 116
============================================================
Parameter
Function
instance
ID
AlarmID
The alarm instance ID (event instance ID)
play
mode
PlayMode Show alarm using default settings = display alarm pictures using the default
settings defined in the GeViScope setup
Live replay = display live pictures of the cameras belonging to the alarm con-
figuration
replay event pictures = replay the pictures belonging to the alarm (only once)
continuous event replay = replay the pictures belonging to the alarm
continuously in a loop
show first alarm picture only = only display the first picture belonging to the
alarm
Viewer show alarm by key
Action name:ViewerShowAlarmByKey(Viewer, ForeignKey, PlayMode)
Action category: command
The action displays pictures of an alarm on the GSCView with the given viewer client num-
ber in the network.
The alarm is identified by its "foreign key". The "foreign key" was assigned explicit to the
alarm as the alarm was started.
The parameter "play mode" defines in which mode the pictures are presented (live replay,
replay event pictures .).
Parameter
Function
viewer Viewer
Global viewer client number, identifies the GSCView that should be remote
controlled
foreign
key
ForeignKey The foreign key that was assigned to the alarm as the alarm was started
play
mode
PlayMode
play stop = if the viewer is already displaying pictures from that channel, it
is stopped? if not the newest picture in the database is displayed
play forward = if the viewer is already displaying pictures from that channel,
it is displaying pictures in normal speed forward from the current position; if
not display of pictures with normal speed starts at the beginning of the data-
base play backward = if the viewer is already displaying pictures from that
channel, it is displaying pictures in normal speed backward from the actual
position; if not display of pictures with normal speed starts at the end of the
database
fast forward = like "play forward" high speed
fast backward = like "play backward" high speed
step forward = like "play forward" picture by picture
step backward = like "play backward" picture by picture
play BOD = display the first (the oldest) picture in the database
play EOD = display the last (the newest) picture in the database
live = display live pictures
next event = jump to the next event recording
prev event = jump to the previous event recording
peek live picture = displays only one current live picture
next detected motion = like "play forward" but only pictures with motion in it
(if no MOS search area is defined in GSCView the whole picture size is used
for it) are displayed; the display stops after motion is detected
prev detected motion = like "play backward" but only pictures with motion in
it (if no MOS search area is defined in GSCView the whole picture size is used
for it) are displayed; the display stops after motion is detected
============================================================
PAGE 117
============================================================
Viewer show alarm by type
Action name:ViewerShowAlarmByType(Viewer, TypeID, ForeignKey, PlayMode)
Action category: command
The action displays pictures of an alarm on the GSCView with the given viewer client num-
ber in the network.
The alarm is identified by its alarm type and optional by its foreign key. The alarm type
(event name) is defined in the GeViScope setup. The foreign key was assigned explicit to
the alarm as the alarm was started. It is optional. If it is not set, the last alarm with the
defined alarm type is displayed.
The parameter "play mode" defines in which mode the pictures are presented (live replay,
replay event pictures .).
Parameter
Function
viewer Viewer
Global viewer client number, identifies the GSCView that should be remote
controlled
alarm
type
TypeID
Type (event name) of the alarm, defined in the GeViScope setup
foreign
key
ForeignKey The foreign key that was assigned to the alarm as the alarm was started
play
mode
PlayMode
play stop = if the viewer is already displaying pictures from that channel, it
is stopped? if not the newest picture in the database is displayed
play forward = if the viewer is already displaying pictures from that channel,
it is displaying pictures in normal speed forward from the current position; if
not display of pictures with normal speed starts at the beginning of the data-
base play backward = if the viewer is already displaying pictures from that
channel, it is displaying pictures in normal speed backward from the actual
position; if not display of pictures with normal speed starts at the end of the
database
fast forward = like "play forward" high speed
fast backward = like "play backward" high speed
step forward = like "play forward" picture by picture
step backward = like "play backward" picture by picture
play BOD = display the first (the oldest) picture in the database
play EOD = display the last (the newest) picture in the database
live = display live pictures
next event = jump to the next event recording
prev event = jump to the previous event recording
peek live picture = displays only one current live picture
next detected motion = like "play forward" but only pictures with motion in it
(if no MOS search area is defined in GSCView the whole picture size is used
for it) are displayed; the display stops after motion is detected
prev detected motion = like "play backward" but only pictures with motion in
it (if no MOS search area is defined in GSCView the whole picture size is used
for it) are displayed; the display stops after motion is detected
Viewer change sync audio/video
Action name:ViewerSyncAudioAndVideo(Viewer, EnableSync)
Action category: command
The active viewer of the GSCView with the given viewer client number or the viewer with
the global number on any GSCView in the network should be remote controlled.
The parameter "enable sync" defines whether audio and video should be synchronized or
not.
============================================================
PAGE 118
============================================================
Parameter
Function
viewer
Viewer
Global viewer client number, identifies the GSCView that should be
remote controlled
or
Global number of a viewer on any GSCView in the network
enable
sync
EnableSync yes = synchronize audio and video
no = don't synchronize audio and video
Viewer text output
Action name:ViewerTextOutput(Viewer, Text)
Action category: command
The action displays a text in the active viewer of the GSCView with the given viewer client
number or the viewer with the global number on any GSCView in the network.
Parameter
Function
viewer
Viewer Global viewer client number, identifies the GSCView that should be remote con-
trolled
or
Global number of a viewer on any GSCView in the network
text
string
Text
Text that should be displayed in the picture
Viewer notification actions
Viewer notifications are fired by GSCView while GSCView is remote controlled. To enable
remote controlling GSCView the "Remote control" setting in GscProfileManager and a
global unique viewer client number has to be configured. To enable GSCView sending
viewer notifications the "Send notification actions" settings in GscProfileManager have to
be configured.
Image export notification
Action name:ImageExportNotification(User, Destination, DestinationType, TimeStamp,
TimeEnd, Channels, ClientHost, ClientType, ClientAccount)
Action category: notification
A single image or a video sequence has been exported by a GSCView in the network.
GSCView has fired this notification because a single picture has been exported via a View-
erExportPicture action while GSCView is remote controlled or because the user has manu-
ally exported a picture or a video sequence in GSCView.
Parameter
Function
user
User
GeViScope user, who
has done the export
destination
Destination
Path (local or UNC)
where the picture or
sequence was exported
destination type
DestinationType
0 = single image
1 = backup file (GBF)
2 = video file (MPEG,
Video DVD, MPEG4CCTV
raw)
3 = snapshot to clip-
============================================================
PAGE 119
============================================================
Parameter
Function
board
4 = print picture
time stamp
TimeStamp
Timestamp belonging to
the picture exported or
belonging to the first pic-
ture of the exported
video sequence. The
parameter is transmitted
in the following format:
"2009/05/06
14:47:48,359
GMT+02:00"
end time
TimeEnd
Timestamp belonging to
the last picture of the
exported video
sequence. The para-
meter is transmitted in
the following format:
"2009/05/06
14:47:48,359
GMT+02:00"
channels
Channels
List of video channels
that are included in the
export result
client host
ClientHost
Host name of the PC
where GSCView is run-
ning
client type
ClientType
1 = GSCView
All other values are for
future use!
client account
ClientAccount
Windows user account
under that GSCView is
running
Scene store modification
Action name:SceneStoreModification(Viewer, SceneStoreID, SceneStoreName,
TimeStamp, ModificationType, User, ClientHost, ClientType, ClientAccount)
Action category: notification
Scene store modification.
Parameter
Function
viewer
Viewer
Global number of a viewer on some GSCView in the network
scene store
GUID
SceneStoreID
Scene store GUID.
scene store
name
SceneStoreNam-
e
Scene store name.
time stamp
TimeStamp
Time stamp.
modification
type
Modi-
ficationType
Modification type.
user
User
Name of the user.
client host
ClientHost
Host name of the PC where GSCView is running
client type
ClientType
1 = GSCView
All other values are for future use!
client account
ClientAccount
Windows user account under that GSCView is running
============================================================
PAGE 120
============================================================
VC alarm queue notification
Action name:VCAlarmQueueNotification(Viewer, Notification, AlarmID, TypeID, Cli-
entHost, ClientType, ClientAccount)
Action category: notification
The state of the alarm queue of the GSCView with the transmitted viewer client number has
been changed.
GSCView has fired this notification because the state of its alarm queue has been changed
via a VCAlarmQueue... action while GSCView is remote controlled or because the user has
manually changed the state of the alarm queue in GSCView.
An alarm can be identified by its alarm instance ID (event instance ID). Every alarm (event)
is assigned a unique instance ID at creation time by the GeViScope server.
Alternatively the alarm can be identified by its alarm type (event type) which means the
name of the alarm (event) in the GeViScope Setup event list.
Parameter
Function
viewer
Viewer
Global viewer client num-
ber, identifies the
GSCView that fired this
notification
notification
Notification
New alarm = an new
alarm occurred
Presented = an alarm was
presented
Stacked = an alarm was
stacked in the queue,
because the queue is
blocked by an active alarm
Confirmed = an alarm was
confirmed
Removed = an alarm was
removed from the queue
Last confirmed = the last
alarm in the queue was
confirmed
Last removed = the last
alarm was removed from
the queue
List confirmed = there are
no more unconfirmed
alarms in the queue
List empty = there are no
more alarms in the queue
instance ID
AlarmID
The alarm instance ID
(event instance ID)
event type
TypeID
The alarm type (event
type)
client host
ClientHost
Host name of the PC
where GSCView is run-
ning
client type
ClientType
1 = GSCView
All other values are for
future use!
Reference in New Issue View Git Blame Copy Permalink