« Back to Product

Documentation

WFC_AudioNotification

Require: IP-Symcon >= 3.0

 boolean WFC_AudioNotification (int $InstanceID, string $Title, int $MediaID) 

Parameters

InstanceID

ID of the WebFront visualization

Title

Audio message title

MediaID

ID of the media object, which is of type "Sound”

Returns

If the command succeeds, it returns TRUE, otherwise FALSE.

Description

Sends an audio message with Title to the WebFront assigned to the configurator with the ID InstanceID. The audio message appears as a small box in the upper right corner of the WebFront and is displayed for the playback duration.

Warning

Please note that not all browsers support all formats: http://www.w3schools.com/tags/tag_audio.asp

Warning

To be able to play "media files" in the WebFront, these must be made available as links in the "visible" area of the WebFront. These can also be stored invisibly. If this is not done, the WebFront cannot access the file and an error, that the instance cannot be found, is displayed.

Warning

Under iOS this function has no effect, as Apple disables the playback of sound files in the WebBrowser!

Warning

Under Android Browser and Android Chrome this function has no effect, as Google prevents the playback of sound files in the WebBrowser!

Under Android Chrome, the automatic playback of sound files can be activated. To do this, "Disable motion request for media playback" has to be enabled under about:flags and then the browser has to be restarted.

Example

WFC_AudioNotification(12345, 'Gong!', 55541); //55541 is the ID of the media object in IP-Symcon
Any questions?