Audio Player

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

Adding an Audio Player component

To add a Star Rating to your app screen:

  • Select the Audio Player component from the Components drawer. You can open the list of components by clicking the + button next to Components.
  • In the Data tab (third tab) in the Properties Panel, add the URL of the Audio file to be played.

In the example above, we're adding a static audio file URL in the URL input data tab. This input field also accepts data variables when placed inside curly braces {{someVariable}}.

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

PropertyDescription
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

PropertyDescription
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

iOS Specific

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

Android Specific

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

Data Properties

PropertyDescription
Source Text - URLThis input supports static text or data & variables through the use of brackets, ie "{{variable}}". For example, you could use "Hello {{name}}" or "https://reddit.com/r/{{subreddit}}"

Conditional Display

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

Triggers

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