Abstract base class for audio. More...

#include <Audio.h>

Inheritance diagram for ime::audio::Audio:

Public Types
using	Ptr = std::unique_ptr< Object >
	Unique object pointer. More...

Public Member Functions
	Audio ()
	Default constructor. More...

std::string	getClassType () const override
	Get the name of this class. More...

virtual void	setSource (const std::string &filename)=0
	Set audio source to be manipulated. More...

virtual const std::string &	getSource () const =0
	Get audio source. More...

virtual void	setVolume (float volume)=0
	Set the volume of the audio. More...

void	adjustVolume (float offset)
	Turn the volume up/down by a given offset. More...

virtual float	getVolume () const =0
	Get the volume of the audio. More...

void	setMute (bool mute)
	Set whether or not the audio should be audible. More...

bool	isMuted () const
	Check if audio is muted or not. More...

virtual void	setPitch (float pitch)=0
	Set the pitch of the audio. More...

virtual float	getPitch () const =0
	Get the pitch of the audio. More...

virtual void	setLoop (bool isLooped)=0
	Set whether or not the audio should loop after reaching the end. More...

virtual bool	isLooped () const =0
	Check if audio is looped or not. More...

virtual void	seek (const Time &position)=0
	Change the current playing position of the audio. More...

virtual Time	getPlayingPosition () const =0
	Get the current playing position of the audio. More...

virtual void	play ()=0
	Play audio. More...

virtual void	pause ()=0
	Pause audio. More...

virtual void	stop ()=0
	Stop playing the audio. More...

void	restart ()
	Reset the playing position to the beginning. More...

virtual Time	getDuration () const =0
	Get the total duration of the audio. More...

virtual Status	getStatus () const =0
	Get the current status of the audio (stopped, paused, playing) More...

	~Audio () override
	Destructor. More...

void	setTag (const std::string &tag)
	Assign the object an alias. More...

const std::string &	getTag () const
	Get the tag assigned to the object. More...

unsigned int	getObjectId () const
	Get the unique id of the object. More...

virtual std::string	getClassName () const =0
	Get the name of the objects concrete class. More...

int	onPropertyChange (const std::string &property, const Callback< Property > &callback, bool oneTime=false)
	Add an event listener to a specific property change event. More...

int	onPropertyChange (const Callback< Property > &callback, bool oneTime=false)
	Add an event listener to any property change event. More...

void	suspendedEventListener (int id, bool suspend)
	Pause or resume execution of an event listener. More...

bool	isEventListenerSuspended (int id) const
	Check if an event listener is suspended or not. More...

bool	removeEventListener (const std::string &event, int id)
	Remove an event listener from an event. More...

bool	removeEventListener (int id)
	Remove an event listener. More...

int	onDestruction (const Callback<> &callback)
	Add a destruction listener. More...

bool	isSameObjectAs (const Object &other) const
	Check if another object is the same instance as this object. More...

Protected Member Functions
void	emitChange (const Property &property)
	Dispatch a property change event. More...

void	emitDestruction ()
	Emit a destruction event. More...

Protected Attributes
EventEmitter	eventEmitter_
	Event dispatcher. More...

Detailed Description

Abstract base class for audio.

Definition at line 48 of file Audio.h.

Member Typedef Documentation

◆ Ptr

using ime::Object::Ptr = std::unique_ptr<Object>

inherited

Unique object pointer.

Definition at line 42 of file Object.h.

Constructor & Destructor Documentation

◆ Audio()

ime::audio::Audio::Audio ( )

Default constructor.

◆ ~Audio()

ime::audio::Audio::~Audio ( )

override

Destructor.

Member Function Documentation

◆ adjustVolume()

void ime::audio::Audio::adjustVolume ( float offset )

Turn the volume up/down by a given offset.

Parameters

offset Value to increase/decrease the volume by

This function adds on to the current volume. A positive offset increases the volume while a negative offset decreases the volume. This function will unmmute the audio if its muted

See also: setMute

◆ emitChange()

void ime::Object::emitChange ( const Property & property )

protectedinherited

Dispatch a property change event.

Parameters

property The property that changed

This function will invoke all the event listeners of the specified property

