flimSounds provide audio playback and processing functionality. More...

Collaboration diagram for flimSounds:

Classes
class	flimSound
	A flim sound. More...

Enumerations
enum	DistanceCurve { DistanceCurve::Linear, DistanceCurve::Logarithmic, DistanceCurve::Reverse_Logarithmic }
	Values that represent distance curves. More...

enum	SourceType { SourceType::Point, SourceType::Plane }
	Values that represent source types. More...

Functions
	flimSound::flimSound (SoundCallID id, bool is3DSound=false, bool occ=false)
	Constructor. More...

snd_err	flimSound::getPosition (Vect &out) const
	Gets a position. More...

snd_err	flimSound::setPosition (const Vect &orient)
	Sets a position. More...

snd_err	flimSound::SetOrientation (const Vect &vect, float xU=0.0f, float yU=1.0f, float zU=0.0f)
	Sets an orientation. More...

snd_err	flimSound::getDistanceCurve (DistanceCurve &out)
	Gets distance curve. More...

snd_err	flimSound::setDistanceCurve (const DistanceCurve &distCurve)
	Sets distance curve. More...

snd_err	flimSound::getReverb (flimReverb &out) const
	Gets a reverb. More...

snd_err	flimSound::getFilter (flimFilter &out) const
	Gets a filter. More...

snd_err	flimSound::Pan (float p, int triggerTime=0)
	Pans. More...

snd_err	flimSound::Pan (float from, float to, float time, int triggerTime=0)
	Pans. More...

snd_err	flimSound::Loop (bool toLoop, int triggerTime=0)
	Loops. More...

snd_err	flimSound::Pitch (float p, int triggerTime=0)
	Pitches. More...

snd_err	flimSound::Pitch (float from, float to, float time, int triggerTime=0)
	Pitches. More...

snd_err	flimSound::Volume (float p, int triggerTime=0)
	Volumes. More...

snd_err	flimSound::Volume (float from, float to, float time, int triggerTime=0)
	Volumes. More...

snd_err	flimSound::Play (bool toLoop=false, int t=0, int _priority=0)
	Plays. More...

snd_err	flimSound::Stop (int t=0)
	Stops the given t. More...

snd_err	flimSound::Pause (int t=0)
	Pauses the given t. More...

snd_err	flimSound::IsPlaying (bool &)
	Is playing. More...

snd_err	flimSound::GetTimeSinceStarted (int &)
	Gets time since started. More...

snd_err	flimSound::GetVolume (float &)
	Gets a volume. More...

snd_err	flimSound::GetPitch (float &)
	Gets a pitch. More...

snd_err	flimSound::GetPan (float &)
	Gets a pan. More...

snd_err	flimSound::GetPriority (int &)
	Gets a priority. More...

snd_err	flimSound::GetLoop (bool &)
	Gets a loop. More...

snd_err	flimSound::SubmitSoundEndedCallback (CallbackCommand *cmd)
	Callback, called when the submit sound ended. More...

errcode	flimSound::Collision (GameObject *)
	Collisions the given parameter 1. More...

errcode	flimSound::Collision (Collidable *) override
	Collisions the given parameter 1. More...

errcode	flimSound::CollisionTerrain (const CollisionVolumeAABB &aabb) override
	Collision terrain. More...

errcode	flimSound::CollisionEnter (Collidable *)
	Collision enter. More...

errcode	flimSound::SetReverbLevel (float level)
	Sets reverb level. More...

errcode	flimSound::SetReverbTime (float time)
	Sets reverb time. More...

errcode	flimSound::SetReverbPreDelay (float time)
	Sets reverb pre delay. More...

errcode	flimSound::SetReverbSize (float size)
	Sets reverb size. More...

errcode	flimSound::SetReverbDensity (float density)
	Sets reverb density. More...

Detailed Description

flimSounds provide audio playback and processing functionality.

Enumeration Type Documentation

◆ DistanceCurve

enum DistanceCurve

strong

Values that represent distance curves.

Enumerator
Linear
Logarithmic
Reverse_Logarithmic

◆ SourceType

enum SourceType

strong

Values that represent source types.

Enumerator
Point
Plane

Function Documentation

◆ Collision() [1/2]

errcode flimSound::Collision ( GameObject * )

Collisions the given parameter 1.

Author: Jack Campbell

Date: 6/1/2017

Parameters

[in,out] parameter1 If non-null, the first parameter.

Returns: An errcode.

◆ Collision() [2/2]

errcode flimSound::Collision ( Collidable * )

inlineoverridevirtual

Collisions the given parameter 1.

Author: Jack Campbell

Date: 6/1/2017

Parameters

[in,out] parameter1 If non-null, the first parameter.

Returns: An errcode.

Reimplemented from Collidable.

◆ CollisionEnter()

errcode flimSound::CollisionEnter ( Collidable * )

virtual

Collision enter.

Author: Jack Campbell

Date: 6/1/2017

Parameters

