technical notes for ocularis 5 - onssi notes for ocularis 5.4 on-net surveillance systems inc. ......

30
Technical Notes Smarter Surveillance for a Safer World

Upload: hanhan

Post on 18-May-2018

244 views

Category:

Documents


1 download

TRANSCRIPT

Page 1: Technical Notes for Ocularis 5 - OnSSI Notes for Ocularis 5.4 On-Net Surveillance Systems Inc. ... • The AVI file format is the only supported format and the Xvid codec is required

Technical Notes

Smarter Surveillance for a Safer World

Page 2: Technical Notes for Ocularis 5 - OnSSI Notes for Ocularis 5.4 On-Net Surveillance Systems Inc. ... • The AVI file format is the only supported format and the Xvid codec is required

Technical Notes for Ocularis 5.4

On-Net Surveillance Systems Inc. | One Blue Hill Plaza, PO Box 1555, Pearl River NY 10965 | T 845-732-7900 | www.onssi.com | page 1

The purpose of this document is to provide technical details for various new features in the Ocularis 5.4 release.

Topics in this Document Auto Update Ocularis Client ..................................................................................................................................................... 1 Improved SQL Installation Options ........................................................................................................................................... 3 Two-Way Audio ........................................................................................................................................................................ 4 AVI Exporting in Ocularis 5 Web & Ocularis 5 Mobile .............................................................................................................. 7 Triggers in Ocularis 5 Web & Ocularis 5 Mobile ..................................................................................................................... 15 Ocularis 5 Web Toast Notifications ........................................................................................................................................ 19 Ocularis 5 Web and I-Frames ................................................................................................................................................ 22 Snapshot in Ocularis 5 Mobile................................................................................................................................................ 23 Ocularis 5 Mobile M2O for iOS............................................................................................................................................... 25

Auto Update Ocularis Client Introduced in Ocularis v5.4, we've included an easy way to update the software on Ocularis Client machines. After Ocularis

Base is installed, Ocularis Client will check its own version number against what is available on Ocularis Base. If Ocularis

Base contains a newer version of Ocularis Client software, the user will be prompted to download and install the new version.

This saves the system administrator from having to visit each and every client machine to do an upgrade.

A few items to note:

• This process will only work if you are upgrading from Ocularis v5.3 SP1. If you are upgrading from an earlier version

of Ocularis, use the standard upgrade process (i.e. install the new software on top of the old software). Moving

forward, this process will be supported on all future versions of Ocularis.

• At this time, Ocularis Client is the only component where self-updating is supported.

• The logged in Windows user must have administrator privileges on the local PC.

Upgrading from 5.3 SP1

Whenever Ocularis Client's login process is performed, the software checks Ocularis Base for the most current version. If the

version of Ocularis Client on the Base is newer than the one being used by the Operator, a prompt appears asking if the

operator would like to download and install the new version.

Note: The logged in Windows user must have administrator rights to the PC in order for this method to work. If the Operator does not have administrator rights, the prompt will not appear. Try right-clicking the Ocularis Client icon and select 'Run as administrator'.

When an Ocularis Client successful login is made after upgrading Ocularis Base, the following message appears:

Figure 1 Version Check for Ocualris Client

Click No to delay the upgrade at this time. The next time you login to Ocularis Client, you'll get this message again. It will keep

appearing until you upgrade or click the 'Don't ask again' checkbox.

Page 3: Technical Notes for Ocularis 5 - OnSSI Notes for Ocularis 5.4 On-Net Surveillance Systems Inc. ... • The AVI file format is the only supported format and the Xvid codec is required

Technical Notes for Ocularis 5.4

On-Net Surveillance Systems Inc. | One Blue Hill Plaza, PO Box 1555, Pearl River NY 10965 | T 845-732-7900 | www.onssi.com | page 2

Click Yes to download the installation files from Ocularis Base. Ocularis Client will launch and the files are downloaded in the

background. This may take several minutes based on your network bandwidth. When the download is complete, you'll see the

message:

Figure 2 Upgrade Downloaded Message

Click No to avoid software installation at this time. The software may be manually installed at a later time by launching

Ocularis Client x64.exe from c:\Program Data\OnSSI\OcularisClient.

Click Yes to close Ocularis Client and start the upgrade process. Follow the system prompts to install the new software.

Note: If you are using the 32-bit Ocularis Client there is an additional step required. Download the 32-bit version of the Client from the onssi.com website and place the file on the Base Server in the following location: c:\Program Files\OnSSI\Ocularis Base\Installer Website\files. Then, when the 32-bit Client logs into the Base the version will be checked and this file will be used to in the update.

Note: For Active Directory users: When upgrading from v5.3 SP1, only AD users with administrator rights will be prompted to upgrade. Workgroup users not running with the Administrator account (even with admin rights) will not be prompted in this version. Try right-clicking the Ocularis Client icon and select 'Run as administrator'.

Page 4: Technical Notes for Ocularis 5 - OnSSI Notes for Ocularis 5.4 On-Net Surveillance Systems Inc. ... • The AVI file format is the only supported format and the Xvid codec is required

Technical Notes for Ocularis 5.4

On-Net Surveillance Systems Inc. | One Blue Hill Plaza, PO Box 1555, Pearl River NY 10965 | T 845-732-7900 | www.onssi.com | page 3

Improved SQL Installation Options If you have an existing SQL Server database that you wish to use for Ocularis Base, you may specify its credentials during

