Skip to main content
Version: 4.55

playAudio

Plays an audio file.

Field Configurations

KeyTypeDescriptionDefault Value
"params" (required)Objectundefinednull

Parameters

KeyTypeDescriptionDefault Value
"async"BooleanSpecifies whether the action should perform asynchronously.null
"repeat"Boolean,StringSpecifies whether the audio file should be played in a loop.false
"url" (required)StringThe URL to the audio file.null

Inherited

From Base Action

Base Action

Field Configurations

KeyTypeDescriptionDefault Value
"dynamicParams"ObjectDynamic params to retrieve data from a specific context e.g. a userSetting.null
"leadingDelimiter"StringThe leading mustache delimiter to use.null
"params"Object,ArrayObject containing the properties of the action.null
"trailingDelimiter"StringThe trailing mustache delimiter to use.null
"type"StringType 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.