Viewer Actions
Viewer actions allow remote controlling G-View. To enable remote controlling G-View the "Remote control" setting in G-View ProfileManager and a global unique viewer client number has to be configured.

Action name: ViewerConnectLive (viewer, channel)
Action category: command
This action displays live pictures of a video channel on the active viewer of the G-View with the given viewer client number or on the viewer with the global number on any G-View in the network.
Parameter |
Function |
|
---|---|---|
viewer |
Viewer |
Global viewer or viewer client no. |
channel |
Channel |
Channel. |

Action name: ViewerConnect (viewer, channel, play mode)
Action category: command
The action displays pictures of a video channel on the active viewer of the G-View with the given viewer client number or on the viewer with the global number on any G-View in the network. The parameter "play mode" defines in which mode the pictures are presented (live, forward, backward .).
Parameter |
Function |
|
---|---|---|
viewer |
Viewer |
Global viewer or viewer client no. |
channel |
Channel |
Channel. |
play mode |
PlayMode |
Viewer play mode. |

Action name: ViewerClear (viewer)
Action category: command
The action clears the active viewer of the G-View with the given viewer client number or the viewer with the global number on any G-View in the network.
Parameter |
Function |
|
---|---|---|
viewer |
Viewer |
Global viewer or viewer client no. |

Action name: ViewerChangeScene (viewer, GlobalMonitorNr)
Action category: command
The action displays the scene where the viewer with the global number on any G-View in the network belongs to.
Parameter |
Function |
|
---|---|---|
viewer |
Viewer |
Global viewer or viewer client no. |

Action name: VCChangeSceneByName (viewer, scene, GlobalMonitorNr)
Action category: command
The action displays a scene in the G-View 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 or viewer client no. |
scene |
Scene |
Scene name. |

Action name: ViewerClearScene (viewer, GlobalMonitorNr)
Action category: command
The action clears the scene where the active viewer of the G-View with the given viewer client number or the viewer with the global number on any G-View in the network belongs to.
Parameter |
Function |
|
---|---|---|
viewer |
Viewer |
Global viewer or viewer client no. |

Action name: VCClearSceneByName (viewer, scene, GlobalMonitorNr)
Action category: command
The action clears a scene in the G-View 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 or viewer client no. |
scene |
Scene |
Scene name. |

Action name: ViewerSyncAudioAndVideo (viewer, enable sync)
Action category: command
The active viewer of the G-View with the given viewer client number or the viewer with the global number on any G-View 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 or viewer client no. |
enable sync |
EnableSync |
Enable audio/video sync. |

Action name: VCSetAudioLevel (viewer, audio level)
Action category: command
The volume of the audio output of the G-View with the given viewer client number can be controlled.
Parameter |
Function |
|
---|---|---|
viewer |
Viewer |
Global viewer or viewer client no. |
audio level |
AudioLevel |
Audio level in range 0 (audio off) till 100 (max. volume). |

Action name: ViewerMaximize (viewer, maximize)
Action category: command
The active viewer of the G-View with the given viewer client number or the viewer with the global number on any G-View 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 or viewer client no. |
maximize |
Maximize |
Maximize. |

Action name: ViewerExportPicture (viewer, file path)
Action category: command
The action exports the current picture of the active viewer of the G-View with the given viewer client number or the viewer with the global number on any G-View in the network. The actual picture is exported as a windows bitmap graphic file in the G-View directory or in the path (local or UNC) defined via the parameter "file path".
Parameter |
Function |
|
---|---|---|
viewer |
Viewer |
Global viewer or viewer client no. |
file path |
FilePath |
File path (local or UNC). G-View default path is used if left empty. |

Action name: ViewerPrintPicture (viewer)
Action category: command
The action prints out the current picture of the active viewer of the G-View with the given viewer client number or the viewer with the global number on any G-View in the network. The print out is done on the default printer of the PC on which G-View is running.
Parameter |
Function |
|
---|---|---|
viewer |
Viewer |
Global viewer or viewer client no. |

Action name: ViewerSelect (viewer)
Action category: command
The action declares the viewer with the global number on any G-View in the network to the active viewer of the corresponding G-View.
Parameter |
Function |
|
---|---|---|
viewer |
Viewer |
Global viewer or viewer client no. |

Action name: VCShowViewerText (viewer, show text)
Action category: command
The text fade-in of all viewers of the G-View with the given viewer client number can be switched on and off.
Parameter |
Function |
|
---|---|---|
viewer |
Viewer |
Global viewer or viewer client no. |
show text |
ShowText |
Show text in viewer client. |

