The Audio widget

Available since version: 0.8.4 (2014)

Author: Markus Damman

Description

The audio widget embeds an audio file, which can be automatically played by incoming data

Settings

For a general understanding of how the configuration files are structured and what elements and attributes are it is recommended to read this section first: visu-config-details.

The behaviour and appearance of the Audio widget can be influenced by using certain attributes and elements. The following tables show the allowed attributes and elements and their possible values. The screenshots show, how both can be edited in the editor.

Attributes underlined by ..... are mandatory, all the others are optional and be omitted.

Allowed attributes in the Audio-element

Element	Attribute
	Name	Content	Description
audio	src	URI
	id	string
	threshold_value	string
	width	dimenstion (number+unit)
	height	dimenstion (number+unit)
	volume	string
	autoplay	string
	loop	string
	flavour	string	Selection of a display variant. See also :ref:’flavour’.
	class	string	Add this value to the CSS class so that it can be formated by a user provided style sheet.

Allowed child-elements und their attributes

Element	Attribute
Structure	Name	Content	Description
audio layout	colspan	decimal	Amount of coloumns this widget sould be wide.
	colspan-m	decimal	Overrules the amount of coloumns on a medium screen.
	colspan-s	decimal	Overrules the amount of coloumns on a small screen.
	rowspan	decimal	Amount of rows this widget should be high.
	x	string	Horizontal position of the widget for 2D pages.
	y	string	Vertical position of the widget for 2D pages.
	z	string	Reserved for future use.
	width	string	Width for the widget for 2D pages.

Element	Attribute
Structure	Name	Content	Description
audio label icon	name	string
	type	string
	flavour	string	Selection of a display variant. See also :ref:’flavour’.
	color	string
	styling	string
	class	string	Add this value to the CSS class so that it can be formated by a user provided style sheet.
audio label #text		string	Text to display a label for the widget.

Element	Attribute
Structure	Name	Content	Description
audio address	transform	string
	mode	disable, read, write or readwrite
	variant	string
	format-pos	decimal
audio address #text		string	The GA (like: 12/0/7) for KNX-backends or the item name for openHAB-backend

Examples

It is possible to manually edit the visu_config.xml and add an entry for the Audio widget.

Caution

Make sure that you only use UTF-8 encoded characters by settings the encoding in your XML-editor to UTF-8 mode!

Default example for defining an audio widget in the configuration

<audio id="audio_widget" src="path/to/audio_file.mp3">
  <layout colspan="4"/>
  <label>Audio</label>
  <address transform="DPT:1.001" mode="read">0/0/0</address>
</audio>

Footnotes

[1]	The simple view might not show everything. To see all elements/attributes use the expert view.