installation. You will be required to enter login credentials for this SQL Server instance.

You no longer need to use the 'sysadmin' account for this. The account you use, however, must be able to create an

OcularisUser account and be able to create the VSEvents and/or VSAudits databases. This account must also have db_owner

permissions on the VSEvents and VS Audits databases. Note: the account must not have a space in the name.

After entering the user credentials, click the Test Connection button. You will be notified if the account does not have the

required permissions. You may also use the current Windows User for this SQL account.

Figure 3 Using a Corporage SQL Instance

Page 5: Technical Notes for Ocularis 5 - OnSSI Notes for Ocularis 5.4 On-Net Surveillance Systems Inc. ... • The AVI file format is the only supported format and the Xvid codec is required

Technical Notes for Ocularis 5.4

On-Net Surveillance Systems Inc. | One Blue Hill Plaza, PO Box 1555, Pearl River NY 10965 | T 845-732-7900 | www.onssi.com | page 4

Two-Way Audio Two-Way Audio is now supported in Ocularis 5. Ocularis Client enables both listening to audio from camera-connected

microphones and sending audio to camera-connected speakers. All camera-connected audio devices are configured on the

recording component.

CONFIGURING TWO-WAY AUDIO IN OCULARIS RECORDER MANAGER The ability to listen to camera audio as well as speak to a camera's speakers must be configured in Ocularis Recorder

Manager. In the 'Stream' configuration screen, you can set the ability to listen to a camera's microphone. The default value is

'No'. Change to 'Yes' next to 'Audio (Listen)' to listen to that camera's microphone.

Figure 4 Set Audio (Listen) to 'Yes'

If the camera has its own speakers, operators can use Ocularis Client to speak to them. In the 'Audio' configuration screen for

that camera, set 'Audio (Speak)' to 'Yes'. The default value is 'No'.

Page 6: Technical Notes for Ocularis 5 - OnSSI Notes for Ocularis 5.4 On-Net Surveillance Systems Inc. ... • The AVI file format is the only supported format and the Xvid codec is required

Technical Notes for Ocularis 5.4

On-Net Surveillance Systems Inc. | One Blue Hill Plaza, PO Box 1555, Pearl River NY 10965 | T 845-732-7900 | www.onssi.com | page 5

Figure 5 Set Audio (Speak) to 'Yes'

Additionally, 'Audio In' and 'Audio Out' are also privileges that can be set in Ocularis Administrator's 'Camera Privilege' group

of the Users / Privileges Tab. Be sure that these are checked for cameras you want to use with two-way audio.

Figure 6 Audio Settings in Camera Privilege Group

Page 7: Technical Notes for Ocularis 5 - OnSSI Notes for Ocularis 5.4 On-Net Surveillance Systems Inc. ... • The AVI file format is the only supported format and the Xvid codec is required

Technical Notes for Ocularis 5.4

On-Net Surveillance Systems Inc. | One Blue Hill Plaza, PO Box 1555, Pearl River NY 10965 | T 845-732-7900 | www.onssi.com | page 6

USING TWO-WAY AUDIO IN OCULARIS CLIENT Cameras with connected audio capabilities display overlay audio icons in the top right corner of the video pane in Ocularis

Client. These icons may be used for listening to a camera-connected microphone as well as sending audio to a camera’s

speaker using a microphone connected to the operator station.

Figure 7 LISTEN and SPEAK icons

Clicking on either icon will enable or disable the feature. The icon will appear with a slash when off. In standard

mode (as opposed to 'Push to Talk'), if you click the icon, the function is enabled (turned on) until you click the icon again

to disable it (turned off). Note that audio icons appear only upon mouse move, as with other overlay controls.

The ‘Audio’ menu may also be used to select an audio stream to hear what is going on near the selected camera-attached-

microphone. Keep in mind that you cannot listen to audio from a camera that is not in displayed in the view.

Push to Talk

‘Push to Talk’ is a feature that is configurable in the ‘Client Setup’ screen of Ocularis Client. It changes the behavior of how

the ‘Speak’ icon functions within a view pane. If Push to Talk is enabled, click and hold the ‘Speak’ icon to enable it and

speak into the microphone to send audio to the vicinity of the camera. Release and the microphone is disabled. This

feature works similar to a ‘walkie-talkie’.

Axis Audio Only Devices

Axis devices which are audio only, such as the P8221, may be used with two-way audio. You must populate a view pane in

Ocularis Client with the device in order to listen to its microphone or to speak to its speaker. The feed in the pane will be

gray but the 'Listen' and 'Speak' icons will appear. These devices do not consume a camera license on the recorder but

they do consume a camera license on Ocularis Base.

SPEAK Click to speak through speaker on camera

LISTEN Click to listen to microphone

on camera

Page 8: Technical Notes for Ocularis 5 - OnSSI Notes for Ocularis 5.4 On-Net Surveillance Systems Inc. ... • The AVI file format is the only supported format and the Xvid codec is required

Technical Notes for Ocularis 5.4

On-Net Surveillance Systems Inc. | One Blue Hill Plaza, PO Box 1555, Pearl River NY 10965 | T 845-732-7900 | www.onssi.com | page 7

AVI Exporting in Ocularis 5 Web & Ocularis 5 Mobile Ocularis 5 Web and Ocularis 5 Mobile supports the exporting to video clips. The following applies to exports:

