---

IDLS Class Reference

Interface structure for DLS collections. More...

#include <IAudio.h>

Inheritance diagram for IDLS::

List of all members.

Public Methods
virtual bool	Init (const DLSInit &init)=0
virtual bool	Lock ()=0
virtual bool	Unlock ()=0

---

Detailed Description

Interface structure for DLS collections.

The IDLS interface is designed to be used internally by segment objects. A DLS collection may be associated with an ISegment object through the SegmentInit::m_pDLS member. Segments will internally call Lock() and Unlock() to load or unload the DLS member explicitly as appropriate.

See also:

DLSInit

---

Member Function Documentation

bool IDLS::Init ( const DLSInit & init ) [pure virtual]

Initializes the DLS object. This must be the first function called on the sound after the object is created. Parameters: init   is the initialization structure for DLS objects, containing pamrameters needed to prepare the DLS object for use. Returns: true indicates success, false indicates failure. See also: Destroy()

bool IDLS::Lock ( ) [pure virtual]

This loads all DLS data. Unlike a typical load function, an internal reference count is incremented with each call to Lock(), and will force the DLS data to remain loaded until either the reference count drops to zero or the Destoy() function is called. Returns: true if the lock was successful and/or the DLS collection was succesfully loaded, and false if there was an error loading the data. See also: Unlock()

bool IDLS::Unlock ( ) [pure virtual]

Decreases an internal reference count incremented by the Lock() function. When the reference count drops to zero, the DLS collection is unloaded. Returns: true indicates success, false indicates failure. See also: Lock()

---

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

• IAudio.h

---