🟧
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
  • bool Using
  • bool Playing
  • bool Paused
  • float Volume
  • int ClipIndex
  • float PlayingTime
  • float CurrentLoopCycleTime
  • int CompletedLoopCycles
  • float ClipDuration
  • AudioClip Clip
  1. DOCUMENTATION
  2. Audio objects
  3. Sound

Properties

πŸ“Œ Summary table

Property
Type
Short description

Using

bool

true when the sound is in useβ€”even if paused.

Playing

bool

true while the sound is actively playing.

Paused

bool

true when the sound is paused (fade-out ignored).

Volume

float

Current volume level (0 – 1).

ClipIndex

int

Index of the clip being played; returns -1 if none is specified.

PlayingTime

float

Total time (in seconds) the sound has been playing.

CurrentLoopCycleTime

float

Elapsed time (in seconds) of the current loop cycle.

CompletedLoopCycles

int

Number of loop cycles completed.

ClipDuration

float

Total duration of the clip now playing.

Clip

AudioClip

Reference to the clip currently being played.


πŸ“˜ Detailed description

bool Using

Returns true when the sound is occupying an AudioSource. This includes both active playback and paused states.


bool Playing

Returns true only while the sound is actively playing. If the sound is paused or stopped, this property is false.


bool Paused

Returns true if the sound is currently paused. Unlike Playing, it disregards any fade-out effect and focuses on the actual paused state.


float Volume

Represents the current volume of the sound, normalised between 0 (silent) and 1 (maximum).


int ClipIndex

Indicates the index of the clip being played within the sound’s clip array. If no specific clip is selected, returns -1.


float PlayingTime

Total time in seconds that the sound has been playing since it last started.


float CurrentLoopCycleTime

Elapsed time of the current loop cycle in seconds. If looping is disabled, this value matches the total playing time.


int CompletedLoopCycles

Number of times the sound has fully completed a loop cycle. Increments only when looping is enabled.


float ClipDuration

Total duration in seconds of the clip currently playing. Returns 0 if no clip is assigned.


AudioClip Clip

Direct reference to the AudioClip being played. Useful for accessing its properties or comparing it with other clips.


PreviousSoundNextMethods

Last updated 17 days ago