Vigil Client Software
v5.00
User’s Guide
Table of Contents
VIGIL CLIENT SOFTWARE V5.00 ... 1
USER’S GUIDE ... 1 TABLE OF CONTENTS ... 2 1 INTRODUCTION ... 4 2 SYSTEM REQUIREMENTS ... 5 3 FEATURES ... 6 4 INSTALLATION ... 7
4.1 SPECIAL WINDOWS INSTALLATION NOTICE... 7
4.2 INSTALLATION ... 8 4.3 UNINSTALL ... 9 5 OPERATION ... 10 5.1 SERVERS WINDOW ... 11 5.1.1 Adding a Server ... 12 5.1.2 DVR Settings ... 14 5.1.3 Remote Register ... 30 5.2 CAMERA LISTS ... 31 5.2.1 Groups Tab ... 31 5.2.2 Sites Tab ... 33 5.2.3 Audio Tab ... 35
5.2.4 POS Data (Live) Tab ... 35
5.3 LIVE VIEWER WINDOW ... 36
5.3.1 Recording Modes ... 37
5.3.2 PTZ Camera Controls ... 38
5.4 SEARCHING VIDEO FOOTAGE ... 41
5.5 VIDEO SEARCH RESULTS ... 42
5.6 SEARCHING POSDATA ... 42
5.7 POSDATA SEARCH RESULTS ... 44
5.7.1 Creating and Running a Custom Search ... 44
5.8 PLAYBACK WINDOW... 46
5.8.1 Synchronized Multi-Screen Playback... 49
5.8.2 Smart Search ... 49 5.8.3 Zoom ... 50 5.8.4 Adjust Image ... 51 5.8.5 Markers ... 51 5.8.6 Cache... 52 5.8.7 Audio Playback ... 52 5.9 EXPORTING FOOTAGE ... 52 5.9.1 Exporting Images ... 53 5.9.2 Exporting Video ... 53
5.9.3 Printing a Still Image ... 55
5.10 SETTINGS ... 55
5.10.5 Hardware Tab ... 58 5.10.6 Destinations Tab ... 59 5.10.7 Audio Tab ... 60 5.10.8 Chat Tab ... 61 5.10.9 Sitemaps Tab ... 61 5.10.10 Transcoder Tab ... 61 5.11 SERVER ALARMS ... 62
5.12 EXPORT FILE BROWSER ... 63
5.13 SITE MAP ... 65
5.14 VIDEO AUTHENTICATION ... 66
6 LOCAL SOFTWARE UPDATE ... 67
7 SITE MAP DESIGNER ... 68
7.1 SITE MAP DESIGNER ICONS AND BUTTONS ... 69
7.2 SITE MAP/HOT SPOT PROPERTIES... 70
8 LANGUAGE SWITCHER ... 71
9 TROUBLESHOOTING ... 72
1
Introduction
This guide describes the installation and operation of CSI Technologies’ Vigil Client Software. This version of User’s Guide is current to Version 5.00 of Vigil Client.
Vigil Client is a powerful, yet easy-to-use, software package for remotely viewing and saving footage from DVRs running Vigil Server. You can retrieve and play stored footage, create video clips and images, and then store or print those clips and pictures.
CSI Technologies (www.csi-tech.com) produces enterprise class DVRs and state-of-the-art surveillance software.
2
System Requirements
PC Feature Minimum Recommended
Operating System Windows 98 Windows 2000 SP4
Windows XP SP2
CPU 850MHz 1.5GHz
RAM 256MB 512MB
HDD Size 5GB 10GB
HDD Transfer Rate DMA 66MHz DMA 133MHz
Note: Vigil Client will only run on Windows platforms that support DirectX 7.01 or higher. Run DxDiag.exe to view the version of DirectX that is currently installed.
3
Features
Feature Details
Search Retrieve a list of stored footage for specified cameras from a start date/time to an end date/time
Quick Search Retrieve a list of all footage for the past 1 – 8 hours Regular Playback Scan through recorded footage using play/pause buttons
Scroll-bar Playback Use a scroll-bar to locate footage by dragging to a desired location, or skim ahead or back 1 or 10 frames per click
Current Frame See the frame number, frame count, frame size (in KB), and frame time/date for the currently displayed frame
Video Cueing Cue video to a specified date/time or frame number
Save Footage Save the currently displayed video footage in AVI or MJPG format Save Picture Save the currently displayed frame in JPG or BMP format
Full Screen View footage or pictures at their full resolution with the click of a button
Live Viewer
View up to 32 video feeds at once; see the site name, camera name, and local time/date for each live video feed; with the client/server, view feeds for multiple sites at once
4
Installation
4.1
Special Windows Installation Notice
Warning: During the installation you may get a Windows File Protection and/or a Windows Logo testing notice. Please follow the following instructions when this happens. Failure to do so can result in a non-functioning software installation.
Click “Continue Anyway”
Click “Cancel”
Click “Yes”
4.2
Installation
To load Vigil Client you must have 80MB of free space on your hard drive: 40MB to load and 40MB once loaded.
Note: To update an existing version of Vigil Client, use the Vigil Client update
(VGL) file instead of the Vigil Client install package (EXE).If you downloaded your install kit for Vigil Client, simply double-click the EXE file that you downloaded to begin the installation. If you are installing from CD, load it in your CD-ROM drive and run the EXE on it.
Navigate through the installation screens as follows:
Install Screen Details
Preparing to Install/InstallShield
Wizard
Decompresses and loads the InstallShield files and wizard.
Customer
Information/Application Privileges
Type in a user and company name (required fields). Select whether to install Vigil Client for all users or for only the current user.
Program Options
Allows for selection of optional installation components, such as the DV player, video CODECs, help files, and the Site Map Designer. The default selections are recommended.
Review Settings Summarizes installation settings. Once you are satisfied, press “Next”.
Progress/Complete
Installs the Vigil Client files. Be sure to review the follow the procedures found in Section 4.1 regarding the Windows installation notices.
The installation process performs the following functions:
• Creates a “Vigil\Client” folder in your “Program Files” folder.
• Loads VigilClient.exe and any required and optional files into the created folders. • Loads required DLL and OCX files into your “System” folder.
• Adds several registry entries in the Windows Registry.
• Creates a “Vigil\Vigil Client” folder in your “Start” menu and copies several shortcuts into the created folder.
• Creates an entry in your list of installed programs to allow for easy uninstall.
4.3
Uninstall
To uninstall Vigil Client, go to “Add/Remove Programs” (Start Menu | Settings | Control Panel | Add/Remove Programs), and click “Remove” by the entry “Vigil Client”. Follow the prompts to perform the removal process.
5
Operation
When Vigil Client is run for the first time, you will be prompted to select which language you wish to use.
The available options are: • English
• French • Spanish • Hebrew
Once you have made a selection, click “Switch” and then “Close”.
This is the main view of Vigil Client.
5.1
Servers Window
A server in this context is a DVR PC running Vigil Server. The purpose of setting up servers is to make connecting to local and remote servers more efficient by not needing to remember IP addresses or DNS names. Server information is stored by a description that is created by the user.
Opens the “Servers” window. You can also open this window from the menu by going to “View | Servers”.
This window displays a list of saved servers. It also displays their current connection status and offers different buttons to interact with the servers, change settings, and more.
Disconnected from the server. Connected to the server.
Connected to the server, but with non-administrative privileges.
Connects to all configured servers. If a server doesn’t have a username and password stored in the settings, it will prompt for the username and password.
Connects to the selected server only. If the server doesn’t have a username and password stored in the settings, it will prompt for the username and password.
Connects to the selected server only. However, it will automatically bypass the stored username and password and will prompt one for this connection. Opens a prompt asking if you want to disconnect from the currently selected server.
Opens the “Server Settings” window.
Opens a prompt confirming if you wish to remove the currently selected server from the server list.
Opens the “Server Settings” window for the currently selected server allowing you to change the stored settings.
Opens the “DVR Settings” window for the currently selected server. You must be connected to the server with administrative privileges.
Opens the “Registration” window for the currently selected server.
5.1.1
Adding a Server
To add a new server, click the “Add” button from the “Servers” window.
Network Settings
IP/DNS Name
The IP address or DNS name of your server. To use a dialup connection, leave this setting blank and mark the “Use Dialup” checkbox and select the dialup connection to use from the dropdown box.
User Name Password
The user name and password that Vigil Client will use to log in to the server. If these are left blank, a prompt will be opened during connection for the user name and password to be inputted manually.
Note: The default administrator login to Vigil Server is: username “administrator” and password “123”. The default user login is: username “user” and password “123”.
Use Dialup Allows you to use a dialup connection to connect to a server.
Note: At least one Windows dialup connection must be set up for “Use Dialup” to be enabled.
TCP/IP Ports Allows you to change the default TCP/IP port settings if they have been changed on the server.
For the Client software to connect properly to the Server, the TCP/IP Ports in the Client software must match the TCP/IP Ports on the Server.
To change the TCP/IP Ports: select a preset number from the dropdown list; enter in the Data Port and then click the “Get Settings” button; or enter the ports in manually.
Reset to Defaults – Click to reset the ports to the default settings.
Get Settings – Retrieves the settings from the server. Enter the Data Port, and then click the “Get Settings” button to retrieve the other ports from the server.
Live Overlay
Use Live Overlay From Card Capture Card
Input Number
Enables live overlay features from an installed capture card to be used. Select the input number from the dropdown list. For this feature to function properly, “Live Overlay” must be enabled in the “Settings | Hardware” section and the capture card drivers must be installed.
5.1.2
DVR Settings
To access a remote server’s DVR settings, Vigil Client must be connected to the server with administrative privileges.
Select a server from the list and click “Connect”. If the default user does not have administrative privileges, use “Connect As” to login as an administrator.
Opens the “DVR Settings” window which allows you to remotely access some of the server’s DVR settings.
5.1.2.1
DVR Recorder Tab
The first settings to appear are the DVR recorder controls. From this window, cameras can be set to start or stop recording, the server can be rebooted or updated, and basic information about the operating performance of the DVR is displayed.
Camera information is displayed in the main portion of the window.
Camera is currently recording.
Along with the status icons, camera settings are also displayed. The camera recording frame rate, the recording resolution, recording mode, and compression quality are listed. At the bottom of the window, DVR information such as running time, number of client connections, current CPU usage, and current memory usage.
DVR Recording
Starts recording on the currently selected camera(s).
Stops recording on the currently selected camera(s).
Restarts the server.
Warning: This action will restart the server and take it temporarily offline.
Opens the “Sequence” window which turns of/off the camera sequencing on connected analog monitors.
Uploads and applies an update file on the server. Select the VGL update file and the update process will begin.
Opens the “Hardware Information” window which provides some basic information on the hardware installed in the server.
5.1.2.2
Picture Quality Tab
The Picture Quality tab allows you to change the recording quality of each camera.
Select the “Apply to All” button if you wish to apply any changes to all cameras at once.
The “Advanced Settings” tab allows the recording quality to be adjusted to any numerical value between 20 and 90. This is for fine-tuning of camera recording quality.
5.1.2.3
Camera Names Tab
The “Camera Names” tab allows the user assigned names of each camera to be changed.
To change the name of a camera, type in the new name beside the camera number and click either “Apply” or “OK”.
To make changes to a camera, first select it from the “Camera” dropdown box.
Camera Setup/Recording Mode
Returns the current camera settings to it’s default settings.
Returns camera settings of all cameras to their default settings. Camera Settings Tab
Brightness Slide to the right for a lighter picture, to the left for a darker picture.
Sharpness Slide to the right to increase image sharpness, to the left to decrease image sharpness.
Contrast Increasing the contrast of the image recorded better defines any contrasting lines or shapes.
Hue
Slide to the right to increase the amount of colour information in the picture, to the left to decrease the amount of colour information in the picture.
Saturation U Saturation V
Use the Saturation U and Saturation V slide bars to adjust the U and V colour difference signals used in YUV colour format.
Noise Reduction Used to reduce video noise on grainy video images. If this value it is set too high it may have detrimental effects under certain conditions.
Recording Mode Tab
Recording Mode
Each camera can be set to one of three recording modes: • Constant – Camera is always recording.
• Motion – Camera only records when motion is detected.
• Schedule – Can record in both constant and motion modes, but can be set up in a custom schedule.
Set Speeds
Enables you to change the current recording speed of the selected camera for each type of recording mode.
Note: If a camera is selected for an alarm input in the “Relays/Alarms” tab in the Vigil Server settings, the camera will record constantly while the alarm input is triggered.
Motion Mode Settings Post Motion
Record
The length of time a camera continues to record after motion or an alarm is detected.
Trigger Blocks The number of motion zones necessary to trigger the motion detector. The recommended value for “Trigger Blocks” is 1.
Motion Sensitivity
Controls the sensitivity of the motion detection. “Very Sensitive” will detect a low amount of motion. “Less Sensitive” will need larger amounts of motion.
Schedule Mode Settings
Once “Schedule” has been selected, the “Schedule” window will open. It consists of a graph that controls the modes and times that the camera will record.
Opens the “Schedule” window.
To modify the schedule, click the appropriate recording type button then click and drag across the desired time slot. Areas that are blank (no color) have no recording modes defined for that time and will not record any footage.
Sets or changes section to constant recording mode. Time periods are coloured green when set to constant record.
Sets or changes section to motion recording mode. Time periods are coloured blue when set to motion record.
Expands and contracts the time graph horizontally. This allows for better precision in setting your time periods.
Expands and contracts the time graph date graph vertically.
Note: The smallest time interval that can be used is 15 minute periods.
Moving a time
period Click and hold the “Shift” key and click-and-drag the section. Copying a time
Changing record mode of a time
period
Select the section by clicking on it and then click the appropriate button to select the desired recording type.
Changing the start or end time
of a period
Select the section by clicking on it and then click and drag the right of left edge of the section.
Importing a schedule from another camera
Select the camera from the “Import From Camera” dropdown box list and then click “Import”.
Note: Importing the schedule of another camera will overwrite the schedule of
the current camera.Viewing the start and end times of
a section
Select the section by clicking on it. The start and end time of the selected section are displayed near the bottom left corner of the “Schedule” window. You can also mouse over the any part of the section and the time will be displayed near the bottom as well.
Deleting a time
period Select the section by clicking on it and then click “Delete”. Deleting a
schedule Click the “Clear All Button” to delete the entire schedule. Apply Schedule
To All Cameras
When marked, this checkbox will apply the created schedule to all cameras that have been set to “Schedule” recording mode.
CODEC Settings Tab
CODEC There are two CODECs available for use: AZTECH and MPEG4. AZTECH CODEC Settings
Space Saving Mode (AZTECH)
Enabled
This feature uses advanced compression technology to decrease the file size of recorded footage. This is a CPU intensive feature.
Sensitivity
Threshold used by the CODEC to identify the areas of change (deltas) between frames. The higher the threshold, the fewer blocks are considered changed.
Noise Adaptive
Noise threshold used by the comparison algorithm when determining whether a block contains “motion”. When this is disabled, advanced noise threshold detection is not used. When this value is increased, more noise is allowed in the block without triggering “motion” for that block. This feature does not decrease “noise” in an image. The Noise Reduction setting in Vigil Server can be used to reduce “noise”; see Vigil Server Users Guide for details.
Detect Using GrayScale Detect Using
Color
When “Detect Using Colour” is selected, color is used instead of GrayScale for delta detection. “Detect Using GrayScale” is the recommended setting for both colour and black and white cameras.
Use B Frame When this feature is enabled, “B” frames are used to decrease the file size of recorded footage. This is a CPU intensive feature.
MPEG4 CODEC Settings
Keyframe Rates Sets the number of keyframes recorded per second. The higher the number of keyframes per second, the greater the data space needed for recording. Motion Search
Scope Used to change the size of the area that is used to detect motion. Quantization
Method
Selects the type of compression used. Selecting “H263” will give better results at the expense of heavier CPU usage.
ME Accuracy
Full pixel checks for motion by comparing differences of full pixels. Half pixel detection will check for motion using an interpolation method. Although half pixel will detect finer movements it is also very CPU intensive and should only be used in extreme cases where ultra sensitivity is required.
ME Algorithm
Changes the shape of the area used to detect motion. Fast search will save time but may miss some motion events. Full search is the best option to use.
H264 CODEC Settings
Variable Bit Rate
The default setting of variable bit rate allows the encoder to change its recording bit rate automatically as required. This option offers the best trade off of file size and visual quality.
Restrict Maximum Bit
Rate
This sets a hard limit on the maximum quality that can be recorded. Options are Low, Medium, High, and Super-high.
Constant Bit Rate
Instead of a variable bit rate, this option will make it constant. A setting of constant, super-high bit rate will provide the maximum video quality settings, at the expense of storage space.
Recording Rate/Resolution
In the “Recording Rate/Resolution” section, the cameras are grouped into “Bank” tabs that represent the physical camera banks in the DVR. This allows the user to maximize the “Recording Speed” for each camera “Bank”.
Change the capture resolution or recording speed
Find and select the tab with the camera number in it. Select the camera from the “Camera” dropdown list. Use the “Capture Resolution” and “Recording Speed” dropdown lists to modify the settings. Tick the “Network Camera” checkbox if this is a network camera that was set up on Vigil Server.
Note: The “Network Camera” feature disables the physical camera input in the
video capture card.5.1.2.5
Settings Tab
The “Settings” tab provides control over some of the basic behaviour of the DVR server.
Site Name The name of the remote site. To change the site name, type the new site name into the text box.
Auto Logon
When this is ticked, a message box comes up and prompts for a username and password. The username and password entered will be used to log into Vigil Server automatically when the program is launched.
Data Drive Settings
The “Data Drive Settings” area displays the data drive information of the DVR.
Global Server Settings Tab
Auto-Start Recorder
When enabled, starts recording footage as soon as the Vigil Server program is launched. If disabled, recording must be started manually via the
Enable Logging Enables Vigil Server log files. Resolve Client
Name
When enabled, the IP Addresses of clients who log in remotely to the Vigil Server are queried to find the computer name of the remote client.
A/C Cameras
When “A/C Cameras” is enabled, Vigil Server is set up to record footage from A/C cameras. When AC Cameras is disabled, it is set up to record footage from DC cameras.
Watchdog
When enabled, the watchdog hardware on the video capture board checks to make sure Vigil Server is responsive. If it becomes unresponsive, the DVR is automatically rebooted.
Note: If the watchdog hardware on the DVR has not been set up correctly, this
feature will not be functional.Limit Search to
One Day When ticked, Vigil Server will allow only one-day searches. Max Network
Connections
The maximum number of connections allowed remote access to Vigil Server at one time.
Note: Each live window, playback window, and settings screen takes up one or
two connections to the server. A minimum “Max Network Connections” setting of 20 is recommended.Sequence Tab
The “Sequence” settings control the order and duration of the sequence of cameras displayed on the analog output monitors.
Monitor Number Selects which monitor that the sequence will be displayed upon. Auto Start
Sequence
When selected, the sequence is automatically started when the Vigil Server software starts.
Opens the “Sequence” window which enables you to add a camera and its dwell time to the sequence. The dwell time is how long the display will show that particular camera on the monitor.
Opens the “Sequence” window for the selected camera.
Deletes the selected camera from the list.
Select a camera and the click the “Up” or “Down” to change its order in the sequence.
5.1.2.6
Users Tab
The “Users” tab allows the configuration of users for the DVR with specific permissions. Each user belongs to a group and each group has a set of permissions.
User Management
Opens the “Add New User” window. Input the desired user name, password, and group to complete the user creation.
Select a user from the dropdown list and click “Edit” to change that user’s password or group.
Select a user from the dropdown list and click “Delete” to remove that user.
Changing a user’s group
To change the user’s group settings, simply put a checkmark beside the appropriate group in the “Groups” section. A user can only belong to a single group.
Selecting this button will modify groups.
Opens the “Add New Group” window. Input the desired group name and click “OK”.
Select a group from the dropdown list and click “Edit” to change that group’s permissions. Place a checkmark beside the appropriate permissions you wish to assign.
Select a group from the dropdown list and click “Delete” to remove that group.
5.1.2.7
Update Tab
The “Update” tab controls the Vigil Update Service on the remote server. This tool can be used to provide software updates to the server alone or host updates for interconnected Vigil DVR Systems.
Update Service Role
Primary Server
A “Primary Server” provides update files to other systems, but does not receive updates from other update servers and does not automatically apply updates to itself.
Secondary Server
A “Secondary Server” acts as a client and as a server. As a Client, it receives update files from other update servers and applies updates to local software. As a server, it provides update files to other systems. It provides the files that it has received as well as files that are added manually.
Client A Client receives and applies updates to local software, but does not provide the updates to other systems.
Update Server Settings
The settings for the update servers from which update files are received. Update Server
Address
The update service connects to the listed update server when it automatically checks for update files.
Backup When the “update service” automatically checks for update files, if the connection to the update server fails, the backup server is used.
Address The IP address or DNS name of the update server, both the update server and the backup server
Port The port used when connecting into the update server. Update Frequency
Configures how often to connect to the update servers to check for update files and whether or not to automatically apply the update files received.
Daily The update service connects to the update server once per day during the hour specified in the “In This Hour” section.
Weekly
The update service connects to the update server once per week on the day selected from the dropdown list during the hour specified in the “In This Hour” section.
Automatically apply updates
When a new version of software is available for one of the products listed in the “Local Products to Update” section. It is automatically applied.
Note: When the system is automatically updated, it will restart itself, apply the
update, and then restart itself again.Note: If there are no products listed in the “Local Products to Update Section", no updates will be applied.
Local Products To Update
If “Automatically apply updates” is enabled, the products listed are automatically updated when a new update is received.
Click “Add” to add a new product to the list. In the “Local Products to Update” window, select a product from the dropdown list.
Removes the selected product from the update list.
5.1.3
Remote Register
The “Remote Register” button from the “Servers” window opens the “Registration” window. This window can allow you to register software
Process for registration:
1. Write down the “Serial Number” from the “Registration” window.
2. Send the “Serial Number”, your name, company name, module you need to register, and contact information to CSI Technologies at [email protected]. CSI Technologies will contact you with a registration key.
3. Once you have received a registration key, select the module from the “Unregistered Modules” dropdown list.
4. Enter the registration key. 5. Click “Register”
6. Repeat steps 1 – 6 for each module you wish to register. 7. Click “Exit” when you’re finished registering.
5.2
Camera Lists
The “Camera” sidebar consists of list of available server DVRs and cameras, audio feeds,
configurable groups, and live data feeds. This sidebar opens on the left side of the main window. The default view is the “Sites” tab
Opens the “Cameras” list. You can also open this sidebar from the menu by going to “View | Cameras”.
5.2.1
Groups Tab
Cameras are typically grouped by server site, but you can define custom camera groupings including cameras from any connected servers. To view custom camera groups, click the “Groups” tab.
Add Grp – To add a new group, click the “Add Grp” button, enter a name for the new group, and click “OK”.
Add – To add a camera to a group, click the “Add” button to open the camera selection screen. Drag and drop the camera onto the group name.
Delete – To delete a group or a camera, click on the group name or camera name to select it, and then click the “Delete” button. Click “Yes” to the confirmation box.
Display – To display all of the cameras of a group in the live viewer, select the group and click the “Display” button.
5.2.2
Sites Tab
The standard camera organization is by server site. To view cameras listed by site, click the “Sites” tab.
Server site status is indicated by the icon:
- Site connected with administrator privileges. - Site connected without administrator privileges. - Site not connected.
A context menu is available by right-clicking on a site name:
Connect – Connect to the site with the configured username and password.
Connect As… - Connect to the site with a username and password prompt.
Refresh – Update the camera list for the site. Disconnect – Disconnect from the site.
Chat – Open a chat session with the site. Refer to section 5.2.2.1: Chat below.
Display All – Adds all available cameras to the Live Viewer.
A camera can be viewed in the “Live Viewer” by double-clicking the camera’s name.
The last 5 minutes of footage from a camera can be played back by right-clicking a camera name and selecting “Replay”.
5.2.2.1
Chat
Vigil Server and Client include a chat feature to speak or write back and forth between Vigil Clients connected to Vigil Servers. The chat session is initiated by the Vigil Client only and can be used to communicate vocally or in writing.
In the “Sites” tab, right-click on a connected site and select “Chat”. This opens the “Chat” window and initiates a chat session with the server.
Note: For voice chat to be available and function correctly, audio settings for chat must be configured correctly in the Vigil Client “Settings” window.
Enabling Audio Right-click on the site name and select “Audio”. This will initialize the audio for the chat session. Uncheck “Audio” to stop all audio.
Disconnecting the chat session
Right-click on the site name and select “Disconnect”. This will end the chat session. Closing the “Chat” window will also end the chat session.
Hands Free
Tick “Hands Free” for Vigil Chat to automatically detect the volume level and only send voice when sound reaches a specific volume. Un-tick “Hands Free” to use the “Talk” button to manually start and stop sending voice data.
Talk When “Hands Free” is unchecked, click “Talk” to send voice data. Unclick “Talk” to stop sending voice data.
Voice Detection
Graphs The voice detection graphs provide a visualization of voice data detected in chat session.
Send Text Type text into the textbox and then click “Send Text”.
Sensitivity Use the button to expand the controls section. Use the slide bar to adjust the chat audio sensitivity.
5.2.3
Audio Tab
To listen to live audio, click the “Audio” tab and expand a connected site with audio recording enabled. Select an audio channel to start the live audio feed or to switch to another feed. Adjust audio volume using the Windows volume controls.
- This level meter indicates the audio level for the currently selected audio channel.
Sensitivity – This slider adjusts the audio
sensitivity without affecting the sensitivity settings on the connected server.
5.2.4
POS Data (Live) Tab
The “Live Data” tab displays POS data in real-time from connected servers.
Current Site – Use the “Current Site” dropdown list to change the DVR site displaying the live data. Filter – Enter a register number to filter displayed data, or leave the entry blank to view data from all data terminals.
The POS data columns can be arranged into any order that you wish.
A context menu is available by right-clicking the data:
Copy Line – Copy the selected line to the Windows clipboard
Export – Saves the data to a predefined export destination. The “Destinations” screen will be displayed. Select the desired destinations, enter a filename, and click “OK.” Another window will open allowing you to customize the amount of POS data that will be exported.
Print – Prints the live data.
Reset Column Order – Resets the order of the POS data columns if they have been rearranged.
• Timestamp – The time at which the Point of Sale event occurred. • Receipt # – The receipt number of the current receipt.
• Reg # – The cash register number.
• Cashier – The cashier currently logged into the data terminal. • Code – The transaction type code identifies the type of transaction. • Qty. – The quantity of the item purchased.
• Item – The item purchased.
• Amount – The price of the item purchased.
5.3
Live Viewer Window
The “Live Viewer” window displays video footage streamed from the DVR servers.
Opens the “Live Viewer” window. You can also open this window from the menu by going to “View | Live” and by double-clicking a camera in the “Sites” or “Groups” tab.
Use the buttons in the top section of the Live Viewer Toolbar to select the viewing style.
Changes the camera layout in the “Live Viewer” window. These are the layout options when connecting to a 32 camera DVR.
Increases the video display rate for all camera feeds to maximum.
Stops the selected camera view. This does not stop the camera from recording.
Displays the current Live Viewer layout in full screen.
To change the currently displayed cameras, drag and drop the desired camera onto the display grid.
Right-clicking on a camera feed provides a context menu with the following options: Zoom Enables the zoom tool; left-click to zoom in, right-click to zoom out.
Copy Copy a still shot of the video feed to the Windows clipboard.
Stop Stops and removes the camera from the “Live Viewer” window. This does not affect the recording settings.
Speed Select the display speed for the camera. Options are: Slow, Medium, Fast, Turbo, Maximum, and Frame by Frame.
Relays
Interfaces to the server relays. Relays can be toggled on or off, corresponding to closed and open states respectively. Relays must be configured on the DVR first.
Quick Search
Retrieve recent footage from the camera for preset intervals of 1, 5, or 10 minutes. This will open the “Search/Playback” window and begin playback of the selected camera and time interval.
5.3.1
Recording Modes
Coloured borders appear around the frame of the streaming video. These are used to provide a quick assessment of current camera recording modes and events.
Red Camera is set to motion alarm recording, has detected motion, and is currently recording. If POS data alarms are used, can also indicate a POS data alarm.
Blue Camera is set to motion recording, has detected motion, and is currently recording.
Yellow Camera is set to either motion or alarm recording and is recording in the post-motion
period after motion has been detected.
No Color If there is no coloured border around the camera feed, the camera is currently not recording footage.
When a camera is active, a small green dot will blink at the lower left of the camera feed. This gives feedback that a camera is still active, especially useful if the video frame rate is much less than 1 frame per second.
5.3.2
PTZ Camera Controls
If a PTZ camera displayed on the live screen, open it in single camera layout to open the “Camera Controller” window for that camera.
Dropdown selection
Controls
Use the mouse to click and drag the blue dot in the middle of the Pan-Tilt control in the desired direction. The speed at which the camera moves increases as the dot is dragged closer to the edge of the circle.
The alternate directional controls are displayed when the selected PTZ camera doesn’t support a full range of motion (i.e., it cannot pan and tilt at the same time)
Zoom/Focus/Iris
Click and drag the appropriate slide bar up to increase or down to decrease. The speed at which the camera is adjusted increases as the bar is moved farther from the center of the control.
If a USB PTZ joystick is attached, this button will be available. Once clicked, it opens the “Joystick Customization” window.
This window allows for customization of each of the joystick buttons. Use the dropdown selection boxes to assign actions to each button.
To determine which button is which, go into the Windows Control Panel and select “Game Controllers”. The device should be listed. Select it and click “Properties”. Press any button on the joystick and the button number should be highlighted on in the resulting window.
Presets
Presets are stored fixed locations that the camera can view.
To save a preset, move the camera to the desired preset location, select the preset number from the dropdown list and click “Save”. This will overwrite any presets saved to that number before.
To move the camera to an existing preset, select a preset from the dropdown list and click “Goto”, or click the button with the preset number on it.
Patterns
Controls the saved pattern of movement of the selected camera. Camera patterns are stored within the camera.
Select a pattern from the dropdown selection box (this will overwrite the existing saved pattern) and click “Record”. Use the other control buttons to move the camera in the desired pattern. Once finished, click “Stop”
Stops recording the current pattern.
Select a pattern from the dropdown selection box and click “Run” to begin the saved pattern.
Tours
A tour is a sequence of camera presets run through Vigil Server. Tour settings are stored within Vigil Server.
Opens the “Tour Settings” window.
Each preset is displayed for the number of seconds specified in the “Dwell Time” section.
Adds a preset to the tour.
Edits a preset in the tour.
Deletes a preset in the tour.
Runs the selected tour. Enhancements
Enhancements are settings on the camera that can be toggled on/off. These include: color, sensitivity, backlight, white balance, and auto focus.
Turns off the selected enhancement. Turns on the selected enhancement. Menu
Some camera’s have built-in menus that can be accessed and configured via this tool. Displays the camera’s menu (this may take a moment to appear)
Exits the camera’s menu. You can also navigate to the “Exit” menu option displayed and click the “Select” button.
Camera menu navigation buttons.
Camera menu select button
5.4
Searching Video Footage
The “Search” window allows you to use various search and POS data criteria to find and playback specific recorded footage or POS data. When first opened, the “Search” window defaults to a search of all cameras, recording in all modes, from the last hour. Clicking the “Search” button immediately will retrieve all footage meeting these criteria.
Each of the search bars, “Search Criteria”, “POS Data Filter”, and “Video Search Results are expandable and collapsible. To do this, click anywhere on the bar.
Resets all search criteria and POS data filters to their default values. The default From/To time is an hour back from the current time.
If a POS data connection has been configured, this button will open the POS data filter and data search results dropdowns.
Several criteria may be used to refine your search: Search Criteria
From/To
You can specify the starting date/time and end date/time of your search. By default, Vigil Server limits your search to be within a single day. This can be changed in the “DVR Settings” window.
Servers Select which connected server you wish to perform the search on. Cameras Select which cameras you wish to perform the search on.
Presets
This drop down includes preset search intervals in hourly increments from 1 hour up to 8 hours. Additionally, selections for 15 and 30 minutes can be added by checking “Short Intervals” the “Settings” window. When a selection is made, the From/To times are adjusted appropriately.
Mode
In addition to the other criteria, you may filter your results by a specific recording mode. Making a selection from this drop down will restrict the returned footage to only the selected type: Constant, Motion, Alarm, or All Types.
Note: Depending on the recording configuration of your cameras, there may be
no saved footage or data matching your search criteria.5.5
Video Search Results
The video search simply shows a table with the start and end dates of the available video footage. To view the resulting video footage, simply click on the desired result and the playback window will open.
5.6
Searching POS Data
In addition to searching video footage, if the server has also been configured to record POS data, you can search this as well. To enable POS data searching, click the “Data” button in the main toolbar.
Search for Line Items
When searching for line items, be aware that the normal search criteria is used as well (i.e., to and from date/times, selected cameras, etc.)
Item
This field allows you to type in text that will match the Item column in the received POS data. It also has a dropdown selection box that will remember your last 10 searches.
Code Matches results in the Code column. Register Matches results in the Register column.
Or / And
Logical operators that will assist in searching with multiple criteria. By default, this is the OR operator, which will match any results, in any of the POS data criteria fields. The AND operator will only match results that have the same POS data criteria, in all the used fields.
Value
Matches results in the Code column. By default, any price is selected. If you wish to match a certain value, select an operator and input a value. The “>=” means “more than or equal to” the value that you input. For example, if I use >= with the value of $20.15, any POS data with the value of 20.15 and higher will be returned. The “<=” operator means “less than or equal to”, while the = operator simply means an exact same value.
Cashier Matches results in the Cashier column. Search for Transaction
This type of search does not use the other criteria as it looks for a particular unique line item or receipt number. Date and times are not used.
Receipt
Number Searches for a matching receipt number.
IDX
Searches for an IDX based on the value you used. If the IDX contains a receipt number, the POS data returned will be that receipt number and all IDX values corresponding to it. If there is no receipt number for the searched IDX value, he returned results will be based on the timestamp of that IDX. The net results will be +/- 10 seconds from that timestamp.
Playback Options
While not search criteria, the playback options allow you to control how your results will be played back. Selecting “Single Screen” will display one camera at a time during playback. Selecting “Synchronized Multi-Screen” will play back up to four cameras at the same time. You can add more cameras to the playback screen by selecting additional cameras as you normally would.
Note: Depending on the recording configuration of your cameras, there may be no saved footage matching your search criteria.
5.7
POS Data Search Results
After completing a POS Data search, a new tab in the sidebar will be opened. This tab is called POS Data Search and will contain your results. Similar to the POS Data (Live) tab, you can rearrange the order of the POS data columns and also right-click on POS line items for a contextual menu.
A context menu is available by right-clicking the data:
Copy Line – Copy the selected line to the Windows clipboard
Export – Saves the data to a predefined export destination. The “Destinations” screen will be displayed. Select the desired destinations, enter a filename, and click “OK.” Another window will open allowing you to customize the amount of POS data that will be exported.
Print – Prints the live data.
Mark Video Region – You can add markers to the playback slide bar with this option to easily identify relevant portions of video. Options are +/- 10, 20, or 30 seconds. You must have the playback window open with video footage selected for this option to become available. Reset Column Order – Resets the order of the POS data columns if they have been rearranged.
5.7.1
Creating and Running a Custom Search
If you find yourself making the same search regularly, a “Custom Search” can be saved. The “Custom Search” window can be accessed from the “Presets” dropdown. It can also be opened from the menu (“Search” | “Custom Search”). When selected, the “Custom Search” window will appear.
Opens the “Create Custom Search” window
Opens the “Edit Custom Search” window (looks the same as the “Create Custom Search” window) for the selected search.
Deletes the selected search.
Runs the selected search.
Server The server that the search will be performed upon. Time Filter The start time and end time to be searched.
Cameras Select the cameras to search, or select “All Cameras”
Data The custom search will include the POS data criteria specified.
Once you’ve completed inputting the search information you would like to save, click “OK”. The window will close and bring you back to the “Custom Search” window. You can either use the “Run” button to begin searching with your selected custom search or by going into the “Search” window and in the “Quick Retrieve” dropdown box, select the name of the custom search.
5.8
Playback Window
To play recorded video footage, double-click a camera from the search results. The “Playback” window will open and the retrieved footage will begin playing.
The information display below the video window indicates the date and time of the footage, the frame rate (if playing), the frame size in kb, the recording mode, the recording resolution and CODEC, and the current frame number. If the zoom feature has been used, then [Sub range] will be displayed.
A visible bar that displays the current cache level can be found just below the main playback window. A green bar indicates the cache level is full and if the bar is almost all red it indicates the cache is low.
Click and drag the variable speed playback slider to change how fast the footage is played back. Playback up to every fifth second of footage. The “Variable Speed” playback tool tip displays the number of times faster the variable speed playback is than the “Fast Backward” or “Fast Forward” buttons.
Click and hold down the “Fast Backward” or “Fast Forward” button to playback as quickly as possible without skipping any frames.
Skips to the very beginning/very end of the video clip.
If clicked while playing the clip, skips one 10th of the clip. While paused or stopped, click to playback frame by frame.
Pauses/plays the video clip.
The scroll bar can be used to quickly move to a different portion of the selected video. Simply click and drag the pointer.
Clicking the scroll bar once and then using the scroll wheel on your mouse will advance or rewind the video 1/50th of the footage time with each click of the mouse wheel.
Stretches the playback image to fill the playback window. Footage is automatically displayed in the resolution at which it was recorded. Footage recorded in 704x480 resolution mode is scaled down to fit the playback window.
Click to save a still image in JPG or BMP format, or to save a video clip in AVI or MJPG format.
Click and select “Print Still Image” to print the current frame, or select “Print Data” to print the currently displayed data.
Click to play in full screen mode. Double-click on the image to return to the standard playback screen.
Frame de-interlacing applies only to DVR480 series DVRs running Vigil Server version 2.03.0000 and higher, recording at resolution 704x480.
When paused in the “Playback” window, use the “Frame De-interlacing” feature to toggle between “F” (Full Field), “AF” (A Field), and “BF” (B Field). Click on the “F” button to toggle between frame types or use the dropdown arrow to select the frame type.
5.8.1
Synchronized Multi-Screen Playback
If “Synchronized Multi-Screen” was selected from the “Search” window, the playback window will be divided into quadrants.
Quadrants are filled in clockwise order beginning in the top left. To add a camera to the playback, click on its name. If all quadrants have cameras loaded, clicking a new camera will replace one of the initial cameras. To remove a camera from playback, right-click in its quadrant and select “Remove”. You can also drag and drop cameras from the “Search” window to the “Playback” window.
Footage will play back from all loaded cameras simultaneously. During playback, if any camera is missing footage, its video will pause with an overlay saying “No Frames Were Found” while the remaining cameras continue to play. When the playback time reaches a point where the paused camera again has saved footage, its playback will resume. When there is no footage for any camera, the playback skips to next time where footage exists for at least one camera.
5.8.2
Smart Search
Smart searching allows you to further refine your video search by performing a custom motion detection search within a specified region of the loaded footage.
To perform a smart search, first select the “Smart Search” item from the drop-down at the left of the “Advanced Features” toolbar. To define the motion search region, simply click and draw within the playback window. A mask pattern will be overlaid on the playback window. Any time you click on a clear area, you are expanding the mask. If you start drawing on a masked area, the mask will be removed.
Shows/hides the smart search masking area.
Offers some quick options for modifying the mask area: Clear – Completely clears the mask.
Select All – Sets the mask to cover the entire footage. Invert - Swaps clear and masked areas.
Sensitivity
This slider controls the sensitivity of the motion detection algorithm used by smart search function. To the left is less sensitive, requiring more definite motion; to the right is more sensitive, detecting smaller movements.
Begins the smart search based on the current mask area.
Restores the originally loaded footage and removes all smart search masks. Enables/disables the “Visual Tracking” feature that highlights moving objects by drawing corners around the object as it moves.
5.8.3
Zoom
You can zoom in on any footage being played back by selecting the “Zoom” option from the “Advanced Features” drop-down.
window. You can also use the “Zoom In” and “Zoom Out” buttons on the “Advanced Features” toolbar.
5.8.4
Adjust Image
When playback is paused, you can adjust the image by selecting the “Adjust Image” option from the “Advanced Features” dropdown. This can be useful for adjusting an image prior to printing or saving.
Here you can adjust the brightness and contrast of the displayed frame. Checking the “Grayscale” box will toggle between a grayscale and colour image. Clicking the “Reset” button will return the image to its default values.
Note: You can only adjust a paused image; adjustment of footage during
playback is too CPU intensive. Any adjustment you have made will be reapplied when footage is paused again.5.8.5
Markers
During playback, if only a sub-section of the loaded footage is of interest, it can quickly be selected by using “Markers”. To use markers, select the “Marker’s option from the “Advanced Features” dropdown.
Position the footage navigation slider at the beginning of the desired footage and click the “Start Range” button. You will notice a small marker appear below the starting point. Next, navigate to the end of the desired footage and click the “End Range” button.
When you want to display the marked footage, click the “View” button. The playback information will indicate that a sub-range is currently displayed. All of the playback controls will operate on only the sub-range of footage.
If you are playing footage in multi-screen mode, each camera can have a different sub-range marked and displayed, independent of the other cameras.
When exporting footage, only the sub-range will be saved.
Note: To export a sub-range, you must have clicked the “View” button;
otherwise, the entire footage will be exported.5.8.6
Cache
Depending on your network/Internet bandwidth, it might be useful to configure the playback caching. Using “Autosense” for the most part will be the most efficient. Only advanced users should attempt to adjust the cache settings.
Auto Sense This is the default value. It will enable the cache to become dynamic and change as required.
Caching Threads
Changes how many caching threads will be used. Each caching thread opens a TCP connection to the DVR, increasing possible bandwidth, but may be limited on CPU usage, as well as the maximum throughput to the DVR.
Cache Size
This is the size of the cache, in number of frames. Settings from 30 to 1800 frames are available. The higher the frame rate, the higher the cache size is recommended.
5.8.7
Audio Playback
If audio hardware was enabled for your DVR, you can also have recorded audio play back at the same time as video footage. To control audio playback, select the “Audio” option from the “Advanced Features” dropdown.
Select the desired audio channel to playback from the Channel dropdown.
All Audio Plays back recorded audio from the selected channel, regardless of whether there is recorded video at the same time.
Video Only Audio
Plays back recorded audio from the selected channel, only when there is corresponding recorded video at the same time.
An audio level meter indicates the signal strength of the currently playing audio.
5.9
Exporting Footage
Video footage can be saved as either a single frame still shot or as video file. This process is referred to as exporting.
Note: To export footage you must have at least one export destination
configured.Note: If “Export Auditing” is enabled on the DVR, required information must be entered before selecting the destination folder for both images and video exports.
5.9.1
Exporting Images
Single frame shots can be saved in either Bitmap (BMP) or JPEG (JPG) format. BMP images retain all of the original image detail, but are typically much larger than JPG images as a result. JPG images are compressed but typically are indistinguishable from the original image with a quality of 70 or greater.
Click to open the Export sub-menu. Select which type of media you wish to export.
BMP Saves the still image as a BMP image. Select the export destinations and enter a filename. Click “Save” when finished or “Cancel” to exit without saving.
JPG
Saves the still image as a JPG image. Select the export destinations and enter a filename. Additionally, you may select a quality setting for the JPG image by adjusting the slider. Closer to the left side means a lower quality, smaller sized file; further to the right means a higher quality, larger sized file. For the most part, the default compression setting is the best choice. Click “Save” when finished or “Cancel” to exit without saving.
Select which destination you wish to save the image to. You can select multiple destinations, as well as create subdirectories by using the New Folder button.
5.9.2
Exporting Video
Video footage can be exported in Microsoft AVI or Motion JPEG (MJPG) formats. The AVI format is widely supported on Microsoft Windows operating systems. However, the file size is typically much larger than files exported in MJPG format. Vigil Client allows video exports to include the Vigil DV player to ensure playback software is available for MJPG exports.
AVI
Saves the current video footage as an AVI video. Select the export destinations and enter a filename.
Clicking the “Advanced” button will open the “CODEC Settings” window that allows you to select and configure the CODEC used during the encoding process.
Click “Save” when finished or “Cancel” to exit without saving.
MJPG Saves the current video footage as a MJPEG. Select the export destinations and enter a filename. Click “Save” when finished or “Cancel” to exit without saving.
With
Audio When selected, also exports any audio on the selected channel with the video file.
AVI export with no audio configured MJEG export with audio configured Select which destination you wish to save the footage to. You can select multiple destinations, as well as create subdirectories by using the New Folder button.
If you are exporting from multi-screen playback, when choosing to export video, you will have the option of exporting the “Selected Camera” or “All Cameras”. Choosing “Selected Camera” will export only the currently selected camera footage. Choosing “All Cameras” will export footage from all currently displayed cameras to separate files. The files will have the camera name appended to the filename you enter.
5.9.3
Printing a Still Image
In addition to exporting still shots to disk, an image can be sent directly to the Windows default printer.
After navigating to the video frame you wish to print, click this button to begin printing to the default printer.
Note: The image will be sent to the default windows printer only. If one has not
been configured an error message will inform you of this.Vigil Client has many different configuration options available. Please be sure to thoroughly review this section to ensure proper software operation.
Opens the “Settings” window. You can also open this window from the menu by going to “View | Settings”.
5.10.1
Startup Tab
The “Startup” tab controls the behaviour of Vigil Client when it first opens.
Auto Logon to All Servers on Startup
When enabled, Vigil Client connects to all servers when the program is launched.
Show Splash Screen on Startup
When enabled, the Vigil Client splash screen is displayed when the program is launched.
Enable Client Login
When Client Login is enabled, a username and password is required when launching Vigil Client. The default username is “user” and the default password is “123”.
Opens the “Change Client Login” window. Type in a new user name and password to change them from the default.
5.10.2
Live Tab
Frame by Frame
When enabled, streams from MPEG4 cameras can be decoded faster. However, this setting may have an adverse effect on non-MPEG4 cameras.
Transfer Motion Block
Enables the transfer of motion block information for use with the SDK. It is not recommended to enable this feature.
5.10.3
Search / Playback Tab
The Search/Playback tab controls options relating to the searching and playback of video footage and POS data.
Allow Client to Stream Live And Playback Streams
Simultaneously
Enable to allow Vigil Client to stream live and playback streams simultaneously. To conserve server resources, leave this option disabled.
Short Intervals
When enabled, the “Quick Retrieve” dropdown list in the “Search” window displays short intervals of 15 and 30 minutes as well as the regular selections.
Remember the last X number of search
items
In the “Search” window, in the “Data Capture Search Criteria” section, previously searched items are remembered and are listed in the “Items” dropdown list. Use the arrows to select how many search items will be remembered.
Set Connection Timeout to X
minutes
When searching video footage, select how many minutes to wait for results from the server before displaying a “Connection Timeout” message.
Auto Sense This is the default value. It will enable the cache to become dynamic and change as required.
Caching Threads
Changes how many caching threads will be used. Each caching thread opens a TCP connection to the DVR, increasing possible bandwidth, but may be limited on CPU usage, as well as the maximum throughput to the DVR.
Cache Size
This is the size of the cache, in number of frames. Settings from 30 to 1800 frames are available. The higher the frame rate, the higher the cache size is recommended.
5.10.4
Alarms Tab
The “Alarms” tab controls the notification settings for alarms received from connected servers.
Automatically Display Inbound Alarms From Server
When enabled, inbound alarms from Vigil Server are automatically displayed in the “Alarms” window.
Audio Notification
Instructs the system to beep or play a Wave file when an incoming alarm is displayed.
System Beep – A system beep is played.
Wave File – Uses an audio WAV file instead of a system beep.
- Browse to the WAV file that will be played.
- Plays the selected WAV file. Changes into a “Stop” button after WAV file begins playing; click again to stop.
Auto Acknowledge After X Seconds
Automatically acknowledge alarm notifications after the specified number of seconds.
5.10.5
Hardware Tab
The “Hardware” tab contains settings specific to the video rendering hardware installed on the client system.
Use Live Overlay From Capture Card
If the Vigil Client PC has a Video Capture card that supports live overlay (hardware rendering), enable to view live overlay from the Video Capture card. Select the video capture card type from the dropdown list. For more information, please contact [email protected]
Use Direct Draw If the Vigil Client PC supports DirectDraw, the program will produce a better quality picture with faster rendering.
5.10.6
Destinations Tab
The “Destinations” tab configures locations for saving video footage, data records, and still shots. If no destinations are configured, you will not be able to export footage, data, or still shots.
Opens the “Media Control” window that allows you to add and configure another destination.
Destination Name – The name that will be displayed when selecting a destination to save to.
Destination Path – The path to the destination, or click to browse to a location. Local hard drive locations or network locations are allowed.
Destination Type – Changes how this destination appears in the selection list: • Default On – By default, the destination checkbox will be selected.
• Default Off – By default, the destination checkbox will not be selected.
• Silent Send – All exports are also sent to this destination without notifying the user.
Include DV Player - Saves the DV Player to the destination in addition to the video during an export. This setting is normally used for CD-R or DVD-R media type destinations.
Opens the “Media Control” window for the selected destination. This enables you to change any settings for this destination.
Deletes the selected destination.
Note: Deleting a destination will not delete the Windows folder or the files
contained in that destination.5.10.7
Audio Tab
The “Audio” tab controls the buffering and compression of audio streams.
Pre Buffer The Pre Buffer is the number of milliseconds to buffer when streaming live audio. Use the arrows to modify the pre buffer.