Methods
📌 Summary Table
Music()
Music
Empty constructor.
Music(Track
track)
Music
Constructor from a Track
.
Music(string
tag)
Music
Constructor from a tag.
SetVolume(float
volume)
Music
Sets initial volume (0 – 1).
SetHearDistance(float
minHearDistance, float
maxHearDistance)
Music
Defines minimum and maximum hearing distances.
SetVolumeRolloffCurve(VolumeRolloffCurve
curve)
Music
Selects logarithmic or linear rolloff curve.
SetCustomVolumeRolloffCurve(AnimationCurve
customCurve)
Music
Applies a custom attenuation curve.
ChangeVolume(float
newVolume, float
lerpTime)
void
Changes volume during playback (smooth if lerpTime > 0).
SetPitch(float
pitch)
Music
Modifies pitch (and playback speed).
SetDopplerLevel(float
dopplerLevel)
Music
Sets Doppler effect intensity (0 – 5).
SetId(string
id)
Music
Assigns a unique identifier.
SetLoop(bool
loop)
Music
Enables or disables looping.
SetClip(string
tag)
Music
Assigns a clip by its tag.
SetClip(Track
track)
Music
Assigns a clip by Track
enum.
SetRandomClip(bool
random)
Music
Enables/disables random clip selection.
SetClipByIndex(int
index)
Music
Selects a specific clip by index.
SetPosition(Vector3
position)
Music
Sets the world position of the emitter.
SetFollowTarget(Transform
followTarget)
Music
Makes the source follow a target transform.
SetSpatialSound(bool
activate)
Music
Toggles 3D (true) or 2D (false) sound.
SetFadeOut(float
fadeOutTime)
Music
Defines the fade-out duration when stopping.
SetOutput(Output
output)
Music
Routes audio to a specific AudioMixerGroup.
OnPlay(Action
onPlay)
Music
Callback invoked at playback start.
OnComplete(Action
onComplete)
Music
Callback invoked at end or stop.
OnLoopCycleComplete(Action
onLoopCycleComplete)
Music
Callback each time a loop cycle completes.
OnPause(Action
onPause)
Music
Callback when paused.
OnPauseComplete(Action
onPauseComplete)
Music
Callback after pause fade-out ends.
OnResume(Action
onResume)
Music
Callback when resumed.
Play(float
fadeInTime)
void
Plays the music (optional fade-in).
Pause(float
fadeOutTime)
void
Pauses with optional fade-out.
Resume(float
fadeInTime)
void
Resumes with optional fade-in.
Stop(float
fadeOutTime)
void
Stops with optional fade-out.
📘 Detailed Description
Music
Music()
Music
Music()Empty constructor. You must assign a clip or tag before calling Play()
.
Music
Music(Track
track)
Music
Music(Track
track)Creates a new Music
instance using the specified Track
enum entry.
Music
Music(string
tag)
Music
Music(string
tag)Creates a new Music
instance using the tag registered in Audio Creator.
Music
SetVolume(float
volume)
Music
SetVolume(float
volume)Sets the initial volume, normalized between 0 (silent) and 1 (full volume).
Music
SetHearDistance(float
minHearDistance, float
maxHearDistance)
Music
SetHearDistance(float
minHearDistance, float
maxHearDistance)Defines the distance at which the music is fully audible and where it begins to fade in.
Music
SetVolumeRolloffCurve(VolumeRolloffCurve
curve)
Music
SetVolumeRolloffCurve(VolumeRolloffCurve
curve)Chooses between Logarithmic or Linear rolloff for distance attenuation.
Music
SetCustomVolumeRolloffCurve(AnimationCurve
customCurve)
Music
SetCustomVolumeRolloffCurve(AnimationCurve
customCurve)Applies a custom attenuation curve you provide.
void
ChangeVolume(float
newVolume, float
lerpTime)
void
ChangeVolume(float
newVolume, float
lerpTime)Changes the volume during playback. If lerpTime > 0
, the change is interpolated smoothly.
Music
SetPitch(float
pitch)
Music
SetPitch(float
pitch)Sets a fixed pitch, affecting both pitch and playback speed.
Music
SetDopplerLevel(float
dopplerLevel)
Music
SetDopplerLevel(float
dopplerLevel)Adjusts the Doppler effect intensity (range 0 – 5).
Music
SetId(string
id)
Music
SetId(string
id)Assigns a unique identifier so you can reference this music via SoundsGoodManager
.
Music
SetLoop(bool
loop)
Music
SetLoop(bool
loop)Enables (true
) or disables (false
) infinite looping.
Music
SetClip(string
tag)
Music
SetClip(string
tag)Assigns a clip by its tag from the Audio Creator configuration.
Music
SetClip(Track
track)
Music
SetClip(Track
track)Assigns a clip using the Track
enum entry.
Music
SetRandomClip(bool
random)
Music
SetRandomClip(bool
random)If true
, selects a random clip from the group on each Play()
call.
Music
SetClipByIndex(int
index)
Music
SetClipByIndex(int
index)Selects a specific clip by its index within the group's clip array.
Music
SetPosition(Vector3
position)
Music
SetPosition(Vector3
position)Sets the 3D world position from which the music is emitted.
Music
SetFollowTarget(Transform
followTarget)
Music
SetFollowTarget(Transform
followTarget)Makes the audio source follow the specified Transform
target.
Music
SetSpatialSound(bool
activate)
Music
SetSpatialSound(bool
activate)Toggles spatialized 3D audio (true
) or global 2D audio (false
).
Music
SetFadeOut(float
fadeOutTime)
Music
SetFadeOut(float
fadeOutTime)Defines how long the fade-out lasts when stopping the music.
Music
SetOutput(Output
output)
Music
SetOutput(Output
output)Routes the music to a given AudioMixerGroup
output.
Music
OnPlay(Action
onPlay)
Music
OnPlay(Action
onPlay)Invoked immediately at playback start.
Music
OnComplete(Action
onComplete)
Music
OnComplete(Action
onComplete)Invoked when playback ends or when you call Stop()
.
Music
OnLoopCycleComplete(Action
onLoopCycleComplete)
Music
OnLoopCycleComplete(Action
onLoopCycleComplete)Invoked at the end of each loop cycle, if looping is enabled.
Music
OnPause(Action
onPause)
Music
OnPause(Action
onPause)Invoked immediately when the music is paused.
Music
OnPauseComplete(Action
onPauseComplete)
Music
OnPauseComplete(Action
onPauseComplete)Invoked once the pause fade-out completes.
Music
OnResume(Action
onResume)
Music
OnResume(Action
onResume)Invoked when the music resumes after a pause.
void
Play(float
fadeInTime)
void
Play(float
fadeInTime)Plays the music. If fadeInTime > 0
, applies a fade-in.
void
Pause(float
fadeOutTime)
void
Pause(float
fadeOutTime)Pauses the music. If fadeOutTime > 0
, fades out before pausing.
void
Resume(float
fadeInTime)
void
Resume(float
fadeInTime)Resumes playback with optional fade-in.
void
Stop(float
fadeOutTime)
void
Stop(float
fadeOutTime)Stops the music. If fadeOutTime > 0
, applies a fade-out; if 0, stops immediately.
Last updated