---

IPlayable Class Reference

Base class defining common interface of all playable audio components. More...

#include <IAudio.h>

Inheritance diagram for IPlayable::

List of all members.

Public Methods
virtual bool	Play ()=0
virtual bool	Pause ()=0
virtual bool	Stop ()=0
virtual bool	IsPlaying () const=0
virtual bool	IsPaused () const=0
virtual bool	IsLooping () const=0

---

Detailed Description

Base class defining common interface of all playable audio components.

IPlayable defines the common interface to which all basic audio components which can play sound or music must conform. Basic control functions such as Play(), Pause(), and Stop() are defined, as well as status functions to ascertain the current state of the object. Playable objects will automatically attempt to call Load() if the object is not currently loaded when it first attempts to play. If needed, the object will load in a background thread and begin playback immediately after the loading is completed.

---

Member Function Documentation

bool IPlayable::IsLooping ( ) const [pure virtual]

This function checks to see if the object is set to continuously loop. Returns: true if the audio object is set to continuously loop

bool IPlayable::IsPaused ( ) const [pure virtual]

Checks to see if Pause() if this audio object has been paused. Returns: true indicates the audio object is playing, otherwise returns false. See also: Pause()

bool IPlayable::IsPlaying ( ) const [pure virtual]

Checks to see if the audio object is currently playing. Returns: true indicates the audio object is playing, otherwise returns false. See also: Play(), Stop(), Pause()

bool IPlayable::Pause ( ) [pure virtual]

Pauses the object playback, leaving the play cursor where it is. Calling Play() after Pause() causes playback to resume where it was stopped, if seeking is supported (note - Segments will start playback from the beginning when paused). Returns: true indicates success, false indicates failure. See also: IsPaused()

bool IPlayable::Play ( ) [pure virtual]

Plays the audio data as appropriate. Note that looping is considered to be a property of the audio object, not a parameter of the play function. Returns: true indicates success, false indicates failure.

bool IPlayable::Stop ( ) [pure virtual]

Stops the audio object playback, resetting the play cursor to the beginning. Returns: true indicates success, false indicates failure.

---

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

• IAudio.h

---