Интеграция SmartPlayer с ivideon/en: различия между версиями

Материал из SmartPlayer
(Новая страница: «Integration of SmartPlayer with ivideon»)
 
(Новая страница: «=== '''Event Setup''' === After completing the actions described earlier, a window with event selection options will open for the user. There will be three available options in this window: # Face recognition # RFID tag # Server application (the required option) thumb|center| Example of event options during broadcast creation |800px The user selects the "Server application" event, and a new...»)
 
(не показано 6 промежуточных версий этого же участника)
Строка 1: Строка 1:
<div lang="ru" dir="ltr" class="mw-content-ltr">
== '''Situation Description''' ==
== '''Описание ситуации''' ==
This instruction is intended to provide information on the proper setup of the ivideon service, as well as information for its integration with the SmartPlayer platform.
Данная инструкция предназначена для получения информации о правильной настройке сервиса ivideon, а также информации для его интеграции с платформой SmartPlayer.
== '''Usage Scenario for Integration with ivideon''' ==
== '''Сценарий использования при интеграции с ivideon''' ==
To understand how the integration between ivideon and SmartPlayer will occur, the following general interaction scenario will be used:
Для понимания как будет происходить интеграция между ivideon и SmartPlayer будет использоваться следующий сценарий взаимодействия в общем виде:  
* Register/log in to the ivideon personal account
* Зарегистрироваться/авторизоваться в личном кабинете ivideon
* Add and configure the camera in the ivideon personal account
* Добавить камеру и настроить камеру в личном кабинете ivideon
* Obtain an API key for integration with SmartPlayer
* Получить API ключ для интеграции со SmartPlayer
* Log in to the SmartPlayer personal account
* Авторизоваться в личном кабинете SmartPlayer
* Create a broadcast in SmartPlayer with two pages
* Создать трансляцию в SmartPlayer с двумя страницами
* Page #1 plays background content (idle mode)
* Страница №1 проигрывает фоновый контент (режим бездействия)
* Page #2 plays content that will be triggered by the motion detection camera
* Страница №2 проигрывает контент, который будет проигрываться для настроенной на движение камеры
* After the content from page #2 is played, it returns (switches back) to page #1
* После проигрывания контента со страницы №2 происходит переход (возвращение) на страницу №1
== '''ivideon Setup''' ==
== '''Настройка ivideon''' ==
{{Note|If you encounter problems setting up the personal account and devices in ivideon, it is recommended to contact ivideon's technical support specialist. |warn}}
{{Note|При возникновении проблем с настройкой личного кабинета и устройств в личном кабинете ivideon рекомендуется обращаться к специалисту технической поддержки компании ivideon. |warn}}
=== '''User Registration/Authorization in ivideon Service''' ===
=== '''Регистрация/авторизация пользователя в сервисе ivideon''' ===
The first step for the user is to register in the ivideon service. You can register by following this [https://my.ivideon.com/service/login link].  
Первым шагом для пользователя будет регистрация в сервисе ivideon. Пройти регистрацию можно по [https://my.ivideon.com/service/login ссылке].  
To start the registration process, the user needs to follow the link and click on the "Register" button.
Для начала процесса регистрации пользователю необходимо перейти по ссылке и нажать на строку "Регистрация".  
[[File:Регистрация_ivideon.png|thumb|center| Example of the "Register" button displayed on the ivideon service page |800px]]
[[File:Регистрация_ivideon.png|thumb|center| Пример отображения строки "Регистрации" на странице сервиса ivideon|800px]]
After clicking, a new window will open with a list of information that needs to be provided by the user. This list includes the following information:  
После нажатия пользователю откроется новое окно со списком данных, которые необходимо указать о себе. В этот список входит следующая информация:  
* Name
* Имя
* Email address (E-Mail)
* Адрес электронной почты (E-Mail)
* Phone number
* Номер телефона
* Password
* Пароль
* Checkbox (checkmark) to accept the terms of service and privacy policy
* Чекбокс (галочка) о принятии условий обслуживания и политике конфиденциальности
[[File:Параметры_регистрации_ivideon.png|thumb|center| Example of the required information for registration in the ivideon service |800px]]
[[File:Параметры_регистрации_ivideon.png|thumb|center| Пример отображения необходимых данных для регистрации в сервисе ivideon|800px]]
{{Note|If the user already has an account in the ivideon service, they need to log in.|warn}}
{{Note|Если пользователь уже имеет учетную запись в сервисе ivideon ему необходимо авторизоваться в нем.|warn}}
After logging into ivideon, the user will be presented with the main page of their personal account.
После авторизации на сервисе ivideon пользователю откроется главная страница личного кабинета пользователя.  
[[File:Стартовая_страница_ivideon.png|thumb|center| Example of the main page of the user's personal account in the ivideon service |800px]]
[[File:Стартовая_страница_ivideon.png|thumb|center| Пример отображения главной страницы личного кабинета пользователя сервиса ivideon|800px]]
=== '''Adding a device to the ivideon personal account''' ===
</div>
On the main page, the user will be prompted to add a device via a special button in the center of the screen - "Connect Device."
<div lang="ru" dir="ltr" class="mw-content-ltr">
[[File:Подключить_устройство.png|thumb|center| Example of the "Connect Device" button displayed in the ivideon user personal account|800px]]
=== '''Добавление устройства в личный кабинет ivideon''' ===
By clicking the "Connect Device" button, the user will open a list where they need to select the desired device. In this case, it's an IP camera.
На главной странице пользователю предложат добавить устройство по специальной кнопке в центре экрана - "Подключить устройство".
[[File:Ip_камера.png|thumb|center| Example of the list of available devices for connection in the ivideon user personal account|800px]]
[[File:Подключить_устройство.png|thumb|center| Пример отображения кнопки "Подключить устройство" в личном кабинете пользователя сервиса ivideon|800px]]
Next, the user is advised to choose the connection method for the IP camera. ivideon technical support specialists strongly recommend using a wired "Ethernet" connection.
Кликнув на кнопку "Подключить устройство" пользователю откроется список, в котором необходимо выбрать нужное устройство. В данном случае это IP-камера.
[[File:Подключение_через_кабель_.png|thumb|center| Example of the types of camera connections in the ivideon user personal account|800px]]
[[File:Ip_камера.png|thumb|center| Пример отображения списка доступных для подключения устройств в личном кабинете пользователя сервиса ivideon|800px]]
At this stage, the user will be asked to provide the device's serial number. If the user does not have this information, it is possible to register the device using the MAC address. By clicking on the special line "Use MAC address," the user will be redirected to a new registration window.
Далее пользователю рекомендуется выбрать способ подключения IP-камеры. Специалисты технической поддержки ivideon настоятельно рекомендуют использовать проводное подключение "Ethernet".
[[File:Серийный_номер_.png|thumb|center| Example of registering a device via serial number and displaying the line for registration via MAC address|800px]]
[[File:Подключение_через_кабель_.png|thumb|center| Пример отображения типа подключений камеры в личном кабинете пользователя сервиса ivideon|800px]]
In the opened registration window, the user needs to enter the MAC address of the device, which can be found on the device itself (IP camera) or on the box in which the device was packaged upon purchase.
На данном этапе пользователя попросят указать серийный номер устройство. Если данной информацией пользователь не располагает, то существует возможность зарегистрировать устройство с помощью MAC-адреса. Кликнув на специальную строку "Использовать MAC-адрес", пользователь сможет перейти в новое окно регистрации.
[[File:Мак_адрес.png|thumb|center| Example of registering a device via MAC address|800px]]
[[File:Серийный_номер_.png|thumb|center| Пример регистрации устройства через серийный номер и отображения строки на переход для регистрации через MAC-адрес|800px]]
After entering the MAC address and clicking the "Continue" button, the user's camera will be registered and displayed in their personal account.
В открывшемся окне регистрации пользователю необходимо ввести MAC-адрес устройства, который можно найти на самом устройстве (IP- камере) или на коробке, в которой устройство было упаковано при покупке.
=== '''Using the camera's web interface for configuration''' ===
[[File:Мак_адрес.png|thumb|center| Пример регистрации устройства через MAC-адрес|800px]]
Manufacturers of various cameras provide an internal interface for configuring the camera. To access it, a certain sequence of steps must be followed.<br>
После указания MAC-адреса и нажатия клавиши "Продолжить" камера пользователя будет зарегистрирована и отобразится в личном кабинете.
First, the user needs to go to the "Settings" section in the ivideon personal account and proceed to the "Security" category.
=== '''Использование web-интерфейса камеры для настройки''' ===
[[File:Настройки_безопасности_.png|thumb|center| Example of the "Settings" section and the "Security" category in the ivideon personal account|800px]]
Производителями различных камер предусмотрен внутренний интерфейс с настройками камеры. Чтобы до него добраться необходимо проделать определенный порядок действий.<br>
In this category, the user can change the camera password and set the desired one if they do not know it.
Первым делом пользователю в личном кабинете ivideon необходимо перейти в раздел "Настройки" и переходим в категорию "Безопасность".
[[File:Изменить_пароль.png|thumb|center| Example of the line for changing the device password|800px]]
[[File:Настройки_безопасности_.png|thumb|center| Пример отображения раздела "Настройки" и категории "Безопасность" в личном кабинете ivideon|800px]]
Next, proceed to the camera information section. To do this, the user needs to click on the three vertical dots in the window of the registered camera and open the list of options for interacting with the camera. In this list, the user selects the line "Camera Information."
В данной категории пользователь может изменить пароль к камере и указать нужный, если он его не знает.
[[File:Информация_о_камере.png|thumb|center| Example of the "Camera Information" line in the ivideon personal account|800px]]
[[File:Изменить_пароль.png|thumb|center| Пример отображения строки для изменения пароля от устройства|800px]]
In the opened window, information about the camera will be provided. At the bottom of the window, there will be the required block "IP Address" with the line "eth 0". The needed IP address will be listed in this line.
Следующим шагом переходим в раздел информация о камере. Для этого пользователю необходимо в окне зарегистрированной камеры нажать на три вертикальных точки и открыть список возможностей по взаимодействию с камерой. В этом списке пользователь выбирает строку "Информация о камере".
[[File:Ip_адрес_камеры.png|thumb|center| Example of the camera's IP address displayed in the ivideon personal account|800px]]
[[File:Информация_о_камере.png|thumb|center| Пример отображения строки "Информации о камере" в личном кабинете ivideon|800px]]
This IP address is copied and pasted into the browser's address bar to open the camera's settings interface. The opened page will require login credentials for the camera.
В открывшемся окне будет описана информации о камере. Внизу окна будет нужный пользователю блок "IP-адрес" со строкой "eth 0". В этой строке и будет указан нужный IP-адрес.
After this, in the camera's web interface, go to the "Configuration" section and enable the setting or checkbox for "Enable motion detection."<br>
[[File:Ip_адрес_камеры.png|thumb|center| Пример отображения IP-адреса камеры в личном кабинете ivideon|800px]]
{{Note|'''Limitation:''' The camera must support the setting for detecting object crossing of a zone; otherwise, the previously mentioned "Enable motion detection" setting may be unavailable in the camera's web interface. An example of a camera that supports the zone-crossing detection setting can be found [here](https://www.dssl.ru/products/ds-2cd2183g2-is-2-8-mm-ip-kamera/). ivideon technical support specialists are always available to assist users with camera settings.|warn}}
Данный IP-адрес копируется и вставляется в браузере в адресную строку. Это нужно чтобы открыть тот самый интерфейс настроек камеры. Открывшаяся страница с авторизацией потребует ввести логин и пароль от камеры.
Some cameras also offer the option to record and store logs. For this purpose, the camera is equipped with the ability to insert a USB-flash drive. Logs can also be viewed in the camera's web interface (this feature is not available on all devices).
После этого в web-интерфейсе настроек камеры необходимо будет найти настройку "Configuration/конфигурации" и включить настройку или чекбокс (поставить галочку) у настройки "Enable motion detection" (включить обнаружение движения).<br>
=== '''Event Display in the ivideon Personal Account''' ===
{{Note|'''Ограничение:''' камера должна поддерживать настройку пересечения объектом зоны, иначе указанная ранее настройка "Enable motion detection" может быть недоступна в настройках web-интерфейса камеры. Пример камеры поддерживающей настройку зоны с реакцией на пересечние можно по [https://www.dssl.ru/products/ds-2cd2183g2-is-2-8-mm-ip-kamera/ ссылке]. В настройках камеры пользователю всегда сможет помочь специалист технической поддержки ivideon|warn}}
After configuring the camera's web interface in the ivideon personal account, events will begin to appear for the user.
Также некоторым камерам доступно записи и хранения логов. Для этого в камере предусмотрена возможность вставить USB-flash накопитель. Просмотреть логи можно также в web-интерфейсе камеры (присутствует не у всех производителей).
[[File:Список_событий ivideon.png|thumb|center| Example of event display in the ivideon personal account|800px]]
</div>
In the "Events" section of the personal account, the user needs to filter events using the provided filters.
<div lang="ru" dir="ltr" class="mw-content-ltr">
[[File:Строка_фильтров.png|thumb|center| Example of event filters in the ivideon personal account|800px]]
=== '''Отображение событий в личном кабинете ivideon''' ===
From the available filters, the user needs to use the event type filter:
После настройки web-интерфейса камеры в личном кабинете ivideon пользователю начнут приходить события.
# Line crossing
[[File:Список_событий ivideon.png|thumb|center| Пример отображения событий в личном кабинете ivideon|800px]]
# Entry into a zone
В разделе личного кабинета "События" пользователю необходимо отсортировать события с помощью фильтров.
After applying the filter, only the filtered events described above will be displayed in the personal account.
[[File:Строка_фильтров.png|thumb|center| Пример отображения фильтров событий в личном кабинете ivideon|800px]]
[[File:Типы_событий.png|thumb|center| Example of filtered events in the ivideon personal account|800px]]
Из имеющихся фильтров пользователю необходимо использовать фильтр по типу события:
{{Note|'''Limitation:''' If one of the events listed above occurs ("Line crossing" or "Entry into a zone"), it is registered in the personal account. The event registration interval is one event every five minutes. If an event (such as a change in the color of one pixel in the camera's zone) occurs within five minutes of the timer starting, the five-minute timer will reset and start counting again. However, the event will not be sent to the ivideon personal account because the initial five-minute timer has not completed. As a result, the event that the SmartPlayer broadcast should respond to will not be triggered. The five-minute timer limitation cannot be disabled.<br>
# Пересечении линии
It's important to understand that even if the event is not sent to the ivideon personal account, the system still detects and counts it. This means that the five-minute timer will refresh and start again. |warn}}
# Вход в зону
== '''Integration with SmartPlayer''' ==
После применения фильтра в личном кабинете будут отображаться только отсортированные события, описанные выше.
For integration with SmartPlayer, the user needs to perform three actions in the SmartPlayer personal account:
[[File:Типы_событий.png|thumb|center| Пример фильтрации событий в личном кабинете ivideon|800px]]
# Add the camera to the desired device
{{Note|'''Ограничение:''' если одно из событий указанных выше произошло ("Пересечение линии" и "Вход в зону") то приходит в личный кабинет. Промежуток регистрации события - одно событие в течение пяти минут. Если после запуска таймера отсчета в пять минут у камеры произойдет событие (изменения одного цвета пикселя в зоне камеры) то пятиминутный таймер сбросится и начнет отсчет по новой. При этом событие в личный кабинет ivideon не придет, так как изначальный таймер в пять минут не закончил свой отсчет. Следовательно, и событие, на которое должна среагировать трансляция в SmartPlayer не приходит. Ограничение на длительность таймера в пять минут отключить невозможно.<br>
# Create an API key in the ivideon personal account and use it to connect to SmartPlayer
Также нужно понимать, что хоть событие и не пришло в личный кабинет ivideon, но система его видела и засчитала. А это значит, что таймер в пять минут снова обновится и начнет отсчет. |warn}}
# Prepare the server application and broadcast(s) with correctly configured events
== '''Интеграция со SmartPlayer''' ==
Each of these points will be detailed below.
Для интеграции со SmartPlayer пользователю в личном кабинете SmartPlayer необходимо сделать три действия:
== '''Adding a Camera to the Device Used in a SmartPlayer Broadcast''' ==
# Добавить на нужное устройство камеру
To receive information about changes in the camera's status, the user needs to connect it to the device that will be used in the broadcast. This can be done in the SmartPlayer personal account.
# Создать API ключ в личном кабинете ivideon и с его помощью подключиться к SmartPlayer
{{Note|The device to which the camera will be connected must first be added to the personal account. It will be displayed in the "Devices" section. |warn}}
# Подготовить серверное приложение и трансляцию/-ии с правильно настроенными событиями
Initially, the user needs to navigate to the "Devices" section in the personal account.
Все эти пункты подробнее будут изложены ниже.
[[File:Устройства_доступные_в_лк.png|thumb|center| Example of the "Devices" section in the SmartPlayer personal account |800px]]
</div>
Next, the user needs to find the required device, click on it, and go to the "Settings" section in the right-hand toolbar.
<div lang="ru" dir="ltr" class="mw-content-ltr">
[[File:Настрйоки_тулбара.png|thumb|center| Example of the "Settings" section in the device settings list|800px]]
== '''Добавление камеры на устройство используемое в трансляции SmartPlayer ''' ==
In the settings section, they need to find the "Camera" category and open it.
Чтобы получать информацию об изменении состоянии камеры пользователю необходимо подключить ее к устройство, которое он будет использовать в трансляции. Данное действие можно сделать в личном кабинете SmartPlayer.
[[File:Настройка_камера.png|thumb|center| Example of the "Camera" category in the device settings|800px]]
{{Note|Предварительно устройство, к которому будет привязана камера, должно быть добавлено в личный кабинет. Оно будет отображено в разделе "Устройства". |warn}}
Once the "Camera" category is opened, the user must click the "Add Camera" button and fill in the following fields:
Изначально пользователю необходимо перейти в раздел "Устройства" личного кабинета.
* Camera Name - enter the camera's name
[[File:Устройства_доступные_в_лк.png|thumb|center| Пример отображения раздела "Устройства" в личном кабинете SmartPlayer |800px]]
* Camera Identifier - this can be obtained from the ivideon personal account, in the "Camera Information" section (Camera ID)
Далее ему нужно найти нужное устройство, кликнуть по нему и в правом тулбаре перейти в раздел "Настройки".
{{Note|Using the "Add Camera" button, the user can add multiple cameras to one device.|warn}}
[[File:Настрйоки_тулбара.png|thumb|center| Пример отображения раздела "Настройки" в списке настроек устройства|800px]]
[[File:Id_камеры.png|thumb|center| Example of the Camera ID in the ivideon personal account|800px]]
В разделе настроек ему нужно найти категорию - "Камера" и открыть данную категорию.
== '''Receiving Data in SmartPlayer via the ivideon API Key''' ==
[[File:Настройка_камера.png|thumb|center| Пример отображения категории "Камера" в настройках устройства|800px]]
To connect to SmartPlayer and receive events from ivideon, the user needs to obtain an API key from the ivideon personal account. After obtaining the API key, it must be added to the settings in the SmartPlayer personal account.
Открыв категорию "Камера" пользователю необходимо будем нажать на кнопку "Добавить камеру" и заполнить следующие поля:
=== '''Creating an API Key in the ivideon Personal Account''' ===
* Название камеры - ввести название камеры
{{Note|To obtain an API key, the ivideon user must have a special subscription plan. |warn}}
* Идентификатор камеры - получить его можно в личном кабинете ivideon, в разделе "Информация о камере" (ID камеры)
To obtain the API key, the user needs to navigate to the "Settings" section in the ivideon personal account and go to the "Access and Security" category.
{{Note|С помощью кнопки "Добавить камер" пользователь может добавить несколько камер к одному устройству.|warn}}
[[File:Настройки_безопасности.png|thumb|center| Example of the "Settings" section and "Access and Security" category in the ivideon personal account |800px]]
[[File:Id_камеры.png|thumb|center| Пример отображения ID камеры в личном кабинете ivideon|800px]]
On the opened page, the user needs to find the "For Developers" block and click the "Open" button next to the "API Access Keys" line.
== '''Прием данных в SmartPlayer по API ключу от ivideon ''' ==
[[File:Для_разработчиков.png|thumb|center| Example of the functionality for creating an API key in the ivideon personal account|800px]]
Чтобы подключиться к SmartPlayer и получать события от ivideon пользователю необходимо получить API - ключ внутри личного кабинета ivideon. После получения API-ключа пользователю нужно будет добавит его в настройках личного кабинета SmartPlayer.
On the new page, the user must create a new API key. To do this, they need to click the "Create Key" button in the upper right corner. It is also possible to delete all keys on this page by clicking the "Delete All Keys" button.
=== '''Создание API-ключа в личном кабинете ivideon''' ===
[[File:Создать_ключ.png|thumb|center| Example of the "Create Key" button|800px]]
{{Note|Чтобы получить API-ключ пользователю ivideon необходимо иметь специальный тариф. |warn}}
In the opened window, the user must enter a name for the key and click the "Continue" button. The "Continue" button will be inactive until the user enters the key name.
Чтобы получить API-ключ пользователю нужно перейти в раздел "Настройки" личного кабинета ivideon и перейти в категорию "Доступ и безопасность".
[[File:Тестовый_ключ_2.png|thumb|center| Example of the "Continue" button and the field for entering the key name|800px]]
[[File:Настройки_безопасности.png|thumb|center| Пример отображения раздела "Настройки" и категории "Доступ и безопасность" в личном кабинете ivideon |800px]]
The next window will display the new key, which the user must copy by clicking the special icon next to the line where the key is shown. The user must also check the checkbox "I have copied the key." Otherwise, the user will not be able to complete the creation of the API key, as the "Done" button will remain inactive.
В открывшейся странице пользователю необходимо найти блок "Для разработчиков" и напротив строки "Ключи доступа к API" нажать кнопку "Открыть".
[[File:Созданный_ключ.png|thumb|center| Example of the window with the created API key|800px]]
[[File:Для_разработчиков.png|thumb|center| Пример отображения функционала для создания API-ключа в личном кабинете ivideon|800px]]
Clicking the "Done" button will return the user to the page with the list of keys, where the new key will be displayed for use in connecting to SmartPlayer.
Открыв новую страницу, пользователь должен создать новый API ключ. Для этого ему необходимо в правом верхнем углу нажать на кнопку "Создать ключ". Также можно удалить все ключи на этой странице нажав на кнопку "Удалить все ключи".
[[File:Готовый_ключ.png|thumb|center| Example of the created API key|800px]]
[[File:Создать_ключ.png|thumb|center| Пример отображения кнопки "Создать ключ"|800px]]
=== '''Applying the API Key for Integration with SmartPlayer''' ===
В открывшемся окне обязательно нужно ввести имя ключа и нажать на кнопку "Продолжить". Кнопка "Продолжить" будет неактивна пока пользователь не введёт название ключа.
The API key obtained in the ivideon personal account must be added to the SmartPlayer personal account. To do this, the user needs to log in to the SmartPlayer personal account and navigate to the "Settings" section.
[[File:Тестовый_ключ_2.png|thumb|center| Пример отображения кнопки "Продолжить" и строки для ввода названия ключа|800px]]
[[File:Настройки_для_api_ключа.png|thumb|center| Example of the "Settings" section in the SmartPlayer personal account|800px]]
Следующее окно отобразит пользователю новый ключ, значение которого необходимо скопировать, нажав на специальную иконку рядом со строкой, в которой указано значение. Также необходимо активировать чекбокс (галочку) "Я скопировал ключ". Иначе пользователь не сможет завершить создание API ключа, потому что кнопка "Готово" будет неактивна.
In the "Settings" section, the user needs to go to the "Integrations" block.
[[File:Созданный_ключ.png|thumb|center| Пример отображения окна с созданным API-ключом|800px]]
[[File:Интеграции_.png|thumb|center| Example of the "Integrations" block in the settings |800px]]
Нажав на кнопку "Готово" пользователя вернет на страницу со списком ключей, где будет отображен новый ключ, который будет использоваться для подключения в SmartPlayer.
In this block, the user needs to configure the following parameters:
[[File:Готовый_ключ.png|thumb|center| Пример отображения созданного API-ключа|800px]]
* Activate the checkbox
</div>
* Enter the API key value (must be copied from the ivideon personal account)
<div lang="ru" dir="ltr" class="mw-content-ltr">
* Select the type of events that will be used in the broadcast. In this case, only the values for "line crossing" and "zone entry" will be used.
=== '''Применение API-ключа для интеграции со SmartPlayer ''' ===
[[File:Параметры_интеграции.png|thumb|center| Example of the filled-out parameters in the "Integrations" block |800px]]
Полученный API-ключи в личном кабинете ivideon пользователь должен добавить в личный кабинет SmartPlayer. Для этого пользователю необходимо авторизоваться в личном кабинете SmartPlayer и перейти в раздел "Настройки".  
== '''Creating a Broadcast for Playback in SmartPlayer with the Necessary Settings''' ==
[[File:Настройки_для_api_ключа.png|thumb|center| Пример отображения раздела "Настройки" в личном кабинете SmartPlayer|800px]]
To receive data from the ivideon service and make SmartPlayer correctly respond to these events, the user must create a broadcast with specially configured parameters.
В разделе "Настройки" пользователю необходимо перейти в блок "Интеграции".  
{{Note|This functionality is available in the following versions of the SmartPlayer client application:
[[File:Интеграции_.png|thumb|center| Пример отображения Блока "Интеграции" в настройках |800px]]
В данной блоке пользователю необходимо настроить следующие параметры:
* Активировать чекбокс (галочку)
* Ввести значение API-ключа (должен быть скопирован из личного кабинете ivideon)
* Выбрать тип событий, которые будут использоваться в трансляции. В текущем кейсе будут использоваться только значения - "пересечения линии" и "вход в зону".
[[File:Параметры_интеграции.png|thumb|center| Пример отображения заполняемых параметров в блоке "Интеграции" |800px]]
== '''Создание трансляции для проигрывания в SmartPlayer с нужными настройками ''' ==
Чтобы принимать данные с сервиса ivideon и заставить правильно реагировать на эти событие SmartPlayer пользователю необходимо создать трансляцию со специально настроенными параметрами.  
{{Note|Данный функционал доступен на следующих версиях клиентских приложения SmartPlayer:
* Windows - ver. 2.41.7
* Windows - ver. 2.41.7
* Linux - ver. 2.41.7
* Linux - ver. 2.41.7
* Android - ver. 1.74.2 и выше.<br>
* Android - ver. 1.74.2 and above.<br>
Также на данный момент не реализован на клиентских приложения Web OS и Tizen OS|warn}}
It is currently not implemented in the Web OS and Tizen OS client applications.|warn}}
==='''Подготовка серверного приложения:'''===
==='''Server Application Setup:'''===
* Создать личный кабинет на нужном серверном приложении. При создании личного кабинета необходимо выставить роль - "admin" с видеоаналитикой
* Create a personal account on the required server application. When creating the personal account, the role must be set to "admin" with video analytics.
* Вручную создать трансляцию в личном кабинете и настроить переходы для нужного контента и значениями событий (действиями для событий)
* Manually create a broadcast in the personal account and configure the transitions for the required content and event values (actions for events).
'''Программная часть:'''
'''Programming Part:'''
* При реализации программной части необходимо использовать "''socket.io v.2''". Данное решение доступно по [https://socket.io/ ссылке]<br>
* When implementing the programming part, "''socket.io v.2''" must be used. This solution is available at the following [https://socket.io/ link].<br>
''Личный кабинет:''
''Personal Account:''
*Взаимодействие с личным кабинетом происходит по протоколу: ''http(s)'' и ''webSocket''. Информация о "''socket.io v.2''" указана выше.<br>
* Interaction with the personal account occurs via the ''http(s)'' and ''webSocket'' protocols. Information about "''socket.io v.2''" is provided above.<br>
''Информация по протоколам:''
''Protocol Information:''
* restApi - используется в большинстве случаев для авторизации и работы с файлами
* restApi - used mostly for authorization and file handling.
* Socket.io - используется большинством методов для работы с личным кабинетом
* Socket.io - used by most methods to interact with the personal account.
''Авторизация:''
''Authorization:''
* Информация о получении необходимых токенов можно получить по [https://dev.smartplayer.org/api-page/pages/1 ссылке]
* Information on obtaining the necessary tokens can be found at this [https://dev.smartplayer.org/api-page/pages/1 link].
* Информация о корректной настройки для "join" можно получить по  [https://dev.smartplayer.org/api-page/events/28 ссылке]
* Information on properly configuring "join" can be found at this [https://dev.smartplayer.org/api-page/events/28 link].
'''Получение трансляции:'''
'''Receiving the Broadcast:'''
* С помощью определенного события можно  получить список трансляций. Информация о получении события доступна по [https://dev.smartplayer.org/api-page/events/367 ссылке]. <br>
* A specific event can be used to get the list of broadcasts. Information on obtaining this event is available at this [https://dev.smartplayer.org/api-page/events/367 link].<br>
После получения данных необходимо будет выбрать нужное событие. У этого объекта необходимо взять ID, который будет подставлен в событие, описанное ниже.<br>
After receiving the data, the user needs to select the desired event. From this object, they must take the ID, which will be used in the event described below.<br>
'''Отправка ответного события:'''
'''Sending a Response Event:'''
* Следующим шагом отправляется другое событие, доступное по [https://dev.smartplayer.org/api-page/events/367 ссылке], с нужными параметрами.<br>
* The next step is to send another event, available at this [https://dev.smartplayer.org/api-page/events/367 link], with the necessary parameters.<br>
Событие с правильными параметрами должно переключать страницы в эфирной сетке.
The event with the correct parameters should switch the pages in the broadcast grid.
</div>
=== '''Creating a Broadcast in the Personal Account''' ===
<div lang="ru" dir="ltr" class="mw-content-ltr">
After configuring the server part, the user can start preparing events for playback in the broadcast.<br>
=== '''Создание трансляции в личном кабинете''' ===
To begin working with events in the broadcast, the user must first log into the personal account.<br>
После настройки серверной части пользователь сможет воспользоваться подготовкой событий для воспроизведения их в трансляции.<br>
The next step is to find the "Broadcasts" section in the personal account and select the "Create" category.
Чтобы начать работу с событиями в трансляции пользователю необходимо сначала авторизоваться в личном кабинете.<br>
[[File:Транлсяция_категория_создать_.png|thumb|center| Example of the "Broadcasts" section and "Create" category in the personal account |800px]]
Следующим шагом пользователю найти в личном кабинете раздел "Трансляции" и выбрать категорию "Создать".  
After clicking on the "Create" category, a new window will open, displaying the entire interface for creating a broadcast.
[[File:Транлсяция_категория_создать_.png|thumb|center| Пример отображения раздела "Трансляции" и категории "Создать" в личном кабинете |800px]]
[[File:Создание_страниц.png|thumb|center| Example of the broadcast creation interface in the personal account|800px]]
После нажатия по категории "Создать" пользователю откроется новое окно, в котором будет показан весь интерфейс для создания трансляции.
Next, the user must create the required number of pages, depending on their needs. This action is done in the lower-left part of the screen by clicking a special icon in the form of a large "+" symbol.
[[File:Создание_страниц.png|thumb|center| Пример отображения интерфейса создания трансляции в личном кабинете|800px]]
[[File:доабвление страниц.png|thumb|center| Example of the ready pages and the icon for adding new pages in the personal account |800px]]
Далее пользователю необходимо в зависимости от своих задач создать нужно количестве страниц. Данное действие делается в левой нижней части экрана по специальной иконке в виде большого символа "+".
After creating the required number of pages, the user must select a content zone on each page. This is done using a special icon in the form of a rectangle at the top of the screen.
[[File:доабвление страниц.png|thumb|center| Пример отображения готовых страниц и иконки для добавления новых страниц в личном кабинете |800px]]
[[File:Добавить_зону.png|thumb|center| Example of the icon for creating a content zone |800px]]
Создав нужное количество страниц, пользователь должен на каждой странице выбрать зону для контента. Это делается по специальной иконке в виде прямоугольника вверху экрана.  
When creating a zone, a toolbar with zone settings will open, allowing the user to configure the zone parameters.
[[File:Добавить_зону.png|thumb|center| Пример отображения иконки создания зоны для контента |800px]]
[[File:Тулбар_настроек_зоны.png|thumb|center| Example of the toolbar with zone settings |800px]]
При создании зоны открывается тулбар с настройками зоны, в котором можно настраивать параметры зоны.
After selecting the content zone, the user can individually customize the zone based on their needs.<br>
[[File:Тулбар_настроек_зоны.png|thumb|center| Пример отображения тулбара с настройками для зоны |800px]]
Once the above steps are completed, the user needs to select the page with the content and open the page settings by clicking on the icon in the lower-left part of the personal account. The page settings will also open in the right toolbar, just like the content zone settings.
После выделения зоны для контента пользователь может индивидуально настроить зону с контентом, в соответствии со своими нуждами.<br>
[[File:Иконка настройки_страницы.png|thumb|center| Example of the icon for accessing the page settings |800px]]
Проделав действия, описанные выше пользователю необходимо выбрать страницу с контентом и открыть настройки страницы по иконке в левой нижней части личного кабинета. Настройки страницы откроются также в тулбаре справа, как и настройки для зоны контента.
In the page settings, the user needs to find the row with the "Event" parameter and click on the "+" icon.
[[File:Иконка настройки_страницы.png|thumb|center| Пример отображения иконки для перехода в настройки страницы |800px]]
[[File:События_для_страницы.png|thumb|center| Example of the row with the "Event" parameter |800px]]
В настройках страницы пользователю необходимо найти строку с параметром "Событие" и нажать на иконку в виде "+".  
This action will open a new window with a list of events for this page.
[[File:События_для_страницы.png|thumb|center| Пример отображения строки с параметром "Событие" |800px]]
=== '''Event Setup''' ===
Данное действие откроет новое окно со списком событий для данной страницы.
After completing the actions described earlier, a window with event selection options will open for the user. There will be three available options in this window:
</div>
# Face recognition
<div lang="ru" dir="ltr" class="mw-content-ltr">
# RFID tag
=== '''Настройка события''' ===
# Server application (the required option)
Проделав действия, описанные ранее пользователю откроется окно с выбором событий. В данном окне будет три доступных варианта:
[[File:Событие_серверное_приложение.png|thumb|center| Example of event options during broadcast creation |800px]]
# Распознавание лица
The user selects the "Server application" event, and a new row for filling out the "Key" will be added. In this row, select the option "By payload."
# RFID метка
[[File:Выбрать_ключ.png|thumb|center| Example of the "Key" field and its value |800px]]
# Серверное приложение (нужный вариант)
After selecting this key, another row - "Value" - will become available. In this row, the user must specify one of the special values:
[[File:Событие_серверное_приложение.png|thumb|center| Пример отображения вариантов событий при создании трансляций |800px]]
Пользователь выбирает событие "Серверное приложение" и ему добавится новая строка для заполнения "Ключ". В ней необходимо выбрать вариант "По полезной нагрузке".
[[File:Выбрать_ключ.png|thumb|center| Пример отображения поля "Ключ" и его значения|800px]]
Выбрав данный ключ пользователю станет доступна еще одна строка - "Значение". В этой строке пользователь и должен указать одно из специальных значений:
{| class="wikitable"
{| class="wikitable"
|+ Таблица значений
|+ Value Table
|-
|-
! Название !! Значение
! Name !! Value
|-
|-
| Пересечение линии || ivs.vca.line_detection.event/started
| Line crossing || ivs.vca.line_detection.event/started
|-
|-
| Вход в зону || ivs.vca.field_detection.event.enter/started
| Entering the zone || ivs.vca.field_detection.event.enter/started
|}
|}
[[File:Значение_ивента.png|thumb|center| Пример отображения поля с прописанным значением|800px]]
[[File:Значение_ивента.png|thumb|center| Example of the field with the specified value |800px]]
После завершения заполнения всех полей в окне пользователю необходимо нажать на кнопку "Сохранить" в центре экрана.
After completing all fields in the window, the user needs to click the "Save" button in the center of the screen.
== '''Связанная информация''' ==
== '''Related Information''' ==
Для дальнейшего завершения настройки трансляции рекомендуется ознакомиться со следующими Wiki-страницами
For further completion of broadcast setup, it is recommended to review the following Wiki pages:
* [[Раздел "Трансляции"]]
* [[Раздел "Трансляции"]]
* [[Раздел "Расписание"]]
* [[Раздел "Расписание"]]
== '''Итог''' ==
== '''Result''' ==
После завершения настройки личного кабинет ivideon, интеграции с серверными приложением SmartPlayer и настройки трансляции с использованием событийной модели в личном кабинете SmartPlayer должно начать функционировать. Данное решение будет проигрывать и изменять контент при любом приближении человека в рамках выбранной и настроенной на камере зоны.
After completing the setup of the ivideon personal account, integration with the SmartPlayer server application, and configuring the broadcast using the event-driven model in the SmartPlayer personal account, the solution should start functioning. This setup will trigger and change the content whenever a person approaches the designated and configured zone on the camera.
== '''Видеоинструкция''' ==
== '''Video Instruction''' ==
[https://www.youtube.com/watch?v=NpgP-P1Q6f4 Настройка интеграции ivideon и SmartPlayer]
[https://www.youtube.com/watch?v=NpgP-P1Q6f4 ivideon and SmartPlayer Integration Setup]
== '''Дополнительная информация''' ==
== '''Additional Information''' ==
Если данная статья не помогает использовать функционал по назначению или после ее прочтения остаются вопросы можно озвучить данные вопросы в разделе "Обсуждения" вверху страницы.
If this article does not help use the functionality as intended or if there are still questions after reading, you can raise those questions in the "Discussion" section at the top of the page.
[[File:Обсуждение_интеграции_с_ivideon.png|thumb|center| Пример отображения вкладки "Обсуждения" на wiki-странице |800px]]
[[File:Обсуждение_интеграции_с_ivideon.png|thumb|center| Example of the "Discussion" tab on the wiki page |800px]]
Также дополнительную информацию можно узнать на странице [[Как взаимодействовать пользователю с разделом "Обсуждения"]]
Additional information can also be found on the page [[How to interact with the user in the "Discussion" section]].
</div>

Текущая версия от 15:23, 23 октября 2024

Situation Description

This instruction is intended to provide information on the proper setup of the ivideon service, as well as information for its integration with the SmartPlayer platform.

Usage Scenario for Integration with ivideon

To understand how the integration between ivideon and SmartPlayer will occur, the following general interaction scenario will be used:

  • Register/log in to the ivideon personal account
  • Add and configure the camera in the ivideon personal account
  • Obtain an API key for integration with SmartPlayer
  • Log in to the SmartPlayer personal account
  • Create a broadcast in SmartPlayer with two pages
  • Page #1 plays background content (idle mode)
  • Page #2 plays content that will be triggered by the motion detection camera
  • After the content from page #2 is played, it returns (switches back) to page #1

ivideon Setup

If you encounter problems setting up the personal account and devices in ivideon, it is recommended to contact ivideon's technical support specialist.

User Registration/Authorization in ivideon Service

The first step for the user is to register in the ivideon service. You can register by following this link. To start the registration process, the user needs to follow the link and click on the "Register" button.

Example of the "Register" button displayed on the ivideon service page

After clicking, a new window will open with a list of information that needs to be provided by the user. This list includes the following information:

  • Name
  • Email address (E-Mail)
  • Phone number
  • Password
  • Checkbox (checkmark) to accept the terms of service and privacy policy
Example of the required information for registration in the ivideon service
If the user already has an account in the ivideon service, they need to log in.

After logging into ivideon, the user will be presented with the main page of their personal account.

Example of the main page of the user's personal account in the ivideon service

Adding a device to the ivideon personal account

On the main page, the user will be prompted to add a device via a special button in the center of the screen - "Connect Device."

Example of the "Connect Device" button displayed in the ivideon user personal account

By clicking the "Connect Device" button, the user will open a list where they need to select the desired device. In this case, it's an IP camera.

Example of the list of available devices for connection in the ivideon user personal account

Next, the user is advised to choose the connection method for the IP camera. ivideon technical support specialists strongly recommend using a wired "Ethernet" connection.

Example of the types of camera connections in the ivideon user personal account

At this stage, the user will be asked to provide the device's serial number. If the user does not have this information, it is possible to register the device using the MAC address. By clicking on the special line "Use MAC address," the user will be redirected to a new registration window.

Example of registering a device via serial number and displaying the line for registration via MAC address

In the opened registration window, the user needs to enter the MAC address of the device, which can be found on the device itself (IP camera) or on the box in which the device was packaged upon purchase.

Example of registering a device via MAC address

After entering the MAC address and clicking the "Continue" button, the user's camera will be registered and displayed in their personal account.

Using the camera's web interface for configuration

Manufacturers of various cameras provide an internal interface for configuring the camera. To access it, a certain sequence of steps must be followed.
First, the user needs to go to the "Settings" section in the ivideon personal account and proceed to the "Security" category.

Example of the "Settings" section and the "Security" category in the ivideon personal account

In this category, the user can change the camera password and set the desired one if they do not know it.

Example of the line for changing the device password

Next, proceed to the camera information section. To do this, the user needs to click on the three vertical dots in the window of the registered camera and open the list of options for interacting with the camera. In this list, the user selects the line "Camera Information."

Example of the "Camera Information" line in the ivideon personal account

In the opened window, information about the camera will be provided. At the bottom of the window, there will be the required block "IP Address" with the line "eth 0". The needed IP address will be listed in this line.

Example of the camera's IP address displayed in the ivideon personal account

This IP address is copied and pasted into the browser's address bar to open the camera's settings interface. The opened page will require login credentials for the camera. After this, in the camera's web interface, go to the "Configuration" section and enable the setting or checkbox for "Enable motion detection."

Limitation: The camera must support the setting for detecting object crossing of a zone; otherwise, the previously mentioned "Enable motion detection" setting may be unavailable in the camera's web interface. An example of a camera that supports the zone-crossing detection setting can be found [here](https://www.dssl.ru/products/ds-2cd2183g2-is-2-8-mm-ip-kamera/). ivideon technical support specialists are always available to assist users with camera settings.

Some cameras also offer the option to record and store logs. For this purpose, the camera is equipped with the ability to insert a USB-flash drive. Logs can also be viewed in the camera's web interface (this feature is not available on all devices).

Event Display in the ivideon Personal Account

After configuring the camera's web interface in the ivideon personal account, events will begin to appear for the user.

Example of event display in the ivideon personal account

In the "Events" section of the personal account, the user needs to filter events using the provided filters.

Example of event filters in the ivideon personal account

From the available filters, the user needs to use the event type filter:

  1. Line crossing
  2. Entry into a zone

After applying the filter, only the filtered events described above will be displayed in the personal account.

Example of filtered events in the ivideon personal account
Limitation: If one of the events listed above occurs ("Line crossing" or "Entry into a zone"), it is registered in the personal account. The event registration interval is one event every five minutes. If an event (such as a change in the color of one pixel in the camera's zone) occurs within five minutes of the timer starting, the five-minute timer will reset and start counting again. However, the event will not be sent to the ivideon personal account because the initial five-minute timer has not completed. As a result, the event that the SmartPlayer broadcast should respond to will not be triggered. The five-minute timer limitation cannot be disabled.
It's important to understand that even if the event is not sent to the ivideon personal account, the system still detects and counts it. This means that the five-minute timer will refresh and start again.

Integration with SmartPlayer

For integration with SmartPlayer, the user needs to perform three actions in the SmartPlayer personal account:

  1. Add the camera to the desired device
  2. Create an API key in the ivideon personal account and use it to connect to SmartPlayer
  3. Prepare the server application and broadcast(s) with correctly configured events

Each of these points will be detailed below.

Adding a Camera to the Device Used in a SmartPlayer Broadcast

To receive information about changes in the camera's status, the user needs to connect it to the device that will be used in the broadcast. This can be done in the SmartPlayer personal account.

The device to which the camera will be connected must first be added to the personal account. It will be displayed in the "Devices" section.

Initially, the user needs to navigate to the "Devices" section in the personal account.

Example of the "Devices" section in the SmartPlayer personal account

Next, the user needs to find the required device, click on it, and go to the "Settings" section in the right-hand toolbar.

Example of the "Settings" section in the device settings list

In the settings section, they need to find the "Camera" category and open it.

Example of the "Camera" category in the device settings

Once the "Camera" category is opened, the user must click the "Add Camera" button and fill in the following fields:

  • Camera Name - enter the camera's name
  • Camera Identifier - this can be obtained from the ivideon personal account, in the "Camera Information" section (Camera ID)
Using the "Add Camera" button, the user can add multiple cameras to one device.
Example of the Camera ID in the ivideon personal account

Receiving Data in SmartPlayer via the ivideon API Key

To connect to SmartPlayer and receive events from ivideon, the user needs to obtain an API key from the ivideon personal account. After obtaining the API key, it must be added to the settings in the SmartPlayer personal account.

Creating an API Key in the ivideon Personal Account

To obtain an API key, the ivideon user must have a special subscription plan.

To obtain the API key, the user needs to navigate to the "Settings" section in the ivideon personal account and go to the "Access and Security" category.

Example of the "Settings" section and "Access and Security" category in the ivideon personal account

On the opened page, the user needs to find the "For Developers" block and click the "Open" button next to the "API Access Keys" line.

Example of the functionality for creating an API key in the ivideon personal account

On the new page, the user must create a new API key. To do this, they need to click the "Create Key" button in the upper right corner. It is also possible to delete all keys on this page by clicking the "Delete All Keys" button.

Example of the "Create Key" button

In the opened window, the user must enter a name for the key and click the "Continue" button. The "Continue" button will be inactive until the user enters the key name.

Example of the "Continue" button and the field for entering the key name

The next window will display the new key, which the user must copy by clicking the special icon next to the line where the key is shown. The user must also check the checkbox "I have copied the key." Otherwise, the user will not be able to complete the creation of the API key, as the "Done" button will remain inactive.

Example of the window with the created API key

Clicking the "Done" button will return the user to the page with the list of keys, where the new key will be displayed for use in connecting to SmartPlayer.

Example of the created API key

Applying the API Key for Integration with SmartPlayer

The API key obtained in the ivideon personal account must be added to the SmartPlayer personal account. To do this, the user needs to log in to the SmartPlayer personal account and navigate to the "Settings" section.

Example of the "Settings" section in the SmartPlayer personal account

In the "Settings" section, the user needs to go to the "Integrations" block.

Example of the "Integrations" block in the settings

In this block, the user needs to configure the following parameters:

  • Activate the checkbox
  • Enter the API key value (must be copied from the ivideon personal account)
  • Select the type of events that will be used in the broadcast. In this case, only the values for "line crossing" and "zone entry" will be used.
Example of the filled-out parameters in the "Integrations" block

Creating a Broadcast for Playback in SmartPlayer with the Necessary Settings

To receive data from the ivideon service and make SmartPlayer correctly respond to these events, the user must create a broadcast with specially configured parameters.

This functionality is available in the following versions of the SmartPlayer client application:
  • Windows - ver. 2.41.7
  • Linux - ver. 2.41.7
  • Android - ver. 1.74.2 and above.
It is currently not implemented in the Web OS and Tizen OS client applications.

Server Application Setup:

  • Create a personal account on the required server application. When creating the personal account, the role must be set to "admin" with video analytics.
  • Manually create a broadcast in the personal account and configure the transitions for the required content and event values (actions for events).

Programming Part:

  • When implementing the programming part, "socket.io v.2" must be used. This solution is available at the following link.

Personal Account:

  • Interaction with the personal account occurs via the http(s) and webSocket protocols. Information about "socket.io v.2" is provided above.

Protocol Information:

  • restApi - used mostly for authorization and file handling.
  • Socket.io - used by most methods to interact with the personal account.

Authorization:

  • Information on obtaining the necessary tokens can be found at this link.
  • Information on properly configuring "join" can be found at this link.

Receiving the Broadcast:

  • A specific event can be used to get the list of broadcasts. Information on obtaining this event is available at this link.

After receiving the data, the user needs to select the desired event. From this object, they must take the ID, which will be used in the event described below.
Sending a Response Event:

  • The next step is to send another event, available at this link, with the necessary parameters.

The event with the correct parameters should switch the pages in the broadcast grid.

Creating a Broadcast in the Personal Account

After configuring the server part, the user can start preparing events for playback in the broadcast.
To begin working with events in the broadcast, the user must first log into the personal account.
The next step is to find the "Broadcasts" section in the personal account and select the "Create" category.

Example of the "Broadcasts" section and "Create" category in the personal account

After clicking on the "Create" category, a new window will open, displaying the entire interface for creating a broadcast.

Example of the broadcast creation interface in the personal account

Next, the user must create the required number of pages, depending on their needs. This action is done in the lower-left part of the screen by clicking a special icon in the form of a large "+" symbol.

Example of the ready pages and the icon for adding new pages in the personal account

After creating the required number of pages, the user must select a content zone on each page. This is done using a special icon in the form of a rectangle at the top of the screen.

Example of the icon for creating a content zone

When creating a zone, a toolbar with zone settings will open, allowing the user to configure the zone parameters.

Example of the toolbar with zone settings

After selecting the content zone, the user can individually customize the zone based on their needs.
Once the above steps are completed, the user needs to select the page with the content and open the page settings by clicking on the icon in the lower-left part of the personal account. The page settings will also open in the right toolbar, just like the content zone settings.

Example of the icon for accessing the page settings

In the page settings, the user needs to find the row with the "Event" parameter and click on the "+" icon.

Example of the row with the "Event" parameter

This action will open a new window with a list of events for this page.

Event Setup

After completing the actions described earlier, a window with event selection options will open for the user. There will be three available options in this window:

  1. Face recognition
  2. RFID tag
  3. Server application (the required option)
Example of event options during broadcast creation

The user selects the "Server application" event, and a new row for filling out the "Key" will be added. In this row, select the option "By payload."

Example of the "Key" field and its value

After selecting this key, another row - "Value" - will become available. In this row, the user must specify one of the special values:

Value Table
Name Value
Line crossing ivs.vca.line_detection.event/started
Entering the zone ivs.vca.field_detection.event.enter/started
Example of the field with the specified value

After completing all fields in the window, the user needs to click the "Save" button in the center of the screen.

Related Information

For further completion of broadcast setup, it is recommended to review the following Wiki pages:

Result

After completing the setup of the ivideon personal account, integration with the SmartPlayer server application, and configuring the broadcast using the event-driven model in the SmartPlayer personal account, the solution should start functioning. This setup will trigger and change the content whenever a person approaches the designated and configured zone on the camera.

Video Instruction

ivideon and SmartPlayer Integration Setup

Additional Information

If this article does not help use the functionality as intended or if there are still questions after reading, you can raise those questions in the "Discussion" section at the top of the page.

Example of the "Discussion" tab on the wiki page

Additional information can also be found on the page How to interact with the user in the "Discussion" section.