Skip to main content

aipix.ai

Russian

English

Main

aipix.ai

Main

Home

Install and set up the Aipix platform

Resources requirements
Prerequisites
Kubernetes single-node installation

Configure the Aipix platform deployment

Install an ingress controller
Install Minio S3

Install the Aipix platform components

Install VMS
Install Mеdiasеrver

Install Analytics

Add the Analytics node to the Kubernetes cluster
Installation of Analytics

Add Vоice Gateway

The Vоice Gateway architectural diagram
Add the Vоice Gateway node to the Kubernetes cluster
Install Vоice Gateway

The options to install Monitoring and Logging

Monitoring and Logging installation

Getting started with the platform after installation

The VSaaS platform

Release notes for the VSaaS platform

Release 24.12

Release 24.09

Release 24.09.1

Release 24.03

Release 24.03.1

Release 23.12

Release 23.12.1

Release 23.09

Release 23.09.1

Release 23.06
Release 23.04

General Glossary
Overview of the VSaaS platform
FAQ. The VSaaS platform
Licensing
Coordinated Universal Time (UTC)

VMS. Video Management System

FAQ VMS
Glossary

Licensing of VMS

Parameters of the VMS licensing

Release notes

Release notes 24.12 VMS

What's new in 24.12 VMS
Fixes in 24.12 VMS

Release 24.09 VMS

What's new in 24.09 VMS
Fixes in 24.09 VMS
Release 24.09.01 VMS

Release 24.03 VMS

What's new 24.03 VMS
Fixes 24.03 VMS
Release 24.03.1 VMS

Release 23.09 VMS

What's New 23.09
Fixes 23.09
Release 23.09.1 VMS

Release 23.12 VMS

What's New 23.12
Fixes 23.12
Release 23.12.1 VMS

Release 23.06 VMS

What's New 23.06
Fixes 23.06

Release 23.04 VMS

What's New 23.04
Fixes 23.04

Introduction to VMS

Configuration of VMS

Requirements

Third-party services
The Desktop client. Requirements for video walls
OS for the Web client and mobile app

The first run

Administrator guide

Start of work
The homepage of the Administrator client

Cameras

Tree view
Custom Tree view

View, add, and edit camera details

Add a camera

Manually add cameras and video streams

General data
Video streams
ONVIF settings
View video in the plаyer
Configuration. View a camera

Provisioning. View a camera

Camera provisioning steps
Provisioning events

Tag Schedule
Complaints. Cameras
Events. Cameras
User actions. Cameras
Analytics. Cameras
Delete a camera

Map
Search
Problem cameras
Incorrect cameras
Deleted cameras
Statistics

Configurations. Camera

Create a configuration template
Apply a template to a camera
Import and export of configuration templates

Tags of cameras
Archive video. Video recordings. The Administrator client

Monitoring

Devices. The Administrator client

Intercom tree view

Intercom list

Add an intercom

View and edit an intercom

The General data tab. The Administrator client
The List of keys tab. The Administrator client

The Apartments tab. The Administrator client

Apartment settings
Export and import apartment data

The Temporary (time) codes tab. The Administrator client
The SIP server tab. The Administrator client
The Switch matrix tab. The Administrator client
The Intercom logs tab. The Administrator client
The Intercom configurations tab. The Administrator client
The View in player tab. The Administrator client
The Analytics tab. The Administrator client
The Events tab. The Administrator client
The Settings tab. The Administrator client
Replace a panel. The Administratоr client

Bridge list

Activate and deactivate a bridge
View details of a bridge

Camera list

Activate and deactivate a camera
View information about a camera

Provisioning

DHCP servers

Add a DHCP server
View and edit a DHCP server
Delete a DHCP server

DHCP subnet groups

Add a DHCP subnet group

View and edit a DHCP subnet group

Add a new DHCP pool to a group
View and edit a DHCP pool
Delete an added DHCP pool

Delete a DHCP subnet group

NTP servers

Add an NTP server
View and edit an NTP server
Delete an NTP server

Media Servers

Add a media server
View and edit a media server
Search for an available media server

Network devices

Media server clusters

Add a cluster
View and edit a cluster
Delete a cluster

Media Server Groups

Create a media server grоup
View and edit a media server group
Delete a media server group

Subnet reservation

Auto-provisioning

Auto-provisioning algorithms

Automatic camera addition and manual video stream setup

Manual stream setup and configuration application

Administration

Administrators
Administrator roles