• The exporting of the video, while initiated via browser, phone or tablet, is performed and saved on the Ocularis Media

Server.

• The default location for the storage of exported video files is located on the Ocularis Media Server.

• The AVI file format is the only supported format and the Xvid codec is required. This codec must be installed on the

Ocularis Media Server. The Xvid codec is free and is available online at www.xvid.com.

• To preserve space and maximize efficiency, there is a maximum time length limit per video clip. The default length is

ten minutes. If you choose a clip longer than the specified time, the app will indicate this at the time of export.

• Also to preserve space, exported files will be saved on the server for a specified duration. The default is fourteen

days. After this duration, the oldest file(s) is deleted (FIFO).

• If there if low disk space available on the Ocularis Media Server, no exporting will be allowed. The default setting is

10% of the drive or 10 GB.

• If the camera supports audio, the audio will automatically be included in the video clip.

• Once the video export is completed, the operator may download the exported file to their local PC or device or share

the link to the clip with others.

• Exporting video is a privileged function. If the export icons are disabled you likely do not have the ability to perform

exports on the camera based on your privilege settings.

EXPORTING AVI VIDEO WITH OCULARIS 5 WEB The following steps identify how to export AVI video with Ocularis 5 Web:

1. Switch to Browse mode.

2. If the camera is not visible, use the 'Select Camera' icon to select it in one of the two larger panes. Otherwise, drag-

and-drop the camera thumbnail to one of the larger panes.

3. Verify that the camera you wish to export is the selected camera by the blue outline around the pane.

4. Identify the start and end of the video clip:

a. Use the mouse to position the Kinetic Timeline at the start of the clip.

b. Click the 'Set Start Marker' icon.

c. Position the Kinetic Timeline at the ending point of the clip (use the mouse or video play tools).

d. Click the 'Set Stop Marker' icon.

e. Click the 'Export AVI Video' icon. You may fine tune the video clip start and stop times.

or

a. Click the 'Export AVI Video' icon. Use the pop-up to establish the start and end times for the clip.

Page 9: Technical Notes for Ocularis 5 - OnSSI Notes for Ocularis 5.4 On-Net Surveillance Systems Inc. ... • The AVI file format is the only supported format and the Xvid codec is required

Technical Notes for Ocularis 5.4

On-Net Surveillance Systems Inc. | One Blue Hill Plaza, PO Box 1555, Pearl River NY 10965 | T 845-732-7900 | www.onssi.com | page 8

Figure 8 Export AVI Video Dialog

5. Click the check mark to start the export or the door to exit and cancel.

The export is initiated on the Ocularis Media Server. Click the 'Exported AVI Files' icon to view the status of exports.

Note: The export will not proceed if the maximum duration of the video clip identified by the user exceeds the defined maximum value even if the amount of actual video is less. This is possible in cases where only motion recording is configured.

VIEWING THE STATUS OF EXPORTED AVI FILES The 'Exported AVI Files' list displays all exports on the server, either in progress or already complete, that were initiated by you

or your user group via Ocularis 5 Web or Ocularis 5 Mobile. The exports remain listed for the configured duration. The list

identifies the name of the camera, the date and time of the starting frame, the duration of the clip and the approximate file size

of the clip.

If the export is still underway, a percentage done appears to indicate the progress of the export. If the export has not yet

started, the label "QUEUED" appears. Once the export is complete, the 'Download' icon appears.

The Share icon is visible immediately when an export is initiated.

Page 10: Technical Notes for Ocularis 5 - OnSSI Notes for Ocularis 5.4 On-Net Surveillance Systems Inc. ... • The AVI file format is the only supported format and the Xvid codec is required

Technical Notes for Ocularis 5.4

On-Net Surveillance Systems Inc. | One Blue Hill Plaza, PO Box 1555, Pearl River NY 10965 | T 845-732-7900 | www.onssi.com | page 9

The Exported AVI Files List By default, the Exported AVI Files list displays the exports from most recent on top to older exports as you go down the list.

Figure 9 Ocularis 5 Web Exported AVI Files List

Note: the date and time that the export was initiated is not displayed. Click on the column heading to sort the list by that item. Click again to reverse the sort order. Name - This is the name of the camera of the video being exported Created - This is the order that the export was initiated Time - This is the date and time of the first frame of video Duration - This is the length of the video (in time) Size- This is the file size of the video

DOWNLOAD OR SHARE EXPORTED FILES Exported AVI files may be viewed or shared with others. You can share a link to a video export prior to it completing the

export. However, viewing an exported file may not be done until the export process is complete.

Sharing Link

The 'Share' icon is used when you want to share the link to the exported video file. Remember, the file itself resides on the

Ocularis Media Server. Therefore, the recipient must have authorized access to the server in order to view the video. This icon

is available immediately in the 'Exported AVI Files' list. Clicking the icon will copy the URL to the exported file to the Windows

clipboard. The user can paste the link into any supported application (email, etc.) The file export must be complete in order to

view the video.

Here's an example of an AVI file link:

https://192.168.11.194:9090/avi/efcd881f-2e93-11e7-b785-00155d0b8307.avi

Page 11: Technical Notes for Ocularis 5 - OnSSI Notes for Ocularis 5.4 On-Net Surveillance Systems Inc. ... • The AVI file format is the only supported format and the Xvid codec is required

Technical Notes for Ocularis 5.4

