| GeViScope SDK > Action documentation > Viewer notifications

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 ViewerExportPicture action while GSCView is remote controlled or because the user has manually 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 clipboard
4 = print picture
time stamp TimeStamp Timestamp belonging to the picture exported or belonging to the first picture 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 parameter 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 running
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 SceneStoreName Scene store name.
time stamp TimeStamp Time stamp.
modification type ModificationType 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

VC alarm queue notification

Action name:VCAlarmQueueNotification(Viewer, Notification, AlarmID, TypeID, ClientHost, 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 number, 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 running
client type ClientType 1 = GSCView
All other values are for future use!
client account ClientAccount Windows user account under that GSCView is running

VC scene changed

Action name:VCSceneChanged(Viewer, Scene)

Action category: notification

The active scene of the GSCView with the transmitted viewer client number has been changed.

 

GSCView has fired this notification because its active scene has been changed via a VCChangeSceneByName or ViewerChangeScene action while GSCView is remote controlled or because the user has manually changed the active scene in GSCView.

 

Parameter Function
viewer Viewer Global viewer client number, identifies the GSCView that fired this notification
scene Scene The name of the scene that is displayed after the change

Viewer cleared

Action name:ViewerCleared(Viewer, ClientHost, ClientType, ClientAccount)

Action category: notification

The viewer with the transmitted global number on some GSCView in the network has been cleared.

 

GSCView has fired this notification because one of its viewers has been cleared via a ViewerClear action while GSCView is remote controlled or because the user has manually cleared the viewer in GSCView.

 

Parameter Function
viewer Viewer Global number of a viewer on some GSCView in the network
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

Viewer connected

Action name:ViewerConnected(Viewer, Channel, PlayMode, ClientHost, ClientType, ClientAccount)

Action category: notification

The viewer with the transmitted global number on some GSCView in the network has been connected.

 

GSCView has fired this notification because one of its viewers has been connected via a ViewerConnect or ViewerConnectLive action while GSCView is remote controlled or because the user has manually connected the viewer in GSCView.

 

The parameter "play mode" defines in which mode the pictures are presented (live, forward, backward, .).

 

Parameter Function
viewer Viewer 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
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

Viewer play mode changed

Action name:ViewerPlayModeChanged(Viewer, Channel, PlayMode, ChannelTime, ClientHost, ClientType, ClientAccount)

Action category: notification

The playmode of the viewer with the transmitted global number on some GSCView in the network has been changed.

 

GSCView has fired this notification because the playmode of one of its viewers has been changed via a ViewerConnect, ViewerConnectLive, ViewerSetPlayMode, ViewerPlayFromTime, ViewerJumpByTime or one of the ViewerShowAlarmBy. actions while GSCView is remote controlled or because the user has manually changed the playmode of the viewer in GSCView.

Parameter Function
viewer Viewer Global number of a viewer on some GSCView in the network
channel Channel Global number of the media channel, displayed in the viewer
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
channel time ChannelTime Timestamp belonging to the picture presented in the viewer directly after the plamode had changed. The parameter is transmitted in the following format: "2009/05/06 14:47:48,359 GMT+02:00"
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

Viewer selection changed

Action name:ViewerSelectionChanged(Viewer, Channel, PlayMode, ClientHost, ClientType, ClientAccount)

Action category: notification

 

The active viewer on some GSCView in the network has been changed.

GSCView has fired this notification because the user has selected one of its viewers by mouse click or by dragging a camera onto one of its viewers.

 

GSCView only fires the notification, if a camera is displayed on the selected viewer.

Parameter Function
viewer Viewer Global number of a viewer on some GSCView in the network
channel Channel Global number of the media channel, displayed in the viewer
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
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