Users

Created via billing
Created by an administrator
Sub-users. The Administrator clinet

Backup copies

Analytics. The Administrator client

The Analytics module in the Administrator client

The adjustable parameters of Analytics. The Administrator client

The Face recognition parameters. The Administrator client
The Counting objects in an area parameters. The Administrator client
The Zone intrusion detection parameters. The Administrator client
The License plate recognition parameters. The Administrator client
The Visitor counting parameters. The Administrator client
The Camera damage/overlap/vandalism detection parameters. The Administrator client
The Detection of loud sounds parameters. The Administrator client
The Smoke and fire detection parameters. The Administrator client
The Line crossing detection parameters. The Administrator client
The Container number recognition parameters. The Administrator client

Reports

Logging

The Events subsection
The User actions subsection

Complaints
Client versions
Documents
System Settings

Translation

Select a language for translations
Select a translation type
Search. Translation
Change a display type
Edit translation

Logos

Replace a logo
Background image modification
Favicon modification

Licensing. The Administrator client

License expiration. License server unavailability

Profile settings

User guides for VMS

Technical conditions and requirements to the operating system

Web client user guide

Where to start. Authorization. Web client user

Cameras. Web client user

All cameras
Camera tree
Camera groups
Layouts
Video recordings
View video in the player
View cameras in a layout

Events. Web client user

User events
Anаlytics events
Camera events
Events from device
System events

Analytics. Web client user

Analytics cases

Add an Analytics case

The Face recognition analytics type
The License plate recognition analytics type
The Counting people (objects) in an area analytics type
The Visitors counting analytics type
The Zone intrusion detection analytics type
The Camera damage/overlap/vandalism detection analytics type
The Detection of loud sounds analytics type
The Smoke and fire detection analytics type
The Line crossing detection analytics type
The Container number recognition analytics type
The License plate recognition analytics type. The list of countries

View and edit analytics cases

The Face recognition analytics type. View and edit
The License plate analytics type. View and edit
The Counting objects in an area analytics type. View and edit
The Visitor counting analytics type. View and edit
The Zone intrusion detection analytics type. View and edit
The Camera damage/overlap/vandalism detection analytics type. View and edit
The Detection of loud sounds analytics type. View and edit
The Smoke and fire detection analytics type. View and edit
The Line crossing detection analytics type. View and edit
The Container number recognition analytics type. View and edit
Camera statuses when viewing a case

Delete an analytics case

Events and reactions. Web client user

Add a new reaction
Delete a reaction
Set up the Telegram message reaction

Analytics resources

Add an analytics resource group
Delete an analytics resource group
Edit resources in an analytics resource group

Analytics cameras
Statistics. Web client user
Dashboard. Web client user

Map. Web client user

The Map subsection

The Plans subsection

Create and manage a plan. Web client user
Create and manage a group of plans. Web client user

The Cameras subsectiоn

Devices. Web client user

Bridges
Cameras with the installed Agent

Settings. Web client user

Subusers. Web client user

The user profile settings

Desktop client user guide

Introduction to the Desktop client
Download and install the Desktop client
Authorization in the Desktop client
Desktop app interface

Side panel

All cameras. Camera tree. Camera groups. Search, add, and edit
Layouts. Layout groups. Create, manage, and search

Live in the Desktop client

The layout panel. Live
Layout templates. Live
Cameras. Live
The toolbar. Live

Archive/DVR in the Desktop client

Layout upper panel. Archive/DVR
Templates for layouts. Archive/DVR
Cameras. Archive/DVR
Toolbar. Archive/DVR
General timeline. Archive/DVR

Events in the Desktop client

The System events tab
The User events tab
The Camera events tab
The Events from devices tab

Map in the Desktop client

The Mаp subsection

The Plаns subsection

Create and manage a plan
Create and manage a group of plans

The Cameras subsection

Downloads in the Desktop client

Archive manager

Overview of the section capabilities
Create and manage a project

Manage video in the project

Add files to the project
Layouts in the project
Edit video
Watch video in the project
Export video from the project

Settings. The Desktop client
Recommendations for working with the Desktop client

Mobile app user guide (Android, iOS)

Mobile app users (Android, iOS)
Install the mobile app (Android, iOS)

Add a profile. Authorize in the mobile app (Android, iOS)

Manage profiles (Android, iOS)

Customize the app notification styles

Cameras (Android, iOS)

