Динамический контент через RSS ленту (пользовательская версия)

Описание ситуации

Периодически у пользователей появляется необходимость вывести какую-нибудь дополнительную текстовую информацию на устройстве совместно с основной трансляцией. Для этого можно запускать динамический контент через RSS ленту в трансляции.

Для чего это можно использовать

Такой контент хорошо подходит для нескольких форматов:

• Вывода статичного текстового контента на устройства
• Вывода динамического контента (бегущих дорожек) на устройства
• Создание "контента", схожего с информационным табло и последующим вывод его на устройства

Логика работы

1. Сначала системный администратор настраивает работу приложения пользователя через RSS.
2. Далее необходимо чтобы пользователь в личном кабинете создал подходящий вид контента, описанного выше.
3. Следующим этапом будет идти "Создание трансляции"
4. Предпоследний действием будет создание расписания для трансляции
5. Вывод нужного контента на устройства

Логика работы функционала

Принцип действия

Для начала необходимо чтобы системный администратор со стороны клиента настроил правильную работу сервера с RSS и возможность подключаться к нашему серверу через API. Инструкцию по настройке можно найти в статье: Динамический контент через RSS ленту (версия для системного администратора)

После того, как, системный администратор клиента настроил работу приложения клиента с RSS, пользователь может начинать готовить контент для выведения на устройство.
Для этого в личном кабинете ему необходимо необходимо перейти в раздел "Контент" и просмотреть доступные варианты контента. Ему необходимо выбрать текстовый контент.
Кликнув на кнопку "Добавить новый текст", откроется новая страница с параметрами, которые необходимо настроить.

Путь до текстового контента

Настройка контента "Текст"

Подготовка

Расположение ID - Company

Для начала системный администратор со стороны пользователя уже должен настроить работу с помощью RSS - запроса и отправить URL, для подключения по API.
URL будет выглядеть примерно так:
https://rc-api.smartplayer.org/v2/company-rss/feed/54
В данном случае заместо последний цифры (54) в запросе идёт - Company ID. Его можно просмотреть в личном кабинете на иконку пользователя.

Работа с контентом типа "Текст"

Для начала необходимо найти раздел "Контент" и выбрать в нём подходящий тип контента. В нашем случае это текст.

Блок "Контент" в личном кабинете

Следующим шагом - пользователь должен создать новый текстовый контент по кнопке.

Текстовый контент

После нажатия кнопки "Добавить новый текст" откроется окно настроек.

Окно настроек текста

Внутри окна первое на что нужно обратить внимание, строка - "Выбрать тип источника". В этой строке выбираем вариант "URL-источник". После проведённых манипуляций вставляем URL нашего сваггера в раздел "RSS - источника" и нажимаем иконку просмотра.

Варианты источников

Swagger/сваггер (или OpenAPI) - это инструмент для создания, документирования и тестирования веб-API. Он помогает разработчикам легко понимать и работать с API, предоставляя визуальное представление и автоматически создаваемую документацию.

Далее сервер SmartPlayer распарсивает URL. Данные по распаршенной ссылку будут выглядеть примерно так:

Пример распаршенного URL

Следующим этапом необходимо выбрать нужную строку для создания из нее шаблона запроса.

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

После клика по выделенной строе - сформируется шаблон с параметрами. Он отобразится в пустой строке сверху. Перед параметрами, в строке, необходимо текстом прописать какая информация будет выводиться.

Пример шаблона

В итоге, внутри шаблона будет статичная часть строки - которую прописывает пользователь и динамическая часть строки - которой является шаблон.

Дополнительные возможности

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

• Частота обновления информации (как часто клиентское приложение SmartPlayer будет обращаться на сервер за новыми данными)
• Шрифт
• Размер шрифта
• Цвет шрифта
• Выравнивание текста
• "Жирный" текст
• Курсивный текс
• Подчеркнутый текст

Список настроек для редактирования текста

Последний шаг - нажимаем на кнопку "Сохранить"

Создание трансляции

Следующим этапом идёт создание трансляции.
Пользователю необходимо перейти в раздел "Трансляции".

Раздел "Трансляция" в личном кабинете

Далее ему необходимо разделить "окно контента" на зоны и заполнить их нужным контентом.

Зоны контента

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

Строка для переименования трансляции

Создание расписания для устройства

Для создания расписания пользователю необходимо найти своё устройство в разделе "Устройство". Выбрав своё устройство он находит в списке раздел "Расписание"

путь до расписания

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

Добавление расписания

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

Стандартные параметры расписания

Дополнительные параметры расписания можно увидеть нажав на клавишу "Ещё".

Развёрнутые параметры расписания

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

Итоговый результат

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