Currency Rates Widget Instruction Manual

Материал из SmartPlayer

Widget Description

This widget is a functionality that allows displaying real-time information. The widget operates as a ticker with customizable parameters.

Adding Widget to Personal Account

To add this widget to your personal account, you need to request the widget from the technical support team. It will be provided as a ".zip" archive.

Example of widget as ".zip" archive

After receiving it, log in to your personal account and navigate to the "Content" section.

Example of "Content" section in personal account

In the "Content" section, drag and drop the widget from local storage to the "Content" area. After transferring, the widget will appear in the content list.

Example of widget transfer via drag-n-drop
If the personal account contains much content, use the sorting function and select "Widget" content type. This functionality allows viewing all widgets added to the personal account.
Example of proper sorting for easier widget search

Data Retrieval for Widget

The widget sends API requests to obtain prices. It receives two price types:

  • Last trade prices for instruments;
  • Trading session closing prices for instruments.

After receiving the response, the widget processes these prices for quotes and displays quote changes based on the data.
The widget then sends another API request containing these parameters:

  • Instrument relation (currency, stock, precious metals) to currency;
  • Icons for instrument display;

Upon receiving the response, the widget transforms the information and displays it on the device.

The widget's API operation uses a token that can be specified in widget settings.

Widget Configuration

Locate the widget in your personal account and double-click it to access the widget's main page.

Example of widget's main page display

Click the gear-shaped settings icon to access widget settings.

Example of settings icon display

The settings page contains three configuration types: 1. Basic settings - control widget operation; 2. Quote settings - manage quote display in the widget; 3. Debugging - handles information display parameters on the device. Below is the parameter list for each settings group.

Basic Settings

Parameter list in "Basic Settings" section:

  • Widget background - select background color for the ticker (use HEX code [reference](https://colorscheme.ru/html-colors.html));
  • Cache storage time - set cache storage duration in minutes;
  • Video placeholder - select video content to use as placeholder.
Example of "Basic Settings" display

Quotes Settings

Parameter list in "Quotes Settings" section:

  • Token - specify API connection token;
  • Request frequency - set request frequency in seconds;
  • Add quote - opens modal window for quote creation:
 ** Quote name - specify name for quote configuration;
 ** Instrument ID - enter instrument ID received via API;
 ** Lot to RUB ratio - specify number of lots per ruble.
Example of "Quotes Settings" display

Debugging

Parameter list in "Debugging" section:

  • Widget width in pixels - set widget width;
  • Screen segment height - specify segment height in pixels;
  • Segment width (segments 1-8) - set segment width in pixels;
  • X-axis segment offset (segments 1-8) - specify horizontal offset in pixels.
Example of "Debugging" settings display

Completing Widget Setup

After completing widget configuration, click "Apply Settings" in bottom right corner.
Example of "Apply Settings" button

The widget will expand to full screen - then click "Save" at bottom center.

Example of "Save" button display

Loading/Downloading Settings

While configuring the widget, users can upload/download settings. These actions are available via separate icons in widget interface (bottom center).

Example of settings upload/download icons

Adding Configured Widget to Broadcast

To fully explore this functionality, users need to launch a scheduled broadcast and add this widget as content. For steps on creating broadcasts and schedules, refer to these Wikipedia articles:

Video Tutorial

Currency Quotes Widget

Additional Information

If this article doesn't help or questions remain, please post them in the "Discussions" section at the top of the page.

Example of "Discussions" tab on wiki-page

More information available at Как взаимодействовать пользователю с разделом "Обсуждения"