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.
Action name:VCAlarmQueueConfirm(Viewer, SelectionMode)
Action category: command
The alarm queue of the GSCView with the given viewer client number can be remote controlled.
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 |
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 GeViScope 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) |
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 |
Action name:VCAlarmQueueRemove(Viewer, SelectionMode)
Action category: command
The alarm queue of the GSCView with the given viewer client number can be remote controlled.
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 |
Action name:VCAlarmQueueRemoveByInstance(Viewer, AlarmID)
Action category: command
The alarm queue of the GSCView with the given viewer client number can be remote controlled.
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) |
Action name:VCAlarmQueueRemoveByType(Viewer, TypeID, SelectionMode)
Action category: command
The alarm queue of the GSCView with the given viewer client number can be remote controlled.
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 |
Action name:VCAlarmQueueSelect(Viewer, SelectionMode)
Action category: command
The alarm queue of the GSCView with the given viewer client number can be remote controlled.
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 |
Action name:VCAlarmQueueSelectByInstance(Viewer, AlarmID)
Action category: command
The alarm queue of the GSCView with the given viewer client number can be remote controlled.
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) |
Action name:VCAlarmQueueSelectByType(Viewer, TypeID, SelectionMode)
Action category: command
The alarm queue of the GSCView with the given viewer client number can be remote controlled.
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 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 |
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 controlled |
| scene | Scene | The name of the scene that should be displayed |
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 controlled |
| scene | Scene | The name of the scene that should be cleared |
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 borders causes controls to fade in no = no controls fade in |
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 |
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 |
Action name:VCStretchMode(Viewer, StretchMode)
Action category: command
The GSCView with the given viewer client number can be switched into stretched mode display 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 |
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 controlled |
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 controlled
or Global number of a viewer on any GSCView in the network |
Action name:ViewerClearScene(Viewer)
Action category: command
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 controlled
or Global number of a viewer on any GSCView in the network |
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 anymore.
| 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 |
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 network.
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 controlled 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 database 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" 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 recordings 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 (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 |
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 controlled
or Global number of a viewer on any GSCView in the network |
| channel | Channel | Global number of the media channel |
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 controlled
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 |
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
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 database 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 |
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 |
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 network.
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 controlled 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 database 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 parameter should be defined in the following format: "2009/02/13 07:22:00,594 GMT+01:00" |
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 controlled or Global number of a viewer on any GSCView in the network |
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.
| Parameter | Function | |
|---|---|---|
| viewer | Viewer | Global number of a viewer on any GSCView in the network |
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 controlled
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 database 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.) |
Action name:ViewerShowAlarmByInstance(Viewer, AlarmID, PlayMode)
Action category: command
The action displays pictures of an alarm on the GSCView with the given viewer client number 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 |
| 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 configuration 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 |
Action name:ViewerShowAlarmByKey(Viewer, ForeignKey, PlayMode)
Action category: command
The action displays pictures of an alarm on the GSCView with the given viewer client number 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 database 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 |
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 number 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 database 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 |
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.
| 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 |
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 controlled
or Global number of a viewer on any GSCView in the network |
| text string | Text | Text that should be displayed in the picture |