Audaspace 1.5.0
A high level audio library.
No Matches
Public Member Functions | List of all members
Loop Class Reference

This sound loops another sound. More...

#include <Loop.h>

Inheritance diagram for Loop:
Inheritance graph

Public Member Functions

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

Additional Inherited Members

- Protected Member Functions inherited from Effect
std::shared_ptr< IReadergetReader () const
 Returns the reader created out of the sound.
- Protected Attributes inherited from Effect
std::shared_ptr< ISoundm_sound
 If there is no reader it is created out of this sound.

Detailed Description

This sound loops another sound.

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.

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

Member Function Documentation

◆ createReader()

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

Creates a reader for playback of the sound source.

A pointer to an IReader object or nullptr if there has been an error.
ExceptionAn 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: