The audio component can display an audio given an src path as an argument. This could either be a local path from the assets folder or an external link.

If we had a local file in the assets folder named test.mp3 we could set url="/test.mp3" to view the audio file.

API Reference

rx.audio

Audio component share with Video component.

PropType | ValuesDefault
src
Union[str, list, list]
playing
bool
loop
bool
controls
bool
Var.create(True)
light
bool
volume
float
muted
bool
config
Dict[str, Any]

Event Triggers

See the full list of default event triggers
TriggerDescription
on_ready Called when media is loaded and ready to play. If playing is set to true, media will play immediately.
on_start Called when media starts playing.
on_play Called when playing is set to true.
on_playing Called when media starts or resumes playing after pausing or buffering.
on_progress Called while the video is loading only. Contains played and loaded progress as a fraction, and playedSeconds and loadedSeconds in seconds. eg { played: 0.12, playedSeconds: 11.3, loaded: 0.34, loadedSeconds: 16.7 }
on_time_update Called when the media's current time changes (~4Hz, use .throttle to limit calls to backend).
on_duration_change Callback containing duration of the media, in seconds.
on_pause Called when media is paused.
on_waiting Called when media starts buffering.
on_seeking Called when the media is seeking.
on_seeked Called when media seeks with seconds parameter.
on_rate_change Called when playback rate of the player changed. Only supported by YouTube, Vimeo (if enabled), Wistia, and file paths.
on_ended Called when media finishes playing. Does not fire when loop is set to true.
on_error Called when an error occurs whilst attempting to play media.
on_click_preview Called when user clicks the light mode preview.
on_enter_picture_in_picture Called when picture-in-picture mode is enabled.
on_leave_picture_in_picture Called when picture-in-picture mode is disabled.

Built with Reflex