AudioReceiver Class Reference

Receivers audio events to be played to the player. The audio receiver can receive two types of audio. The first type is backing music (i.e. music to set the games mood/theme) and sound effects (i.e. gunshots, explosions etc). This allows both music and sound effects to be mixed over one another. More...

List of all members.

Public Member Functions
void	Start ()
	Initialises the audio receivers attributes.
void	setCurrentSoundEffect (AudioClip _soundEffect, float _volume)
	Sets the current sound effect to be played.
void	setCurrentMusic (AudioClip _music, float _volume)
	Sets the current music to be played.

---

Detailed Description

Receivers audio events to be played to the player. The audio receiver can receive two types of audio. The first type is backing music (i.e. music to set the games mood/theme) and sound effects (i.e. gunshots, explosions etc). This allows both music and sound effects to be mixed over one another.

Author:

Alexander Poolton

Version:

3.0

Date:

15/7/2011

---

Member Function Documentation

void AudioReceiver::setCurrentMusic	(	AudioClip	_music,
		float	_volume
	)		[inline]

Sets the current music to be played.

Parameters:

[in]	_music	The music to be played
[in]	_volume	The volume of the music

void AudioReceiver::setCurrentSoundEffect	(	AudioClip	_soundEffect,
		float	_volume
	)		[inline]

Sets the current sound effect to be played.

Parameters:

[in]	_soundEffect	The sound effect to be played
[in]	_volume	The volume of the sound effect

---

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

• C:/Users/Alex/Desktop/Gamepad Classes/Player/AudioReceiver.cs