On-Net Surveillance Systems Inc. | One Blue Hill Plaza, PO Box 1555, Pearl River NY 10965 | T 845-732-7900 | www.onssi.com | page 10

Notice that the filename itself is randomly generated for security reasons.

Keep in mind that the file will eventually expire on the server, so if you need to save the export, you should download the file. If

you try to access an expired export, you will receive a message stating that the export was deleted. This error message will

only appear for a configured duration.

Download an AVI Export

The 'Download' icon is used to download a copy of an AVI export. This procedure is possible only when the export is

complete. Clicking this icon will open a Windows 'Save As' dialog, allowing you to identify where you would like the download

file to be stored. You may also change the name of the file here.

VIEWING A DOWNLOADED AVI FILE ON A PC 1. Locate the file that was downloaded.

2. Double-click the file in Windows Explorer to launch the default media player software. Or you can manually select the

player and open the file from within the player application. Any player that supports .AVI file format should work,

however, the xvid codec is needed on this computer in order to view the video.

The video begins to play. The filename is superimposed over the video for a few seconds and then disappears. In the upper

left portion of the video is the camera name, date and time of the video. The time increments as the video plays. If there was

audio associated with the camera, the audio will be included in the export.

TO EXPORT VIDEO WITH OCULARIS MOBILE 1. Open the camera for which you want to export video.

2. In portrait mode, swipe left until you see the Kinetic Timeline for recorded video.

3. Position the timeline at the start of the video clip and tap the 'Select Clip' icon.

Page 12: Technical Notes for Ocularis 5 - OnSSI Notes for Ocularis 5.4 On-Net Surveillance Systems Inc. ... • The AVI file format is the only supported format and the Xvid codec is required

Technical Notes for Ocularis 5.4

On-Net Surveillance Systems Inc. | One Blue Hill Plaza, PO Box 1555, Pearl River NY 10965 | T 845-732-7900 | www.onssi.com | page 11

Figure 10 Identify Export Clip (shown on iOS)

4. Position the timeline at the end of the clip and tap the 'Select Clip' icon again.

This enables the Export icon.

Note: A purple bar appears to represent the video clip. In some cases, the 'Export' icon may not be visible on the device due to its resolution. Swipe up to uncover the 'Export 'icon.

Figure 11 Identify Export clip (shown on Android)

Select Clip icon

Export icon

Page 13: Technical Notes for Ocularis 5 - OnSSI Notes for Ocularis 5.4 On-Net Surveillance Systems Inc. ... • The AVI file format is the only supported format and the Xvid codec is required

Technical Notes for Ocularis 5.4

On-Net Surveillance Systems Inc. | One Blue Hill Plaza, PO Box 1555, Pearl River NY 10965 | T 845-732-7900 | www.onssi.com | page 12

Figure 12 AVI icon (Android)

Tap the 'Export' icon.

a. With iOS, you will be presented with two options:

i. Confirm & Share - this option initiates the export and opens the device's shareable apps (email, etc.) where you can transmit (or copy) the link to the exported file.

ii. Confirm - this option initiates the export on the server. Open the AVI export files list to view the status.

b. With Android you have 3 options:

i. OK - this option initiates the export on the server. Open the AVI export files list to view the status.

ii. Confirm and Share - this option initiates the export and opens the device's shareable apps (email, etc.) where you can transmit (or copy) the link to the exported file.

iii. Cancel - cancels the export

If the size of the export file (by duration or disk space) exceeds the amount configured on the Ocularis Media Server, an

error message will be displayed and the export is cancelled. If you need to export lengthy video clips, we recommend

using the desktop Ocularis Client.

Note: The export will not proceed if the maximum duration of the video clip identified by the user exceeds the defined maximum value even if the amount of actual video is less. This is possible in cases where only motion recording is configured.

TO VIEW THE STATUS OF EXPORTS WITH OCULARIS 5 MOBILE The Exported AVI Files list displays all exports on the server either in progress or already complete that were initiated by you

or your user group for Ocularis 5 Web and Ocularis 5 Mobile. The exports remain listed for the configured duration. The list

identifies the name of the camera, the date and time of the export, the length of the export and size of the export.

Apple

Tap the AVI Exports icon at the bottom of app. This icon is visible while viewing the

camera list, alerts list, setting screen or even while streaming.

Then, select the Ocularis Media Server.

Android

From the cameras list, tap the AVI icon.

AVI icon

Page 14: Technical Notes for Ocularis 5 - OnSSI Notes for Ocularis 5.4 On-Net Surveillance Systems Inc. ... • The AVI file format is the only supported format and the Xvid codec is required

Technical Notes for Ocularis 5.4

On-Net Surveillance Systems Inc. | One Blue Hill Plaza, PO Box 1555, Pearl River NY 10965 | T 845-732-7900 | www.onssi.com | page 13

Accessing Exports Once complete, exports can be accessed from Ocularis 5 Mobile or Ocularis 5 Web. Exports are in AVI format and the Xvid

codec must be installed on the Ocularis Media Server to perform the exports.

Ocularis 5 Mobile - Android

1. From the Exported AVI Files list:

If the exports are not completed, the list will display the status of the export. The Share icon is available so that the

operator can share the link to the export using the device's onboard sharing apps. When the Share icon is used, a link to

the file is shared. The video will not be available until the export is complete.

Figure 13 Incomplete Exports (Android)

When the exports are completed a Download icon appears.

