Loop Class Reference

This sound loops another sound. More...

#include <Loop.h>

Inheritance diagram for Loop:

Public Member Functions
	Loop (std::shared_ptr< ISound > sound, int loop=-1)
	Creates a new loop sound. More...
int	getLoop () const
	Returns the loop count.
virtual std::shared_ptr< IReader >	createReader ()
	Creates a reader for playback of the sound source. More...
Public Member Functions inherited from Effect
	Effect (std::shared_ptr< ISound > sound)
	Creates a new sound. More...
virtual	~Effect ()
	Destroys the sound.
std::shared_ptr< ISound >	getSound () const
	Returns the saved sound. More...
Public Member Functions inherited from ISound
virtual	~ISound ()
	Destroys the sound.

Additional Inherited Members
Protected Member Functions inherited from Effect
std::shared_ptr< IReader >	getReader () const
	Returns the reader created out of the sound. More...
Protected Attributes inherited from Effect
std::shared_ptr< ISound >	m_sound
	If there is no reader it is created out of this sound.

Detailed Description

This sound loops another sound.

Note

The reader has to be seekable.

Constructor & Destructor Documentation

Loop()

Loop::Loop	(	std::shared_ptr< ISound >	sound,
		int	loop = -1
	)

Creates a new loop sound.

Parameters

sound	The input sound.
loop	The desired loop count, negative values result in endless looping.

Member Function Documentation

createReader()

virtual std::shared_ptr<IReader> Loop::createReader ( )

virtual

Creates a reader for playback of the sound source.

Returns

A pointer to an IReader object or nullptr if there has been an error.

Exceptions

Exception

An exception may be thrown if there has been a more unexpected error during reader creation.

Implements ISound.

---

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

• fx/Loop.h