Audio Player

An Audio Player component is used to play audio. It accepts a URL as its value.

The Audio Player has a default UI that has some customization options. You can also disable the Audio Player UI and create your own using any of the available components and Actions.

Style Properties

Style properties allow you to customize the look and feel of the component. Combinations of styles applied to components can be saved as Stylesheets to easily reuse styles throughout your app. Styles can also be set dynamically using Variables. To learn more about all the different styling properties and how they work, take a look at Intro to Styling.

Component Specific Styles

Completed track colorColor of the completed portion of the track
Hide durationWhether the current duration text should be hidden or not
Hide toggle playback iconWhether the toggle playback icon/button should be hidden or not
Hide SliderWhether the slider should be hidden or not
Remaining track colorColor of the remaining portion of the track
Thumb colorSelect or create a color
Toggle playback icon colorColor of the toggle playback icon (pause/play icon)
Toggle playback icon sizeSize of the toggle playback icon (pause/play icon)

Configuration Properties

Component NameTo alter the name of the component. The name is reflected in the Components tree. Defaults to Audio Player.
ModeThe mode of the audio player. 'interface' to render an interface for the player, 'headless' to render nothing an be controlled only thorough actions and triggers.
Interruption modeHow the player should interact with the audio from other apps
Plays in backgroundDetermines if audio playback should stay active even when the app goes into background


When using the Plays in background prop on an Audio Player component, iOS automatically adds the Background Modes capability in Project Settings:

iOS Specific

Plays in silent modeWhether audio should play in silent mode or not

Android Specific

Plays through earpieceWhether audio should be routed to the earpiece or not

Data Properties

Source Text - URLThis input supports static text or variables, e.g. "https://myurl.ex/audio.mp3" or {{ url }}.

Conditional Display

You can conditionally display a component based on a given condition. Learn more about conditionally displaying components in the Conditional Display doc.


On Playback Status UpdateStarts the action when playback status is updated
On Playback FinishStarts the action when playback is finished


Play MediaPlays the media associated with the selected Target Component
Pause MediaPauses the media associated with the selected Target Component
Seek Media PositionUpdates play play position for the media associated with the selected Target Component in milliseconds
Toggle Media PlaybackPlays or pauses the media associated with a selected Target Component depending on the current playback state.