Action name: VCFullMode (viewer, full mode, sensitive area enabled)
Action category: command
The G-View with the given viewer client number can be switched into full mode display or normal mode display. In full mode display G-View 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 or viewer client no. |
full mode |
FullMode |
Switch viewer client in full mode. |
sensitive area enabled |
SensitiveAreaEnabled |
Sensitive area enabled. |

Action name: VCStretchMode (viewer, stretch mode)
Action category: command
The G-View 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 G-View main window. In the normal mode display the viewers are sized in 4:3 ratio.
Parameter |
Function |
|
---|---|---|
viewer |
Viewer |
Global viewer or viewer client no. |
stretch mode |
StretchMode |
Switch viewer client in stretch mode. |

Action name: ViewerTextOutput (viewer, text string)
Action category: command
The action displays a text in the active viewer of the G-View with the given viewer client number or the viewer with the global number on any G-View in the network.
Parameter |
Function |
|
---|---|---|
viewer |
Viewer |
Global viewer or viewer client no. |
text string |
Text |
Text string to display. |

Action name: ViewerClearTextOutput (viewer)
Action category: command
The action doesn't display a text in the active viewer of the G-View with the given viewer client number or the viewer with the global number on any G-View in the network anymore.
Parameter |
Function |
|
---|---|---|
viewer |
Viewer |
Global viewer or viewer client no. |

Action name: VCAlarmQueueSelect (viewer, selection mode)
Action category: command
The alarm queue of the G-View 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 or viewer client no. |
selection mode |
SelectionMode |
Selection mode. |

Action name: VCAlarmQueueSelectByType (viewer, event type, selection mode)
Action category: command
The alarm queue of the G-View 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 G-Core server 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 or viewer client no. |
event type |
TypeID |
Type of the event. |
selection mode |
SelectionMode |
Selection mode. |

Action name: VCAlarmQueueSelectByInstance (viewer, instance ID)
Action category: command
The alarm queue of the G-View 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 or viewer client no. |
instance ID |
AlarmID |
Instance ID of the alarm. |

Action name: VCAlarmQueueConfirm (viewer, selection mode)
Action category: command
The alarm queue of the G-View 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 or viewer client no. |
selection mode |
SelectionMode |
Selection mode. |

Action name: VCAlarmQueueConfirmByType (viewer, event type, selection mode)
Action category: command
The alarm queue of G-View 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 G-Core server 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 or viewer client no. |
event type |
TypeID |
Type of the event. |
selection mode |
SelectionMode |
Selection mode. |

Action name: VCAlarmQueueConfirmByInstance (viewer, instance ID)
Action category: command
The alarm queue of G-View 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 G-Core server.
Parameter |
Function |
|
---|---|---|
viewer |
Viewer |
Global viewer or viewer client no. |
instance ID |
AlarmID |
Instance ID of the alarm. |

Action name: VCAlarmQueueRemove (viewer, selection mode)
Action category: command
The alarm queue of the G-View 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 or viewer client no. |
selection mode |
SelectionMode |
Selection mode. |

Action name: VCAlarmQueueRemoveByType (viewer, event type, selection mode)
Action category: command
The alarm queue of the G-View 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 G-Core server event list. The parameter "selection mode" defines which alarm will be removed.
Parameter |
Function |
|
---|---|---|
viewer |
Viewer |
Global viewer or viewer client no. |
event type |
TypeID |
Type of the event. |
selection mode |
SelectionMode |
Selection mode. |

Action name: VCAlarmQueueRemoveByInstance (viewer, instance ID)
Action category: command
The alarm queue of the G-View 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 or viewer client no. |
instance ID |
AlarmID |
Instance ID of the alarm. |

Action name: ViewerShowAlarmByInstance (viewer, instance ID, play mode)
Action category: command
The action displays pictures of an alarm on the G-View 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 G-Core server. The parameter "play mode" defines in which mode the pictures are presented (live replay, replay event pictures, .).
Parameter |
Function |
|
---|---|---|
viewer |
Viewer |
Global viewer or viewer client no. |
instance ID |
AlarmID |
Instance ID of the alarm. |
play mode |
PlayMode |
Viewer alarm's play mode. |

Action name: ViewerShowAlarmByKey (viewer, foreign key, play mode)
Action category: command
The action displays pictures of an alarm on the G-View 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 or viewer client no. |
foreign key |
ForeignKey |
Foreign key used to start the alarm. |
play mode |
PlayMode |
Viewer alarm's play mode. |

Action name: ViewerShowAlarmByType (viewer, alarm type, foreign key, play mode)
Action category: command
The action displays pictures of an alarm on the G-View 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 G-Core server 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 or viewer client no. |
alarm type |
TypeID |
Type of the alarm. |
foreign key |
ForeignKey |
Foreign key used to start the alarm. |
play mode |
PlayMode |
Viewer alarm's play mode. |

