Connection and integration in SmartPlayer using server events

Материал из SmartPlayer
Версия от 14:08, 26 сентября 2024; N.Bloshkin (обсуждение | вклад) (Новая страница: «== Situation Description == This page allows potential partners to connect and integrate into the SmartPlayer platform, as well as configure the ability to manage content using external events for broadcasts. By utilizing this functionality, the user can create more interactive and engaging broadcasts tailored to their needs. == Action Algorithm == === Integration with the Server Application === '''Server Application Preparation:''' * Create a personal ac...»)

Situation Description

This page allows potential partners to connect and integrate into the SmartPlayer platform, as well as configure the ability to manage content using external events for broadcasts. By utilizing this functionality, the user can create more interactive and engaging broadcasts tailored to their needs.

Action Algorithm

Integration with the Server Application

Server Application Preparation:

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

Programmatic Part:

  • When implementing the programmatic part, use "socket.io v.2." This solution is available at this link.

Personal Account:

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

Protocol Information:

  • restApi – used in most cases for authentication and file operations.
  • Socket.io – used by most methods for interacting with the personal account.

Authorization:

  • Information about obtaining the necessary tokens is available at this link.
  • Information on proper configuration for "join" is available at this link.

Fetching a Broadcast:

  • Using a specific event, you can retrieve a list of broadcasts. Information on retrieving the event is available at this link.

After receiving the data, you will need to select the desired event. From this object, 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.
    An event with the correct parameters should switch pages in the broadcast schedule.

Взаимодействие с личным кабинетом

После настройки серверной части пользователь сможет воспользоваться подготовкой событий для воспроизведения их в трансляции.
Чтобы начать работу с событиями в трансляции пользователю необходимо сначала авторизоваться в личном кабинете.
Следующим шагом пользователю найти в личном кабинете раздел "Трансляции" и выбрать категорию "Создать".

Пример отображения раздела "Трансляции" и категории "Создать" в личном кабинете

После нажатия по категории "Создать" пользователю откроется новое окно, в котором будет показан весь интерфейс для создания трансляции.

Пример отображения интерфейса создания трансляции в личном кабинете

Далее пользователю необходимо в зависимости от своих задач создать нужно количестве страниц. Данное действие делается в левой нижней части экрана по специальной иконке в виде большого символа "+".

Пример отображения готовых страниц и иконки для добавления новых страниц в личном кабинете

Создав нужное количество страниц, пользователь должен на каждой странице выбрать зону для контента. Это делается по специальной иконке в виде прямоугольника вверху экрана.

Пример отображения иконки создания зоны для контента

При создании зоны открывается тулбар с настройками зоны, в котором можно настраивать параметры зоны.

Пример отображения тулбара с настройками для зоны

После выделения зоны для контента пользователь может индивидуально настроить зону с контентом, в соответствии со своими нуждами.
Проделав действия, описанные выше пользователю необходимо выбрать страницу с контентом и открыть настройки страницы по иконке в левой нижней части личного кабинета. Настройки страницы откроются также в тулбаре справа, как и настройки для зоны контента.

Пример отображения иконки для перехода в настройки страницы

В настройках страницы пользователю необходимо найти строку с параметром "Событие" и нажать на иконку в виде "+".

Пример отображения строки с параметром "Событие"

Данное действие откроет новое окно со списком событий для данной страницы.

Список событий

На текущий момент доступно три события, каждый со своим ключевым параметром для активации:

Доступные события
Событие Ключи Значение
Распознавание лица По половому признаку Выбор пола
RFID метка По идентификатору
По полезной нагрузке
Указывается значение в обоих случаях
Серверное приложение По полезной нагрузке Указывается значение
Пример отображения списка доступных событий

После выбора нужного параметра и его ключа пользователю необходимо нажат на кнопку "Сохранить" в нижней части окна. Добавленные события можно просмотреть под параметром "События". Все добавленные события можно удалить по специальной иконке в виде мусорной корзины или же отредактировать по специальной иконки в виде карандаша.

Пример отображения иконок для взаимодействия с готовыми событиями для страницы

Связанная информация

Чтобы полностью использовать возможности, данной функциональность пользователю необходимо запустить трансляцию с расписанием и добавить в качестве контента данный виджет. Для ознакомления с описанными ранее шагами по созданию трансляции и расписания рекомендуется просмотреть следующие статьи из Wikipedia:

Видеоинструкция

Настройка трансляции с событиями в личном кабинете

Дополнительная информация

Если данная статья не помогает использовать функционал по назначению или после ее прочтения остаются вопросы можно озвучить данные вопросы в разделе "Обсуждения" вверху страницы.

Пример отображения вкладки "Обсуждения" на wiki-странице

Также дополнительную информацию можно узнать на странице Как взаимодействовать пользователю с разделом "Обсуждения"