zui docs v0.0.5
GitHub ↗
Multimedia and capture Native Qt

Sound Effect

Sound Effect is a native Zui component in the multimedia and capture catalog, with 8 component-specific properties.

Usage

Ruby example

Paste this complete Builder example inside the app surface from the Quickstart. Replace illustrative asset paths with files from your project.

Ruby
sound_effect "assets/complete.ogg", volume: 0.7, playback: :play, command_revision: 1
API

Component properties

8 component-specific values, plus shared item and layout properties.

sourceSource configuration for Sound Effect.property
loopsLoops configuration for Sound Effect.property
volumeVolume configuration for Sound Effect.property
mutedMuted configuration for Sound Effect.property
playbackPlayback configuration for Sound Effect.property
commandCommand configuration for Sound Effect.property
command_revisionCommand revision configuration for Sound Effect.property
visibleVisible configuration for Sound Effect.property
Show 16 shared item properties
enabledopacityscalerotationzwidthheightfill_widthfill_heightpreferred_widthpreferred_heightminimum_widthminimum_heightmaximum_widthmaximum_heightlayout_alignment
Interaction

Events

Subscribe with on widget, :event and keep behavior in Ruby.

playNative event payload
stopNative event payload
statusNative event payload
errorNative event payload
loops_remainingNative event payload