Navigate through cameras. Search for a camera (Android, iOS)
The tile or list view of cameras on tabs (Android, iOS)
Camera settings (Android, iOS)
Rename a camera (Android, iOS)
Report a camera issue (Android, iOS)
Favorite cameras (Android, iOS)

Camera groups (Android, iOS)

Create a camera group (Android, iOS)
Add a camera to a camera group (Android,iOS)
Move a camera from one group to another (Android, iOS)
Rename a camera group (Android, iOS)
Delete a camera group (Android, iOS)
Delete a camera from a camera group (Android, iOS)

The camera player in Live and Archive (Android, iOS)

View camera feed in Live mode (Android, iOS)
View camera footage in Archive mode (Android, iOS)
Manage action buttons on the player panel
Play video full screen (Android, iOS)
Zoom in the camera player (Android, iOS)
Select HD/SD video quality (Android, iOS)
The PTZ function (Android, iOS)
Manage sound in the player (Android, iOS)
Take a screenshot (Android, iOS)
Download an archive segment (Android, iOS)
Camera events feed. View events in the player (Android, iOS)
Add and manage user events (Android, iOS)
Event markers on the player timeline (Android, iOS)
Blocked cameras (Android, iOS)

Layоuts (Android, iOS)

Create a layout
The list of layouts
Watch video in the layout
Edit a layout
Delete a layout
Manage cameras in a layout

Devices (Android, iOS)

Intercom (Android, iOS)

View the Intercom tab (Android, iOS)

Intercom settings (Android, iOS)

Schedule (Android, iOS)
Photos to open (Android, iOS)

Handle intercom calls (Android, iOS)

Android user
iOS user

Open an intercom camera (Android, iOS)
Open an intercom door (Android, iOS)

Intercom information (Android, iOS)

The Events tab. Intercoms (Android, iOS)

Visitors (Android, iOS)

Add a visitor (Android, iOS)
Delete visitors (Android, iOS)

Calls history (Android, iOS)

Delete the calls history (Android, iOS)

Bridge (Android, iOS)

Events (Android, iOS)

User events (Android, iOS)
Analytics events (Android, iOS)
System events (Android, iOS)

Other (Android, iOS)

My screenshots and videos (Android, iOS)
Active sessions (Android, iOS)
Settings (Android, iOS)
Feedback (Android, iOS)
The app version (Android, iOS)

The user profile (Android, iOS)

Change the password (Android, iOS)
Exit the app account (Android, iOS)

Update the application (Android, iOS)

Developer guide. VMS

Product release versions
VMS API essentials

API methods

Integration API

Gеneral information

Validаtion
Еnv variablеs
Pеmissions: admin, user

Cаmeras

Crеate a camera
View а camera
Get a list of cameras by an external system
Get a link to watch Live, Archive
Camera update by an external system
Dеlete a camera

Dеvices

Аctivate a device
Dеactivate a device
Chеck device availability
Rеserve a device
Cаncel device reservation
Updаte a device

Tree

Creating a tree element
Get a tree
Updating a tree element
Deleting a tree element

Folders

Creating a private folder
Updating a private folder
Deleting a private folder

User

Create а user
Cаmera management
Manage user's intercoms
Check license management
Manage user licenses
Updаte a user
Deleting a user

Videо streams

Create a video stream

VMSMobileSDK. Android and iOS

iOS. VMSMobileSDK

API. iOS

VMS initialization
VMSApiError. iOS

Requests

Authorization. Requests

AuthorizationApi. iOS
AuthorizationExternalApi. iOS

Cameras. API

CameraApi. iOS
CameraEventsApi. iOS
FavoritesApi. iOS
GroupApi. iOS

User. API

SessionsApi. iOS
UserApi. iOS

CallsApi. iOS
EventsListApi. iOS
IntercomApi. iOS
PlayerApi. iOS
SocketApi. iOS
StaticsApi. iOS
WidgetApi. iOS

Socket

VMSPusherApi. iOS

Player

VMSPlayerController. iOS

Android. VMSMobileSDK

API. Android

VMSMobileSDK initialization
ApiError

Requests. Android

Authorization. Android

AuthorizationApi. Android
AuthorizationExternalApi. Android

Cameras. Android

CameraApi. Android
CameraEventsApi. Android
FavoritesApi. Android
GroupApi. Android

User. Android

SessionsApi. Android
UserApi. Android

