Glossary

Access token
Access tokens are used in token-based authentication to allow an application to access an API.

Accounts

End user account The actual user of the Eagle Eye Cloud VMS product, or any other products using the Eagle Eye Video API Platform. End-user accounts can have users, devices (e.g. bridges or cameras), and can access recorded video.
Reseller account A group of end-user accounts. Reseller accounts are typically created for resellers or installers who have end-users using cameras for video surveillance. Each reseller account can have one or more users. Reseller accounts have the following capabilities:
- Listing end user accounts
- Changing branding (both the logo and the subdomains)
- Changing and limiting the default user settings
- Changing the terms of service
- Applying password policies
- Access to the dashboard feature

Actor
An entity that has created an event.

Application
An application is a specific use case that accesses the Eagle Eye Video API. An application is unique to each Technology Partner and API use case. A Technology Partner may have multiple applications. An application can be used for video analytics use cases or other use cases. An application consists of the following:

Software-generating events
A set of APIs to make use of the EEN Video API Platform
An application registry entry describing the "application" to the Eagle Eye Video API Platform
An API Key

Audit log
The audit log is a system that tracks each user's actions and changes made to that account, for example, deleting a camera.

Available devices
Devices (e.g. cameras, speakers) that are visible by the Bridge but are not attached to the Bridge/account. They are available to be attached to the Bridge/account. If they are attached, they can no longer be used by other accounts.

Base URL
Camera settings return the relevant base URL depending on the location of the account. The base URL makes sure you communicate directly with the Eagle Eye Video API Platform, minimizing the distance and latency in data communication.

Camera
A camera is a source of video and audio data streams that are delivered to the Eagle Eye Video API Platform. Different types of cameras are supported, for example, IP cameras, analog cameras, fisheye cameras, body-worn cameras, and so on.

Bridge
An Eagle Eye bridge is a cloud-managed, on-premise device used by the Eagle Eye Cloud VMS to connect cameras to Eagle Eye Cloud Data Centers. It acts as a bridge between the Eagle Eye Cloud Data Center and the on-site cameras. The bridge buffers the video in case the internet connection goes down and performs the encryption, data deduplication, bandwidth management, motion analysis, and compression of the video.

Client credentials
Client credentials are required for using the API. They are part of the OAuth2 framework. Each application requires its own client credentials. The client credentials consist of a client ID and a client secret.

Client ID
Client Id is part of the Oauth2 client credentials. Each application requires its own client credentials to identify the application.

Client secret
The client secret is part of the OAuth client credentials. Each application requires its own client credentials to identify the application.

Client settings
Your account's base URL can be retrieved through this endpoint.

CORS
Cross-origin resource sharing (CORS) is a browser security feature that establishes rules for cross-origin requests. E-mail [email protected] to whitelist your domain.

Eagle Eye Local Display Station
The Eagle Eye Local Display Station is a dedicated network device capable of supporting up to 96 video sources, and can simultaneously decode and display up to 32 IP cameras/encoder sources.

Editions
Eagle Eye Cloud VMS comes in three editions that provide different levels of capabilities:

Standard Edition
This is the base level that includes all the core capabilities of the Eagle Eye Networks Cloud VMS and is designed to meet the needs of the majority of businesses that value remote cloud access at an affordable cost.
Professional Edition
Designed for mid-sized (10 to 25+) locations, and rapidly growing business operations. Includes added features for the better management of large quantities of locations, users, and cameras.
Enterprise Edition
Ideal for large, distributed, and multinational businesses. Enterprise supports unlimited users and provides a sophisticated access management solution and advanced operational reporting to meet audit and regulatory requirements.

Event
An event is an occurrence detected in the system. Events can happen at a specific point in time, or have a timespan. Events can be of the following nature: device status changes, motion detection, person detection, license plate recognition, tampering, and so on.

Event subscription
You can subscribe to events to receive notifications once those events are called.

Feed
A feed is a video or audio stream for a specific device. Each feed is linked to the applicable device. One device can have multiple feeds.

For example, a camera can have the following feeds:

A full video feed with 4MP resolution in H.264 format
A preview video feed with VGA resolution in MJPEG format
An audio push feed with a G.711 bitrate to send audio to the camera (for 2-Way Audio)

An IP speaker has only one feed to send audio to the speaker, an audio push feed with a G.711 bitrate to send audio to the camera (for 2-Way Audio).

