Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
Loading...
Searching...
No Matches
Progress Control

Table of Contents

Used to show the progress of a particular operation.

The progress control is used to show the progress of an item that may take a long time, or to show how far through a movie you are. You can choose the position, size, and look of the progress control.

Example

<control type="progress" id="12">
<description>My first progress control</description>
<posx>80</posx>
<posy>60</posy>
<width>250</width>
<height>30</height>
<visible>true</visible>
<reveal>false</reveal>
<texturebg>mybackgroundtexture.png</texturebg>
<lefttexture>mydowntexture.png</lefttexture>
<midtexture>mymidtexture.png</midtexture>
<righttexture>myrighttexture.png</righttexture>
<overlaytexture>myoverlaytexture.png</overlaytexture>
<info></info>
</control>
height
const char const uint8_t size_t unsigned int unsigned int * height
Definition kodi-dev-kit/include/kodi/c-api/addon-instance/ImageDecoder.h:417
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

Available tags

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
reveal If set to true the midtexture will reveal itself instead of stretching to fill the gap (works best when its the same size as texturebg)
texturebg Specifies the image file which should be displayed in the background of the progress control. See here for additional information about textures.
lefttexture Specifies the image file which should be displayed for the left side of the progress bar. This is rendered on the left side of the bar.
midtexture Specifies the image file which should be displayed for the middle portion of the progress bar. This is the fill texture used to fill up the bar. It's positioned on the right of the <lefttexture> texture, and fills the gap between the <lefttexture> and <righttexture> textures, depending on how far progressed the item is.
righttexture Specifies the image file which should be displayed for the right side of the progress bar. This is rendered on the right side of the bar.
overlaytexture Specifies the image file which should be displayed over the top of all other images in the progress bar. It is centered vertically and horizontally within the space taken up by the background image.
info Specifies the information that the progress bar is reporting on. See here for more information.

See also

Development: