Инструкция к виджету трансляции событий (Event Broadcast)

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

Компания SmartPlayer разработала виджет, который позволяет управлять трансляцией и событиями внутри неё с помощью кнопок на сенсорных экранах. Данный виджет позволяет создавать элементы управления — кнопки, к которым можно привязать реакции и события. Настроенный виджет можно использовать в качестве пульта управления трансляцией.

Добавление виджета в личный кабинет

Чтобы добавить данный виджет в личный кабинет, пользователю необходимо запросить у специалиста команды технической поддержки архив с содержимым. Он будет предоставлен в формате ZIP-архива.

Пример виджета в формате ZIP-архива

После этого пользователь должен авторизоваться в личном кабинете и перейти в раздел «Контент».

Пример отображения раздела «Контент» в личном кабинете

В разделе «Контент» необходимо перенести данный виджет из локального хранилища в личный кабинет. После того как пользователь перенесёт виджет в личный кабинет, он отобразится в списке контента.

Пример отображения переноса виджета в личном кабинете SmartPlayer

Главная страница виджета

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

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

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

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

Кнопка «Настройки»

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

Пример отображения разделения экрана в разделе «Настройки» виджета

В список настраиваемых параметров виджета входят:

• выбор языка — позволяет выбрать один из доступных языков для отображения интерфейса виджета. Доступны следующие языки: русский, английский, португальский, испанский и казахский;
• размер шрифта виджета — позволяет установить размер шрифта текста с помощью ползунка или числового значения;
• фон виджета — позволяет выбрать фон виджета с помощью палитры. Цвет внутри палитры можно указать с помощью HEX-кода, который можно подобрать с помощью общедоступных цветовых палитр;
• изображение фона виджета — позволяет выбрать изображение с помощью кнопки «Выберите изображение». Предварительно нужное изображение необходимо загрузить в личный кабинет SmartPlayer;
• масштаб кнопок — позволяет установить масштаб создаваемых в виджете кнопок с помощью ползунка или числового значения;
• тип кнопок — позволяет выбрать тип отображения кнопок на экране. Доступны два варианта: с прямыми углами и со скруглёнными углами;
• кнопка «Добавить кнопку» — добавляет на экран виджета кнопку, которая реагирует на нажатие;
• кнопка «Добавить группу кнопок» — добавляет на экран виджета кнопку с возможностью добавить в неё другие кнопки и разворачивать их по нажатию.

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

Настройки кнопок для событий трансляции

Кнопки «Добавить кнопку» и «Добавить группу кнопок» при нажатии изменяют интерфейс виджета и добавляют дополнительные параметры для настройки каждого варианта по отдельности.

Добавить кнопку

При нажатии на кнопку «Добавить кнопку» пользователь увидит изменения интерфейса в настройках виджета.

Пример отображения изменений интерфейса при нажатии «Добавить кнопку»

Для настройки добавленной кнопки пользователю необходимо изменить следующие параметры:

• название кнопки — указать текстовое название кнопки;
• идентификатор трансляции — указать ID трансляции, к которой будет привязана кнопка. ID можно скопировать из адресной строки при просмотре уже созданной трансляции;

Пример отображения ID трансляции

• имя события — неизменяемый параметр. По умолчанию установлено значение события «label»;
• значение события — указать значение события, установленное при настройке трансляции;
• изображение кнопки — после нажатия на кнопку «Выберите изображение» пользователь должен выбрать изображение кнопки из личного кабинета SmartPlayer. Рекомендуется загрузить изображение заранее.

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

Добавить группу кнопок

При нажатии на кнопку «Добавить группу кнопок» пользователь увидит изменения интерфейса в настройках виджета.

Пример отображения изменений интерфейса при нажатии «Добавить группу кнопок»

Для настройки добавленной группы кнопок пользователю необходимо изменить следующие параметры:

• имя группы — указать текстовое название группы;
• изображение кнопки — после нажатия на кнопку «Выберите изображение» пользователь должен выбрать изображение кнопки из личного кабинета SmartPlayer. Рекомендуется загрузить изображение заранее;
• кнопка «Добавить кнопку» — добавляет настройки кнопки, описанные в разделе выше. Данные параметры необходимо настроить. Добавленная здесь кнопка будет входить в группу.

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

Завершение настройки виджета

После завершения настройки виджета пользователь должен нажать на кнопку «Применить настройки» в правой нижней части экрана.

Пример отображения кнопки «Применить настройки»

Далее виджет развернётся на весь экран, и пользователь должен нажать на кнопку «Сохранить», расположенную внизу по центру экрана.

Пример отображения кнопки «Сохранить»

Загрузка и скачивание настроек

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

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

Серверная логика

При настройке параметров виджета, кнопок или групп кнопок, пользователь настраивает параметры, на которые реагирует серверное приложение SmartPlayer. Список параметров, на которые реагирует серверное приложение SmartPlayer:

• идентификатор трансляции;
• имя события;
• значение события.

Пример отображения параметров, взаимодействующих с сервером

Обратите внимание: пользователю необходимо настроить событие по следующему пути: «Добавить событие» в трансляции или в списке событий → выбрать событие «Серверное приложение» → ключ по полезной нагрузке → значение, то есть числовое значение события.

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

Добавление настроенного виджета в трансляцию

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

• Раздел "Устройства"
• Раздел "Контент на устройства"
• Раздел "Трансляции"
• Раздел "Расписание"
• Подключения и интеграция в SmartPlayer c использованием серверных событий

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

Инструкция к виджету трансляции событий (Event Broadcast)

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

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

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

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