Aire::AudioSource Class Reference

AudioSource class to play sound effects. More...

#include <audioSource.h>

Public Member Functions
	AudioSource (const std::string &soundFile)
	Constructs an AudioSource object with the specified sound file.
	AudioSource (const std::string &soundFile, float x, float y, float z)
	Constructs an AudioSource object with the specified sound file and position.
	AudioSource (const std::string &soundFile, const glm::vec3 &pos)
	Constructs an AudioSource object with the specified sound file and position.
void	release ()
	Releases resources associated with the AudioSource.
void	play ()
	Plays the audio.
void	pause ()
	Pauses the audio.
void	stop ()
	Stops the audio.
AudioSource *	loop (bool shouldLoop)
	Sets whether the audio should loop.
AudioSource *	spatial (bool isSpatial)
	Sets whether the audio should be spatial.
AudioSource *	setPosition (float x, float y, float z)
	Sets the position of the AudioSource.
AudioSource *	setPosition (const glm::vec3 &pos)
	Sets the position of the AudioSource.
AudioSource *	setValue (float value)
	Set the value of the AudioSource.
AudioSource *	setLinearDistanceModel ()
	Set the distance model to linear.
AudioSource *	setExponentialDistanceModel (float refDistance, float rollFactor)
	Set the distance model to exponential.
glm::vec3	getPosition () const
	Gets the position of the AudioSource.

Detailed Description

AudioSource class to play sound effects.

Constructor & Destructor Documentation

AudioSource() [1/3]

AudioSource::AudioSource

(

const std::string &

soundFile

)

Constructs an AudioSource object with the specified sound file.

Parameters

soundFile

The path to the sound file.

AudioSource() [2/3]

AudioSource::AudioSource	(	const std::string &	soundFile,
		float	x,
		float	y,
		float	z )

Constructs an AudioSource object with the specified sound file and position.

Parameters

soundFile	The path to the sound file.
x	The x-coordinate of the position.
y	The y-coordinate of the position.
z	The z-coordinate of the position.

Here is the call graph for this function:

AudioSource() [3/3]

Aire::AudioSource::AudioSource	(	const std::string &	soundFile,
		const glm::vec3 &	pos )

Constructs an AudioSource object with the specified sound file and position.

Parameters

soundFile	The path to the sound file.
pos	The position vector.

Here is the call graph for this function:

Member Function Documentation

getPosition()

glm::vec3 Aire::AudioSource::getPosition

(

)

const

Gets the position of the AudioSource.

Returns

The position vector.

loop()

AudioSource * AudioSource::loop

(

bool

shouldLoop

)

Sets whether the audio should loop.

Parameters

shouldLoop

True if the audio should loop, false otherwise.

Returns

Pointer to the current AudioSource object.

Here is the caller graph for this function:

setExponentialDistanceModel()

AudioSource * Aire::AudioSource::setExponentialDistanceModel	(	float	refDistance,
		float	rollFactor )

Set the distance model to exponential.

Parameters

refDistance
rollFactor

Returns

Pointer to the current AudioSource object.

Here is the caller graph for this function:

setLinearDistanceModel()

AudioSource * Aire::AudioSource::setLinearDistanceModel

(

)

Set the distance model to linear.

Returns

Pointer to the current AudioSource object.

setPosition() [1/2]

AudioSource * Aire::AudioSource::setPosition

(

const glm::vec3 &

pos

)

Sets the position of the AudioSource.

Parameters

pos	The position vector.

Returns

Pointer to the current AudioSource object.

Here is the call graph for this function:

Here is the caller graph for this function:

setPosition() [2/2]

AudioSource * AudioSource::setPosition	(	float	x,
		float	y,
		float	z )

Sets the position of the AudioSource.

Parameters

x	The x-coordinate of the position.
y	The y-coordinate of the position.
z	The z-coordinate of the position.

Returns

Pointer to the current AudioSource object.

Here is the caller graph for this function:

setValue()

AudioSource * Aire::AudioSource::setValue

(

float

value

)

Set the value of the AudioSource.

Parameters

value

Returns

Pointer to the current AudioSource object.

Here is the caller graph for this function:

spatial()

AudioSource * Aire::AudioSource::spatial

(

bool

isSpatial

)

Sets whether the audio should be spatial.

Parameters

isSpatial

True if the audio should be spatial, false otherwise.

Returns

Pointer to the current AudioSource object.

Here is the caller graph for this function:

---

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

• source/audio/audioSource.h
• source/audio/audioSource.cpp