public class AudioSourceWrapper : MonoBehaviourWrapper

An audio source.

Spawnable via "Entity.AudioSource".

public void Play()

(Client) Plays the audio source.

public void Stop()

(Client) Stops the audio source.

public void Pause()

(Client) Pauses the audio source.

public void Unpause()

(Client) Unpauses the audio source.

public bool IsPlaying()

(Client) Checks whether this audio source is currently playing.

Returns: (bool) Whether this audio source is currently playing.

public AudioResource GetAudioClip()

(Client) Gets the audio resource of the source.

Returns: (AudioResource) The audio resource.

public void SetAudioClip(AudioResource clip)

(Client) Sets the audio resource of the source.

Arguments

• (AudioResource) The audio resource. [clip]

public void SetSoundType(SoundType type)

(Client) Sets the type of sound this audio source is. This is used for volume control.

Arguments

• (SoundType) The sound type of this audio source. (SoundType.Effect, SoundType.Music, SoundType.VoiceChat) [type]

public float GetVolume()

(Client) Get the volume of this audio source.

Returns: (float) The volume of this audio source.

public void SetVolume(float volume)

(Client) Set the volume of this audio source.

Arguments

• (float) The volume of this audio source. [volume]

public bool GetMute()

(Client) Checks whether this audio source is muted.

Returns: (bool) Whether this audio source is muted.

public void SetMute(bool mute)

(Client) Sets whether this audio source is muted.

Arguments

• (bool) Whether this audio source should be muted. [mute]

public float GetPitch()

(Client) Gets the pitch level of this audio source.

Returns: (float) The pitch level of this audio source.

public void SetPitch(float pitch)

(Client) Sets the pitch level of this audio source.

Arguments

• (float) The pitch level of this audio source. [pitch]

public bool GetLoop()

(Client) Checks whether this audio source is set to loop.

Returns: (bool) Whether this audio source is set to loop.

public void SetLoop(bool loop)

(Client) Sets whether this audio source should loop.

Arguments

• (bool) Whether this audio source should loop. [loop]

public bool Get3D()

(Client) Checks whether this audio source is 3D.

Returns: (bool) Whether this audio source is 3D.

public void Set3D(bool is3D)

(Client) Sets whether this audio source is 3D.

Arguments

• (bool) Whether this audio source is 3D. [is3D]

public float GetMinDistance()

(Client) Gets the minimum distance where the audio source can be heard at full volume (when set as 3D).

Returns: (float) The minimum distance of this audio source.

public void SetMinDistance(float minDistance)

(Client) Sets the minimum distance where the audio source can be heard at full volume (when set as 3D).

Arguments

• (float) The minimum distance of this audio source. [minDistance]

public float GetMaxDistance()

(Client) Gets the maximum distance where the audio source can be heard (when set as 3D).

Returns: (float) The maximum distance of this audio source.

public void SetMaxDistance(float maxDistance)

(Client) Sets the maximum distance where the audio source can be heard (when set as 3D).

Arguments

• (float) The maximum distance of this audio source. [maxDistance]

public bool GetReverbBypass()

(Client) Checks whether this audio source is set to ignore reverb effects.

Returns: (bool) Whether this audio source is set to ignore reverb effects.

public void SetReverbBypass(bool bypass)

(Client) Sets whether this audio source should ignore reverb effects

Arguments

• (bool) Whether this audio source should ignore reverb effects. [bypass]

public float GetDopplerLevel()

(Client) Gets the doppler level of this audio source.

Returns: (float) The doppler level of this audio source.

public void SetDopplerLevel(float doppler)

(Client) Sets the doppler level of this audio source.

Arguments

• (float) The doppler level of this audio source. [doppler]

public float GetSpread()

(Client) Gets the 3D spread of this audio source.

Returns: (float) The 3D spread of this audio source.

public void SetSpread(float spread)

(Client) Sets the 3D spread of this audio source.

Arguments

• (float) The 3D spread of this audio source. [spread]