[in,out] parameter1 If non-null, the first parameter.

Returns: An errcode.

Reimplemented from Collidable.

◆ CollisionTerrain()

errcode flimSound::CollisionTerrain ( const CollisionVolumeAABB & aabb )

overridevirtual

Collision terrain.

Author: Jack Campbell

Date: 6/1/2017

Parameters

aabb The aabb.

Returns: An errcode.

Reimplemented from Collidable.

◆ flimSound()

flimSound::flimSound	(	SoundCallID	id,
		bool	is3DSound = `false`,
		bool	occ = `false`
	)

Constructor.

Author: Jack Campbell

Date: 6/1/2017

Parameters

id	The identifier.
is3DSound	(Optional) True if this object is 3D sound.
occ	(Optional) True to occ.

◆ getDistanceCurve()

snd_err flimSound::getDistanceCurve ( DistanceCurve & out )

Gets distance curve.

Author: Jack Campbell

Date: 6/1/2017

Parameters

[in,out] out The out.

Returns: The distance curve.

◆ getFilter()

snd_err flimSound::getFilter ( flimFilter & out ) const

Gets a filter.

Author: Jack Campbell

Date: 6/1/2017

Parameters

[in,out] out The out.

Returns: The filter.

◆ GetLoop()

snd_err flimSound::GetLoop ( bool & loop )

Gets a loop.

Author: Jack Campbell

Date: 6/1/2017

Parameters

[in,out] parameter1 The first parameter.

Returns: The loop.

◆ GetPan()

snd_err flimSound::GetPan ( float & p )

Gets a pan.

Author: Jack Campbell

Date: 6/1/2017

Parameters

[in,out] parameter1 The first parameter.

Returns: The pan.

◆ GetPitch()

snd_err flimSound::GetPitch ( float & p )

Gets a pitch.

Author: Jack Campbell

Date: 6/1/2017

Parameters

[in,out] parameter1 The first parameter.

Returns: The pitch.

◆ getPosition()

snd_err flimSound::getPosition ( Vect & out ) const

Gets a position.

Author: Jack Campbell

Date: 6/1/2017

Parameters

[in,out] out The out.

Returns: The position.

◆ GetPriority()

snd_err flimSound::GetPriority ( int & p )

Gets a priority.

Author: Jack Campbell

Date: 6/1/2017

Parameters

[in,out] parameter1 The first parameter.

Returns: The priority.

◆ getReverb()

snd_err flimSound::getReverb ( flimReverb & out ) const

Gets a reverb.

Author: Jack Campbell

Date: 6/1/2017

Parameters

[in,out] out The out.

Returns: The reverb.

◆ GetTimeSinceStarted()

snd_err flimSound::GetTimeSinceStarted ( int & time )

Gets time since started.

Author: Jack Campbell

Date: 6/1/2017

Parameters

[in,out] parameter1 The first parameter.

Returns: The time since started.

◆ GetVolume()

snd_err flimSound::GetVolume ( float & vol )

Gets a volume.

Author: Jack Campbell

Date: 6/1/2017

Parameters

[in,out] parameter1 The first parameter.

Returns: The volume.

◆ IsPlaying()

snd_err flimSound::IsPlaying ( bool & out )

Is playing.

Author: Jack Campbell

Date: 6/1/2017

Parameters

[in,out] parameter1 The first parameter.

Returns: A snd_err.

◆ Loop()

snd_err flimSound::Loop	(	bool	toLoop,
		int	triggerTime = `0`
	)

Loops.

Author: Jack Campbell

Date: 6/1/2017

Parameters

toLoop	True to to loop.
triggerTime	(Optional) The trigger time.

Returns: A snd_err.

◆ Pan() [1/2]

snd_err flimSound::Pan	(	float	p,
		int	triggerTime = `0`
	)

Pans.

Author: Jack Campbell

Date: 6/1/2017

Parameters

p	The float to process.
triggerTime	(Optional) The trigger time.

Returns: A snd_err.

◆ Pan() [2/2]

snd_err flimSound::Pan	(	float	from,
		float	to,
		float	time,
		int	triggerTime = `0`
	)

Pans.

Author: Jack Campbell

Date: 6/1/2017

Parameters

from	Source for the.
to	to.
time	The time.
triggerTime	(Optional) The trigger time.

Returns: A snd_err.

◆ Pause()

snd_err flimSound::Pause ( int t = 0 )

Pauses the given t.

Author: Jack Campbell

Date: 6/1/2017

Parameters

t	(Optional) The int to process.

Returns: A snd_err.

◆ Pitch() [1/2]

snd_err flimSound::Pitch	(	float	p,
		int	triggerTime = `0`
	)

Pitches.

Author: Jack Campbell

Date: 6/1/2017

Parameters

p	The float to process.
triggerTime	(Optional) The trigger time.

Returns: A snd_err.

◆ Pitch() [2/2]

snd_err flimSound::Pitch	(	float	from,
		float	to,
		float	time,
		int	triggerTime = `0`
	)

