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

Материал из SmartPlayer
Нет описания правки
Нет описания правки
Строка 16: Строка 16:
{{Note|Для начала необходимо чтобы системный администратор со стороны клиента настроил правильную работу сервера с RSS и возможность подключаться к нашему серверу через API. |warn}}
{{Note|Для начала необходимо чтобы системный администратор со стороны клиента настроил правильную работу сервера с RSS и возможность подключаться к нашему серверу через API. |warn}}
После того, как, системный администратор клиента настроил работу приложения клиента с RSS, пользователь может начинать готовить контент для выведения на устройство.<br>
После того, как, системный администратор клиента настроил работу приложения клиента с RSS, пользователь может начинать готовить контент для выведения на устройство.<br>
Для этого в личном кабинете ему необходимо необходимо перейти в раздел "Контент" и находим раздел с текстом.<br>
Для этого в личном кабинете ему необходимо необходимо перейти в раздел "Контент" и просмотреть доступные варианты контента. Ему необходимо выбрать текстовый контент.<br>
Кликнув на кнопку "Добавить новый текст", откроется новая страница с параметрами, которые необходимо настроить.
Кликнув на кнопку "Добавить новый текст", откроется новая страница с параметрами, которые необходимо настроить.
[[File:Путь до текстового контента.png|thumb|center | Путь до текстового контента|800px]]
[[File:Путь до текстового контента.png|thumb|center | Путь до текстового контента|800px]]
=== '''Настройка контента "Текст"''' ===
==='''Настройка контента "Текст"''' ===
[[File:Ид компании.png|thumb|right | Расположение ID - Company|300px]]
==== '''Подготовка''' ====
[[File:Ид компании.png|thumb|right | Расположение ID - Company|150px]]
Для начала системный администратор со стороны пользователя уже должен настроить работу с помощью RSS - запроса и отправить URL, для подключения по API.<br>
Для начала системный администратор со стороны пользователя уже должен настроить работу с помощью RSS - запроса и отправить URL, для подключения по API.<br>
URL будет выглядеть примерно так:<br>
URL будет выглядеть примерно так:<br>
<code>https://rc-api.smartplayer.org/v2/company-rss/feed/54</code><br>
<code>https://rc-api.smartplayer.org/v2/company-rss/feed/54</code><br>
В данном случае заместо последний цифры(54) в запросе идёт - Company ID.  
В данном случае заместо последний цифры (54) в запросе идёт - Company ID.  
Его можно просмотреть в личном кабинете на иконку пользователя.
Его можно просмотреть в личном кабинете на иконку пользователя.
[[File:Тип источника.png|thumb|right | Варианты источников|300px]]
==== '''Работа с контентом типа "Текст"''' ====
Далее вставляем URL нашего сваггера в раздел "RSS - источника" и нажимаем иконку просмотра.
Для начала необходимо найти раздел "Контент" и выбрать в нём подходящий тип контента. В нашем случае это текст.
[[File:Раздел контент.png|thumb|center | Блок "Контент" в личном кабинете|300px]]
Следующим шагом - пользователь должен создать новый текстовый контент по кнопке.
[[File:Путь текстового контента.png|thumb|center | Текстовый контент|800px]]
После нажатия кнопки "Добавить новый текст" откроется окно настроек.<br>
[[File:Окно настроек текста.png|thumb|center | Окно настроек текста|800px]]
Внутри окна первое на что нужно обратить внимание, строка -  "Выбрать тип источника". В этой строке выбираем вариант "URL-источник".
После проведённых манипуляций вставляем URL нашего сваггера в раздел "RSS - источника" и нажимаем иконку просмотра.
[[File:Тип источника.png|thumb|center | Варианты источников|300px]]
{{Note|''Swagger/сваггер'' (или OpenAPI) - это инструмент для создания, документирования и тестирования веб-API. Он помогает разработчикам легко понимать и работать с API, предоставляя визуальное представление и автоматически создаваемую документацию. |warn}}
{{Note|''Swagger/сваггер'' (или OpenAPI) - это инструмент для создания, документирования и тестирования веб-API. Он помогает разработчикам легко понимать и работать с API, предоставляя визуальное представление и автоматически создаваемую документацию. |warn}}
Далее сервер SmartPlayer распарсивает URL и позволяет выбрать поле, которое будет показываться клиентским приложением.<br>
Далее сервер SmartPlayer распарсивает URL. Данные по распаршенной ссылку будут выглядеть примерно так:
В данном случае это будет поле (из скрина)<br>
[[File:Распаршенный URL.png|thumb|center | Пример распаршенного URL |300px]]<br>
Следующим этапом необходимо выбрать нужную строку для создания из нее шаблона запроса.
[[File:Нужная строка.png|thumb|center | Пример нужной строки для шаблона|300px]]<br>
После клика по нужной строке - сформируется шаблон строки.
После клика по нужной строке - сформируется шаблон строки.
Перед ним, в строке, необходимо текстом указать "что за информация" будет выводиться.
Перед ним, в строке, необходимо текстом указать "что за информация" будет выводиться.
Получится так что в шаблоне будет статичная часть строки - которую прописывает пользователь и динамическая часть строки - которой является шаблон.<br>
Получится так что в шаблоне будет статичная часть строки - которую прописывает пользователь и динамическая часть строки - которой является шаблон.<br>
[[File:Окно редактур контента.png|thumb|center | Примеры параметров контента "Текст"|800px]]
При желании пользователя можно будет поменять внешний вид контента. Из параметров которые можно настроить:  
При желании пользователя можно будет поменять внешний вид контента. Из параметров которые можно настроить:  
* Редактирование текста
* Редактирование текста

Версия от 14:45, 15 сентября 2023

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

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

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

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

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

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

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

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

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

После того, как, системный администратор клиента настроил работу приложения клиента с 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 будет обращаться на сервер за новыми данными)

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

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

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

Создание расписания

Заходим в раздел "Расписание".

Источник — https://wiki.smartplayer.org/index.php?title=Динамический_контент_через_RSS_ленту_(пользовательская_версия)&oldid=10207