Eazy Sound Manager API Refrence
Audio Class |
The audio object
Inheritance Hierarchy
Namespace: Hellmade.Sound
Assembly: Assembly-CSharp (in Assembly-CSharp.dll) Version: 0.0.0.0
Syntax
C#
public class Audio
The Audio type exposes the following members.
Constructors
Properties
Name | Description | |
---|---|---|
Activated |
Whether the audio is created and updated at least once.
| |
AudioID |
The ID of the Audio
| |
AudioSource |
The audio source that is responsible for this audio. Do not modify the audiosource directly as it could result to unpredictable behaviour. Use the Audio class instead.
| |
Clip |
Audio clip to play/is playing
| |
DopplerLevel |
The doppler scale of the audio
| |
FadeInSeconds |
How many seconds it needs for the audio to fade in/ reach target volume (if higher than current)
| |
FadeOutSeconds |
How many seconds it needs for the audio to fade out/ reach target volume (if lower than current)
| |
IsPlaying |
Whether the audio is currently playing
| |
Loop |
Whether the audio will be lopped
| |
Max3DDistance |
(Logarithmic rolloff) MaxDistance is the distance a sound stops attenuating at.
| |
Min3DDistance |
Within the Min distance the audio will cease to grow louder in volume.
| |
Mute |
Whether the audio is muted
| |
Paused |
Whether the audio is paused
| |
Persist |
Whether the audio persists in between scene changes
| |
Pitch |
The pitch of the audio
| |
Priority |
Sets the priority of the audio
| |
ReverbZoneMix |
The amount by which the signal from the AudioSource will be mixed into the global reverb associated with the Reverb Zones.
| |
RolloffMode |
How the audio attenuates over distance
| |
SourceTransform |
The source transform of the audio.
| |
SpatialBlend |
Sets how much this AudioSource is affected by 3D spatialisation calculations (attenuation, doppler etc). 0.0 makes the sound full 2D, 1.0 makes it full 3D.
| |
Spread |
The spread angle (in degrees) of a 3d stereo or multichannel sound in speaker space.
| |
StereoPan |
Pans a playing sound in a stereo way (left or right). This only applies to sounds that are Mono or Stereo.
| |
Stopping |
Whether the audio is stopping
| |
Type |
The type of the Audio
| |
Volume |
The volume of the audio. Use SetVolume to change it.
|
Methods
Name | Description | |
---|---|---|
Pause |
Pause playing audio clip
| |
Play |
Start playing audio clip from the beggining
| |
Play(Single) |
Start playing audio clip from the beggining
| |
Resume |
Resume playing audio clip
| |
Set3DDistances |
Sets the Audio 3D distances
| |
SetVolume(Single) |
Sets the audio volume
| |
SetVolume(Single, Single) |
Sets the audio volume
| |
SetVolume(Single, Single, Single) |
Sets the audio volume
| |
Stop |
Stop playing audio clip
| |
UnPause |
Resume playing audio clip
| |
Update |
Update loop of the Audio. This is automatically called from the sound manager itself. Do not use this function anywhere else, as it may lead to unwanted behaviour.
|
See Also