CallsApi. Android
EventsListApi. Android
IntercomApi. Android
PlayerApi. Android
SocketApi. Android
StaticsApi. Android
WidgetApi. Android

Socket. Android

VMSPusherApi. Android

Player. Android

VMSPlayerController. Android

External system integration

Intercom systems

Add an intercom. Integration

Add a Sputnik intercom
Add an Intersvyaz intercom
Add a Beward intercom
Add a Rubetek intercom

Intercom details. The information panel

The information panel of Sputnik intercoms
The information panel of Intersvyaz intercoms
The information panel of Beward intercoms
The information panel of Rubetek intercoms

Intercom details. The General data tab

The General data tab. Sputnik intercoms
The General data tab. Intersvyaz intercoms
The General data tab. Beward intercoms
The General data tab. Rubetek intercoms

Intercom details. Apartment settings

Apartment settings for Sputnik intercoms
Apartment settings for Intersvyaz intercoms
Apartment settings for Beward intercoms
Apartment settings for Rubetek intercoms

Intercom details. The SIP server tab

The SIP server tab. Sputnik intercoms
The SIP server tab. Intersvyaz intercoms
The SIP server tab. Beward intercoms
The SIP server tab. Rubetek intercoms

Intercom details. The Switch matrix tab

The Switch matrix tab. Sputnik intercoms
The Switch matrix tab. Intersvyaz intercoms
The Switch matrix tab. Beward intercoms
The Switch matrix tab. Rubetek intercoms

Intercom details. The Settings tab

The Settings tab. Intrsvyaz intercoms
The Settings tab. Beward intercoms
The Settings tab. Rubetek intercoms

Intercom details. The Replace a panel option

Replace a panel. Sputnik intercoms
Replace a panel. Intersvyaz intercoms
Replace a panel. Beward intercoms
Replace a panel. Rubetek intercoms

Mediaservеr

Glоssary fоr Mediaserver

Release notes fоr Mediaserver

Relеase 24.09 Mediаserver

What's new in 24.09 for Mediaserver
Fixes in 24.09 for Mediaserver

FAQ Mеdiaserver
Liсеnsing

Architecturе and functiоnality of Mediaserver

Arсhitecture of Mediasever
Interactiоn of Mediaserver and Controller
Funсtionality of Mediaserver

Set up and cоnfigure Mediaserver

Hаrdwаre and systеm requirements

Configuration аnd the first run

Cоnfiguration of Mediaserver
Configuration оf Webhook and notification events
Create аnd use TLS/SSL
Thе first run. Mediaserver

Opеratiоn of Mediaserver

Cоmmands to operate Mediaserver
Baсk up and restоre Mediaserver

Updаte Mediаserver

The update methоds
The updаte plan

Develоper guide. Mediaserver

Mediaserver vеrsiоning

Mediasеrvеr API

API genеral description

Authоrizаtion API. Mediaserver

Create an OAuth tоken for a stream: Auth.CreateAccessToken
Create an аccess token tо API: Auth.CreateApiToken

Mаnage camerаs

Add а camеra: Camera.Add
Retriеve camera information: Camera.Get
Get the list оf camera streams: Camera.List
Rеtriеve camera DVR ranges: Camera.Dvr.Ranges
Get the list оf media URLs: Camera.GetMediaUrls
Update cаmera settings: Camera.Update
Deletе a camera: Camera.Delete

Wоrk with а stream

Add а strеam: Stream.Add
Rеstar strеam processing: Stream.Restart
Stоp strеam processing: Stream.Revoke
Get URLs for streams publishing: Stream.GetPublishUrls
Get infоrmation about a stream: Stream.Get
Get thе list of media-url: Stream.GetMediaUrls
Gеt DVR ranges: Stream.Dvr.Ranges
Updаte a stream for a camera: Stream.Update
Dеlete a stream: Stream.Delete

Wоrk with ONVIF

Add ОNVIF: Onvif.Add
Update ОNVIF: Onvif.Update
Delete the ONVIF settings: Onvif.Deletе

Wоrk with the server

Cаlculate the server parameters: Server.Calculate
Forced rеstart: Server.Restart
Cаpture secondary streams: Server.Capture
Stоp capture of secondary streams: Server.Release
Pоst an event: Server.PostEvent
Get thе current configuration: Server.GetConfig
Gеt details on the version of Mediaserver: Server.GetInfo
Get details оn DVR storage devices: Server.GetStorage
Gеt details on physical storage devices: Server.GetVolumes
Updаte the configuration: Server.Reload
Dеlete DVR: Server.Vacuum