Figure 14 Completed Export Files (Android)

2. Tap the 'Download' icon to download the AVI file to the device.

The file is downloaded to the device's default download location.

3. Use the device's on board tools to locate the download. Tap the Download to launch the AVI file for playing.

Page 15: Technical Notes for Ocularis 5 - OnSSI Notes for Ocularis 5.4 On-Net Surveillance Systems Inc. ... • The AVI file format is the only supported format and the Xvid codec is required

Technical Notes for Ocularis 5.4

On-Net Surveillance Systems Inc. | One Blue Hill Plaza, PO Box 1555, Pearl River NY 10965 | T 845-732-7900 | www.onssi.com | page 14

Ocularis 5 Mobile - Apple

Apple devices cannot inherently play files in AVI format. Therefore, the options on these devices are limited. Operators can

share the link for exports initiated on these devices so that the exports can be played on other equipment (PCs for example).

1. From the Exported AVI Files list:

If the exports are not completed, the list will display the status of the export. A 'Share' link is available so that the operator

can share the link to the export using the device's onboard sharing apps. When the Share link is used, a link to the file is

shared. The video will not be available until the export is complete.

Figure 15 Exported AVI Files List (Apple)

EXPIRED EXPORTS After the configured file save duration (default is 14 days), the exported AVI files on the server are deleted and the file is

removed from the Exported AVI Files list on the Web and Mobile apps. If the user attempts to access the file via a shared link,

they will receive a message that the requested AVI Download has been deleted. This error message will appear only for a

short duration. The duration for the message is twice the length of the configured save file duration. So, assuming default

values, the expired download message will appear for 28 days after which the link will no longer display anything if clicked.

Therefore, it is important to save any important export files to a location other than the Ocularis Media Server.

Page 16: Technical Notes for Ocularis 5 - OnSSI Notes for Ocularis 5.4 On-Net Surveillance Systems Inc. ... • The AVI file format is the only supported format and the Xvid codec is required

Technical Notes for Ocularis 5.4

On-Net Surveillance Systems Inc. | One Blue Hill Plaza, PO Box 1555, Pearl River NY 10965 | T 845-732-7900 | www.onssi.com | page 15

Triggers in Ocularis 5 Web & Ocularis 5 Mobile Ocularis 5 Web supports camera level and global triggers. Ocularis 5 Mobile supports camera level triggers. Triggers, also

called 'Buttons', allow Operators to manually initiate a command or action. For example: you can configure a trigger to stop the

camera from streaming, start the camera stream, start or stop an alarm scenario, open or close an output and more! Triggers

are configured using Ocularis Recorder Manager under the 'Buttons' section. They are privileged via Ocularis Administrator.

GLOBAL TRIGGERS IN OCULARIS 5 WEB Global Triggers are those which do not necessarily apply to any specific camera. Examples could be: unlock a door, sound a

siren, turn on a light, etc.

To Execute a Global Trigger in Ocularis 5 Web From Live mode, click the 'Global Triggers' icon located on the bottom left of the Task Bar.

Figure 16 Global Triggers in Ocularis 5 Web

The Global Triggers menu appears above the icon.

Select the Global Trigger you wish to execute. Use the vertical scroll bar if the list is long.

CAMERA TRIGGERS Camera level Triggers are typically related to a specific camera. For example: a camera level trigger may be used to start or

stop a camera stream or to start alarm recording on the camera. There are many examples for camera level triggers.

Global Triggers

icon

Page 17: Technical Notes for Ocularis 5 - OnSSI Notes for Ocularis 5.4 On-Net Surveillance Systems Inc. ... • The AVI file format is the only supported format and the Xvid codec is required

Technical Notes for Ocularis 5.4

On-Net Surveillance Systems Inc. | One Blue Hill Plaza, PO Box 1555, Pearl River NY 10965 | T 845-732-7900 | www.onssi.com | page 16

To Execute a Camera Trigger in Ocularis 5 Web 1. From the camera pane with the camera trigger, click the Camera Trigger icon. (if there are no camera triggers, the

icon will not appear).

Figure 17 Camera Level Triggers in Ocularis 5 Web

The list of camera triggers appears above the icon.

2. Click the desired camera trigger to execute it. If there are many triggers, a scroll bar appears.

Camera Triggers

icon

Page 18: Technical Notes for Ocularis 5 - OnSSI Notes for Ocularis 5.4 On-Net Surveillance Systems Inc. ... • The AVI file format is the only supported format and the Xvid codec is required

Technical Notes for Ocularis 5.4

On-Net Surveillance Systems Inc. | One Blue Hill Plaza, PO Box 1555, Pearl River NY 10965 | T 845-732-7900 | www.onssi.com | page 17

To Execute a Camera Trigger in Ocularis 5 Mobile 1. In portrait mode, if you don't see the Triggers list, swipe the bottom of the screen left until you do.

Figure 18 Camera Triggers (shown on Android)

2. Tap a trigger to execute it.

Page 19: Technical Notes for Ocularis 5 - OnSSI Notes for Ocularis 5.4 On-Net Surveillance Systems Inc. ... • The AVI file format is the only supported format and the Xvid codec is required

Technical Notes for Ocularis 5.4

On-Net Surveillance Systems Inc. | One Blue Hill Plaza, PO Box 1555, Pearl River NY 10965 | T 845-732-7900 | www.onssi.com | page 18

