AudioManager  1.3.0
A simple way for programmers to manage and control their 2D game’s background music and sound effects
Papae.UnitySDK.Managers.SoundEffect Class Reference

Structure and properties for a sound effect More...

Inheritance diagram for Papae.UnitySDK.Managers.SoundEffect:

Properties

string Name [get]
 Gets or sets the name of the sound effect. More...
 
float Length [get]
 Gets the length of the sound effect in seconds. More...
 
float PlaybackPosition [get]
 Gets the playback position in seconds. More...
 
AudioSource Source [get, set]
 Gets or sets the source of the sound effect. More...
 
float OriginalVolume [get, set]
 Gets or sets the original volume of the sound effect. More...
 
float Duration [get, set]
 Gets or sets the duration for the sound effect to play in seconds. More...
 
float Time [get, set]
 Gets or sets the time left or remaining for the sound effect to play in seconds. More...
 
float NormalisedTime [get]
 Gets the normalised time left for the sound effect to play. More...
 
Action Callback [get, set]
 Gets or sets the callback that would fire when the sound effect finishes playing. More...
 
bool Singleton [get, set]
 Gets or sets a value indicating whether this Papae.UnitySDK.Managers.SoundEffect is a singleton. More...
 

Detailed Description

Structure and properties for a sound effect

Property Documentation

◆ Callback

Action Papae.UnitySDK.Managers.SoundEffect.Callback
getset

Gets or sets the callback that would fire when the sound effect finishes playing.

The callback.

◆ Duration

float Papae.UnitySDK.Managers.SoundEffect.Duration
getset

Gets or sets the duration for the sound effect to play in seconds.

The duration.

◆ Length

float Papae.UnitySDK.Managers.SoundEffect.Length
get

Gets the length of the sound effect in seconds.

The length.

◆ Name

string Papae.UnitySDK.Managers.SoundEffect.Name
get

Gets or sets the name of the sound effect.

The name.

◆ NormalisedTime

float Papae.UnitySDK.Managers.SoundEffect.NormalisedTime
get

Gets the normalised time left for the sound effect to play.

The normalised time.

◆ OriginalVolume

float Papae.UnitySDK.Managers.SoundEffect.OriginalVolume
getset

Gets or sets the original volume of the sound effect.

The original volume.

◆ PlaybackPosition

float Papae.UnitySDK.Managers.SoundEffect.PlaybackPosition
get

Gets the playback position in seconds.

The playback position.

◆ Singleton

bool Papae.UnitySDK.Managers.SoundEffect.Singleton
getset

Gets or sets a value indicating whether this Papae.UnitySDK.Managers.SoundEffect is a singleton.

Meaning that only one instance of the sound effect is ever allowed to be active.

true if repeat; otherwise, false.

◆ Source

AudioSource Papae.UnitySDK.Managers.SoundEffect.Source
getset

Gets or sets the source of the sound effect.

The source.

◆ Time

float Papae.UnitySDK.Managers.SoundEffect.Time
getset

Gets or sets the time left or remaining for the sound effect to play in seconds.

The duration.


The documentation for this class was generated from the following file: