Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
Loading...
Searching...
No Matches
Fade label control

Table of Contents

Used to show multiple pieces of text in the same position, by fading from one to the other.

The fade label control is used for displaying multiple pieces of text in the same space in Kodi. You can choose the font, size, colour, location and contents of the text to be displayed. The first piece of information to display fades in over 50 frames, then scrolls off to the left. Once it is finished scrolling off screen, the second piece of information fades in and the process repeats. A fade label control is not supported in a list container.

Example

<control type="fadelabel" id="1">
<description>My First fadelabel</description>
<posx>80</posx>
<posy>60</posy>
<width>250</width>
<visible>true</visible>
<scrollout>true</scrollout>
<pauseatend>200</pauseatend>
<label>6</label>
<info>MusicPlayer.Genre</info>
<info>MusicPlayer.Artist</info>
<info>MusicPlayer.Album</info>
<info>MusicPlayer.Year</info>
<font>font14</font>
<textcolor>FFB2D4F5</textcolor>
<textoffsetx>20</textoffsetx>
<scroll>true</scroll>
<randomize>true</randomize>
</control>
info
const char struct KODI_ADDON_IMAGEDECODER_INFO_TAG * info
Definition kodi-dev-kit/include/kodi/c-api/addon-instance/ImageDecoder.h:410
width
const char const uint8_t size_t unsigned int * width
Definition kodi-dev-kit/include/kodi/c-api/addon-instance/ImageDecoder.h:416
label
label
Definition modules_cpp_peripheral_lifetime_diagram_1.dox:147

Tag descriptions

In addition to the Default Control Tags the following tags are available. Note that each tag is lower case only. This is important, as xml tags are case-sensitive.

Tag Description
label Specifies the text which should be drawn. You should specify an entry from the strings.po here, however you may also specify a piece of text yourself if you wish, though of course it will not be localisable. You may also specify more than one piece of information here by using the $INFO and $LOCALIZE formats.
info Specifies the information that should be presented. Kodi will auto-fill in this info in place of the <label>. See here for more information.
font Specifies the font to use from the font.xml file.
textcolor Specified the color the text should be, in hex AARRGGBB format, or a name from the colour theme.
textoffsetx Specify the offset from the left edge that the text should be rendered at when static (not scrolling). The scrolling text will still scroll using the full <width> of the control.
shadowcolor Specifies the color of the drop shadow on the text, in AARRGGBB format, or a name from the colour theme.
angle Specifies the angle at which the text should be drawn, measured counter clockwise from the horizontal.
scrollout If set to False the fadelabel will only scroll until the last char is to the right side of the width of the fadelabel instead of all the way out to the left.
pauseatend Specifies the time that the text will wait until it fades away before it scrolls again or moves to the next item.
resetonlabelchange If set to false the fadelabel will not reset the scrolling offset when the label's content changes. Useful if you have things such as the play time (in seconds) inside a fadelabel. Defaults to true.
scrollspeed Scroll speed of text in pixels per second. Defaults to 60.
scroll If set to false, the labels won't scroll. Defaults to true.
randomize If set to true, the labels will be displayed in a random order. Defaults to false.

See also

Development: