playAudio

Plays the audio file specified by the URL.

note

Only file types supported by the operating system can be used.

Field Configurations

Key	Type	Description	Default Value
"params" (required)	Object	undefined	null

Parameters

Key	Type	Description	Default Value
"async"	Boolean	Specifies whether the action should perform asynchronously.	null
"repeat"	Boolean,String	Specifies whether the audio file should be played in a loop.	false
"url" (required)	String	The URL to the audio file.	null

Inherited

From Base Action

Base Action

Field Configurations

Key	Type	Description	Default Value
"dynamicParams"	Object	Dynamic params to retrieve data from a specific context e.g. a userSetting.	null
"leadingDelimiter"	String	The leading mustache delimiter to use.	null
"params"	Object,Array	Object containing the properties of the action.	null
"trailingDelimiter"	String	The trailing mustache delimiter to use.	null
"type"	String	Type name of the action.	null

Examples

Example 1: Play an audio file

Goal: Create an playAudio action playing an audio file in a loop.

To achieve this the following code can be used:

{
  "type": "playAudio",
  "params": {
    "url": "https://res.appframework.de/projects/demo-app/47.mp3",
    "repeat": true
  }
}

The repeat parameter specifies that the audio file is to be played in a loop.

Result:

An pauseAudio action has been created.