TRIGGER PRIVILEGES Triggers are a privileged function as of Ocularis v5.4. Triggers are configured using Ocularis Recorder Manager under the

'Buttons' section. They are privileged in the Ocularis Administrator Users / Privileges Tab. Triggers can be camera specific or

global. Global triggers are executed from the Ocularis Client 'Triggers' menu or Ocularis 5 Web's Task Bar and camera

specific triggers are located in the camera pane's 'aux' menu of Ocularis Client, on the video pane with Ocularis 5 Web and in

a Triggers List in Ocularis 5 Mobile.

Figure 19 Trigger Privileges

With a new installation or upgrade, all triggers are located in the 'Unprivileged Triggers' group for each User Group except for

the 'Administrators' group. The 'Administrators' group is automatically assigned all triggers.

1. Select the user group for which you want to assign triggers.

2. Assign triggers to the 'Privileged Triggers' group by either dragging and dropping the trigger between groups or by

right-clicking the trigger(s) and selecting 'Privileged Triggers'. You may use the [CTRL] or [SHIFT] keys to multi select

items. Use the same procedure as you would when you assign camera privileges.

There is a 'Filter' field that acts as a keyword search of the triggers list if you want to narrow your selection. Notice that Global

Triggers display a blue icon and camera level triggers display a green icon.

Page 20: Technical Notes for Ocularis 5 - OnSSI Notes for Ocularis 5.4 On-Net Surveillance Systems Inc. ... • The AVI file format is the only supported format and the Xvid codec is required

Technical Notes for Ocularis 5.4

On-Net Surveillance Systems Inc. | One Blue Hill Plaza, PO Box 1555, Pearl River NY 10965 | T 845-732-7900 | www.onssi.com | page 19

Ocularis 5 Web Toast Notifications Ocularis 5 Web Toast Notifications are small notices that appear on the screen to notify you of an event. You can configure

these to display alert notifications as they arrive. This allows you to receive notification of an alert, even if the Ocularis 5 Web

browser is minimized or in the background. The unobtrusive notice identifies the priority of the alert, the first camera

associated with the event and the event name. If configured, an audible alert may also be played when an alert arrives.

Here is an example of a toast notification:

Figure 20 Sample Ocularis Toast Notification

On Windows operating systems, these notifications appear at the bottom right of the primary monitor. For Apple computers,

they will appear in the upper right.

If you want to view the alert in Ocularis 5 Web, click the notice. The browser with Ocularis 5 Web will be restored, and you'll be

brought directly to the alert in the Alerts list. Recorded video based on the alert is displayed in the upper left pane while live

video is shown in the upper right.

If you want to close the notice, click the 'x' in the upper right of the message.

If you want to cease receiving these messages you can disable them via the browser by clicking the settings wheel in the

lower right of the message. Or you can configure Ocularis 5 Web to not provide notification of events using the Options menu

in Ocularis 5 Web.

The following behavior is applicable to the browser listed:

Microsoft Edge: there is no support for Microsoft Edge at this time. Microsoft Internet Explorer: toast notifications are not supported in IE. Alert audio, however, is supported. Apple Safari: the option to cancel an individual notice is not available; however, the notice will disappear after a few

seconds.

Page 21: Technical Notes for Ocularis 5 - OnSSI Notes for Ocularis 5.4 On-Net Surveillance Systems Inc. ... • The AVI file format is the only supported format and the Xvid codec is required

Technical Notes for Ocularis 5.4

On-Net Surveillance Systems Inc. | One Blue Hill Plaza, PO Box 1555, Pearl River NY 10965 | T 845-732-7900 | www.onssi.com | page 20

CONFIGURE TOAST NOTIFICATIONS IN OCULARIS 5 WEB Toast Notifications are set to 'on' by default for events with priority level 6 or higher. The priority of an alert is configured in the Servers / Events Tab in Ocularis Administrator. Operators can modify or turn off the visible toast notifications.

To Configure Toast Notifications

1. Select the Ocularis 5 Web 'Options' menu.

2. Under 'Notification', the drop-down menu contains the following options:

Figure 21 Notification Options

3. Select the desired level of priority that you wish to receive notices for. Or, select 'No Events' if you do not want to

receive any toast notifications. You can also disable these via the browser by clicking the settings icon in the

message itself.

4. Once you select your desired notification level, simply close the menu and your choice is saved.

Note: Accompanying audio is configured separately. See To Configure Alert Audio in Ocularis 5 Web below.

This setting applies to the current PC and the current browser. If you log in from a different PC or use a different browser, the

default level (Priority 6 or Higher) will apply until you change it.

USING TOAST NOTIFICATIONS When a toast notification appears, you can:

Click the notification. The browser will be restored and switched to the Ocularis 5 Web Alerts List where the

corresponding alert is highlighted. Recorded alert video is displayed in the upper left pane (click the pane and use the tools at

the bottom of the screen to play video) and live video for the camera appears in the upper right pane.

Clear the notification. Click the 'x' in the upper right corner to clear the notice from the screen. (this is not available with

Apple Safari). The alert will still be available in the Alerts list.

Do nothing. The alert will clear itself after several seconds or be replaced by another subsequent alert. The alert will still be

available in the Alerts list.

Page 22: Technical Notes for Ocularis 5 - OnSSI Notes for Ocularis 5.4 On-Net Surveillance Systems Inc. ... • The AVI file format is the only supported format and the Xvid codec is required