See also: emit

◆ emitDestruction()

void ime::Object::emitDestruction ( )

protectedinherited

Emit a destruction event.

Note: This function must be the first statement in the definition of a destructor to avoid undefined behavior. In addition, note that destruction listeners are invoked once. Therefore, multiple classes in a hierarchy may call this function but the class that makes the call first will be the one that invokes the destruction listeners

◆ getClassName()

virtual std::string ime::Object::getClassName ( ) const

pure virtualinherited

Get the name of the objects concrete class.

Returns: The name of the objects concrete class

This function is implemented by all internal classes that inherit from this class (either directly or indirectly). Example:

class ime::GameObject : public ime::Object {...}
GameObject gObject;
std::cout << gObject.getClassName(); // Prints "GameObject"

See also: getClassType

Implemented in ime::audio::Music, ime::audio::SoundEffect, ime::GameObject, ime::GridObject, ime::CyclicGridMover, ime::GridMover, ime::KeyboardGridMover, ime::RandomGridMover, ime::TargetGridMover, ime::AABB, ime::BoxCollider, ime::CircleCollider, ime::EdgeCollider, ime::PolygonCollider, ime::DistanceJoint, ime::RigidBody, ime::RenderLayer, ime::RenderLayerContainer, ime::Scene, ime::Camera, ime::CircleShape, ime::ConvexShape, ime::RectangleShape, ime::Sprite, ime::SpriteSheet, and ime::Tile.

◆ getClassType()

std::string ime::audio::Audio::getClassType ( ) const

overridevirtual

Get the name of this class.

Returns: The name of this class

Note that this function is only implemented by child classes of Object which also serve as a base class for other classes

See also: getClassName

Reimplemented from ime::Object.

◆ getDuration()

virtual Time ime::audio::Audio::getDuration ( ) const

pure virtual

Get the total duration of the audio.

Returns: The total duration of the audio

Implemented in ime::audio::Music, and ime::audio::SoundEffect.

◆ getObjectId()

unsigned int ime::Object::getObjectId ( ) const

inherited

Get the unique id of the object.

Returns: The unique id of the object

Note that each instance of ime::Object has a unique id

See also: setTag

◆ getPitch()

virtual float ime::audio::Audio::getPitch ( ) const

pure virtual

Get the pitch of the audio.

Returns: The pitch of the audio

Implemented in ime::audio::Music, and ime::audio::SoundEffect.

◆ getPlayingPosition()

virtual Time ime::audio::Audio::getPlayingPosition ( ) const

pure virtual

Get the current playing position of the audio.

Returns: Current playing position of the audio

Implemented in ime::audio::Music, and ime::audio::SoundEffect.

◆ getSource()

virtual const std::string & ime::audio::Audio::getSource ( ) const

pure virtual

Get audio source.

Returns: Filename of the actual audio file

Implemented in ime::audio::Music, and ime::audio::SoundEffect.

◆ getStatus()

virtual Status ime::audio::Audio::getStatus ( ) const

pure virtual

Get the current status of the audio (stopped, paused, playing)

Returns: Current status of the audio

Implemented in ime::audio::Music, and ime::audio::SoundEffect.

◆ getTag()

const std::string & ime::Object::getTag ( ) const

inherited

Get the tag assigned to the object.

Returns: The tag of the object

See also: setTag

◆ getVolume()

virtual float ime::audio::Audio::getVolume ( ) const

pure virtual

Get the volume of the audio.

Returns: Volume of the audio, in the range [0, 100]

Implemented in ime::audio::Music, and ime::audio::SoundEffect.

◆ isEventListenerSuspended()

bool ime::Object::isEventListenerSuspended ( int id ) const

inherited

Check if an event listener is suspended or not.

Parameters

id	The identification number of the listener to be checked

Returns: True if suspended, otherwise false

This function also returns false if the specified event listener does not exist

See also: suspendedEventListener

◆ isLooped()

virtual bool ime::audio::Audio::isLooped ( ) const

pure virtual

Check if audio is looped or not.

Returns: True if audio is looped, otherwise false

Implemented in ime::audio::Music, and ime::audio::SoundEffect.

◆ isMuted()

