Skip to main content

stopAudio

Stops any audio that the app may be playing.

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: Stopping Audio

Goal: Stop audio being played from the app.

To achieve this the following code can be used:

{
"type": "stopAudio"
}

Note that it does not require parameters.

Result:

All audio playing from the application will be stopped.