Technical Notes for Ocularis 5.4

On-Net Surveillance Systems Inc. | One Blue Hill Plaza, PO Box 1555, Pearl River NY 10965 | T 845-732-7900 | www.onssi.com | page 21

ALERT AUDIO IN OCULARIS 5 WEB Ocularis 5 Web supports the playing of an audible alert when an event occurs. The audio will play regardless of whether the

browser is open, minimized or in the background. Configuring alert audio is separate from toast notifications so you may

enable one, the other or both.

Alert audio is set to 'on' by default for events with priority level 6 or higher. The priority of an alert is configured in the Servers / Events Tab in Ocularis Administrator. Operators can modify or turn off alert audio.

To Configure Alert Audio in Ocularis 5 Web

1. Select the Ocularis 5 Web 'Options' menu.

2. Under 'Audio Alarm', the drop-down menu contains the following options:

Figure 22 Alert Audio Options

3. Select the desired level of priority for which you want to hear alert audio. Or, select 'No Events' if you do not want to

receive any audio.

4. Once you select your desired audio level, simply close the menu and your choice is saved.

Note: Accompanying visual toast notifications are configured separately. See To Configure Toast Notifications above.

This setting applies to the current PC and the current browser. If you log in from a different PC or using a different browser, the

default level for audio (Priority 6 or Higher) will apply until you change it.

Note: The 'redalert.wav' file, which is also the default audio file for Ocularis, will be used for all alerts even if the alert is configured with a different .wav file in Ocularis Administrator.

Page 23: Technical Notes for Ocularis 5 - OnSSI Notes for Ocularis 5.4 On-Net Surveillance Systems Inc. ... • The AVI file format is the only supported format and the Xvid codec is required

Technical Notes for Ocularis 5.4

On-Net Surveillance Systems Inc. | One Blue Hill Plaza, PO Box 1555, Pearl River NY 10965 | T 845-732-7900 | www.onssi.com | page 22

Ocularis 5 Web and I-Frames Please note that when using Ocularis Media Server, the i-frame distance should not be changed to any value greater than 1.

i.e.

Figure 23 Setting the I-Frame Distance in Ocularis Recorder Manager

Using any larger value than 1 will lead to problems loading live video as well as performance issues.

Page 24: Technical Notes for Ocularis 5 - OnSSI Notes for Ocularis 5.4 On-Net Surveillance Systems Inc. ... • The AVI file format is the only supported format and the Xvid codec is required

Technical Notes for Ocularis 5.4

On-Net Surveillance Systems Inc. | One Blue Hill Plaza, PO Box 1555, Pearl River NY 10965 | T 845-732-7900 | www.onssi.com | page 23

Snapshot in Ocularis 5 Mobile Similar to the snapshot feature available in Ocularis Client, Ocularis 5 Mobile also supports the ability to take a snapshot in

one-click (or tap). This feature is available on both Android and Apple devices for live or recorded video. However, with

Android it is only available in portrait mode.

1. Open a camera on a device using Ocularis 5 Mobile.

2. In Live or Browse mode, tap the snapshot tool.

Snapshot Tool - Android Snapshot Tool - Apple

Notice in the example above that you can take a snapshot viewing the PTZ Presets list as well. If there are camera

Triggers, snapshot works on that screen too.

When the Snapshot tool is tapped, a snapshot of just the camera image is taken in .jpg format. You are prompted to view

the image with the device's Gallery, Photos or other corresponding local apps that will be able to display, print or email

a .jpg.

3. Select the desired target app for the image.

When you view the image, it will include the camera name as well as the date and time the snapshot was taken.

Snapshot Tool

Snapshot Tool

Page 25: Technical Notes for Ocularis 5 - OnSSI Notes for Ocularis 5.4 On-Net Surveillance Systems Inc. ... • The AVI file format is the only supported format and the Xvid codec is required

Technical Notes for Ocularis 5.4

On-Net Surveillance Systems Inc. | One Blue Hill Plaza, PO Box 1555, Pearl River NY 10965 | T 845-732-7900 | www.onssi.com | page 24

Figure 24 Snapshot

If you save snapshots to the local device, they will remain until manually deleted.

Page 26: Technical Notes for Ocularis 5 - OnSSI Notes for Ocularis 5.4 On-Net Surveillance Systems Inc. ... • The AVI file format is the only supported format and the Xvid codec is required

Technical Notes for Ocularis 5.4

On-Net Surveillance Systems Inc. | One Blue Hill Plaza, PO Box 1555, Pearl River NY 10965 | T 845-732-7900 | www.onssi.com | page 25

Ocularis 5 Mobile M2O for iOS M2O, Mobile to Ocularis, is when a device can use its on-board camera and stream video to Ocularis. This feature was first

introduced on the Android platform and with v5.4, we've extended support to Apple devices as well. The streaming video can

be viewed live with Ocularis Client, Ocularis 5 Web or another Ocularis 5 Mobile device. Recordings from the device will be

saved in an Ocularis recorder. Operators can view the recorded video as well. Remember that streaming video from a device

consumes one camera license and standard data rates apply when not using wifi.

For more information or instructions for Android, refer to the Ocularis 5 Mobile User Guide.

CREATE A CAMERA FOR THE MOBILE DEVICE Using either an Android or Apple device, you must create a camera to represent the device on a recorder. This will consume

one camera license.