bool ime::audio::Audio::isMuted ( ) const

Check if audio is muted or not.

Returns: True if audio is muted or false if audio is not muted

◆ isSameObjectAs()

bool ime::Object::isSameObjectAs ( const Object & other ) const

inherited

Check if another object is the same instance as this object.

Parameters

other The object to compare against this object

Returns: True if other is the same instance as this object, otherwise false

◆ onDestruction()

int ime::Object::onDestruction ( const Callback<> & callback )

inherited

Add a destruction listener.

Parameters

callback Function to be executed when the object is destroyed

Returns: The unique id of the destruction listener

The destruction listener is called when the object reaches the end of its lifetime. Note that an object may have multiple destruction listeners registered to it

Warning: It's not advised to call virtual functions in the destruction callback as some parts of the object may have already been destroyed by the time the callback is invoked. In such an event, the behavior is undefined

See also: removeEventListener

◆ onPropertyChange() [1/2]

int ime::Object::onPropertyChange	(	const Callback< Property > &	callback,
		bool	oneTime = `false`
	)

inherited

Add an event listener to any property change event.

Parameters

callback	The function to be executed when any property changes
oneTime	True to execute the callback one-time or false to execute it every time the event is triggered

Returns: The unique id of the event listener

When unsubscribing the any property change event handler, you must pass "propertyChange" as the name of the event

See also: onPropertyChange(const std::string&, const ime::Callback<ime::Property>&)

◆ onPropertyChange() [2/2]

int ime::Object::onPropertyChange	(	const std::string &	property,
		const Callback< Property > &	callback,
		bool	oneTime = `false`
	)

inherited

Add an event listener to a specific property change event.

Parameters

property	The name of the property to add an event listener to
oneTime	True to execute the callback one-time or false to execute it every time the event is triggered
callback	The function to be executed when the property changes

Returns: The unique id of the event listener

A property change event is triggered by any function that begins with set, where the the text after set is the name of the property. For example, the setTag() function, modifies the tag property of the object, thus will generate a "tag" change event each time it is called

Note that multiple event listeners may be registered to the same property change event. In addition, when adding a property change event listener, the name of the property must be in lowercase.

// Prints the tag of the player object to the console everytime it changes
player.onPropertyChange("tag", [](const Property& property) {
     cout << "New tag: " <<  property.getValue<std::string>() << endl;
});
 
...
//Sets tag = "player1" and invokes event listener(s)
player.setTag("player1");

See also: unsubscribe and onPropertyChange(const ime::Callback<ime::Property>&)

◆ pause()

virtual void ime::audio::Audio::pause ( )

pure virtual

Pause audio.

This function pauses the stream if it was playing, otherwise (audio already paused or stopped) it has no effect

Implemented in ime::audio::Music, and ime::audio::SoundEffect.

◆ play()

virtual void ime::audio::Audio::play ( )

pure virtual

Play audio.

This function starts the audio if it was stopped, resumes it if it was paused, and restarts it from the beginning if it was already playing. This function uses its own thread so that it doesn't block the rest of the program while the audio is played

Implemented in ime::audio::Music, and ime::audio::SoundEffect.

◆ removeEventListener() [1/2]

bool ime::Object::removeEventListener	(	const std::string &	event,
		int	id
	)

inherited

Remove an event listener from an event.

Parameters

event	The name of the event to remove an event listener from
id	The unique id of the event listener to be removed

Returns: True if the event listener was removed or false if the event or the event listener is does not exist

// Display the tag of the object to console every time it changes
auto tagChangeId = object.onPropertyChange("tag", [](ime::Property tag) {
     std::cout << name.getValue<std::string>() << std::endl;
});
 
// Stop displaying the tag of the object when it changes
object.removeEventListener("tag", tagChangeId);

◆ removeEventListener() [2/2]

bool ime::Object::removeEventListener ( int id )

inherited

Remove an event listener.

Parameters

id	The id of the event listener to be removed

Returns: True if the event listener was removed or false if no such handler exists

◆ restart()

void ime::audio::Audio::restart ( )

Reset the playing position to the beginning.

This function will reset the playing position without stopping the audio (unlike stop function), which would require play to be called to get the audio to play again