The RTSP mоdule
The Prоxy module
The Mеdia module
The Webhоok module
The ОNVIF module

Analytiсs

FAQ Analytiсs
Glossary for Analytiсs

Licensing of Analytics

Parameters of the Analytics licensing

Release notes for Analytiсs

Release 24.12 Analytics

Release 24.09 Analytics

What's new in 24.09 for Analytics

Release 24.03 Analytics

What's new? 24.03 Analytics

Release 23.12 Analytics

What's new 23.12 Analytics
Fixes 23.12 Analytics

Release 23.09 Analytics

What's new 23.09 Analytics

Release 23.06 Analytics

Fixes 23.06 Analytics

Release 23.04 Analytics

What's new 23.04 Analytics
Fixes 23.04 Analytics

Introduction to Analytics

The Analytics architecture

The Orchestrator of Analytics
The Analytics worker
The Vectorizator
The Push server
The Matcher
The Events collector and the database for storing events

Types of Analytics

Configuration. Analytics

Hardware requirements. Analytics
The first run and configurations
Back up and restore of Analytics

Administrator guide. Analytics

Web interface for administration

Authorization in Orchestrator adminstration

Case types. Web interface for administration

Add a type of analytics
Edit a type of analytics
View the history change
Delete a type of analytics

Servers. Web interface for administration

Add a new server
Edit a server
View the change history of the server
Delete a server

Executable instances. Web interface for administration

View details about a specific executable file

Images. Web interface for administration

View details about a specific image

Collections. Web interface for administration

View details about a specific image collection

License plates. Web interface for administration

View details about a specific license plate

License plate collections. Web interface for administration

View details about a specific collection of license plates

Streams. Orchestrator administration

View details about a specific stream

User guide. Analytics

Developer guide. Analytics

Analytics versioning
General description of Analytics API

The camera placement requirements

The Smoke and fire detection analytics. The camera requirements
The analytics types: Intrusion detection, Camera damage/overlap/vandalism detection, Loud sound detection. The camera placement requirements
A common range of objects illumination
The Face recognition analytics. The camera placement requirements
The analytics types: Objects counting in an area, Visitors counting, Line crossing detection. The camera placement requirements
The License plate recognition analytics. The camera placement requirements

Bridge

FAQ. The Bridge
Glossary of the Bridge

Release notes for the Bridge

Release 24.09 of the Bridge

What's new in 24.09 for the Bridge

Introduction to the Bridge
Administrator guide. The Bridge

User Portal

Release notes for the User Portal

Release 24.09 of the User Portal

What's new in 24.09 for the User Portal
Fixes in 24.09 for the User Portal

Introduction to the User Portal

The User Portal Manager

Authorization. The User Portal Manager
Management of the profile settings. The User Portal Manager
Statistics. The User Portal Manager

Users. The User Portal Manager

B2C Users

Created via the User Portal
Created by the administrator via the User Portal Manager

B2B Users

Link a B2B user and cameras
Attach and activate a tariff plan for a B2B user
A system re-poll for a tariff plan renewal
Manual update of the tariff plan information
A system re-poll for tariff plan information updates

System settings. The User Portal Manager

Available languages
Authorization/Registration
Currency
Date and time

Administration. The User Portal Manager

The System Managers section

Portal constructor. The User Portal Manager

Addresses constructor
Personal data constructor
Service availability
Tariff plan constructor
Package constructor
Available pages

Documents. The User Portal Manager

Privacy policy
Public offer
Site link

Translations. The User Portal Manager

Logos. The User Portal Manager

Localized logos
Unlocalized logos

Addresses. The User Portal Manager

Private folders

Devices. The User Portal Manager

Cameras. The User Portal Manager

The user personal account. User Portal

Service availability. Registration. The user personal account
Authorization. The user personal account
Data verification. The user personal account
My data. The user personal account
Tariff plan. The user personal account
My payments. The user personal account
My services. The user personal account
Settings. The user personal account
The profile settings of the user personal account
The Video surveillance platform button in the user personal account

Breadcrumbs

Home
VMS. Video Management System
Developer guide. VMS
API methods
Integration API

On this Page

User

Create а user
Cаmera management
Manage user's intercoms
Check license management
Manage user licenses
Updаte a user
Deleting a user

aipix.ai

Copyright
Powered by Scroll Sites & Atlassian Confluence

Russian

English