1. The Ocularis System Administrator must create a camera in a recorder (DM) to represent the mobile device. Using

the Ocularis Recorder Manager:

a. Create a new camera for the mobile device

b. Provide a name for the device

c. Select ‘Generic Video’ driver

d. Uncheck ‘Use authorization’

e. For 'Host (IP address or name)' use the IP address of the Ocularis Media Server

f. Assign the device to a DM

g. Click OK

Figure 25 Create a Camera for the Mobile Device

Page 27: Technical Notes for Ocularis 5 - OnSSI Notes for Ocularis 5.4 On-Net Surveillance Systems Inc. ... • The AVI file format is the only supported format and the Xvid codec is required

Technical Notes for Ocularis 5.4

On-Net Surveillance Systems Inc. | One Blue Hill Plaza, PO Box 1555, Pearl River NY 10965 | T 845-732-7900 | www.onssi.com | page 26

6. Next, configure the device's stream 1.

a. Select the new device to open its 'Camera configuration' screen

b. Select ‘Stream 1/4’

c. Set the ‘Transmission mode’ to ‘RTP_Over_RSTP_over_TCP’

d. Set the URL to:

rtsp://{IP of OMS}:5544/{Device_ID# of device}

Note: Device ID is case sensitive. You can view this in the Ocularis 5 Mobile app under 'Settings'.

e. You can also modify other configuration settings (such as Standard and Alarm recordings) at this time.

f. When done, click 'Save'

Figure 26 Configure Stream 1 for the Mobile Device

7. Next, refresh the recorder in Ocularis Base. This is done by an Ocularis System Administrator.

a. Open the Ocularis Administrator application

b. Refresh the recorder in Servers / Events tab by right-clicking on the recorder name and selecting 'Refresh

server'

c. Assign privileges to new device in Users / Privileges tab

d. (Optional) Add the new device to a view in Views tab

Reminder, this device will consume one camera license in Ocularis Base.

8. Restart the Ocularis Event Proxy service.

Page 28: Technical Notes for Ocularis 5 - OnSSI Notes for Ocularis 5.4 On-Net Surveillance Systems Inc. ... • The AVI file format is the only supported format and the Xvid codec is required

Technical Notes for Ocularis 5.4

On-Net Surveillance Systems Inc. | One Blue Hill Plaza, PO Box 1555, Pearl River NY 10965 | T 845-732-7900 | www.onssi.com | page 27

CONFIGURATION FOR STREAMING VIDEO (APPLE) Use the following to configure an Apple device to be able to stream video.

1. On the Apple device, start Ocularis 5 Mobile and access the server list by tapping the Settings icon.

2. Tap the arrow to the right of 'Ingress Server'.

Figure 27 Configure Streaming

3. Tap the server you would like to stream to. Note that you most likely want to select the server with an external IP

address for access outside of the office. A checkmark indicates the selected server.

Figure 28 Select the Ingress Server

4. Tap '< Settings' in the upper left to return to the previous screen.

TO STREAM VIDEO FROM AN APPLE DEVICE 1. Open the Ocularis 5 Mobile app.

2. Tap the stream icon.

3. Tap the 'Start' bar.

Page 29: Technical Notes for Ocularis 5 - OnSSI Notes for Ocularis 5.4 On-Net Surveillance Systems Inc. ... • The AVI file format is the only supported format and the Xvid codec is required

Technical Notes for Ocularis 5.4

On-Net Surveillance Systems Inc. | One Blue Hill Plaza, PO Box 1555, Pearl River NY 10965 | T 845-732-7900 | www.onssi.com | page 28

Figure 29 Start Bar on Apple Devices

4. You may now capture local video through the device's camera.

Figure 30 Stream video from an Apple device to Ocularis

While the video is streaming, you'll see a Video Timer at the top of the screen, indicating the length of the video clip.

If the device has a flash, you can tap the Flashbulb icon to illuminate the outward camera's field of view.

Figure 31 Flashbulb icon (Apple)

5. When you want to stop streaming, tap the 'Stop' bar.

The video stream from the device will cease but recorded video will be saved and visible using Ocularis Client, Ocularis 5

Web or Ocularis 5 Mobile.

Note: Audio is not supported in this version when streaming video from a mobile device to Ocularis.

Start Bar

Stop Bar

Video Timer

Selfie icon

Page 30: Technical Notes for Ocularis 5 - OnSSI Notes for Ocularis 5.4 On-Net Surveillance Systems Inc. ... • The AVI file format is the only supported format and the Xvid codec is required

Technical Notes for Ocularis 5.4

On-Net Surveillance Systems Inc. | One Blue Hill Plaza, PO Box 1555, Pearl River NY 10965 | T 845-732-7900 | www.onssi.com | page 29

Note: The stream will be recorded using the orientation of the device when you first initiate the stream. Therefore, if you start the stream in portrait mode, it will record and display in Ocularis Client in portrait mode. Rotating the device after starting the stream does not work despite appearances. You should begin the stream in the orientation (portrait or landscape) you want the video to be recorded in and the Operator to view.

Apple devices support the use of the 'Selfie' camera. If you want to use this camera, tap the Selfie Icon prior to

tapping the Start bar. Similar to the orientation limitation above, once you start the stream using the Selfie camera you

cannot switch to the outwardly facing camera midstream. You must stop the stream, switch cameras and then restart the

stream.

00006142017-1639-5.4.0.128