◆ seek()

virtual void ime::audio::Audio::seek ( const Time & position )

pure virtual

Change the current playing position of the audio.

Parameters

position New playing position of the audio

The playing position can be changed when the audio is either paused or playing. Changing the playing position when the audio is stopped has no effect, since playing the audio would reset its position

Implemented in ime::audio::Music, and ime::audio::SoundEffect.

◆ setLoop()

virtual void ime::audio::Audio::setLoop ( bool isLooped )

pure virtual

Set whether or not the audio should loop after reaching the end.

Parameters

isLooped True to play in loop, false to play once

Implemented in ime::audio::Music, and ime::audio::SoundEffect.

◆ setMute()

void ime::audio::Audio::setMute ( bool mute )

Set whether or not the audio should be audible.

Parameters

mute	True to make audio inaudible, or false to make audio audible

When set to true the audio will not be audible but will continue to play if currently playing

◆ setPitch()

virtual void ime::audio::Audio::setPitch ( float pitch )

pure virtual

Set the pitch of the audio.

Parameters

pitch The new pitch of the audio

The pitch represents the perceived fundamental frequency of a sound; thus you can make a sound more acute or grave by changing its pitch. Changing the pitch also changes the playing speed of the audio.

The default value for the pitch is 1

Implemented in ime::audio::Music, and ime::audio::SoundEffect.

◆ setSource()

virtual void ime::audio::Audio::setSource ( const std::string & filename )

pure virtual

Set audio source to be manipulated.

Parameters

filename Filename of an audio file

The filename must refer to an actual audio file on the disk. This audio file is the one to be played, pitched and done all sorts of things

Implemented in ime::audio::Music, and ime::audio::SoundEffect.

◆ setTag()

void ime::Object::setTag ( const std::string & tag )

inherited

Assign the object an alias.

Parameters

tag	The alias of the object

This function is useful if you want to refer to the object by a tag instead of its object id. Unlike an object id, multiple objects may have the same tag

By default, the tag is an empty string

See also: getObjectId

◆ setVolume()

virtual void ime::audio::Audio::setVolume ( float volume )

pure virtual

Set the volume of the audio.

Parameters

volume Volume to set

The volume is a value between 0 (mute) and 100 (full volume).

The default value for the volume is 100

Implemented in ime::audio::Music, and ime::audio::SoundEffect.

◆ stop()

virtual void ime::audio::Audio::stop ( )

pure virtual

Stop playing the audio.

This function stops the audio if it was playing or paused, and does nothing if it was already stopped. It also resets the playing position

Implemented in ime::audio::Music, and ime::audio::SoundEffect.

◆ suspendedEventListener()

void ime::Object::suspendedEventListener	(	int	id,
		bool	suspend
	)

inherited

Pause or resume execution of an event listener.

Parameters

id	The event listeners unique identification number
suspend	True to suspend/pause or false to unsuspend/resume

See also: isEventListenerSuspended

Member Data Documentation

◆ eventEmitter_

EventEmitter ime::Object::eventEmitter_

protectedinherited

Event dispatcher.

Definition at line 289 of file Object.h.

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

Audio.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Ptr

Constructor & Destructor Documentation

◆ Audio()

◆ ~Audio()

Member Function Documentation

◆ adjustVolume()

◆ emitChange()

◆ emitDestruction()

◆ getClassName()

◆ getClassType()

◆ getDuration()

◆ getObjectId()

◆ getPitch()

◆ getPlayingPosition()

◆ getSource()

◆ getStatus()

◆ getTag()

◆ getVolume()

◆ isEventListenerSuspended()

◆ isLooped()

◆ isMuted()

◆ isSameObjectAs()

◆ onDestruction()

◆ onPropertyChange() [1/2]

◆ onPropertyChange() [2/2]

◆ pause()

◆ play()

◆ removeEventListener() [1/2]

◆ removeEventListener() [2/2]

◆ restart()

◆ seek()

◆ setLoop()

◆ setMute()

◆ setPitch()

◆ setSource()

◆ setTag()

◆ setVolume()

◆ stop()

◆ suspendedEventListener()

Member Data Documentation

◆ eventEmitter_