AudioPlayer Component

Table of Contents


AudioPlayer component provides the functionality to play the specified sound file, both triggered from browser events and when the specified condition evaluated on server side data occurs.

Available Properties

name (Required): Name of the component. Default is AudioPlayer
soundFile(Required): The URL of the sound file to be played.

Additional Properties

url (Optional): The default URL to be used for requests to the server to retrieve the data.
playCondition (Optional): The javascript expression evaluated on received data to determine whether the sound file will be played or not. Default is "true".

To write playCondition expression following javascript objects are available
  •  params.response: Javascript object which represents the server side response object
  •  params.xmlObject: Root node of the javascript xml dom object if the server side response is in XML format
 Following playConditions evaluate to "true" for the following server side response:

 params.xmlObject.getAttribute('shouldPlay') == 'true'
 params.xmlObject.getElementsByTagName('ChildTag') == 3

 

 <Response shouldPlay="true">
    <ChildTag name="child1"/>
    <ChildTag name="child2"/>
    <ChildTag name="child3"/>
</Response>

volume(Optional): The percentage of the sound volume. Default is 100.
pollingInterval(Optional): Time delay between two server requests.
timeout (Optional):The time interval in seconds to wait the server request completes successfully before aborting.

Available Actions

Clone: Creates a copy of the component with same properties
Delete: Deletes the component

Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.