Integration of SmartPlayer with ivideon
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
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.
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
After logging into ivideon, the user will be presented with the main page of their personal account.
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."
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.
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.
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.
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.
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.
In this category, the user can change the camera password and set the desired one if they do not know it.
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."
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.
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."
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).
Отображение событий в личном кабинете ivideon
После настройки web-интерфейса камеры в личном кабинете ivideon пользователю начнут приходить события.
В разделе личного кабинета "События" пользователю необходимо отсортировать события с помощью фильтров.
Из имеющихся фильтров пользователю необходимо использовать фильтр по типу события:
- Пересечении линии
- Вход в зону
После применения фильтра в личном кабинете будут отображаться только отсортированные события, описанные выше.
Также нужно понимать, что хоть событие и не пришло в личный кабинет ivideon, но система его видела и засчитала. А это значит, что таймер в пять минут снова обновится и начнет отсчет.
Интеграция со SmartPlayer
Для интеграции со SmartPlayer пользователю в личном кабинете SmartPlayer необходимо сделать три действия:
- Добавить на нужное устройство камеру
- Создать API ключ в личном кабинете ivideon и с его помощью подключиться к SmartPlayer
- Подготовить серверное приложение и трансляцию/-ии с правильно настроенными событиями
Все эти пункты подробнее будут изложены ниже.
Добавление камеры на устройство используемое в трансляции SmartPlayer
Чтобы получать информацию об изменении состоянии камеры пользователю необходимо подключить ее к устройство, которое он будет использовать в трансляции. Данное действие можно сделать в личном кабинете SmartPlayer.
Изначально пользователю необходимо перейти в раздел "Устройства" личного кабинета.
Далее ему нужно найти нужное устройство, кликнуть по нему и в правом тулбаре перейти в раздел "Настройки".
В разделе настроек ему нужно найти категорию - "Камера" и открыть данную категорию.
Открыв категорию "Камера" пользователю необходимо будем нажать на кнопку "Добавить камеру" и заполнить следующие поля:
- Название камеры - ввести название камеры
- Идентификатор камеры - получить его можно в личном кабинете ivideon, в разделе "Информация о камере" (ID камеры)
Прием данных в SmartPlayer по API ключу от ivideon
Чтобы подключиться к SmartPlayer и получать события от ivideon пользователю необходимо получить API - ключ внутри личного кабинета ivideon. После получения API-ключа пользователю нужно будет добавит его в настройках личного кабинета SmartPlayer.
Создание API-ключа в личном кабинете ivideon
Чтобы получить API-ключ пользователю нужно перейти в раздел "Настройки" личного кабинета ivideon и перейти в категорию "Доступ и безопасность".
В открывшейся странице пользователю необходимо найти блок "Для разработчиков" и напротив строки "Ключи доступа к API" нажать кнопку "Открыть".
Открыв новую страницу, пользователь должен создать новый API ключ. Для этого ему необходимо в правом верхнем углу нажать на кнопку "Создать ключ". Также можно удалить все ключи на этой странице нажав на кнопку "Удалить все ключи".
В открывшемся окне обязательно нужно ввести имя ключа и нажать на кнопку "Продолжить". Кнопка "Продолжить" будет неактивна пока пользователь не введёт название ключа.
Следующее окно отобразит пользователю новый ключ, значение которого необходимо скопировать, нажав на специальную иконку рядом со строкой, в которой указано значение. Также необходимо активировать чекбокс (галочку) "Я скопировал ключ". Иначе пользователь не сможет завершить создание API ключа, потому что кнопка "Готово" будет неактивна.
Нажав на кнопку "Готово" пользователя вернет на страницу со списком ключей, где будет отображен новый ключ, который будет использоваться для подключения в SmartPlayer.
Применение API-ключа для интеграции со SmartPlayer
Полученный API-ключи в личном кабинете ivideon пользователь должен добавить в личный кабинет SmartPlayer. Для этого пользователю необходимо авторизоваться в личном кабинете SmartPlayer и перейти в раздел "Настройки".
В разделе "Настройки" пользователю необходимо перейти в блок "Интеграции".
В данной блоке пользователю необходимо настроить следующие параметры:
- Активировать чекбокс (галочку)
- Ввести значение API-ключа (должен быть скопирован из личного кабинете ivideon)
- Выбрать тип событий, которые будут использоваться в трансляции. В текущем кейсе будут использоваться только значения - "пересечения линии" и "вход в зону".
Создание трансляции для проигрывания в SmartPlayer с нужными настройками
Чтобы принимать данные с сервиса ivideon и заставить правильно реагировать на эти событие SmartPlayer пользователю необходимо создать трансляцию со специально настроенными параметрами.
- Windows - ver. 2.41.7
- Linux - ver. 2.41.7
- Android - ver. 1.74.2 и выше.
Подготовка серверного приложения:
- Создать личный кабинет на нужном серверном приложении. При создании личного кабинета необходимо выставить роль - "admin" с видеоаналитикой
- Вручную создать трансляцию в личном кабинете и настроить переходы для нужного контента и значениями событий (действиями для событий)
Программная часть:
- При реализации программной части необходимо использовать "socket.io v.2". Данное решение доступно по ссылке
Личный кабинет:
- Взаимодействие с личным кабинетом происходит по протоколу: http(s) и webSocket. Информация о "socket.io v.2" указана выше.
Информация по протоколам:
- restApi - используется в большинстве случаев для авторизации и работы с файлами
- Socket.io - используется большинством методов для работы с личным кабинетом
Авторизация:
- Информация о получении необходимых токенов можно получить по ссылке
- Информация о корректной настройки для "join" можно получить по ссылке
Получение трансляции:
- С помощью определенного события можно получить список трансляций. Информация о получении события доступна по ссылке.
После получения данных необходимо будет выбрать нужное событие. У этого объекта необходимо взять ID, который будет подставлен в событие, описанное ниже.
Отправка ответного события:
- Следующим шагом отправляется другое событие, доступное по ссылке, с нужными параметрами.
Событие с правильными параметрами должно переключать страницы в эфирной сетке.
Создание трансляции в личном кабинете
После настройки серверной части пользователь сможет воспользоваться подготовкой событий для воспроизведения их в трансляции.
Чтобы начать работу с событиями в трансляции пользователю необходимо сначала авторизоваться в личном кабинете.
Следующим шагом пользователю найти в личном кабинете раздел "Трансляции" и выбрать категорию "Создать".
После нажатия по категории "Создать" пользователю откроется новое окно, в котором будет показан весь интерфейс для создания трансляции.
Далее пользователю необходимо в зависимости от своих задач создать нужно количестве страниц. Данное действие делается в левой нижней части экрана по специальной иконке в виде большого символа "+".
Создав нужное количество страниц, пользователь должен на каждой странице выбрать зону для контента. Это делается по специальной иконке в виде прямоугольника вверху экрана.
При создании зоны открывается тулбар с настройками зоны, в котором можно настраивать параметры зоны.
После выделения зоны для контента пользователь может индивидуально настроить зону с контентом, в соответствии со своими нуждами.
Проделав действия, описанные выше пользователю необходимо выбрать страницу с контентом и открыть настройки страницы по иконке в левой нижней части личного кабинета. Настройки страницы откроются также в тулбаре справа, как и настройки для зоны контента.
В настройках страницы пользователю необходимо найти строку с параметром "Событие" и нажать на иконку в виде "+".
Данное действие откроет новое окно со списком событий для данной страницы.
Настройка события
Проделав действия, описанные ранее пользователю откроется окно с выбором событий. В данном окне будет три доступных варианта:
- Распознавание лица
- RFID метка
- Серверное приложение (нужный вариант)
Пользователь выбирает событие "Серверное приложение" и ему добавится новая строка для заполнения "Ключ". В ней необходимо выбрать вариант "По полезной нагрузке".
Выбрав данный ключ пользователю станет доступна еще одна строка - "Значение". В этой строке пользователь и должен указать одно из специальных значений:
| Название | Значение |
|---|---|
| Пересечение линии | ivs.vca.line_detection.event/started |
| Вход в зону | ivs.vca.field_detection.event.enter/started |
После завершения заполнения всех полей в окне пользователю необходимо нажать на кнопку "Сохранить" в центре экрана.
Связанная информация
Для дальнейшего завершения настройки трансляции рекомендуется ознакомиться со следующими Wiki-страницами
Итог
После завершения настройки личного кабинет ivideon, интеграции с серверными приложением SmartPlayer и настройки трансляции с использованием событийной модели в личном кабинете SmartPlayer должно начать функционировать. Данное решение будет проигрывать и изменять контент при любом приближении человека в рамках выбранной и настроенной на камере зоны.
Видеоинструкция
Настройка интеграции ivideon и SmartPlayer
Дополнительная информация
Если данная статья не помогает использовать функционал по назначению или после ее прочтения остаются вопросы можно озвучить данные вопросы в разделе "Обсуждения" вверху страницы.
Также дополнительную информацию можно узнать на странице Как взаимодействовать пользователю с разделом "Обсуждения"
