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

Description of the Situation

SmartPlayer has developed a widget that allows users to control a broadcast and the events within it using buttons on touch screens. This widget makes it possible to create control elements (buttons) to which reactions and events can be assigned. The configured widget can be used as a remote control for managing a broadcast.

Adding the Widget to the Personal Account

To add this widget to the personal account, the user must request the archive containing the widget from a SmartPlayer technical support specialist. It will be provided as a ZIP archive.

Example of the widget provided as a ZIP archive

After that, the user must log in to the personal account and navigate to the Content section.

Example of the Content section in the personal account

In the Content section, the widget must be transferred from local storage to the personal account. Once the user uploads the widget, it will appear in the content list.

Example of transferring the widget to the SmartPlayer personal account

Widget Main Page

After transferring the widget to the personal account, the user must double-click the widget icon to perform the initial configuration. The widget's main page will then open.

Example of the widget's main page

On the widget's main page, the user can click the gear icon to open the widget settings.

Example of the icon used to open the widget settings

The "Settings" Button

After opening the widget settings, the user will see a list of configurable parameters on the left side of the screen. The right side contains the widget preview area, where all changes are displayed.

Example of the screen layout in the widget's Settings section

The widget settings include the following parameters:

• Language Selection — allows the user to choose one of the available interface languages. The following languages are available: Russian, English, Portuguese, Spanish, and Kazakh;
• Widget Font Size — allows the user to set the text font size using a slider or a numeric value;
• Widget Background — allows the user to select the widget background color using a color palette. The color can also be specified using a HEX code selected from any publicly available color palette;
• Widget Background Image — allows the user to select an image using the Select Image button. The required image must first be uploaded to the SmartPlayer personal account;
• Button Scale — allows the user to set the size of the buttons created in the widget using a slider or a numeric value;
• Button Type — allows the user to choose the button appearance. Two options are available: square corners or rounded corners;
• Add Button — adds a clickable button to the widget;
• Add Button Group — adds a button that can contain other buttons and expand when pressed.

Example of the widget configuration parameters

Configuring Buttons for Broadcast Events

Clicking the Add Button or Add Button Group buttons changes the widget interface and displays additional settings specific to each option.

Add Button

After clicking the Add Button button, the widget settings interface changes.

Example of the interface after clicking Add Button

To configure the added button, the user must specify the following parameters:

• Button Name — specify the button label;
• Broadcast Identifier — specify the ID of the broadcast associated with the button. The ID can be copied from the browser address bar while viewing an existing broadcast;

Example of a broadcast ID

• Event Name — a fixed parameter. By default, the event name is label;
• Event Value — specify the event value configured in the broadcast settings;
• Button Image — after clicking the Select Image button, the user must select an image for the button from the SmartPlayer personal account. It is recommended to upload the image in advance.

Example of button settings

Add Button Group

After clicking the Add Button Group button, the widget settings interface changes.

Example of the interface after clicking Add Button Group

To configure the newly added button group, the user must specify the following parameters:

• Group Name — specify the group name;
• Button Image — after clicking the Select Image button, the user must select an image from the SmartPlayer personal account. It is recommended to upload the image in advance;
• Add Button — adds the button settings described in the previous section. These settings must be configured. The newly added button will become part of the group.

Example of button group settings

Completing the Widget Configuration

After configuring the widget, the user must click the Apply Settings button in the lower-right corner of the screen.

Example of the Apply Settings button

The widget will then expand to full screen, and the user must click the Save button located at the bottom center of the screen.

Example of the Save button

Importing and Exporting Settings

While working with the widget settings, the user can upload previously saved settings or download the current widget configuration. Each action is performed using a separate icon in the widget interface. These icons are located at the bottom center of the widget.

Example of the icons used for importing and exporting widget settings

Server Logic

When configuring the widget, buttons, or button groups, the user defines the parameters that the SmartPlayer server application responds to. The SmartPlayer server application responds to the following parameters:

• broadcast identifier;
• event name;
• event value.

Example of the parameters used for server interaction

Please note: the user must configure the event using the following path: Add Event in the broadcast or in the event list → select the Server Application event → Key by Payload → Value (the numeric event value).

When the widget is configured correctly, every touch interaction will cause the server application to perform the assigned action, such as switching to another content page.

To configure this correctly, review the documentation listed in the section below. Pay particular attention to the documentation on server events.

Adding the Configured Widget to a Broadcast

To fully understand how this functionality works, the user must launch a scheduled broadcast and add this widget as content. Detailed information about creating broadcasts and schedules is available in the following SmartPlayer Wiki articles:

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

Video Tutorial

Event Broadcast Widget Guide (Event Broadcast)

Additional Information

If this article does not help you use the functionality as intended or if you still have questions after reading it, you can ask them in the Discussions section at the top of the page.

Example of the Discussions tab on a wiki page

Additional information is also available on the page Как взаимодействовать пользователю с разделом "Обсуждения".