File
Users can archive parts of the recorded video to the archive storage. With the files API you can list, move, rename, delete, or download these files.

Floor
Users can upload floor plans for several floors within a location.

Floor plan
Floor plans offer end users a way to monitor larger, more complex sites or even multiple locations by presenting cameras in a visual manner on a floor plan within the Cloud VMS.

HLS
HTTP Live Streaming (HLS) is an HTTP-based adaptive bitrate streaming communications protocol developed by Apple Inc.

Layout
With layouts, users can group devices for display purposes. Layouts contain panes, which are groups of cameras arranged for viewing on screen. Layouts are associated with an account, and users are granted view, write and share permissions for the layout.

Localhost
A localhost is the standard hostname given to the machine itself. On almost all networking systems, the localhost IP address is 127.0.0.1.

Location
Locations are a group of devices and users that are geographically organized. Each location has a name, a street address, a city, a state, region, or province, and postal (zip) code information and coordinates for a map. Only a location name is mandatory for a location to exist. A device (e.g. a camera or a bridge) can only belong to one location at the same time.

LPR
Eagle Eye License Plate Recognition (LPR) analytics enable any camera connected on Eagle Eye Cloud VMS to function as an LPR camera. Eagle Eye LPR analytics involves the analysis of video data to extract license plate information, and additional vehicle attributes such as Vehicle Make and Color.

Main
The main video is a high-resolution video that is recorded according to the configuration of each camera.

Media
Media is a recorded and stored feed on the edge, or on the cloud. Each feed generates media when recorded. For each media file the following is provided:

Information on whether the file is stored on the edge or the cloud.
Information on whether the recording is ongoing, meaning that the media file is getting larger.
The available Streaming Protocol URLs, for example: HLS over HTTPS, MP4 over HTTPS, RTSP or FLV.

Multi-camera
A device that has multiple cameras. The following devices are supported:

Digital video recorders (DVR)
Network video recorder (NVR)
Encoders
WiFi Kits (recorders with wireless cameras)

Password reset
Password reset makes it possible to request a password reset. The user will get an email with a link to set the password. If the email is ignored the password will not be changed.

Preview
A preview is a low-resolution video that is recorded all the time even when there is no event.

Refresh token
A refresh token is a special key that enables a client for an API or service to retrieve new access tokens without requiring the user to perform a complete login.

Resource grant
When creating new users or editing existing users the resource grants can be used to which cameras, layouts or bridges the user has access.

PTZ camera
Pan-tilt-zoom (PTZ) cameras can be added to the Eagle Eye Cloud VMS and their pan, tilt, and zoom controls can be manipulated directly from the Live View, allowing users to change what the camera is viewing.

Redirect URI
Redirect URI is part of the OAuth2 framework. It is an additional security layer that assures that the response to the request for authentication is returning back to the legitimate party.

RTSP
Real-Time Streaming Protocol (RTSP) is an application-level network communication system that transfers real-time data from multimedia to an endpoint device by communicating directly with the server streaming the data.

Speaker
A speaker is a destination for audio data streams that are delivered from the Eagle Eye Video API Platform to an on-site speaker. A speaker can be an IP speaker connected to a bridge.

Span
The timespan of an event that starts with the triggering of the event and spans until it ends.

Streaming URL
The Media API provides the streaming URL based on different protocols and format that allows a user to access the video stream of a chosen camera and play it in their video player of choice.

Switch
Eagle Eye Networks provides managed Ethernet switches to be integrated into the Eagle Eye Video API platform. The managed switch uses PoE (Power over Ethernet) to provide power to cameras connected to its LAN ports the same way a typical PoE switch would, but it can additionally switch the power in individual ports on or off in response to commands delivered via Eagle Eye Network API, forcing a camera hard reset by cycling its power supply.

Tags
With tags, users can label and group devices. The user can search for a specific tag to display all devices under it.

User
A person with credentials, e.g. email and password, who can log in to the system. A user can belong to any account, including L2 Partner accounts or end-user accounts.

VSP
The Eagle Eye Vehicle Surveillance Package (VSP) is an add-on package of Eagle Eye Cloud VMS that allows users to monitor vehicle data. The VSP stores and analyzes vehicle data, and raises real time alerts for rules configured around license plates. Using VSP users can search for a specific vehicle based on license plate across multiple cameras and locations.