Skip to content

Audio ui-audio

Try Demo

Adds an audio player to the dashboard. The audio player can be controlled by the user or by control messages.

Properties

PropDynamicDescription
GroupDefines which group of the UI Dashboard this widget will render in.
SizeControls the width of the button with respect to the parent group. Maximum value is the width of the group.
SourceThe source is the url where the audio file can be fetched..
AutoplaySpecify whether the audio file will start playing automatically.
LoopSpecify whether the audio should be looping, i.e. start playing automatically again when ended.
MutedSpecify whether the audio should be muted.

Dynamic Properties

Dynamic properties are those that can be overriden at runtime by sending a particular msg to the node.

Where appropriate, the underlying values set within Node-RED will be overriden by the values set in the received messages.

PropPayloadStructuresExample Values
Sourcemsg.ui_update.sourceString
Autoplaymsg.ui_update.autoplay'on' | 'off'
Loopmsg.ui_update.loop'on' | 'off'
Mutedmsg.ui_update.muted'on' | 'off'

Controls

msg.ExampleDescription
enabledtrue | falseAllow control over whether or not the button is clickable.