BuiltinSound enum

Built-in synthesized audio clips shipped with flutter_confetti_engine.

All 10 clips are 100 % original, synthesized in Python, and released under the same MIT licence as the package — safe to redistribute. No external assets or pubspec.yaml entries needed.

// Pick a clip:
ConfettiEngine.celebrate(
  context,
  feedback: CelebrationFeedback(
    enableSound: true,
    builtinSound: BuiltinSound.fanfare,
  ),
);

// Auto-pick the best clip for a preset:
CelebrationFeedback.bundledForPreset(Preset.nova);

// Raw asset path for use with audioplayers directly:
AudioPlayer().play(AssetSource(BuiltinSound.levelUp.assetPath));

Inheritance

Object
Enum
BuiltinSound

Available extensions

EnumName

Values

pop → const BuiltinSound: Short, punchy confetti-popper snap (~0.4 s). Great for quick bursts — Preset.nova, Preset.crossfire.
chime → const BuiltinSound: Bright C-major bell chord with inharmonic overtones (~2.2 s). Great for streaming presets — Preset.cascade, Preset.flare.
fanfare → const BuiltinSound: Triumphant 4-note ascending brass fanfare (~1.6 s). Perfect for big achievement moments.
applause → const BuiltinSound: Crowd clapping and cheering (~2.0 s). Ideal for task completions, leaderboards, and congrats screens.
whoosh → const BuiltinSound: Fast, sweeping whoosh (~0.55 s). Great for swipe gestures, quick transitions, or speed rewards.
drumroll → const BuiltinSound: Accelerating snare roll ending in a cymbal crash (~1.6 s). Perfect for countdowns, reveals, or dramatic moments.
levelUp → const BuiltinSound: 8-bit style ascending arpeggio with chord tail (~1.0 s). Classic video game level-up feel — works with any burst preset.
bell → const BuiltinSound: Clear resonant D5 bell with long inharmonic decay (~2.2 s). Great for single-note dings, notifications, or gentle wins.
sparkle → const BuiltinSound: Magical high-frequency twinkling sparkle (~1.4 s). Perfect for emoji/star effects — ConfettiShowcase.starField, ConfettiShowcase.emojiPop.
airhorn → const BuiltinSound: Short, bold air-horn blast (~0.85 s). High-energy — great for sports wins, perfect scores, big milestones.

Properties

assetPath → String: Flutter asset path for this clip.
no setter
hashCode → int: The hash code for this object.
no setterinherited
index → int: A numeric identifier for the enumerated value.
no setterinherited
name → String: Available on Enum, provided by the EnumName extension
The name of the enum value.
no setter
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
toString() → String: A string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Constants

values → const List<BuiltinSound>: A constant List of the values in this enum, in order of their declaration.