🟧
Sounds Good Documentation
English
English
  • Welcome!
  • FIRSTS STEPS
    • Create your first sound
  • Create and use audio outputs
  • Included Prefabs
  • Update from 1.0 to 2.0
  • DOCUMENTATION
    • Assemblies and Namespaces
    • Prefixes
    • Audio objects
      • Sound
        • Properties
        • Methods
      • Music
        • Properties
        • Methods
      • Playlist
        • Properties
        • Methods
      • DynamicMusic
        • Properties
        • Methods
    • Editor windows
      • Audio Creator
      • Audio Collection
      • Output Manager
    • SoundsGoodManager
  • Extras
    • Credits
    • Acknowledgments
Powered by GitBook
On this page
  • πŸ“Œ Summary Table
  • πŸ“˜ Detailed Description
  1. DOCUMENTATION
  2. Audio objects
  3. DynamicMusic

Properties

πŸ“Œ Summary Table

Property
Type
Short Description

Using

bool

True if the dynamic music is in use, even if it’s paused.

Playing

bool

True if the dynamic music is currently playing.

Paused

bool

True if the dynamic music is paused, ignoring any fade-out.

PlayingTime

float

Total time (in seconds) the dynamic music has been playing.

CurrentLoopCycleTime

float

Current time (in seconds) of the active loop cycle.

CompletedLoopCycles

int

Number of completed loop cycles.

ClipDuration

float

Duration of each clip in seconds (all stems should match length).

Clips

AudioClip[]

Array of audio clips that compose the dynamic music.


πŸ“˜ Detailed Description

bool Using

Returns true if the dynamic music is in use. This includes both active playback and paused states, as long as it’s still assigned to one or more AudioSource instances.


bool Playing

Returns true if the dynamic music is actively playing. Returns false if it’s paused or stopped.


bool Paused

Returns true if the dynamic music is paused. This property is unaffected by any fade-out effects.


float PlayingTime

Total time (in seconds) that has elapsed since the dynamic music began playing.


float CurrentLoopCycleTime

Elapsed time (in seconds) of the current loop cycle. If looping is disabled, this value matches the elapsed time of the current clip.


int CompletedLoopCycles

Number of times the dynamic music has completed a full loop cycle since starting. Only increments if looping is active.


float ClipDuration

Duration (in seconds) of each clip. All clips are assumed to share the same length, so this reflects the length of the first clip.


AudioClip[] Clips

Array containing all AudioClip stems that form the dynamic music. Each clip typically represents a separate instrumental layer you can control independently.


PreviousDynamicMusicNextMethods

Last updated 16 days ago