Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

SegmentInit Struct Reference

Initialization structure for the ISegment class. More...

#include <IAudio.h>

List of all members.

Public Methods

 SegmentInit ()
void Clear ()

Public Attributes

std::string m_sFileName
 Source file used when creating segment object. More...

bool m_bLooping
 Does the segment loop?

bool m_bMusic
 Is this segment part of the music playback system? (defaults to true).

IDLSm_pDLS
 This DLS object is used by the segment. More...


Detailed Description

Initialization structure for the ISegment class.

All initial parameters can be set in this structure. Generally speaking, parameters listed in this structure are crucial to the initial contruction of the sound object, and so cannot be modified at run-time.

See also:
ISegment::Init()


Constructor & Destructor Documentation

SegmentInit::SegmentInit ( ) [inline]
 

SegmentInit constructor automatically calls Clear() to initialize the structure.


Member Function Documentation

void SegmentInit::Clear ( ) [inline]
 

Sets all members either to an appropriate default value if it exists, or else to zero.


Member Data Documentation

IDLS * SegmentInit::m_pDLS
 

This DLS object is used by the segment.

The segment will automatically call Lock() on the DLS interface, which increments an internal reference count and loads the DLS file whenever the segment is loaded, and calls Unlock() when it is unloaded.

std::string SegmentInit::m_sFileName
 

Source file used when creating segment object.

For Win32/DirectX platform, valid file types include DirectMusic segments, MIDI files, and wave files (uncompressed or ACM compressed).


The documentation for this struct was generated from the following file:
Generated at Sun Jul 28 23:17:42 2002 for GAP Audio System by doxygen1.2.8.1 written by Dimitri van Heesch, © 1997-2001