Pitches.

Author: Jack Campbell

Date: 6/1/2017

Parameters

from	Source for the.
to	to.
time	The time.
triggerTime	(Optional) The trigger time.

Returns: A snd_err.

◆ Play()

snd_err flimSound::Play	(	bool	toLoop = `false`,
		int	t = `0`,
		int	_priority = `0`
	)

Plays.

Author: Jack Campbell

Date: 6/1/2017

Parameters

toLoop	(Optional) True to to loop.
t	(Optional) The int to process.
_priority	(Optional) The priority.

Returns: A snd_err.

◆ setDistanceCurve()

snd_err flimSound::setDistanceCurve ( const DistanceCurve & distCurve )

Sets distance curve.

Author: Jack Campbell

Date: 6/1/2017

Parameters

distCurve The distance curve.

Returns: A snd_err.

◆ SetOrientation()

snd_err flimSound::SetOrientation	(	const Vect &	vect,
		float	xU = `0.0f`,
		float	yU = `1.0f`,
		float	zU = `0.0f`
	)

Sets an orientation.

Author: Jack Campbell

Date: 6/1/2017

Parameters

vect	The vect.
xU	(Optional) The x coordinate u.
yU	(Optional) The y coordinate u.
zU	(Optional) The z coordinate u.

Returns: A snd_err.

◆ setPosition()

snd_err flimSound::setPosition ( const Vect & orient )

Sets a position.

Author: Jack Campbell

Date: 6/1/2017

Parameters

orient The orient.

Returns: A snd_err.

◆ SetReverbDensity()

errcode flimSound::SetReverbDensity ( float density )

Sets reverb density.

Author: Jack Campbell

Date: 6/1/2017

Parameters

density The density.

Returns: An errcode.

◆ SetReverbLevel()

errcode flimSound::SetReverbLevel ( float level )

Sets reverb level.

Author: Jack Campbell

Date: 6/1/2017

Parameters

level The level.

Returns: An errcode.

◆ SetReverbPreDelay()

errcode flimSound::SetReverbPreDelay ( float time )

Sets reverb pre delay.

Author: Jack Campbell

Date: 6/1/2017

Parameters

time The time.

Returns: An errcode.

◆ SetReverbSize()

errcode flimSound::SetReverbSize ( float size )

Sets reverb size.

Author: Jack Campbell

Date: 6/1/2017

Parameters

size The size.

Returns: An errcode.

◆ SetReverbTime()

errcode flimSound::SetReverbTime ( float time )

Sets reverb time.

Author: Jack Campbell

Date: 6/1/2017

Parameters

time The time.

Returns: An errcode.

◆ Stop()

snd_err flimSound::Stop ( int t = 0 )

Stops the given t.

Author: Jack Campbell

Date: 6/1/2017

Parameters

t	(Optional) The int to process.

Returns: A snd_err.

◆ SubmitSoundEndedCallback()

snd_err flimSound::SubmitSoundEndedCallback ( CallbackCommand * cmd )

Callback, called when the submit sound ended.

Author: Jack Campbell

Date: 6/1/2017

Parameters

[in,out] cmd If non-null, the command.

Returns: A snd_err.

◆ Volume() [1/2]

snd_err flimSound::Volume	(	float	p,
		int	triggerTime = `0`
	)

Volumes.

Author: Jack Campbell

Date: 6/1/2017

Parameters

p	The float to process.
triggerTime	(Optional) The trigger time.

Returns: A snd_err.

◆ Volume() [2/2]

snd_err flimSound::Volume	(	float	from,
		float	to,
		float	time,
		int	triggerTime = `0`
	)

Volumes.

Author: Jack Campbell

Date: 6/1/2017

Parameters

from	Source for the.
to	to.
time	The time.
triggerTime	(Optional) The trigger time.

Returns: A snd_err.

Classes

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ DistanceCurve

◆ SourceType

Function Documentation

◆ Collision() [1/2]

◆ Collision() [2/2]

◆ CollisionEnter()

◆ CollisionTerrain()

◆ flimSound()

◆ getDistanceCurve()

◆ getFilter()

◆ GetLoop()

◆ GetPan()

◆ GetPitch()

◆ getPosition()

◆ GetPriority()

◆ getReverb()

◆ GetTimeSinceStarted()

◆ GetVolume()

◆ IsPlaying()

◆ Loop()

◆ Pan() [1/2]

◆ Pan() [2/2]

◆ Pause()

◆ Pitch() [1/2]

◆ Pitch() [2/2]

◆ Play()

◆ setDistanceCurve()

◆ SetOrientation()

◆ setPosition()

◆ SetReverbDensity()

◆ SetReverbLevel()

◆ SetReverbPreDelay()

◆ SetReverbSize()

◆ SetReverbTime()

◆ Stop()

◆ SubmitSoundEndedCallback()

◆ Volume() [1/2]

◆ Volume() [2/2]