Class AudioSourcePlayer
Audio Player that uses an AudioSource to play the audio
Inherited Members
Namespace: Doozy.Runtime.Soundy
Assembly: cs.temp.dll.dll
Syntax
public class AudioSourcePlayer : AudioPlayerProperties
autoPaused
Check if the audio player is paused by checking if it is in use, if it is playing and if the audio source is not playing. This is a special case to handle the fact that the audio source is not playing when the game is paused.
Declaration
protected override bool autoPaused { get; }Property Value
| Type | Description |
|---|---|
| Boolean |
Overrides
clip
Audio clip that will be played
Declaration
public override AudioClip clip { get; set; }Property Value
| Type | Description |
|---|---|
| AudioClip |
Overrides
dopplerLevel
Doppler scale for the audio clip
Declaration
public override float dopplerLevel { get; set; }Property Value
| Type | Description |
|---|---|
| Single |
Overrides
ignoreListenerPause
Allows AudioSource to play even though AudioListener.pause is set to true
Declaration
public override bool ignoreListenerPause { get; set; }Property Value
| Type | Description |
|---|---|
| Boolean |
Overrides
maxDistance
(Logarithmic rolloff) MaxDistance is the distance a sound stops attenuating at
Declaration
public override float maxDistance { get; set; }Property Value
| Type | Description |
|---|---|
| Single |
Overrides
minDistance
Within the Min distance the AudioSource will cease to grow louder in volume
Declaration
public override float minDistance { get; set; }Property Value
| Type | Description |
|---|---|
| Single |
Overrides
mute
Mute flag for the audio clip
Declaration
public override bool mute { get; set; }Property Value
| Type | Description |
|---|---|
| Boolean |
Overrides
outputAudioMixerGroup
Audio mixer group that the audio will be routed through
Declaration
public override AudioMixerGroup outputAudioMixerGroup { get; set; }Property Value
| Type | Description |
|---|---|
| AudioMixerGroup |
Overrides
panStereo
Pan the playing audio in a stereo way (left or right)
Declaration
public override float panStereo { get; set; }Property Value
| Type | Description |
|---|---|
| Single |
Overrides
pitch
Pitch to play the audio clip at
Declaration
public override float pitch { get; set; }Property Value
| Type | Description |
|---|---|
| Single |
Overrides
priority
Priority of the AudioSource
Declaration
public override int priority { get; set; }Property Value
| Type | Description |
|---|---|
| Int32 |
Overrides
source
Returns the AudioSource component reference that this player uses to play the audio. If the reference is null, it will try to get it from the GameObject. If the reference is still null, it will add an AudioSource component to the GameObject. This never returns null.
Declaration
public AudioSource source { get; }Property Value
| Type | Description |
|---|---|
| AudioSource |
spatialBlend
How much the audio is affected by 3D spatialisation calculations
Declaration
public override float spatialBlend { get; set; }Property Value
| Type | Description |
|---|---|
| Single |
Overrides
spread
Spread angle (in degrees) of a 3d stereo or multichannel sound in speaker space
Declaration
public override float spread { get; set; }Property Value
| Type | Description |
|---|---|
| Single |
Overrides
time
Playback position in seconds
Declaration
public override float time { get; set; }Property Value
| Type | Description |
|---|---|
| Single |
Overrides
timeSamples
Playback position in PCM samples
Declaration
public override int timeSamples { get; set; }Property Value
| Type | Description |
|---|---|
| Int32 |
Overrides
volume
Volume to for the audio clip
Declaration
public override float volume { get; set; }Property Value
| Type | Description |
|---|---|
| Single |
Overrides
Methods
Awake()
Declaration
protected override void Awake()Overrides
Pause()
Pause the audio player
Declaration
public override void Pause()Overrides
Play()
Play the currently set audio clip
Declaration
public override void Play()Overrides
ResetAudioPlayer()
Reset the audio player to its default values
Declaration
public override void ResetAudioPlayer()Overrides
Stop()
Stop the currently playing audio
Declaration
public override void Stop()Overrides
UnPause()
UnPause the audio player
Declaration
public override void UnPause()