Action name: ViewerJumpByTime (viewer, channel, play mode, time in sec)
Action category: command
The action displays pictures of a video channel on the active viewer of the G-View with the given viewer client number or on the viewer with the global number on any G-View 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 or viewer client no. |
channel |
Channel |
Channel. |
play mode |
PlayMode |
Viewer play mode. |
time in sec |
TimeInSec |
Time to jump in seconds. Use negative values to jump in past. |

Action name: ViewerPlayFromTime (viewer, channel, play mode, time)
Action category: command
The action displays pictures of a video channel on the active viewer of the G-View with the given viewer client number or on the viewer with the global number on any G-View 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 or viewer client no. |
channel |
Channel |
Channel. |
play mode |
PlayMode |
Viewer play mode. |
time |
Time |
Time to play from. |

Action name: ViewerSetPlayMode (viewer, play mode, play speed)
Action category: command
The action sets the "play mode" of the active viewer of the G-View with the given viewer client number or the viewer with the global number on any G-View in the network.
Parameter |
Function |
|
---|---|---|
viewer |
Viewer |
Global viewer or viewer client no. |
play mode |
PlayMode |
Viewer play mode. |
play speed |
PlaySpeed |
Optional play speed parameter. |

Action name: VCChangeMapByName (viewer, map)
Action category: command
The action displays a map in the viewer application with the given viewer client number. The map is identified by its name which is case insensitive. (e.g. "MyMap" equal "mymap")
Parameter |
Function |
|
---|---|---|
viewer |
Viewer |
Global viewer or viewer client no. |
map |
Map |
map name. |

Action name: CameraCycleStart (viewer, cycle ID, cycle name)
Action category: command
This action starts a pre-defined cycle.
Parameter |
Function |
|
---|---|---|
viewer |
Viewer |
Global viewer or viewer client no. |
cycle ID |
CycleID |
Cycle ID. |
cycle name |
CycleName |
Cycle name. |

Action name: CameraCycleStop (viewer)
Action category: command
This action stops a running cycle.
Parameter |
Function |
|
---|---|---|
viewer |
Viewer |
Global viewer or viewer client no. |

Action name: CameraCyclePause (viewer)
Action category: command
This action interrupts a running cycle.
Parameter |
Function |
|
---|---|---|
viewer |
Viewer |
Global viewer or viewer client no. |

Action name: CameraCycleResume (viewer)
Action category: command
This action resumes an interrupted cycle.
Parameter |
Function |
|
---|---|---|
viewer |
Viewer |
Global viewer or viewer client no. |

Action name: CameraCyclePrev (viewer)
Action category: command
This action selects the previous position in a running cycle.
Parameter |
Function |
|
---|---|---|
viewer |
Viewer |
Global viewer or viewer client no. |

Action name: CameraCycleNext (viewer)
Action category: command
This action selects the next position in a running cycle.
Parameter |
Function |
|
---|---|---|
viewer |
Viewer |
Global viewer or viewer client no. |

Action name: ViewerChangeSceneEx (viewer, GlobalMonitorNr)
Action category: command
The extended action displays the scene where the viewer with the global number on any G-View in the network belongs to.
Parameter |
Function |
|
---|---|---|
viewer |
Viewer |
Global viewer or viewer client no. |
GlobalMonitorNr |
GlobalMonitorNr |
Global monitor number. |

Action name: VCChangeSceneByNameEx (viewer, scene, GlobalMonitorNr)
Action category: command
The extended action displays a scene in the G-View with given viewer client number. The scene is identified by its name which is case sensitive. (e.g. "MyScene" equal "myscene")
Parameter |
Function |
|
---|---|---|
viewer |
Viewer |
Global viewer or viewer client no. |
scene |
Scene |
Scene name. |
GlobalMonitorNr |
GlobalMonitorNr |
Global monitor number. |

Action name: ViewerClearSceneEx (viewer, GlobalMonitorNr)
Action category: command
The extended action clears the scene where the active viewer of the G-View with the given viewer client number or the viewer with the global number on any G-View in the network belongs to.
Parameter |
Function |
|
---|---|---|
viewer |
Viewer |
Global viewer or viewer client no. |
GlobalMonitorNr |
GlobalMonitorNr |
Global monitor number. |

Action name: VCClearSceneByNameEx (viewer, scene, GlobalMonitorNr)
Action category: command
The extended action clears a scene in the G-View with given viewer client number. The scene is identified by its name which is case sensitive. 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 or viewer client no. |
scene |
Scene |
Scene name. |
GlobalMonitorNr |
GlobalMonitorNr |
Global monitor number. |