Sound audio entity implementation. More...

#include <tdme/audio/Sound.h>

Inheritance diagram for Sound:

Collaboration diagram for Sound:

Public Member Functions
	Sound (const string &id, const string &pathName, const string &fileName)
	Protected constructor. More...

bool	isPlaying () override

void	rewind () override
	Rewinds this audio entity. More...

void	play () override
	Plays this audio entity. More...

void	pause () override
	Pauses this audio entity. More...

void	stop () override
	Stops this audio entity. More...

Public Member Functions inherited from AudioEntity
virtual const string &	getId () const

virtual const bool	isLooping () const

virtual void	setLooping (bool looping)
	Set looping. More...

virtual const bool	isFixed () const

virtual void	setFixed (bool fixed)
	Set this entity fixed, means the sound will always played no matter where the position and listener is located. More...

virtual const float	getPitch () const

virtual void	setPitch (float pitch)
	Set up pitch. More...

virtual const float	getGain () const

virtual void	setGain (float gain)
	Set up gain. More...

virtual const Vector3 &	getSourcePosition () const

virtual void	setSourcePosition (const Vector3 &sourcePosition)
	Set source position. More...

virtual const Vector3 &	getSourceDirection () const

virtual void	setSourceDirection (const Vector3 &sourceDirection)
	Set source direction. More...

virtual const Vector3 &	getSourceVelocity () const

virtual void	getSourceVelocity (const Vector3 &sourceVelocity)
	Set source velocity. More...

virtual bool	isPlaying ()=0

virtual void	rewind ()=0
	Rewinds this audio entity. More...

virtual void	play ()=0
	Plays this audio entity. More...

virtual void	pause ()=0
	Pauses this audio entity. More...

virtual void	stop ()=0
	Stops this audio entity. More...

Protected Member Functions
bool	initialize () override
	Initiates this OpenAL entity to OpenAl. More...

void	update () override
	Commits properties to OpenAl. More...

void	dispose () override
	Dispose this entity from OpenAL. More...

Protected Member Functions inherited from AudioEntity
	AudioEntity (const string &id)
	Constructor. More...

virtual	~AudioEntity ()
	Constructor. More...

virtual bool	initialize ()=0
	Initiates this OpenAL entity to OpenAl. More...

virtual void	update ()=0
	Commits properties to OpenAl. More...

virtual void	dispose ()=0
	Dispose this entity from OpenAL. More...

Private Attributes
bool	initiated

string	pathName

string	fileName

string	bufferId

uint32_t	alBufferId

uint32_t	alSourceId

Friends
class	Audio

Additional Inherited Members
Protected Attributes inherited from AudioEntity
string	id

bool	looping

bool	fixed

float	pitch

float	gain

Vector3	sourcePosition

Vector3	sourceDirection

Vector3	sourceVelocity

Detailed Description

Sound audio entity implementation.

Author: Andreas Drewke

Version: $Id$

Definition at line 18 of file Sound.h.

Constructor & Destructor Documentation

◆ Sound()

Sound	(	const string &	id,
		const string &	pathName,
		const string &	fileName
	)

Protected constructor.

Parameters

id	id
pathName	path name
fileName	file name

Definition at line 38 of file Sound.cpp.

Member Function Documentation

◆ dispose()

void dispose ( )

overrideprotectedvirtual

Dispose this entity from OpenAL.

Implements AudioEntity.

Definition at line 223 of file Sound.cpp.

◆ initialize()

bool initialize ( )

overrideprotectedvirtual

Initiates this OpenAL entity to OpenAl.

Implements AudioEntity.

Definition at line 101 of file Sound.cpp.

◆ isPlaying()

bool isPlaying ( )

overridevirtual

Returns: if stream is playing

Implements AudioEntity.

Definition at line 48 of file Sound.cpp.

◆ pause()

void pause ( )

overridevirtual

Pauses this audio entity.

Implements AudioEntity.

Definition at line 79 of file Sound.cpp.

◆ play()

void play ( )

overridevirtual

Plays this audio entity.

Implements AudioEntity.

Definition at line 66 of file Sound.cpp.

◆ rewind()

void rewind ( )

overridevirtual

Rewinds this audio entity.

Implements AudioEntity.

Definition at line 55 of file Sound.cpp.

◆ stop()

void stop ( )

overridevirtual

Stops this audio entity.

Implements AudioEntity.

Definition at line 90 of file Sound.cpp.

◆ update()

void update ( )

overrideprotectedvirtual

Commits properties to OpenAl.

Implements AudioEntity.

Definition at line 205 of file Sound.cpp.

Friends And Related Function Documentation

◆ Audio

friend class Audio

friend

Definition at line 21 of file Sound.h.

Member Data Documentation

◆ alBufferId

uint32_t alBufferId

private

Definition at line 28 of file Sound.h.

◆ alSourceId

uint32_t alSourceId

private

Definition at line 29 of file Sound.h.

◆ bufferId

string bufferId

private

Definition at line 27 of file Sound.h.

◆ fileName

string fileName

private

Definition at line 26 of file Sound.h.

◆ initiated

bool initiated

private

Definition at line 24 of file Sound.h.

◆ pathName

string pathName

private

Definition at line 25 of file Sound.h.

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

/home/andreas/Development/drewke.net/tdme2/src/tdme/audio/Sound.h
/home/andreas/Development/drewke.net/tdme2/src/tdme/audio/Sound.cpp

Public Member Functions

Protected Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Sound()

Member Function Documentation

◆ dispose()

◆ initialize()

◆ isPlaying()

◆ pause()

◆ play()

◆ rewind()

◆ stop()

◆ update()

Friends And Related Function Documentation

◆ Audio

Member Data Documentation

◆ alBufferId

◆ alSourceId

◆ bufferId

◆ fileName

◆ initiated

◆ pathName